Final releasenotes for Fuel/Arno SR1
[genesis.git] / common / docs / user-guide.rst
index d482000..08b2767 100644 (file)
@@ -21,14 +21,13 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 2015-05-28         | 0.0.1              | Christopher Price  | Initial version    |
+| 2015-06-04         | 1.0.0              | Christopher Price  | Initial revision   |
 |                    |                    | (Ericsson AB)      |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 2015-06-02         | 0.0.2              | Christopher Price  | Minor Updates      |
-|                    |                    | (Ericsson AB)      |                    |
+| 2015-06-05         | 1.0.1              | Christopher Price  | Corrected links &  |
+|                    |                    | (Ericsson AB)      | e-mail address     |
 +--------------------+--------------------+--------------------+--------------------+
 
-
 .. contents:: Table of Contents
    :backlinks: none
 
@@ -60,16 +59,16 @@ Hardware Requirements
 
 The Arno release of OPNFV is intended to be run as a baremetal deployment on a "Pharos compliant" lab infrastructure.  The Pharos project in OPNFV is a community activity to provide guidance and establish requirements on hardware platforms supporting the Arno virtualisation platform.
 
-Prior to deploying the OPNFV platform it is important that the hardware infrastructure be configured according to the Pharos specification: http://artifacts.opnfv.org/pharos/docs/spec.html
+Prior to deploying the OPNFV platform it is important that the hardware infrastructure be configured according to the Pharos specification: https://www.opnfv.org/sites/opnfv/files/release/pharos-spec.arno.2015.1.0.pdf
 
 Arno Platform Deployment
 ------------------------
 
 The Arno platform supports installation and deployment using two deployment tools; a Foreman based deployment toolchain and a Fuel based deployment toolchain.
 
-In order to deploy the Arno release on a Pharos compliant lab using the Foreman deployment toolchain you should follow in the Foreman installation guide: http://artifacts.opnfv.org/genesis/foreman/docs/installation-instructions.html
+In order to deploy the Arno release on a Pharos compliant lab using the Foreman deployment toolchain you should follow in the Foreman installation guide: https://www.opnfv.org/sites/opnfv/files/release/foreman_install-guide.arno.2015.1.0.pdf
 
-In order to deploy the Arno release on a Pharos compliant lab using the Fuel deployment toolchain you should follow in the Fuel installation guide: http://artifacts.opnfv.org/genesis/fuel/docs/installation-instructions.html
+In order to deploy the Arno release on a Pharos compliant lab using the Fuel deployment toolchain you should follow in the Fuel installation guide: https://www.opnfv.org/sites/opnfv/files/release/install-guide.arno.2015.1.0.pdf
 
 Enabling or disabling OpenDaylight and the native Neutron driver
 ----------------------------------------------------------------
@@ -79,7 +78,7 @@ You may find that you wish to adjust the system by enabling or disabling the nat
 Deployment Validation
 ---------------------
 
-Once installed you should validate the deployment completed successfully by executing the automated basic platform validation routines outlined in the Arno testing documentation: http://artifacts.opnfv.org/functest/docs/functest.html
+Once installed you should validate the deployment completed successfully by executing the automated basic platform validation routines outlined in the Arno testing documentation: https://www.opnfv.org/sites/opnfv/files/release/functest.arno.2015.1.0.pdf
 
 Operating the Arno platform
 ===========================
@@ -87,7 +86,7 @@ Operating the Arno platform
 The Arno release provides a platform for deploying software on virtual infrastructure.  The majority of operations to be executed on the platform revolve around deploying, managing and removing software (applications) on the platform itself.  Application deployment is covered in the following sections, however some platform operations you may want to perform include setting up a tenant, in OpenStack tenants are also known as projects in this document we will refer to them as tenants, and associated users for that tenant.
 
 OpenStack provides a good overview of how to create your first tenant for deploying your applications.  You should create a tenant for your applications, associate users with the tenant and assign quota's.
-- Open the OpenStack console (Horizon) you should find this by logging into your control node; for example to access the console of POD1 of the OPNFV lab you would browse to <172.30.9.70:80>
+ - Open the OpenStack console (Horizon) you should find this by logging into your control node; for example to access the console of POD1 of the OPNFV lab you would browse to <172.30.9.70:80>
  - Create your tenant and users by following the instructions at: http://docs.openstack.org/openstack-ops/content/projects_users.html
 
 Further actions and activities for checking logs and status can be found in other areas of the operations document: http://docs.openstack.org/openstack-ops/content/openstack-ops_preface.html
@@ -117,7 +116,7 @@ You can engage with the community to help us improve and further develop the OPN
  - To access Jira for issue reporting or improvement proposals head to: https://jira.opnfv.org/
  - To get started helping out developing the platform head to: https://wiki.opnfv.org/developer
 
-Alternatively if you are intending to invest your time as a user of the platform you can request support and help from our mailing list at: mailto://support@opnfv.org
+Alternatively if you are intending to invest your time as a user of the platform you can ask questions and request help from our mailing list at: mailto://opnfv-users@lists.opnfv.org
 
 License
 =======
@@ -128,20 +127,28 @@ Arno platform components and their licences are described in their respective Re
 References
 ==========
 
-OPNFV
------
-
 OpenStack
 ---------
 
+`OpenStack Admin User Guide <http://docs.openstack.org/user-guide-admin/>`_
+
 OpenDaylight
 ------------
 
+`OpenDaylight User Guide <https://www.opendaylight.org/sites/opendaylight/files/User-Guide-Helium-SR2.pdf>`_
+
 Foreman
 -------
 
+`Foreman User Manual <http://theforeman.org/manuals/1.7/index.html>`_
+
+Fuel
+----
+
+`Fuel User Guide <http://docs.fuel-infra.org/openstack/fuel/fuel-6.0/user-guide.html>`_
+
 :Authors: Christopher Price (christopher.price@ericsson.com)
-:Version: 0.0.2
+:Version: 1.0.1
 
 **Documentation tracking**