Update the Devstack Tacker install guide & local.conf.example

This patch updates the install instruction of Tacker in Devstack
with two modes, i.e., all-in-one mode and standalone mode.
It also removes some redundant configurations in local.conf.example
which already had in the Devstack settings.

Change-Id: I6d8d1bbe54b1a382fcbf83a1aef1fa389c43c1fc

devstack/local.conf.example

@@ -28,34 +28,25 @@ ENABLE_DEBUG_LOG_LEVEL=True
 ENABLE_VERBOSE_LOG_LEVEL=True
 
 # Neutron ML2 with OpenVSwitch
-
 Q_PLUGIN=ml2
 Q_AGENT=openvswitch
 
-#Disable security groups
+# Disable security groups
 Q_USE_SECGROUP=False
 LIBVIRT_FIREWALL_DRIVER=nova.virt.firewall.NoopFirewallDriver
 
-#NET K8S NETWORK CONFIGURATION
-#FIXED_RANGE_K8S=${FIXED_RANGE_K8S:-192.168.72.0/22}
-#NETWORK_GATEWAY_K8S=${NETWORK_GATEWAY_K8S:-192.168.72.1}
-#NETWORK_GATEWAY_K8S_IP=${NETWORK_GATEWAY_K8S_IP:-192.168.72.1/24}
-
-# Required for l3-agent to connect to external-network-bridge
-PUBLIC_BRIDGE=br-ext
-
 # Enable heat, networking-sfc, barbican and mistral
 enable_plugin heat https://git.openstack.org/openstack/heat master
 enable_plugin networking-sfc git://git.openstack.org/openstack/networking-sfc master
 enable_plugin barbican https://git.openstack.org/openstack/barbican master
 enable_plugin mistral https://git.openstack.org/openstack/mistral master
 
-#Ceilometer
+# Ceilometer
 #CEILOMETER_PIPELINE_INTERVAL=300
 enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer master
 enable_plugin aodh https://git.openstack.org/openstack/aodh master
 
-#Tacker
+# Tacker
 enable_plugin tacker https://git.openstack.org/openstack/tacker master
 
 enable_service n-novnc
@@ -63,9 +54,6 @@ enable_service n-cauth
 
 disable_service tempest
 
-#TACKER CONFIGURATION
-USE_BARBICAN=True
-
 # Enable Kubernetes and kuryr-kubernetes
 KUBERNETES_VIM=True
 NEUTRON_CREATE_INITIAL_NETWORKS=False

doc/source/install/devstack.rst

@@ -19,17 +19,110 @@
 Install via Devstack
 ====================
 
-The devstack supports installation from different code branch by specifying
+The Devstack supports installation from different code branch by specifying
 <branch-name> below. If there is no preference, it is recommended to install
 Tacker from master branch, i.e. the <branch-name> is master. If pike branch
 is the target branch, the <branch-name> is stable/pike.
 
-1. Download DevStack::
+1. Download DevStack:
+
+.. code-block:: console
 
     $ git clone https://git.openstack.org/openstack-dev/devstack -b <branch-name>
     $ cd devstack
 
-2. Enable tacker related devstack plugins in ``local.conf`` file::
+..
+
+2. Enable tacker related Devstack plugins in **local.conf** file:
+
+First, the **local.conf** file needs to be created by manual or copied from
+Tacker Repo [#f1]_ and renamed to **local.conf**. We have two Tacker
+configuration installation files. First, it is the all-in-one mode that
+installs full Devstack environment including Tacker in one PC or Laptop.
+Second, it is the standalone mode which only will install a standalone
+Tacker environment with some mandatory OpenStack services.
+
+2.1. All-in-one mode
+
+The **local.conf** file of all-in-one mode from [#f2]_ is shown as below:
+
+.. code-block:: ini
+
+    [[local|localrc]]
+    ############################################################
+    # Customize the following HOST_IP based on your installation
+    ############################################################
+    HOST_IP=127.0.0.1
+
+    ADMIN_PASSWORD=devstack
+    MYSQL_PASSWORD=devstack
+    RABBIT_PASSWORD=devstack
+    SERVICE_PASSWORD=$ADMIN_PASSWORD
+    SERVICE_TOKEN=devstack
+
+    ############################################################
+    # Customize the following section based on your installation
+    ############################################################
+
+    # Pip
+    PIP_USE_MIRRORS=False
+    USE_GET_PIP=1
+
+    #OFFLINE=False
+    #RECLONE=True
+
+    # Logging
+    LOGFILE=$DEST/logs/stack.sh.log
+    VERBOSE=True
+    ENABLE_DEBUG_LOG_LEVEL=True
+    ENABLE_VERBOSE_LOG_LEVEL=True
+
+    # Neutron ML2 with OpenVSwitch
+    Q_PLUGIN=ml2
+    Q_AGENT=openvswitch
+
+    # Disable security groups
+    Q_USE_SECGROUP=False
+    LIBVIRT_FIREWALL_DRIVER=nova.virt.firewall.NoopFirewallDriver
+
+    # Enable heat, networking-sfc, barbican and mistral
+    enable_plugin heat https://git.openstack.org/openstack/heat master
+    enable_plugin networking-sfc git://git.openstack.org/openstack/networking-sfc master
+    enable_plugin barbican https://git.openstack.org/openstack/barbican master
+    enable_plugin mistral https://git.openstack.org/openstack/mistral master
+
+    # Ceilometer
+    #CEILOMETER_PIPELINE_INTERVAL=300
+    enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer master
+    enable_plugin aodh https://git.openstack.org/openstack/aodh master
+
+    # Tacker
+    enable_plugin tacker https://git.openstack.org/openstack/tacker master
+
+    enable_service n-novnc
+    enable_service n-cauth
+
+    disable_service tempest
+
+    # Enable Kubernetes and kuryr-kubernetes
+    KUBERNETES_VIM=True
+    NEUTRON_CREATE_INITIAL_NETWORKS=False
+    enable_plugin kuryr-kubernetes https://git.openstack.org/openstack/kuryr-kubernetes master
+    enable_plugin neutron-lbaas git://git.openstack.org/openstack/neutron-lbaas master
+    enable_plugin devstack-plugin-container https://git.openstack.org/openstack/devstack-plugin-container master
+
+    [[post-config|/etc/neutron/dhcp_agent.ini]]
+    [DEFAULT]
+    enable_isolated_metadata = True
+
+..
+
+
+2.2. Standalone mode
+
+The **local.conf** file of standalone mode from [#f3]_ is shown as below:
+
+.. code-block:: ini
 
     [[local|localrc]]
     ############################################################
@@ -60,6 +153,22 @@ is the target branch, the <branch-name> is stable/pike.
     enable_plugin mistral ${GIT_BASE}/openstack/mistral $TACKER_BRANCH
     enable_plugin tacker ${GIT_BASE}/openstack/tacker $TACKER_BRANCH
 
-3. Run ``stack.sh``::
+..
+
+3. Installation
+
+After saving the **local.conf**, we can run **stack.sh** in the terminal
+to start setting up:
+
+.. code-block:: console
 
     $ ./stack.sh
+
+..
+
+.. rubric:: Footnotes
+
+.. [#f1] https://github.com/openstack/tacker/tree/master/devstack
+.. [#f2] https://github.com/openstack/tacker/blob/master/devstack/local.conf.example
+.. [#f3] https://github.com/openstack/tacker/blob/master/devstack/local.conf.standalone
+