Update docs for Colorado

JIRA: COPPER-1

Change-Id: I2c0b1fa29c7129aceff6779ca48f7fb26f288063
Signed-off-by: blsaws <bryan.sullivan@att.com>

2 files changed, 92 insertions, 243 deletions

diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
index f871258..5c900d7 100644
--- a/docs/configguide/featureconfig.rst
+++ b/docs/configguide/featureconfig.rst
@@ -1,15 +1,13 @@
 Copper configuration
 ====================
-This release focused on use of the OpenStack Congress service for managing
-configuration policy. The Congress install procedure described here is largely
-manual. This procedure, as well as the longer-term goal of automated installer
-support, is a work in progress. The procedure is further specific to one OPNFV
-installer (JOID, i.e. MAAS/JuJu) based environment. Support for other OPNFV
-installer deployed environments is also a work in progress.
+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
 ----------------------------
-This procedure assumes OPNFV has been installed via the JOID installer.
+None required.
 
 Hardware configuration
 ----------------------
@@ -17,55 +15,60 @@ There is no specific hardware configuration required for the Copper project.
 
 Feature configuration
 ---------------------
-Following are instructions for installing Congress on an Ubuntu 14.04 LXC
-container in the OPNFV Controller node, as installed by the JOID installer.
-This guide uses instructions from the
-`Congress intro guide on readthedocs <http://congress.readthedocs.org/en/latest/readme.html#installing-congress|Congress>`_.
-Specific values below will need to be modified if you intend to repeat this
-procedure in your JOID-based install environment.
 
-Install Procedure
-.................
-The install currently occurs via four bash scripts provided in the copper repo. See these files for the detailed steps:
-  * `install_congress_1.sh <https://git.opnfv.org/cgit/copper/tree/components/congress/joid/install_congress_1.sh>`_
-    * creates and starts the linux container for congress on the controller node
-    * copies install_congress_2.sh to the controller node and invokes it via ssh
-  * `install_congress_2.sh <https://git.opnfv.org/cgit/copper/tree/components/congress/joid/install_congress_2.sh>`_
-    * installs congress on the congress server.
+OPNFV installer support
+.......................
 
-Cleanup Procedure
-.................
-If there is an error during installation, use the bash script
-`clean_congress.sh <https://git.opnfv.org/cgit/copper/tree/components/congress/joid/clean_congress.sh>`_
-which stops the congress server if running, and removes the congress user and
-service from the controller database.
+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
 
-Restarting after server power loss etc
-......................................
+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.
 
-Currently this install procedure is manual. Automated install and restoral after host
-recovery is TBD. For now, this procedure will get the Congress service running again.
+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::
 
-  # On jumphost, SSH to Congress server
-  source ~/env.sh
-  juju ssh ubuntu@$CONGRESS_HOST
-  # If that fails
-    # On jumphost, SSH to controller node
-    juju ssh ubuntu@node1-control
-    # Start the Congress container
-    sudo lxc-start -n juju-trusty-congress -d
-    # Verify the Congress container status
-    sudo lxc-ls -f juju-trusty-congress
-    NAME                  STATE    IPV4            IPV6  GROUPS  AUTOSTART
-    ----------------------------------------------------------------------
-    juju-trusty-congress  RUNNING  192.168.10.117  -     -       NO
-    # exit back to the Jumphost, wait a minute, and go back to the "SSH to Congress server" step above
-  # On the Congress server that you have logged into
-  source ~/admin-openrc.sh
-  cd ~/git/congress
-  source bin/activate
-  bin/congress-server &
-  disown -h  %1
+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/postinstall.rst b/docs/configguide/postinstall.rst
index 9252d95..69c38c3 100644
--- a/docs/configguide/postinstall.rst
+++ b/docs/configguide/postinstall.rst
@@ -1,212 +1,58 @@
 Copper post installation procedures
 ===================================
-This release focused on use of the OpenStack Congress service for managing
-configuration policy. The Congress install verify procedure described here
-is largely manual. This procedure, as well as the longer-term goal of
-automated verification support, is a work in progress. The procedure is
-further specific to one OPNFV installer (JOID, i.e. MAAS/JuJu) based
-environment.
 
-Automated post installation activities
---------------------------------------
-No automated procedures are provided at this time.
+This section describes optional procedures for verifying that the Congress
+service is operational, and additional test tools developed for the Colorado
+release.
 
-Copper post configuration procedures
-------------------------------------
-No configuration procedures are required beyond the basic install procedure.
+Copper functional tests
+-----------------------
 
