From 8136666e1efc9f89ac0793d5fbd7b41c1be91712 Mon Sep 17 00:00:00 2001 From: blsaws Date: Thu, 8 Sep 2016 08:49:19 -0700 Subject: Update to new docs folders and names. JIRA: COPPER-1 Remove trailing whitespace Change-Id: I6291106ca6133034cdee6551df1b7b075ea5ee69 Signed-off-by: blsaws (cherry picked from commit f845679c6e99e9a8b48a4f9ad01a6647383aa62e) --- docs/configguide/featureconfig.rst | 79 ---------------------- docs/configguide/index.rst | 10 --- docs/configguide/postinstall.rst | 63 ----------------- docs/design/featureconfig_link.rst | 2 +- docs/design/featureusage_link.rst | 2 +- docs/design/index.rst | 1 + docs/design/introduction.rst | 18 ----- docs/design/postinstall_link.rst | 2 +- docs/design/releasenotes_link.rst | 2 + .../feature.configuration.rst | 79 ++++++++++++++++++++++ docs/installationprocedure/index.rst | 10 +++ .../installation.instruction.rst | 63 +++++++++++++++++ docs/releasenotes/index.rst | 9 +++ docs/releasenotes/release.notes.rst | 27 ++++++++ docs/userguide/feature.usage.rst | 15 ++++ docs/userguide/featureusage.rst | 15 ---- docs/userguide/index.rst | 2 +- 17 files changed, 210 insertions(+), 189 deletions(-) delete mode 100644 docs/configguide/featureconfig.rst delete mode 100644 docs/configguide/index.rst delete mode 100644 docs/configguide/postinstall.rst create mode 100644 docs/design/releasenotes_link.rst create mode 100644 docs/installationprocedure/feature.configuration.rst create mode 100644 docs/installationprocedure/index.rst create mode 100644 docs/installationprocedure/installation.instruction.rst create mode 100644 docs/releasenotes/index.rst create mode 100644 docs/releasenotes/release.notes.rst create mode 100644 docs/userguide/feature.usage.rst delete mode 100644 docs/userguide/featureusage.rst diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst deleted file mode 100644 index fce0044..0000000 --- a/docs/configguide/featureconfig.rst +++ /dev/null @@ -1,79 +0,0 @@ -.. This work is licensed under a -.. Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV - -Copper configuration -==================== -This release includes installer support for the OpenStack Congress service under -JOID and Apex installers. Congress is installed by default for all JOID and Apex -scenarios. Support for other OPNFV installer deployed environments is planned -for the next release. - -Pre-configuration activities ----------------------------- -None required. - -Hardware configuration ----------------------- -There is no specific hardware configuration required for the Copper project. - -Feature configuration ---------------------- - -OPNFV installer support -....................... - -The Congress service is automatically configured as required by the JOID and -Apex installers, including creation of datasources per the installed datasource -drivers. This release includes default support for the following datasource drivers: - * nova - * neutronv2 - * ceilometer - * cinder - * glancev2 - * keystone - -For JOID, Congress is installed through a JuJu Charm, and for Apex through a -Puppet Module. Both the Charm and Module are being upstreamed to OpenStack for -future maintenance. - -Other project installer support (e.g. Doctor) may install additional datasource -drivers once Congress is installed. - -Manual installation -................... - -NOTE: This section describes a manual install procedure that had been tested -under the JOID and Apex base installs, prior to the integration of native -installer support through JuJu (JOID) and Puppet (Apex). This procedure is being -maintained as a basis for additional installer support in future releases. -However since Congress is pre-installed for JOID and Apex, this procedure is not -necessary and not recommended for use if Congress is already installed. - -Copper provides a set of bash scripts to automatically install Congress based -upon a JOID or Apex install which does not already have Congress installed. -These scripts are in the Copper repo at: - * components/congress/install/bash/install_congress_1.sh - * components/congress/install/bash/install_congress_2.sh - -Prerequisites to using these scripts: - * OPFNV installed via JOID or Apex - * For Apex installs, on the jumphost, ssh to the undercloud VM and "su stack". - * For JOID installs, admin-openrc.sh saved from Horizon to ~/admin-openrc.sh - * Retrieve the copper install script as below, optionally specifying the branch - to use as a URL parameter, e.g. ?h=stable%2Fbrahmaputra - -To invoke the procedure, enter the following shell commands, optionally -specifying the branch identifier to use for OpenStack. - -.. code:: - - cd ~ - wget https://git.opnfv.org/cgit/copper/plain/components/congress/install/bash/install_congress_1.sh - wget https://git.opnfv.org/cgit/copper/plain/components/congress/install/bash/install_congress_2.sh - bash install_congress_1.sh [openstack-branch] - -Copper post configuration procedures ------------------------------------- -No configuration procedures are required beyond the basic install procedure. diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst deleted file mode 100644 index f39e084..0000000 --- a/docs/configguide/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -******************************** -OPNFV Copper Configuration Guide -******************************** - -.. toctree:: - :numbered: - :maxdepth: 4 - - featureconfig.rst - postinstall.rst diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst deleted file mode 100644 index b80bb2f..0000000 --- a/docs/configguide/postinstall.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. This work is licensed under a -.. Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV - -Copper post installation procedures -=================================== - -This section describes optional procedures for verifying that the Congress -service is operational, and additional test tools developed for the Colorado -release. - -Copper functional tests ------------------------ - -This release includes the following test cases which are integrated into OPNFV -Functest for the JOID and Apex installers: - * DMZ Placement: dmz.sh - * SMTP Ingress: smtp_ingress.sh - * Reserved Subnet: reserved_subnet.sh - -These scripts, related scripts that clean up the OpenStack environment afterward, -and a combined test runner (run.sh) are in the Copper repo under the "tests" -folder. Instructions for using the tests are provided as script comments. - -Further description of the tests is provided on the Copper wiki at -https://wiki.opnfv.org/display/copper/testing. - - -Congress test webapp --------------------- - -This release also provides a webapp that can be automatically installed in a -docker container on the jumphost. This script is in the Copper repo at: - * components/congress/test-webapp/setup/install_congress_testserver.sh - -Prerequisites to using this script: - * OPFNV installed per JOID or Apex installer - * For Apex installs, on the jumphost, ssh to the undercloud VM and "su stack" - -To invoke the procedure, enter the following shell commands, optionally -specifying the branch identifier to use for Copper. - -.. code:: - - wget https://git.opnfv.org/cgit/copper/plain/components/congress/test-webapp/setup/install_congress_testserver.sh - bash install_congress_testserver.sh [copper-branch] - -Using the test webapp -..................... - -Browse to the webapp IP address provided at the end of the install -procedure. - -Interactive options are meant to be self-explanatory given a basic familiarity -with the Congress service and data model. - -Removing the test webapp -........................ - -The webapp can be removed by running this script from the Copper repo: - * components/congress/test-webapp/setup/clean_congress_testserver.sh - diff --git a/docs/design/featureconfig_link.rst b/docs/design/featureconfig_link.rst index 20ab6a9..6af66f7 100644 --- a/docs/design/featureconfig_link.rst +++ b/docs/design/featureconfig_link.rst @@ -1,2 +1,2 @@ .. include:: - ../configguide/featureconfig.rst + ../installationprocedure/feature.configuration.rst diff --git a/docs/design/featureusage_link.rst b/docs/design/featureusage_link.rst index 135cf01..c3ac10b 100644 --- a/docs/design/featureusage_link.rst +++ b/docs/design/featureusage_link.rst @@ -1,2 +1,2 @@ .. include:: - ../userguide/featureusage.rst + ../userguide/feature.usage.rst diff --git a/docs/design/index.rst b/docs/design/index.rst index 0f0d20a..637278b 100644 --- a/docs/design/index.rst +++ b/docs/design/index.rst @@ -12,6 +12,7 @@ OPNFV Copper Project :maxdepth: 4 introduction.rst + releasenotes_link.rst definitions.rst usecases.rst architecture.rst diff --git a/docs/design/introduction.rst b/docs/design/introduction.rst index 5f604c0..ad1f5f5 100644 --- a/docs/design/introduction.rst +++ b/docs/design/introduction.rst @@ -97,21 +97,3 @@ For that reason, the Copper project will initially focus on more specific configuration requirements as fulfilled by specific configuration capabilities, and how those requirements and capabilities are expressed in VNF and service design and packaging, or as generic poicies for the NFVI. - -Copper Release 1 Scope ----------------------- -OPNFV Brahmaputra was the initial OPNFV release for Copper, and achieved the -goals: - * Add the OpenStack Congress service to OPNFV, through at least one installer - project, through post-install configuration. - * Provide basis tests scripts and tools to exercise the Congress service - -Copper Release 2 Scope ----------------------- -OPNFV Colorado includes the additional features: - * Congress support in the the OPNFV CI/CD pipeline for the JOID and Apex - installers, through the following projects being upstreamed to OpenStack: - * For JOID, a JuJu Charm for Congress - * For Apex, a Puppet Module for Congress - * Congress use case tests integrated into Functest and as manual tests - * Further enhancements of Congress test tools diff --git a/docs/design/postinstall_link.rst b/docs/design/postinstall_link.rst index ab2038f..ca8d99c 100644 --- a/docs/design/postinstall_link.rst +++ b/docs/design/postinstall_link.rst @@ -1,2 +1,2 @@ .. include:: - ../configguide/postinstall.rst + ../installationprocedure/installation.instruction.rst diff --git a/docs/design/releasenotes_link.rst b/docs/design/releasenotes_link.rst new file mode 100644 index 0000000..6ee81a3 --- /dev/null +++ b/docs/design/releasenotes_link.rst @@ -0,0 +1,2 @@ +.. include:: + ../releasenotes/release.notes.rst diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst new file mode 100644 index 0000000..fce0044 --- /dev/null +++ b/docs/installationprocedure/feature.configuration.rst @@ -0,0 +1,79 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV + +Copper configuration +==================== +This release includes installer support for the OpenStack Congress service under +JOID and Apex installers. Congress is installed by default for all JOID and Apex +scenarios. Support for other OPNFV installer deployed environments is planned +for the next release. + +Pre-configuration activities +---------------------------- +None required. + +Hardware configuration +---------------------- +There is no specific hardware configuration required for the Copper project. + +Feature configuration +--------------------- + +OPNFV installer support +....................... + +The Congress service is automatically configured as required by the JOID and +Apex installers, including creation of datasources per the installed datasource +drivers. This release includes default support for the following datasource drivers: + * nova + * neutronv2 + * ceilometer + * cinder + * glancev2 + * keystone + +For JOID, Congress is installed through a JuJu Charm, and for Apex through a +Puppet Module. Both the Charm and Module are being upstreamed to OpenStack for +future maintenance. + +Other project installer support (e.g. Doctor) may install additional datasource +drivers once Congress is installed. + +Manual installation +................... + +NOTE: This section describes a manual install procedure that had been tested +under the JOID and Apex base installs, prior to the integration of native +installer support through JuJu (JOID) and Puppet (Apex). This procedure is being +maintained as a basis for additional installer support in future releases. +However since Congress is pre-installed for JOID and Apex, this procedure is not +necessary and not recommended for use if Congress is already installed. + +Copper provides a set of bash scripts to automatically install Congress based +upon a JOID or Apex install which does not already have Congress installed. +These scripts are in the Copper repo at: + * components/congress/install/bash/install_congress_1.sh + * components/congress/install/bash/install_congress_2.sh + +Prerequisites to using these scripts: + * OPFNV installed via JOID or Apex + * For Apex installs, on the jumphost, ssh to the undercloud VM and "su stack". + * For JOID installs, admin-openrc.sh saved from Horizon to ~/admin-openrc.sh + * Retrieve the copper install script as below, optionally specifying the branch + to use as a URL parameter, e.g. ?h=stable%2Fbrahmaputra + +To invoke the procedure, enter the following shell commands, optionally +specifying the branch identifier to use for OpenStack. + +.. code:: + + cd ~ + wget https://git.opnfv.org/cgit/copper/plain/components/congress/install/bash/install_congress_1.sh + wget https://git.opnfv.org/cgit/copper/plain/components/congress/install/bash/install_congress_2.sh + bash install_congress_1.sh [openstack-branch] + +Copper post configuration procedures +------------------------------------ +No configuration procedures are required beyond the basic install procedure. diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst new file mode 100644 index 0000000..9b5d02f --- /dev/null +++ b/docs/installationprocedure/index.rst @@ -0,0 +1,10 @@ +******************************** +OPNFV Copper Configuration Guide +******************************** + +.. toctree:: + :numbered: + :maxdepth: 4 + + feature.configuration.rst + installation.instruction.rst diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/installationprocedure/installation.instruction.rst new file mode 100644 index 0000000..b80bb2f --- /dev/null +++ b/docs/installationprocedure/installation.instruction.rst @@ -0,0 +1,63 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV + +Copper post installation procedures +=================================== + +This section describes optional procedures for verifying that the Congress +service is operational, and additional test tools developed for the Colorado +release. + +Copper functional tests +----------------------- + +This release includes the following test cases which are integrated into OPNFV +Functest for the JOID and Apex installers: + * DMZ Placement: dmz.sh + * SMTP Ingress: smtp_ingress.sh + * Reserved Subnet: reserved_subnet.sh + +These scripts, related scripts that clean up the OpenStack environment afterward, +and a combined test runner (run.sh) are in the Copper repo under the "tests" +folder. Instructions for using the tests are provided as script comments. + +Further description of the tests is provided on the Copper wiki at +https://wiki.opnfv.org/display/copper/testing. + + +Congress test webapp +-------------------- + +This release also provides a webapp that can be automatically installed in a +docker container on the jumphost. This script is in the Copper repo at: + * components/congress/test-webapp/setup/install_congress_testserver.sh + +Prerequisites to using this script: + * OPFNV installed per JOID or Apex installer + * For Apex installs, on the jumphost, ssh to the undercloud VM and "su stack" + +To invoke the procedure, enter the following shell commands, optionally +specifying the branch identifier to use for Copper. + +.. code:: + + wget https://git.opnfv.org/cgit/copper/plain/components/congress/test-webapp/setup/install_congress_testserver.sh + bash install_congress_testserver.sh [copper-branch] + +Using the test webapp +..................... + +Browse to the webapp IP address provided at the end of the install +procedure. + +Interactive options are meant to be self-explanatory given a basic familiarity +with the Congress service and data model. + +Removing the test webapp +........................ + +The webapp can be removed by running this script from the Copper repo: + * components/congress/test-webapp/setup/clean_congress_testserver.sh + diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst new file mode 100644 index 0000000..f33c7fc --- /dev/null +++ b/docs/releasenotes/index.rst @@ -0,0 +1,9 @@ +************************** +OPNFV Copper Rekease Notes +************************** + +.. toctree:: + :numbered: + :maxdepth: 4 + + release.notes.rst diff --git a/docs/releasenotes/release.notes.rst b/docs/releasenotes/release.notes.rst new file mode 100644 index 0000000..c62ae74 --- /dev/null +++ b/docs/releasenotes/release.notes.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV + +Release Notes +============= + +Copper Release 1 Scope +---------------------- +OPNFV Brahmaputra was the initial OPNFV release for Copper, and achieved the +goals: + * Add the OpenStack Congress service to OPNFV, through at least one installer + project, through post-install configuration. + * Provide basis tests scripts and tools to exercise the Congress service + +Copper Release 2 Scope +---------------------- +OPNFV Colorado includes the additional features: + * Congress support in the the OPNFV CI/CD pipeline for the JOID and Apex + installers, through the following projects being upstreamed to OpenStack: + + * For JOID, a JuJu Charm for Congress + * For Apex, a Puppet Module for Congress + + * Congress use case tests integrated into Functest and as manual tests + * Further enhancements of Congress test tools diff --git a/docs/userguide/feature.usage.rst b/docs/userguide/feature.usage.rst new file mode 100644 index 0000000..4570106 --- /dev/null +++ b/docs/userguide/feature.usage.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV + +Copper capabilities and usage +============================= +This release focused on use of the OpenStack Congress service for managing +configuration policy. See the `Congress intro guide on readthedocs +`_ for general information +on the capabilities and usage of Congress. + +Examples of Congress API usage can be found in the Copper tests as described +on the OPNFV wiki at https://wiki.opnfv.org/display/copper/testing. + diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst deleted file mode 100644 index 4570106..0000000 --- a/docs/userguide/featureusage.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a -.. Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV - -Copper capabilities and usage -============================= -This release focused on use of the OpenStack Congress service for managing -configuration policy. See the `Congress intro guide on readthedocs -`_ for general information -on the capabilities and usage of Congress. - -Examples of Congress API usage can be found in the Copper tests as described -on the OPNFV wiki at https://wiki.opnfv.org/display/copper/testing. - diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index dce8b75..73f3126 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -6,4 +6,4 @@ OPNFV Copper Configuration Guide :numbered: :maxdepth: 4 - featureusage.rst + feature.usage.rst -- cgit 1.2.3-korg