Merge "Consolidate devstack config into sample"

devstack/README.rst

@@ -7,20 +7,3 @@ This directory contains the files necessary to integrate zun with devstack.
 Refer the quickstart guide at
 https://docs.openstack.org/zun/latest/contributor/quickstart.html
 for more information on using devstack and zun.
-
-To install zun into devstack, add the following settings to enable the
-zun plugin::
-
-     cat > /opt/stack/devstack/local.conf << END
-     [[local|localrc]]
-     enable_plugin zun https://git.openstack.org/openstack/zun master
-     END
-
-If you would like to install python-zunclient from git, add to local.conf::
-
-     LIBS_FROM_GIT="python-zunclient"
-
-Then run devstack normally::
-
-    cd /opt/stack/devstack
-    ./stack.sh

devstack/local.conf.sample

@@ -1,10 +1,12 @@
 [[local|localrc]]
+HOST_IP=10.0.0.11 # change this to your IP address
 DATABASE_PASSWORD=password
 RABBIT_PASSWORD=password
 SERVICE_TOKEN=password
 SERVICE_PASSWORD=password
 ADMIN_PASSWORD=password
 enable_plugin zun https://git.openstack.org/openstack/zun
+enable_plugin zun-tempest-plugin https://git.openstack.org/openstack/zun-tempest-plugin
 
 #This below plugin enables installation of container engine on Devstack.
 #The default container engine is Docker
@@ -18,3 +20,6 @@ LIBS_FROM_GIT="python-zunclient"
 
 # Optional:  uncomment to enable the Zun UI plugin in Horizon
 # enable_plugin zun-ui https://git.openstack.org/openstack/zun-ui
+
+# Optional:  uncomment to enable the Heat plugin for container orchestration
+# enable_plugin heat https://git.openstack.org/openstack/heat

devstack/local.conf.subnode.sample

@@ -0,0 +1,19 @@
+[[local|localrc]]
+HOST_IP=10.0.0.31 # change this to your IP address
+DATABASE_PASSWORD=password
+RABBIT_PASSWORD=password
+SERVICE_TOKEN=password
+SERVICE_PASSWORD=password
+ADMIN_PASSWORD=password
+enable_plugin devstack-plugin-container https://git.openstack.org/openstack/devstack-plugin-container
+enable_plugin zun https://git.openstack.org/openstack/zun
+enable_plugin kuryr-libnetwork https://git.openstack.org/openstack/kuryr-libnetwork
+
+# Following is for multi host settings
+MULTI_HOST=True
+SERVICE_HOST=10.0.0.11 # change this to controller's IP address
+DATABASE_TYPE=mysql
+MYSQL_HOST=$SERVICE_HOST
+RABBIT_HOST=$SERVICE_HOST
+
+ENABLED_SERVICES=zun-compute,kuryr-libnetwork,q-agt

doc/source/contributor/quickstart.rst

@@ -28,24 +28,11 @@ Clone devstack::
 We will run devstack with minimal local.conf settings required to enable
 required OpenStack services::
 
-    $ cat > /opt/stack/devstack/local.conf << END
+    $ HOST_IP=<your ip>
-    [[local|localrc]]
+    $ git clone https://git.openstack.org/openstack/zun /opt/stack/zun
-    HOST_IP=$(ip addr | grep 'state UP' -A2 | tail -n1 | awk '{print $2}' | cut -f1  -d'/')
+    $ cat /opt/stack/zun/devstack/local.conf.sample \
-    DATABASE_PASSWORD=password
+        | sed "s/HOST_IP=.*/HOST_IP=$HOST_IP/" \
-    RABBIT_PASSWORD=password
+        > /opt/stack/devstack/local.conf
-    SERVICE_TOKEN=password
-    SERVICE_PASSWORD=password
-    ADMIN_PASSWORD=password
-    enable_plugin devstack-plugin-container https://git.openstack.org/openstack/devstack-plugin-container
-    enable_plugin zun https://git.openstack.org/openstack/zun
-    enable_plugin kuryr-libnetwork https://git.openstack.org/openstack/kuryr-libnetwork
-
-    # install python-zunclient from git
-    LIBS_FROM_GIT="python-zunclient"
-
-    # Optional:  uncomment to enable the Zun UI plugin in Horizon
-    # enable_plugin zun-ui https://git.openstack.org/openstack/zun-ui
-    END
 
 More devstack configuration information can be found at `Devstack Configuration
 <https://docs.openstack.org/devstack/latest/configuration.html>`_
@@ -113,28 +100,13 @@ On the second host, clone devstack::
 The second host will only need zun-compute service along with kuryr-libnetwork
 support. You also need to tell devstack where the SERVICE_HOST is::
 
-    $ export CTRL_IP=<controller's ip>
+    $ SERVICE_HOST=<controller's ip>
-    $ cat > /opt/stack/devstack/local.conf << END
+    $ HOST_IP=<your ip>
-    [[local|localrc]]
+    $ git clone https://git.openstack.org/openstack/zun /opt/stack/zun
-    HOST_IP=$(ip addr | grep 'state UP' -A2 | tail -n1 | awk '{print $2}' | cut -f1  -d'/')
+    $ cat /opt/stack/zun/devstack/local.conf.subnode.sample \
-    DATABASE_PASSWORD=password
+        | sed "s/HOST_IP=.*/HOST_IP=$HOST_IP/" \
-    RABBIT_PASSWORD=password
+        | sed "s/SERVICE_HOST=.*/SERVICE_HOST=$SERVICE_HOST/" \
-    SERVICE_TOKEN=password
+        > /opt/stack/devstack/local.conf
-    SERVICE_PASSWORD=password
-    ADMIN_PASSWORD=password
-    enable_plugin devstack-plugin-container https://git.openstack.org/openstack/devstack-plugin-container
-    enable_plugin zun https://git.openstack.org/openstack/zun
-    enable_plugin kuryr-libnetwork https://git.openstack.org/openstack/kuryr-libnetwork
-
-    # Following is for multi host settings
-    MULTI_HOST=True
-    SERVICE_HOST=$CTRL_IP
-    DATABASE_TYPE=mysql
-    MYSQL_HOST=$CTRL_IP
-    RABBIT_HOST=$CTRL_IP
-
-    ENABLED_SERVICES=zun-compute,kuryr-libnetwork,q-agt
-    END
 
 .. note::
 

doc/source/contributor/tempest-tests.rst

@@ -31,26 +31,9 @@ Prerequisite
 
 You need to deploy Zun in a devstack environment.
 
-Clone devstack::
+Refer the ``Exercising the Services Using Devstack`` session at `Developer
-
+Quick-Start Guide <https://docs.openstack.org/zun/latest/contributor/quickstart.html#exercising-the-services-using-devstack>`_
-    # Create a root directory for devstack if needed
+for details.
-    sudo mkdir -p /opt/stack
-    sudo chown $USER /opt/stack
-
-    git clone https://git.openstack.org/openstack-dev/devstack /opt/stack/devstack
-
-We will run devstack with minimal local.conf settings required. You can use the
-sample local.conf as a quick-start::
-
-    git clone https://git.openstack.org/openstack/zun /opt/stack/zun
-    cp /opt/stack/zun/devstack/local.conf.sample /opt/stack/devstack/local.conf
-
-Run devstack::
-
-    cd /opt/stack/devstack
-    ./stack.sh
-
-**NOTE:** This will take a while to setup the dev environment.
 
 Run the test
 ============