-Platform components validation
-------------------------------
+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
 
-Following are notes on creating a container as test driver for Congress.
-This is based upon an Ubuntu host as installed by JOID.
+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.
 
-Create and Activate the Container
-.................................
-On the jumphost:
+Further description of the tests is provided on the Copper wiki at
+https://wiki.opnfv.org/display/copper/testing.
 
-.. code::
 
-  sudo lxc-create -n trusty-copper -t /usr/share/lxc/templates/lxc-ubuntu \
-  -- -b ubuntu ~/opnfv
-  sudo lxc-start -n trusty-copper -d
-  sudo lxc-info --name trusty-copper
-  (typical output)
-  Name:           trusty-copper
-  State:          RUNNING
-  PID:            4563
-  IP:             10.0.3.44
-  CPU use:        28.77 seconds
-  BlkIO use:      522.79 MiB
-  Memory use:     559.75 MiB
-  KMem use:       0 bytes
-  Link:           vethDMFOAN
-   TX bytes:      2.62 MiB
-   RX bytes:      88.48 MiB
-   Total bytes:   91.10 MiB
-
-Login and configure the test server
-...................................
+Congress test webapp
+--------------------
 
-.. code::
+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
 
-  ssh ubuntu@10.0.3.44
-  sudo apt-get update
-  sudo apt-get upgrade -y
-
-  # Install pip
-  sudo apt-get install python-pip -y
-
-  # Install java
-  sudo apt-get install default-jre -y
-
-  # Install other dependencies
-  sudo apt-get install git gcc python-dev libxml2 libxslt1-dev \
-  libzip-dev php5-curl -y
-
-  # Setup OpenStack environment variables per your OPNFV install
-  export CONGRESS_HOST=192.168.10.117
-  export KEYSTONE_HOST=192.168.10.108
-  export CEILOMETER_HOST=192.168.10.105
-  export CINDER_HOST=192.168.10.101
-  export GLANCE_HOST=192.168.10.106
-  export HEAT_HOST=192.168.10.107
-  export NEUTRON_HOST=192.168.10.111
-  export NOVA_HOST=192.168.10.112
-  source ~/admin-openrc.sh
-
-  # Install and test OpenStack client
-  mkdir ~/git
-  cd git
-  git clone https://github.com/openstack/python-openstackclient.git
-  cd python-openstackclient
-  git checkout stable/liberty
-  sudo pip install -r requirements.txt
-  sudo python setup.py install
-  openstack service list
-  (typical output)
-  +----------------------------------+------------+----------------+
-  | ID                               | Name       | Type           |
-  +----------------------------------+------------+----------------+
-  | 2f8799ae50f24c928c021fabf8a50f5f | keystone   | identity       |
-  | 351b13f56d9a4e25849406ec1d5a2726 | cinder     | volume         |
-  | 5129510c3143454f9ba8ec7e6735e267 | cinderv2   | volumev2       |
-  | 5ee1e220460f41dea9be06921400ce9b | congress   | policy         |
-  | 78e73a7789a14f56a5d248a0cd141201 | quantum    | network        |
-  | 9d5a00fb475a45b2ae6767528299ed6b | ceilometer | metering       |
-  | 9e4b1624ef0b434abc0b82f607c5045c | heat       | orchestration  |
-  | b6c01ceb5023442d9f394b83f2a18e01 | heat-cfn   | cloudformation |
-  | ba6199e3505045ad87e2a7175bd0c57f | glance     | image          |
-  | d753f304a0d541dbb989780ae70328a8 | nova       | compute        |
-  +----------------------------------+------------+----------------+
-
-  # Install and test Congress client
-  cd ~/git
-  git clone https://github.com/openstack/python-congressclient.git
-  cd python-congressclient
-  git checkout stable/liberty
-  sudo pip install -r requirements.txt
-  sudo python setup.py install
-  openstack congress driver list
-  (typical output)
-  +------------+--------------------------------------------------------------------------+
-  | id         | description                                                              |
-  +------------+--------------------------------------------------------------------------+
-  | ceilometer | Datasource driver that interfaces with ceilometer.                       |
-  | neutronv2  | Datasource driver that interfaces with OpenStack Networking aka Neutron. |
-  | nova       | Datasource driver that interfaces with OpenStack Compute aka nova.       |
-  | keystone   | Datasource driver that interfaces with keystone.                         |
-  | cinder     | Datasource driver that interfaces with OpenStack cinder.                 |
-  | glancev2   | Datasource driver that interfaces with OpenStack Images aka Glance.      |
-  +------------+--------------------------------------------------------------------------+
-
-  # Install and test Glance client
-  cd ~/git
-  git clone https://github.com/openstack/python-glanceclient.git
-  cd python-glanceclient
-  git checkout stable/liberty
-  sudo pip install -r requirements.txt
-  sudo python setup.py install
-  glance image-list
-  (typical output)
-  +--------------------------------------+---------------------+
-  | ID                                   | Name                |
-  +--------------------------------------+---------------------+
-  | 6ce4433e-65c0-4cd8-958d-b06e30c76241 | cirros-0.3.3-x86_64 |
-  +--------------------------------------+---------------------+
-
-  # Install and test Neutron client
-  cd ~/git
-  git clone https://github.com/openstack/python-neutronclient.git
-  cd python-neutronclient
-  git checkout stable/liberty
-  sudo pip install -r requirements.txt
-  sudo python setup.py install
-  neutron net-list
-  (typical output)
-  +--------------------------------------+----------+------------------------------------------------------+
-  | id                                   | name     | subnets                                              |
-  +--------------------------------------+----------+------------------------------------------------------+
-  | dc6227df-af41-439f-bd2c-c2c2f0fe7fc5 | public   | 5745846c-dd79-4900-a7da-bf506348ceac 192.168.10.0/24 |
-  | a3f9f13a-5de9-4d3b-98c8-d2e40a2ef8e9 | internal | 5e0be862-90da-44ab-af43-56d5c65aa049 10.0.0.0/24     |
-  +--------------------------------------+----------+------------------------------------------------------+
-
-  # Install and test Nova client
-  cd ~/git
-  git clone https://github.com/openstack/python-novaclient.git
-  cd python-novaclient
-  git checkout stable/liberty
-  sudo pip install -r requirements.txt
-  sudo python setup.py install
-  nova hypervisor-list
-  (typical output)
-  +----+---------------------+-------+---------+
-  | ID | Hypervisor hostname | State | Status  |
-  +----+---------------------+-------+---------+
-  | 1  | compute1.maas       | up    | enabled |
-  +----+---------------------+-------+---------+
-
-  # Install and test Keystone client
-  cd ~/git
-  git clone https://github.com/openstack/python-keystoneclient.git
-  cd python-keystoneclient
-  git checkout stable/liberty
-  sudo pip install -r requirements.txt
-  sudo python setup.py install
-
-Setup the Congress Test Webapp
-..............................
+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"
 
