From c1d2d78f1d0b528b2529f614342ead89b4b69b49 Mon Sep 17 00:00:00 2001 From: Aimee Ukasick Date: Tue, 31 Jan 2017 12:07:14 -0600 Subject: Update for Danube JIRA: COPPER-1 Updated several files for continuity in capitalization and punctuation. Updated release notes. Updated or removed invalid URLs. Generated documentation locally to verify HTML output. Change-Id: I50bc0886f502c26c8fc0539e7e8104763d1a06a2 Signed-off-by: Aimee Ukasick --- .../feature.configuration.rst | 23 ++++++++++++--------- .../installation.instruction.rst | 24 +++++++++++++--------- 2 files changed, 27 insertions(+), 20 deletions(-) (limited to 'docs/installationprocedure') diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst index 1e059ef..54eab4b 100644 --- a/docs/installationprocedure/feature.configuration.rst +++ b/docs/installationprocedure/feature.configuration.rst @@ -1,32 +1,33 @@ .. This work is licensed under a .. Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. (c) 2015-2016 AT&T Intellectual Property, Inc +.. (c) 2015-2017 AT&T Intellectual Property, Inc -Copper configuration +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 +Pre-configuration Activities ---------------------------- None required. -Hardware configuration +Hardware Configuration ---------------------- There is no specific hardware configuration required for the Copper project. -Feature configuration +Feature Configuration --------------------- -OPNFV installer support +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 @@ -41,23 +42,25 @@ future maintenance. Other project installer support (e.g. Doctor) may install additional datasource drivers once Congress is installed. -Manual installation +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 +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 +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 @@ -74,6 +77,6 @@ specifying the branch identifier to use for OpenStack. 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 +Copper Post Configuration Procedures ------------------------------------ No configuration procedures are required beyond the basic install procedure. diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/installationprocedure/installation.instruction.rst index c8d7ad8..da3918e 100644 --- a/docs/installationprocedure/installation.instruction.rst +++ b/docs/installationprocedure/installation.instruction.rst @@ -1,20 +1,21 @@ .. This work is licensed under a .. Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. (c) 2015-2016 AT&T Intellectual Property, Inc +.. (c) 2015-2017 AT&T Intellectual Property, Inc -Copper post installation procedures +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 +service is operational as well as additional test tools developed for the Colorado release. -Copper functional tests +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 @@ -27,26 +28,28 @@ Further description of the tests is provided on the Copper wiki at https://wiki.opnfv.org/display/copper/testing. -Congress test webapp +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: +Docker container on the OPNFV jumphost. This script is in the Copper repo at: + * components/congress/test-webapp/setup/install_congress_testserver.sh -Prerequisites to using this script: +Prerequisites for 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. +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 +Using the Test Webapp ..................... Browse to the webapp IP address provided at the end of the install @@ -55,9 +58,10 @@ procedure. Interactive options are meant to be self-explanatory given a basic familiarity with the Congress service and data model. -Removing the test webapp +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 -- cgit 1.2.3-korg