diff options
Diffstat (limited to 'docs/configguide')
-rw-r--r-- | docs/configguide/featureconfig.rst | 79 | ||||
-rw-r--r-- | docs/configguide/index.rst | 10 | ||||
-rw-r--r-- | docs/configguide/postinstall.rst | 63 |
3 files changed, 0 insertions, 152 deletions
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 - |