From 572ce78c886cf49bd617a2ff3d96491b22a66f88 Mon Sep 17 00:00:00 2001 From: Aimee Ukasick <aimeeu.opensource@gmail.com> Date: Tue, 7 Feb 2017 13:23:37 -0600 Subject: Updated to use new docs structure WIP JIRA: COPPER-1 WIP - not sure how to fill in the docs/release/scenarios section Change-Id: I8684e4647e7b943ca05dc77131a54338ff932b78 Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com> --- docs/release/configguide/featureconfig.rst | 23 +++++++++++ docs/release/configguide/index.rst | 14 +++++++ docs/release/configguide/postinstall.rst | 66 ++++++++++++++++++++++++++++++ 3 files changed, 103 insertions(+) create mode 100644 docs/release/configguide/featureconfig.rst create mode 100644 docs/release/configguide/index.rst create mode 100644 docs/release/configguide/postinstall.rst (limited to 'docs/release/configguide') diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst new file mode 100644 index 0000000..0669172 --- /dev/null +++ b/docs/release/configguide/featureconfig.rst @@ -0,0 +1,23 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +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. + +.. contents:: + :depth: 3 + :local: + +Pre-configuration Activities +---------------------------- +None required. + +Hardware Configuration +---------------------- +There is no specific hardware configuration required for the Copper project. diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst new file mode 100644 index 0000000..b9454e2 --- /dev/null +++ b/docs/release/configguide/index.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +================================ +OPNFV Copper Configuration Guide +================================ + +.. toctree:: + :maxdepth: 1 + + featureconfig.rst + postinstall.rst diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst new file mode 100644 index 0000000..2f959ad --- /dev/null +++ b/docs/release/configguide/postinstall.rst @@ -0,0 +1,66 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +Copper Post Installation Procedures +=================================== + +This section describes optional procedures for verifying that the Congress +service is operational. + +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 OPNFV jumphost. This script is in the Copper repo at: + + * components/congress/test-webapp/setup/install_congress_testserver.sh + +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: + +.. 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 + -- cgit