Correct Formatting of Deployment Guide
The code blocks were in incorrect format due to wrong alignment in the .rst file. This patch set is meant to correct that. Change-Id: I30378b5d970d4394db5309dd1d09e108b3a96343
This commit is contained in:
Anthony Lin
parent
ea107c29f9
commit
dcc6c3fb6e
|
|
@ -29,19 +29,15 @@ sets up an 'All-In-One' UCP environment that allows developers to bring up Shipy
|
|||
and the rest of the UCP components on a single Ubuntu 16.04 Virtual Machine.
|
||||
|
||||
.. note::
|
||||
Note that the minimum recommended size of the VM is 4 vCPUs, 16GB of RAM with
|
||||
64GB disk space
|
||||
The minimum recommended size of the VM is 4 vCPUs, 16GB of RAM with 64GB disk space
|
||||
|
||||
|
||||
Pre-Deployment Preparations
|
||||
---------------------------
|
||||
|
||||
#. Set up ``etc/hosts`` on a freshly installed Ubuntu 16.04 Virtual Machine with the
|
||||
IP and hostname of the VM
|
||||
IP and hostname of the VM::
|
||||
|
||||
E.g. ``30.30.30.4 node1``
|
||||
|
||||
::
|
||||
HOST_IFACE=$(ip route | grep "^default" | head -1 | awk '{ print $5 }')
|
||||
LOCAL_IP=$(ip addr | awk "/inet/ && /${HOST_IFACE}/{sub(/\/.*$/,\"\",\$2); print \$2}")
|
||||
cat << EOF | sudo tee -a /etc/hosts
|
||||
|
|
@ -57,27 +53,24 @@ Production Deployment
|
|||
We will use this approach if we are not making any changes to Shipyard and would like to bring up
|
||||
the UCP environment as it is
|
||||
|
||||
#. Switch to root user after performing the steps in the *Pre-Deployment Preparations* section.
|
||||
#. Switch to root user after performing the steps in the *Pre-Deployment Preparations* section::
|
||||
|
||||
::
|
||||
sudo -i
|
||||
cd /home/ubuntu/ucp-integration/manifests/basic_ucp/
|
||||
sudo -i
|
||||
cd /home/ubuntu/ucp-integration/manifests/basic_ucp/
|
||||
|
||||
#. Export the variables that are unique to the environment. For instance, we can do the following
|
||||
to update the environment variables for a VM with hostname **node1** that is assigned an IP of
|
||||
**30.30.30.4** on interface **ens3** (network **30.30.30.0/24**):
|
||||
**30.30.30.4** on interface **ens3** (network **30.30.30.0/24**)::
|
||||
|
||||
::
|
||||
export GENESIS_NODE_NAME=node1
|
||||
export CEPH_CLUSTER_NET=30.30.30.0/24
|
||||
export CEPH_PUBLIC_NET=30.30.30.0/24
|
||||
export GENESIS_NODE_IP=30.30.30.4
|
||||
export NODE_NET_IFACE=ens3
|
||||
export GENESIS_NODE_NAME=node1
|
||||
export CEPH_CLUSTER_NET=30.30.30.0/24
|
||||
export CEPH_PUBLIC_NET=30.30.30.0/24
|
||||
export GENESIS_NODE_IP=30.30.30.4
|
||||
export NODE_NET_IFACE=ens3
|
||||
|
||||
#. Start the UCP deployment
|
||||
#. Start the UCP deployment::
|
||||
|
||||
::
|
||||
./deploy_ucp.sh
|
||||
./deploy_ucp.sh
|
||||
|
||||
|
||||
Dev Environment Deployment
|
||||
|
|
@ -88,46 +81,42 @@ dags and operators in Airflow. Changes to Shipyard API/CLI will require a rebuil
|
|||
images with the updates. We will need to reference to the custom image in our environment variables
|
||||
so that it does not point to the image in the Master branch.
|
||||
|
||||
1. Create the following directories on the target host machine:
|
||||
#. Create the following directories on the target host machine::
|
||||
|
||||
::
|
||||
mkdir -p /var/tmp/airflow/dags
|
||||
mkdir -p /var/tmp/airflow/plugins
|
||||
mkdir -p /var/tmp/airflow/logs
|
||||
mkdir -p /var/tmp/airflow/dags
|
||||
mkdir -p /var/tmp/airflow/plugins
|
||||
mkdir -p /var/tmp/airflow/logs
|
||||
|
||||
2. Copy the `rest_api_plugin`_ into the newly created plugins directory, i.e. ``/var/tmp/airflow/plugins``
|
||||
#. Copy the `rest_api_plugin`_ into the newly created plugins directory, i.e. ``/var/tmp/airflow/plugins``
|
||||
so that it can be loaded by Airflow during startup. **Note** that other custom operators
|
||||
should be added to the directory as required.
|
||||
|
||||
**Note** that custom dags should be added into the newly created dags directory, i.e. ``/var/tmp/airflow/dags``
|
||||
|
||||
3. Switch to root user after performing Step 1 and 2
|
||||
#. Switch to root user after performing Step 1 and 2::
|
||||
|
||||
::
|
||||
sudo -i
|
||||
cd /home/ubuntu/ucp-integration/manifests/basic_ucp/
|
||||
sudo -i
|
||||
cd /home/ubuntu/ucp-integration/manifests/basic_ucp/
|
||||
|
||||
4. Export the variables that are unique to the environment. For instance, we can do the below
|
||||
#. Export the variables that are unique to the environment. For instance, we can do the below
|
||||
to update the environment variables for a VM with hostname **node1** that is assigned an IP
|
||||
of **30.30.30.4** on interface **ens3** (network **30.30.30.0/24**):
|
||||
of **30.30.30.4** on interface **ens3** (network **30.30.30.0/24**).
|
||||
|
||||
Update image references in the environment variables if we want to test a new Shipyard and
|
||||
Airflow image, e.g. image v0.1.0 as a result of code changes.
|
||||
Airflow image, e.g. image v0.1.0 as a result of code changes::
|
||||
|
||||
::
|
||||
export SHIPYARD_PROD_DEPLOY=false
|
||||
export GENESIS_NODE_NAME=node1
|
||||
export CEPH_CLUSTER_NET=30.30.30.0/24
|
||||
export CEPH_PUBLIC_NET=30.30.30.0/24
|
||||
export GENESIS_NODE_IP=30.30.30.4
|
||||
export NODE_NET_IFACE=ens3
|
||||
export SHIPYARD_IMAGE="attcomdev/shipyard:v0.1.0"
|
||||
export AIRFLOW_IMAGE="attcomdev/airflow:v0.1.0"
|
||||
export SHIPYARD_PROD_DEPLOY=false
|
||||
export GENESIS_NODE_NAME=node1
|
||||
export CEPH_CLUSTER_NET=30.30.30.0/24
|
||||
export CEPH_PUBLIC_NET=30.30.30.0/24
|
||||
export GENESIS_NODE_IP=30.30.30.4
|
||||
export NODE_NET_IFACE=ens3
|
||||
export SHIPYARD_IMAGE="attcomdev/shipyard:v0.1.0"
|
||||
export AIRFLOW_IMAGE="attcomdev/airflow:v0.1.0"
|
||||
|
||||
5. Start the UCP deployment
|
||||
#. Start the UCP deployment::
|
||||
|
||||
::
|
||||
./deploy_ucp.sh
|
||||
./deploy_ucp.sh
|
||||
|
||||
|
||||
Post Deployment
|
||||
|
|
@ -136,63 +125,61 @@ Post Deployment
|
|||
#. The deployment is fully automated and can take a while to complete (it can take 30 minutes
|
||||
to an hour for a full deployment to complete)
|
||||
|
||||
#. The environment should resemble the following after executing the required steps:
|
||||
#. The environment should resemble the following after executing the required steps::
|
||||
|
||||
::
|
||||
# sudo kubectl get pods -n ucp
|
||||
NAME READY STATUS RESTARTS AGE
|
||||
airflow-flower-6cdc6f9cb4-5r62v 1/1 Running 0 3h
|
||||
airflow-scheduler-6d54445bf8-6ldrd 1/1 Running 0 3h
|
||||
airflow-web-7bd69d857d-qlptj 1/1 Running 0 3h
|
||||
airflow-worker-666696d6c5-vffpg 1/1 Running 0 3h
|
||||
armada-api-84df5b7fc9-4nxp5 1/1 Running 0 4h
|
||||
barbican-api-85c956c84f-p4q7h 1/1 Running 0 4h
|
||||
deckhand-5468d59455-2mcqd 1/1 Running 0 4h
|
||||
drydock-api-f9897cf44-csbc8 1/1 Running 0 4h
|
||||
drydock-api-f9897cf44-jgv4q 1/1 Running 0 4h
|
||||
etcd-5bcbbd679c-rb5rf 1/1 Running 0 4h
|
||||
ingress-api-xvkzx 1/1 Running 0 4h
|
||||
ingress-error-pages-5d79688f6c-9b8xc 1/1 Running 0 4h
|
||||
keystone-api-6bc85c98-886mg 1/1 Running 0 4h
|
||||
maas-rack-5d4b84c4d5-dt87j 1/1 Running 0 4h
|
||||
maas-region-0 1/1 Running 0 4h
|
||||
mariadb-0 1/1 Running 0 4h
|
||||
mariadb-1 1/1 Running 0 4h
|
||||
mariadb-2 1/1 Running 0 4h
|
||||
memcached-5bf49657db-kq6qh 1/1 Running 0 4h
|
||||
postgresql-0 1/1 Running 0 4h
|
||||
rabbitmq-f68649644-pnw6p 1/1 Running 0 4h
|
||||
shipyard-6f4c7765d-n2kx6 1/1 Running 0 3h
|
||||
# sudo kubectl get pods -n ucp
|
||||
NAME READY STATUS RESTARTS AGE
|
||||
airflow-flower-6cdc6f9cb4-5r62v 1/1 Running 0 3h
|
||||
airflow-scheduler-6d54445bf8-6ldrd 1/1 Running 0 3h
|
||||
airflow-web-7bd69d857d-qlptj 1/1 Running 0 3h
|
||||
airflow-worker-666696d6c5-vffpg 1/1 Running 0 3h
|
||||
armada-api-84df5b7fc9-4nxp5 1/1 Running 0 4h
|
||||
barbican-api-85c956c84f-p4q7h 1/1 Running 0 4h
|
||||
deckhand-5468d59455-2mcqd 1/1 Running 0 4h
|
||||
drydock-api-f9897cf44-csbc8 1/1 Running 0 4h
|
||||
drydock-api-f9897cf44-jgv4q 1/1 Running 0 4h
|
||||
etcd-5bcbbd679c-rb5rf 1/1 Running 0 4h
|
||||
ingress-api-xvkzx 1/1 Running 0 4h
|
||||
ingress-error-pages-5d79688f6c-9b8xc 1/1 Running 0 4h
|
||||
keystone-api-6bc85c98-886mg 1/1 Running 0 4h
|
||||
maas-rack-5d4b84c4d5-dt87j 1/1 Running 0 4h
|
||||
maas-region-0 1/1 Running 0 4h
|
||||
mariadb-0 1/1 Running 0 4h
|
||||
mariadb-1 1/1 Running 0 4h
|
||||
mariadb-2 1/1 Running 0 4h
|
||||
memcached-5bf49657db-kq6qh 1/1 Running 0 4h
|
||||
postgresql-0 1/1 Running 0 4h
|
||||
rabbitmq-f68649644-pnw6p 1/1 Running 0 4h
|
||||
shipyard-6f4c7765d-n2kx6 1/1 Running 0 3h
|
||||
|
||||
To check that all relevant helm charts have been deployed:
|
||||
#. Check that all relevant helm charts have been deployed::
|
||||
|
||||
::
|
||||
# sudo helm ls
|
||||
NAME REVISION UPDATED STATUS CHART NAMESPACE
|
||||
ucp-armada 1 Fri Dec 1 10:03:44 2017 DEPLOYED armada-0.1.0 ucp
|
||||
ucp-barbican 1 Fri Dec 1 10:03:47 2017 DEPLOYED barbican-0.1.0 ucp
|
||||
ucp-calico 1 Fri Dec 1 10:00:05 2017 DEPLOYED calico-0.1.0 kube-system
|
||||
ucp-calico-etcd 1 Fri Dec 1 09:59:28 2017 DEPLOYED etcd-0.1.0 kube-system
|
||||
ucp-ceph 1 Fri Dec 1 10:00:58 2017 DEPLOYED ceph-0.1.0 ceph
|
||||
ucp-coredns 1 Fri Dec 1 10:00:26 2017 DEPLOYED coredns-0.1.0 kube-system
|
||||
ucp-deckhand 1 Fri Dec 1 10:03:39 2017 DEPLOYED deckhand-0.1.0 ucp
|
||||
ucp-drydock 1 Fri Dec 1 10:03:37 2017 DEPLOYED drydock-0.1.0 ucp
|
||||
ucp-etcd-rabbitmq 1 Fri Dec 1 10:02:44 2017 DEPLOYED etcd-0.1.0 ucp
|
||||
ucp-ingress 1 Fri Dec 1 10:02:45 2017 DEPLOYED ingress-0.1.0 ucp
|
||||
ucp-keystone 1 Fri Dec 1 10:03:45 2017 DEPLOYED keystone-0.1.0 ucp
|
||||
ucp-kubernetes-apiserver 1 Fri Dec 1 10:00:32 2017 DEPLOYED apiserver-0.1.0 kube-system
|
||||
ucp-kubernetes-controller-manager 1 Fri Dec 1 10:00:33 2017 DEPLOYED controller_manager-0.1.0 kube-system
|
||||
ucp-kubernetes-etcd 1 Fri Dec 1 10:00:31 2017 DEPLOYED etcd-0.1.0 kube-system
|
||||
ucp-kubernetes-proxy 1 Fri Dec 1 09:58:46 2017 DEPLOYED proxy-0.1.0 kube-system
|
||||
ucp-kubernetes-scheduler 1 Fri Dec 1 10:00:34 2017 DEPLOYED scheduler-0.1.0 kube-system
|
||||
ucp-maas 1 Fri Dec 1 10:03:36 2017 DEPLOYED maas-0.1.0 ucp
|
||||
ucp-maas-postgresql 1 Fri Dec 1 10:02:44 2017 DEPLOYED postgresql-0.1.0 ucp
|
||||
ucp-rabbitmq 1 Fri Dec 1 10:02:45 2017 DEPLOYED rabbitmq-0.1.0 ucp
|
||||
ucp-rbac 1 Fri Dec 1 10:00:44 2017 DEPLOYED rbac-0.1.0 kube-system
|
||||
ucp-shipyard 1 Fri Dec 1 10:38:08 2017 DEPLOYED shipyard-0.1.0 ucp
|
||||
ucp-ucp-ceph-config 1 Fri Dec 1 10:02:40 2017 DEPLOYED ceph-0.1.0 ucp
|
||||
ucp-ucp-mariadb 1 Fri Dec 1 10:02:43 2017 DEPLOYED mariadb-0.1.0 ucp
|
||||
ucp-ucp-memcached 1 Fri Dec 1 10:02:44 2017 DEPLOYED memcached-0.1.0 ucp
|
||||
# sudo helm ls
|
||||
NAME REVISION UPDATED STATUS CHART NAMESPACE
|
||||
ucp-armada 1 Fri Dec 1 10:03:44 2017 DEPLOYED armada-0.1.0 ucp
|
||||
ucp-barbican 1 Fri Dec 1 10:03:47 2017 DEPLOYED barbican-0.1.0 ucp
|
||||
ucp-calico 1 Fri Dec 1 10:00:05 2017 DEPLOYED calico-0.1.0 kube-system
|
||||
ucp-calico-etcd 1 Fri Dec 1 09:59:28 2017 DEPLOYED etcd-0.1.0 kube-system
|
||||
ucp-ceph 1 Fri Dec 1 10:00:58 2017 DEPLOYED ceph-0.1.0 ceph
|
||||
ucp-coredns 1 Fri Dec 1 10:00:26 2017 DEPLOYED coredns-0.1.0 kube-system
|
||||
ucp-deckhand 1 Fri Dec 1 10:03:39 2017 DEPLOYED deckhand-0.1.0 ucp
|
||||
ucp-drydock 1 Fri Dec 1 10:03:37 2017 DEPLOYED drydock-0.1.0 ucp
|
||||
ucp-etcd-rabbitmq 1 Fri Dec 1 10:02:44 2017 DEPLOYED etcd-0.1.0 ucp
|
||||
ucp-ingress 1 Fri Dec 1 10:02:45 2017 DEPLOYED ingress-0.1.0 ucp
|
||||
ucp-keystone 1 Fri Dec 1 10:03:45 2017 DEPLOYED keystone-0.1.0 ucp
|
||||
ucp-kubernetes-apiserver 1 Fri Dec 1 10:00:32 2017 DEPLOYED apiserver-0.1.0 kube-system
|
||||
ucp-kubernetes-controller-manager 1 Fri Dec 1 10:00:33 2017 DEPLOYED controller_manager-0.1.0 kube-system
|
||||
ucp-kubernetes-etcd 1 Fri Dec 1 10:00:31 2017 DEPLOYED etcd-0.1.0 kube-system
|
||||
ucp-kubernetes-proxy 1 Fri Dec 1 09:58:46 2017 DEPLOYED proxy-0.1.0 kube-system
|
||||
ucp-kubernetes-scheduler 1 Fri Dec 1 10:00:34 2017 DEPLOYED scheduler-0.1.0 kube-system
|
||||
ucp-maas 1 Fri Dec 1 10:03:36 2017 DEPLOYED maas-0.1.0 ucp
|
||||
ucp-maas-postgresql 1 Fri Dec 1 10:02:44 2017 DEPLOYED postgresql-0.1.0 ucp
|
||||
ucp-rabbitmq 1 Fri Dec 1 10:02:45 2017 DEPLOYED rabbitmq-0.1.0 ucp
|
||||
ucp-rbac 1 Fri Dec 1 10:00:44 2017 DEPLOYED rbac-0.1.0 kube-system
|
||||
ucp-shipyard 1 Fri Dec 1 10:38:08 2017 DEPLOYED shipyard-0.1.0 ucp
|
||||
ucp-ucp-ceph-config 1 Fri Dec 1 10:02:40 2017 DEPLOYED ceph-0.1.0 ucp
|
||||
ucp-ucp-mariadb 1 Fri Dec 1 10:02:43 2017 DEPLOYED mariadb-0.1.0 ucp
|
||||
ucp-ucp-memcached 1 Fri Dec 1 10:02:44 2017 DEPLOYED memcached-0.1.0 ucp
|
||||
|
||||
|
||||
.. _ucp-integration: https://github.com/att-comdev/ucp-integration
|
||||
|
|
|
|||
Loading…
Reference in New Issue