diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/configguide/featureconfig.rst | 23 | ||||
| -rw-r--r-- | docs/release/configguide/index.rst | 14 | ||||
| -rw-r--r-- | docs/release/configguide/postinstall.rst | 66 | ||||
| -rw-r--r-- | docs/release/installation/index.rst | 13 | ||||
| -rw-r--r-- | docs/release/installation/installation.instruction.rst | 78 | ||||
| -rw-r--r-- | docs/release/release-notes/index.rst | 13 | ||||
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 90 | ||||
| -rw-r--r-- | docs/release/scenarios/scenario.name/index.rst | 17 | ||||
| -rw-r--r-- | docs/release/scenarios/scenario.name/scenario.description.rst | 43 | ||||
| -rw-r--r-- | docs/release/userguide/feature.userguide.rst | 20 | ||||
| -rw-r--r-- | docs/release/userguide/index.rst | 24 |
11 files changed, 401 insertions, 0 deletions
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 + diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst new file mode 100644 index 0000000..73edca1 --- /dev/null +++ b/docs/release/installation/index.rst @@ -0,0 +1,13 @@ +.. 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 Installation +========================= + +.. toctree:: + :maxdepth: 1 + + installation.instruction diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst new file mode 100644 index 0000000..fa3732e --- /dev/null +++ b/docs/release/installation/installation.instruction.rst @@ -0,0 +1,78 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +=============================== +OPNFV Copper Installation Guide +=============================== + +This document describes how to install Copper, its dependencies and required system resources. + +.. contents:: + :depth: 3 + :local: + +Version History +--------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2017 Feb 7 | 1.0 | Bryan Sullivan | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + +Introduction +------------ +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] diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 0000000..963d2e3 --- /dev/null +++ b/docs/release/release-notes/index.rst @@ -0,0 +1,13 @@ +.. 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 Release Notes +========================== + +.. toctree:: + :maxdepth: 1 + + release-notes.rst diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 0000000..b77e049 --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,90 @@ +.. 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 Release Notes +====================================================================== + +This document provides the release notes for the Danube Release of Copper. + +.. contents:: + :depth: 3 + :local: + + +Version History +--------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2017 Feb 7 | 1.0 | Bryan Sullivan | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + +Important Notes +--------------- + + +Summary +------- + +The Danube release of OPNFV Copper is based on OpenStack Newton. + +Release Data +------------ + +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 + +Copper Release 3 Scope +^^^^^^^^^^^^^^^^^^^^^^ +OPNFV Danube includes the additional features: + * Manual tests + + * Network Bridging test to detect when a VM is connected to 2 networks with different security levels and then pause that VM + + * Further enhancements of Congress test scripts + +Version Change +^^^^^^^^^^^^^^ + +Module Version Changes +~~~~~~~~~~~~~~~~~~~~~~ +- Openstack has changed from Mitaka to Newton + +Known Limitations, Issues and Workarounds +----------------------------------------- + +The following features have not been verified as of this release: + + * HA deployment: Congress should be installed in OPNFV deployments in a + non-HA mode, including in HA deployment scenarios. Basic HA support has been + implemented for Congress (see http://docs.openstack.org/developer/congress/index.html), but + this feature has not yet been verified on the OPNFV platform. + + * Horizon plugin: The Congress OpenStack Dashboard plugin (a "Policy tab") has not been + deployed in OPNFV as of this release. Installing the needed Congress Dashboard plugin + files on the OpenStack Dashboard host is a future work item. + diff --git a/docs/release/scenarios/scenario.name/index.rst b/docs/release/scenarios/scenario.name/index.rst new file mode 100644 index 0000000..9b710da --- /dev/null +++ b/docs/release/scenarios/scenario.name/index.rst @@ -0,0 +1,17 @@ +.. 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 + +================== +<scenario name> +================== +.. This document will be used to provide a description of the scenario for an end user. +.. You should explain the purpose of the scenario, the types of capabilities provided and +.. the unique components that make up the scenario including how they are used. + +.. toctree:: + :maxdepth: 1 + + scenario.description + diff --git a/docs/release/scenarios/scenario.name/scenario.description.rst b/docs/release/scenarios/scenario.name/scenario.description.rst new file mode 100644 index 0000000..af6e41b --- /dev/null +++ b/docs/release/scenarios/scenario.name/scenario.description.rst @@ -0,0 +1,43 @@ +.. 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 <Scenario Name> +========================= + +This document provides scenario level details for <RELEASE> of <COMPONENT>. + +.. contents:: + :depth: 3 + :local: + +Introduction +--------------- +.. In this section explain the purpose of the scenario and the types of capabilities provided + +Scenario components and composition +------------------------------------- +.. In this section describe the unique components that make up the scenario, +.. what each component provides and why it has been included in order +.. to communicate to the user the capabilities available in this scenario. + +Scenario usage overview +---------------------------- +.. Provide a brief overview on how to use the scenario and the features available to the +.. user. This should be an "introduction" to the userguide document, and explicitly link to it, +.. where the specifics of the features are covered including examples and API's + +Limitations, Issues and Workarounds +--------------------------------------- +.. Explain scenario limitations here, this should be at a design level rather than discussing +.. faults or bugs. If the system design only provide some expected functionality then provide +.. some insight at this point. + +References +----------------- + +For more information on the OPNFV Danube release, please visit +http://www.opnfv.org/danube + diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst new file mode 100644 index 0000000..c43a502 --- /dev/null +++ b/docs/release/userguide/feature.userguide.rst @@ -0,0 +1,20 @@ +.. 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 User Guide +======================= + +.. contents:: + :depth: 3 + :local: + +This release focuses on use of the OpenStack Congress service for managing +configuration policy. See the Congress `intro guide <http://docs.openstack.org/developer/congress/index.html>`_ +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/release/userguide/index.rst b/docs/release/userguide/index.rst new file mode 100644 index 0000000..1004c3e --- /dev/null +++ b/docs/release/userguide/index.rst @@ -0,0 +1,24 @@ +.. 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 User Guide +======================= + +.. The feature user guide should provide an OPNFV user with enough information to +.. use the features provided by the feature project in the supported scenarios. +.. This guide should walk a user through the usage of the features once a scenario +.. has been deployed and is active according to the installation guide provided +.. by the installer project. + +.. toctree:: + :maxdepth: 1 + + feature.userguide +.. The feature.userguide.rst file should contain the text for this document +.. additional documents can be added to this directory and added in the right order +.. to this file as a list below. + + |