summaryrefslogtreecommitdiffstats
path: root/docs/installationprocedure
diff options
context:
space:
mode:
authorAimee Ukasick <aimeeu.opensource@gmail.com>2017-02-07 13:23:37 -0600
committerAimee Ukasick <aimeeu.opensource@gmail.com>2017-02-07 13:23:37 -0600
commit572ce78c886cf49bd617a2ff3d96491b22a66f88 (patch)
treed32e4c9d727ece871ec89f1d47005756ddc2b3c7 /docs/installationprocedure
parentc04ffff59b770ae32c4691bdc3d3b4363604db78 (diff)
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>
Diffstat (limited to 'docs/installationprocedure')
-rw-r--r--docs/installationprocedure/feature.configuration.rst82
-rw-r--r--docs/installationprocedure/index.rst10
-rw-r--r--docs/installationprocedure/installation.instruction.rst67
3 files changed, 0 insertions, 159 deletions
diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst
deleted file mode 100644
index 54eab4b..0000000
--- a/docs/installationprocedure/feature.configuration.rst
+++ /dev/null
@@ -1,82 +0,0 @@
-.. 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.
-
-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
deleted file mode 100644
index 2776b88..0000000
--- a/docs/installationprocedure/index.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-***********************************
-OPNFV Copper Installation Procedure
-***********************************
-
-.. toctree::
- :numbered:
- :maxdepth: 4
-
- feature.configuration.rst
- installation.instruction.rst
diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/installationprocedure/installation.instruction.rst
deleted file mode 100644
index da3918e..0000000
--- a/docs/installationprocedure/installation.instruction.rst
+++ /dev/null
@@ -1,67 +0,0 @@
-.. 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 as well as 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 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
-