====== Arno Release Documentation ======

This page contains links to all Arno release related documents.  Prior to release please take the time to proof read and provide patches to the documents in the associated repositories.

===== Release artifact documentation =====

==== Arno User Guide ====

[[http://artifacts.opnfv.org/genesis/common/docs/user-guide.html|Arno User Guide.]]

This document provides a brief outline and reference to upstream documentation for using the Arno release of OPNFV.  The documents was built from this [[https://git.opnfv.org/cgit/genesis/tree/common/docs/user-guide.rst|RST source]]. To contribute to this document, you can start by cloning the [[https://gerrit.opnfv.org/gerrit/#/admin/projects/genesis|genesis project repository]] as described at the [[https://wiki.opnfv.org/developer|OPNFV developer wiki page]].

----


==== Arno release notes (using Fuel as deployment tool) ====

[[http://artifacts.opnfv.org/genesis/fuel/docs/release-notes.html|Arno release notes for the Fuel deployment system.]]

This document describes the content and status of the Arno release when using the Fuel deployment tool.  The documents was built from this [[https://git.opnfv.org/cgit/genesis/tree/fuel/docs/src/release-notes.rst|RST source]]. To contribute to this document, you can start by cloning the [[https://gerrit.opnfv.org/gerrit/#/admin/projects/genesis|genesis project repository]] as described at the [[https://wiki.opnfv.org/developer|OPNFV developer wiki page]].

----

==== Arno installation guide using Fuel as deployment tool ====

[[http://artifacts.opnfv.org/genesis/fuel/docs/installation-instructions.html|Arno installation instructions for the Fuel deployment system.]]

This document describes the installation procedures for the Arno release when using the Fuel deployment tool.  The documents was built from this [[https://git.opnfv.org/cgit/genesis/tree/fuel/docs/src/installation-instructions.rst|RST source]]. To contribute to this document, you can start by cloning the [[https://gerrit.opnfv.org/gerrit/#/admin/projects/genesis|genesis project repository]] as described at the [[https://wiki.opnfv.org/developer|OPNFV developer wiki page]].

----

==== Arno release notes (using Foreman/Quickstack as deployment tool) ====

[[http://artifacts.opnfv.org/genesis/foreman/docs/release-notes.html|Arno release notes for the Foreman deployment system.]]

This document describes the content and status of the Arno release when using the Foreman deployment tool.  The documents was built from this [[https://git.opnfv.org/cgit/genesis/tree/foreman/docs/release-notes.rst|RST source]]. To contribute to this document, you can start by cloning the [[https://gerrit.opnfv.org/gerrit/#/admin/projects/genesis|genesis project repository]] as described at the [[https://wiki.opnfv.org/developer|OPNFV developer wiki page]].

----

==== Arno installation guide using Foreman/Quickstack as deployment tool ====

[[http://artifacts.opnfv.org/genesis/foreman/docs/installation-instructions.html|Arno installation guide for the Foreman deployment system.]]

This document describes the installation procedures for the Arno release when using the Foreman deployment tool.  The documents was built from this [[https://git.opnfv.org/cgit/genesis/tree/foreman/docs/installation-instructions.rst|RST source]]. To contribute to this document, you can start by cloning the [[https://gerrit.opnfv.org/gerrit/#/admin/projects/genesis|genesis project repository]] as described at the [[https://wiki.opnfv.org/developer|OPNFV developer wiki page]].

----

===== Pharos lab documentation =====

[[http://artifacts.opnfv.org/pharos/docs/pharos-spec.html|Arno release hardware configuration specification.]]

This document describes the pre-deploy hardware configuration required to install the Arno release using either the Fuel or Foreman deployment tools.  The document was built from the RST source at https://git.opnfv.org/cgit/pharos/tree/docs/pharos-spec.rst. To contribute to this document, you can start by cloning the [[https://gerrit.opnfv.org/gerrit/#/admin/projects/pharos|pharos project repository]] as described at the [[https://wiki.opnfv.org/developer|OPNFV developer wiki page]].

----

===== Function testing documentation =====

[[http://artifacts.opnfv.org/functest/docs/functest.html|Arno release function testing report and automated test procedures.]]

This document describes the post-deploy validation test suites for the Arno release.  The document was built from the RST source at https://git.opnfv.org/cgit/functest/tree/docs/functest.rst. To contribute to this document, you can start by cloning the [[https://gerrit.opnfv.org/gerrit/#/admin/projects/functest|functest project repository]] as described at the [[https://wiki.opnfv.org/developer|OPNFV developer wiki page]].

----

===== Lab OPNFV Jenkins Connection Documentation =====

[[http://artifacts.opnfv.org/octopus/docs/opnfv-jenkins-slave-connection.html|Arno release procedures for connecting a Pharos lab to the Jenkins infrastructure.]]

This document describes the procedures for connecting a Pharos compliant lab to the Jenkins infrastructure for automated deployment of the Arno release.  The document was built from the RST source at https://git.opnfv.org/cgit/octopus/tree/docs/opnfv-jenkins-slave-connection.rst. To contribute to this document, you can start by cloning the [[https://gerrit.opnfv.org/gerrit/#/admin/projects/octopus|octopus project repository]] as described at the [[https://wiki.opnfv.org/developer|OPNFV developer wiki page]].

----