-.. code::
+To invoke the procedure, enter the following shell commands, optionally
+specifying the branch identifier to use for Copper.
 
-  # Clone Copper (if not already cloned in user home)
-  cd ~/git
-  if [ ! -d ~/git/copper ]; then \
-  git clone https://gerrit.opnfv.org/gerrit/copper; fi
+.. code::
 
-  # Copy the Apache config
-  sudo cp ~/git/copper/components/congress/test-webapp/www/ubuntu-apache2.conf \
-  /etc/apache2/apache2.conf
+wget https://git.opnfv.org/cgit/copper/plain/components/congress/test-webapp/setup/install_congress_testserver.sh
+bash install_congress_testserver.sh [copper-branch]
 
-  # Point proxy.php to the Congress server per your install
-  sed -i -- "s/192.168.10.117/$CONGRESS_HOST/g" \
-  ~/git/copper/components/congress/test-webapp/www/html/proxy/index.php
+Using the test webapp
+.....................
 
-  # Copy the webapp to the Apache root directory and fix permissions
-  sudo cp -R ~/git/copper/components/congress/test-webapp/www/html /var/www
-  sudo chmod 755 /var/www/html -R
+Browse to the webapp IP address provided at the end of the install
+procedure.
 
-  # Make webapp log directory and set permissions
-  mkdir ~/logs
-  chmod 777 ~/logs
+Interactive options are meant to be self-explanatory given a basic familiarity
+with the Congress service and data model.
 
-  # Restart Apache
-  sudo service apache2 restart
+Removing the test webapp
+........................
 
-Using the Test Webapp
-.....................
-Browse to the trusty-copper server IP address.
+The webapp can be removed by running this script from the Copper repo:
+  * components/congress/test-webapp/setup/clean_congress_testserver.sh
 
-Interactive options are meant to be self-explanatory given a basic familiarity
-with the Congress service and data model.
-But the app will be developed with additional features and UI elements.