summaryrefslogtreecommitdiffstats
path: root/docs/setupservicevm
diff options
context:
space:
mode:
authorBin Hu <bh526r@att.com>2016-01-06 15:54:57 -0800
committerBin Hu <bh526r@att.com>2016-01-06 15:54:57 -0800
commitc1f22085089d9be36b51ddc44179da48d52739f1 (patch)
treea2a046b9b1848cd998a7f48bc6a50c779131e269 /docs/setupservicevm
parentc1762113c12b971753c35ce99f05d3d48dfa9eee (diff)
JIRA:IPVSIX-29
Change-Id: Ic4471d17588c43ded7a79d297580c8aae74e868d Signed-off-by: Bin Hu <bh526r@att.com>
Diffstat (limited to 'docs/setupservicevm')
-rw-r--r--docs/setupservicevm/scenario-3-0-ipv6-configguide-prep-infra.rst32
-rw-r--r--docs/setupservicevm/scenario-3-2-ipv6-configguide-os-controller.rst108
-rw-r--r--docs/setupservicevm/scenario-3-3-ipv6-configguide-os-compute.rst102
-rw-r--r--docs/setupservicevm/scenario-3.rst6
4 files changed, 245 insertions, 3 deletions
diff --git a/docs/setupservicevm/scenario-3-0-ipv6-configguide-prep-infra.rst b/docs/setupservicevm/scenario-3-0-ipv6-configguide-prep-infra.rst
new file mode 100644
index 0000000..9703991
--- /dev/null
+++ b/docs/setupservicevm/scenario-3-0-ipv6-configguide-prep-infra.rst
@@ -0,0 +1,32 @@
+====================
+Infrastructure Setup
+====================
+
+In order to set up the service VM as an IPv6 vRouter, we need to
+prepare 3 hosts, each of which has minimum 8GB RAM and 40GB storage. One host is used as OpenStack Controller
+Node. The second host is used as Open Daylight Controller Node. And the third one is used as
+OpenStack Compute Node.
+
+For exemplary purpose, we assume:
+
+* The hostname of OpenStack Controller+Network+Compute Node is ``opnfv-os-controller``, and the host IP address
+ is ``192.168.0.10``
+* The hostname of OpenStack Compute Node is ``opnfv-os-compute``, and the host IP address is ``192.168.0.20``
+* The hostname of Open Daylight Controller Node is ``opnfv-odl-controller``, and the host IP address is
+ ``192.168.0.30``
+* We use ``opnfv`` as username to login.
+* We use ``devstack`` to install OpenStack Kilo. Please note that OpenStack Liberty can be used as well.
+
+The underlay network topology of those 3 hosts are shown as follows in :numref:`s2-figure1`:
+
+.. figure:: images/ipv6-topology-scenario-2.png
+ :name: s2-figure1
+ :width: 100%
+
+ Underlay Network Topology - Scenario 2
+
+**Please note that the IP address shown in** :numref:`s2-figure1`
+**are for exemplary purpose. You need to configure your public IP
+address connecting to Internet according to your actual network
+infrastructure. And you need to make sure the private IP address are
+not conflicting with other subnets**.
diff --git a/docs/setupservicevm/scenario-3-2-ipv6-configguide-os-controller.rst b/docs/setupservicevm/scenario-3-2-ipv6-configguide-os-controller.rst
new file mode 100644
index 0000000..050be79
--- /dev/null
+++ b/docs/setupservicevm/scenario-3-2-ipv6-configguide-os-controller.rst
@@ -0,0 +1,108 @@
+====================================
+Setting Up OpenStack Controller Node
+====================================
+
+Please **note** that the instructions shown here are using ``devstack`` installer. If you are an experienced
+user and installs OpenStack in a different way, you can skip this step and follow the instructions of the
+method you are using to install OpenStack.
+
+For exemplary purpose, we assume:
+
+* The hostname of OpenStack Controller Node is ``opnfv-os-controller``, and the host IP address is ``192.168.0.10``
+* Ubuntu 14.04 or Fedora 21 is installed
+* We use ``opnfv`` as username to login.
+* We use ``devstack`` to install OpenStack Kilo. Please note that although the instructions are based on
+ OpenStack Kilo, they can be applied to Liberty in the same way.
+
+**OS-N-0**: Login to OpenStack Controller Node with username ``opnfv``
+
+**OS-N-1**: Update the packages and install git
+
+For **Ubuntu**:
+
+.. code-block:: bash
+
+ sudo apt-get update -y
+ sudo apt-get install -y git
+
+For **Fedora**:
+
+.. code-block:: bash
+
+ sudo yum update -y
+ sudo yum install -y git
+
+**OS-N-2**: Clone the following GitHub repository to get the configuration and metadata files
+
+.. code-block:: bash
+
+ git clone https://github.com/sridhargaddam/opnfv_os_ipv6_poc.git /opt/stack/opnfv_os_ipv6_poc
+
+**OS-N-3**: Download devstack and switch to stable/kilo branch
+
+.. code-block:: bash
+
+ git clone https://github.com/openstack-dev/devstack.git -b stable/kilo
+
+**OS-N-4**: Start a new terminal, and change directory to where OpenStack is installed.
+
+.. code-block:: bash
+
+ cd ~/devstack
+
+**OS-N-5**: Create a ``local.conf`` file from the GitHub repo we cloned at **OS-N-2**.
+
+.. code-block:: bash
+
+ cp /opt/stack/opnfv_os_ipv6_poc/scenario2/local.conf.odl.controller ~/devstack/local.conf
+
+Please **note** that you need to change the IP address of ``ODL_MGR_IP`` to point to your actual IP address
+of Open Daylight Controller.
+
+**OS-N-6**: Initiate Openstack setup by invoking ``stack.sh``
+
+.. code-block:: bash
+
+ ./stack.sh
+
+**OS-N-7**: If the setup is successful you would see the following logs on the console. Please note
+that the IP addresses are all for the purpose of example. Your IP addresses will match the ones
+of your actual network interfaces.
+
+.. code-block:: bash
+
+ This is your host IP address: 192.168.0.10
+ This is your host IPv6 address: ::1
+ Horizon is now available at http://192.168.0.10/
+ Keystone is serving at http://192.168.0.10:5000/
+ The default users are: admin and demo
+ The password: password
+
+Please **note** that The IP addresses above are exemplary purpose. It will show you the actual IP address of your host.
+
+**OS-N-8**: Assuming that all goes well, you can set ``OFFLINE=True`` and ``RECLONE=no`` in ``local.conf``
+to lock the codebase. Devstack uses these configuration parameters to determine if it has to run with
+the existing codebase or update to the latest copy.
+
+**OS-N-9**: Source the credentials.
+
+.. code-block:: bash
+
+ opnfv@opnfv-os-controller:~/devstack$ source openrc admin demo
+
+**OS-N-10**: Verify some commands to check if setup is working fine.
+
+.. code-block:: bash
+
+ opnfv@opnfv-os-controller:~/devstack$ nova flavor-list
+ +----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
+ | ID | Name | Memory_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public |
+ +----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
+ | 1 | m1.tiny | 512 | 1 | 0 | | 1 | 1.0 | True |
+ | 2 | m1.small | 2048 | 20 | 0 | | 1 | 1.0 | True |
+ | 3 | m1.medium | 4096 | 40 | 0 | | 2 | 1.0 | True |
+ | 4 | m1.large | 8192 | 80 | 0 | | 4 | 1.0 | True |
+ | 5 | m1.xlarge | 16384 | 160 | 0 | | 8 | 1.0 | True |
+ +----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
+
+Now you can start the Compute node setup.
diff --git a/docs/setupservicevm/scenario-3-3-ipv6-configguide-os-compute.rst b/docs/setupservicevm/scenario-3-3-ipv6-configguide-os-compute.rst
new file mode 100644
index 0000000..a27ae4c
--- /dev/null
+++ b/docs/setupservicevm/scenario-3-3-ipv6-configguide-os-compute.rst
@@ -0,0 +1,102 @@
+=================================
+Setting Up OpenStack Compute Node
+=================================
+
+Please **note** that the instructions shown here are using ``devstack`` installer. If you are an experienced user
+and installs OpenStack in a different way, you can skip this step and follow the instructions of the method you
+are using to install OpenStack.
+
+For exemplary purpose, we assume:
+
+* The hostname of OpenStack Compute Node is ``opnfv-os-compute``, and the host IP address is ``192.168.0.20``
+* Ubuntu 14.04 or Fedora 21 is installed
+* We use ``opnfv`` as username to login.
+* We use ``devstack`` to install OpenStack Kilo. Please note that although the instructions are based on
+ OpenStack Kilo, they can be applied to Liberty in the same way.
+
+**OS-M-0**: Login to OpenStack Compute Node with username ``opnfv``
+
+**OS-M-1**: Update the packages and install git
+
+For **Ubuntu**:
+
+.. code-block:: bash
+
+ sudo apt-get update -y
+ sudo apt-get install -y git
+
+For **Fedora**:
+
+.. code-block:: bash
+
+ sudo yum update -y
+ sudo yum install -y git
+
+**OS-M-2**: Clone the following GitHub repository to get the configuration and metadata files
+
+.. code-block:: bash
+
+ git clone https://github.com/sridhargaddam/opnfv_os_ipv6_poc.git /opt/stack/opnfv_os_ipv6_poc
+
+**OS-M-3**: Download devstack and switch to stable/kilo branch
+
+.. code-block:: bash
+
+ git clone https://github.com/openstack-dev/devstack.git -b stable/kilo
+
+**OS-M-4**: Start a new terminal, and change directory to where OpenStack is installed.
+
+.. code-block:: bash
+
+ cd ~/devstack
+
+**OS-M-5**: Create a ``local.conf`` file from the GitHub repo we cloned at **OS-M-2**.
+
+.. code-block:: bash
+
+ cp /opt/stack/opnfv_os_ipv6_poc/scenario2/local.conf.odl.compute ~/devstack/local.conf
+
+Please Note:
+
+* Note 1: you need to change the IP address of ``SERVICE_HOST`` to point to your actual IP address
+ of OpenStack Controller.
+* Note 2: you need to change the IP address of ``ODL_MGR_IP`` to point to your actual IP address
+ of Open Daylight Controller.
+
+**OS-M-6**: Initiate Openstack setup by invoking ``stack.sh``
+
+.. code-block:: bash
+
+ ./stack.sh
+
+**OS-M-7**: Assuming that all goes well, you should see the following output.
+
+.. code-block:: bash
+
+ This is your host IP address: 192.168.0.20
+ This is your host IPv6 address: ::1
+
+Please **note** that The IP addresses above are exemplary purpose. It will show you the actual IP address of your host.
+
+You can set ``OFFLINE=True`` and ``RECLONE=no`` in ``local.conf`` to lock the codebase. Devstack uses these
+configuration parameters to determine if it has to run with the existing codebase or update to the latest copy.
+
+**OS-M-8**: Source the credentials.
+
+.. code-block:: bash
+
+ opnfv@opnfv-os-compute:~/devstack$ source openrc admin demo
+
+**OS-M-9**: You can verify that OpenStack is set up correctly by showing hypervisor list
+
+.. code-block:: bash
+
+ opnfv@opnfv-os-compute:~/devstack$ nova hypervisor-list
+ +----+------------------------------------+---------+------------+
+ | ID | Hypervisor hostname | State | Status |
+ +----+------------------------------------+---------+------------+
+ | 1 | opnfv-os-controller | up | enabled |
+ | 2 | opnfv-os-compute | up | enabled |
+ +----+------------------------------------+---------+------------+
+
+Now you can start to set up the service VM as an IPv6 vRouter in the environment of OpenStack and Open Daylight.
diff --git a/docs/setupservicevm/scenario-3.rst b/docs/setupservicevm/scenario-3.rst
index cb47209..7f3ac98 100644
--- a/docs/setupservicevm/scenario-3.rst
+++ b/docs/setupservicevm/scenario-3.rst
@@ -11,8 +11,8 @@ In this scenario, we can fully automate the setup similar to Scenario 1.
:numbered:
:maxdepth: 4
- 0-ipv6-configguide-prep-infra.rst
+ scenario-3-0-ipv6-configguide-prep-infra.rst
scenario-3-1-ipv6-configguide-odl-setup.rst
- 2-ipv6-configguide-os-controller.rst
- 3-ipv6-configguide-os-compute.rst
+ scenario-3-2-ipv6-configguide-os-controller.rst
+ scenario-3-3-ipv6-configguide-os-compute.rst
scenario-3-4-ipv6-configguide-servicevm.rst