From 701dd585c3cce8fc1aea5771c3d4b47eb64034e4 Mon Sep 17 00:00:00 2001
From: Craig Anderson <craig.anderson@att.com>
Date: Thu, 31 Aug 2017 12:04:01 -0700
Subject: [PATCH] Merge separate AIO docs into one
Creation of one source of truth for kubeadm-aio docs. The kubeadm-aio
README now links to developer all-in-one document.
Change-Id: I9e405036e50cfd5336e0e6ce901d5e5d6850fae4
Closes-Bug: #1711727
---
doc/source/install/developer/all-in-one.rst | 32 +++++-
tools/kubeadm-aio/README.rst | 108 +-------------------
2 files changed, 33 insertions(+), 107 deletions(-)
diff --git a/doc/source/install/developer/all-in-one.rst b/doc/source/install/developer/all-in-one.rst
index 88b2268a47..e67ce86a7d 100644
--- a/doc/source/install/developer/all-in-one.rst
+++ b/doc/source/install/developer/all-in-one.rst
@@ -95,7 +95,7 @@ Using git, clone the repository that holds all of the OpenStack service charts.
::
- git clone https://github.com/openstack/openstack-helm.git
+ git clone https://git.openstack.org/openstack/openstack-helm.git
cd openstack-helm
Setup Helm client
@@ -143,6 +143,17 @@ Using the Dockerfile defined in tools/kubeadm-aio directory, build the
export KUBEADM_IMAGE=openstackhelm/kubeadm-aio:v1.6.8
sudo docker build --pull -t ${KUBEADM_IMAGE} tools/kubeadm-aio
+CNI Configuration
+-----------------
+
+Before deploying AIO, you may optionally set additional parameters which
+control aspects of the CNI used:
+
+::
+
+ export KUBE_CNI=calico # or "canal" "weave" "flannel"
+ export CNI_POD_CIDR=192.168.0.0/16
+
Deploy
------
@@ -161,6 +172,25 @@ displayed during execution.
mkdir -p ${HOME}/.kube
cat ${KUBECONFIG} > ${HOME}/.kube/config
+Dummy Neutron Networks
+----------------------
+
+If you wish to create dummy network devices for Neutron to manage there is a
+helper script that can set them up for you:
+
+::
+
+ sudo docker exec kubelet /usr/bin/openstack-helm-aio-network-prep
+
+Logs
+----
+
+You can get the logs from your kubeadm-aio container by running:
+
+::
+
+ sudo docker logs -f kubeadm-aio
+
Helm Chart Installation
=======================
diff --git a/tools/kubeadm-aio/README.rst b/tools/kubeadm-aio/README.rst
index 795c57644b..908f75631a 100644
--- a/tools/kubeadm-aio/README.rst
+++ b/tools/kubeadm-aio/README.rst
@@ -1,110 +1,6 @@
Kubeadm AIO Container
=====================
-This container builds a small AIO Kubeadm based Kubernetes deployment
-for Development and Gating use.
+Documentation for Kubeadm AIO is now consolidated here_.
-Instructions
-------------
-
-OS Specific Host setup:
-~~~~~~~~~~~~~~~~~~~~~~~
-
-Ubuntu:
-^^^^^^^
-
-From a freshly provisioned Ubuntu 16.04 LTS host run:
-
-.. code:: bash
-
- sudo apt-get update -y
- sudo apt-get install -y \
- docker.io \
- nfs-common \
- git \
- make
-
-OS Independent Host setup:
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You should install the ``kubectl`` and ``helm`` binaries:
-
-.. code:: bash
-
- KUBE_VERSION=v1.6.8
- HELM_VERSION=v2.5.1
-
- TMP_DIR=$(mktemp -d)
- curl -sSL https://storage.googleapis.com/kubernetes-release/release/${KUBE_VERSION}/bin/linux/amd64/kubectl -o ${TMP_DIR}/kubectl
- chmod +x ${TMP_DIR}/kubectl
- sudo mv ${TMP_DIR}/kubectl /usr/local/bin/kubectl
- curl -sSL https://storage.googleapis.com/kubernetes-helm/helm-${HELM_VERSION}-linux-amd64.tar.gz | tar -zxv --strip-components=1 -C ${TMP_DIR}
- sudo mv ${TMP_DIR}/helm /usr/local/bin/helm
- rm -rf ${TMP_DIR}
-
-And clone the OpenStack-Helm repo:
-
-.. code:: bash
-
- git clone https://git.openstack.org/openstack/openstack-helm
-
-Build the AIO environment (optional)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-A known good image is published to dockerhub on a fairly regular basis, but if
-you wish to build your own image, from the root directory of the OpenStack-Helm
-repo run:
-
-.. code:: bash
-
- export KUBEADM_IMAGE=openstackhelm/kubeadm-aio:v1.6.8
- sudo docker build --pull -t ${KUBEADM_IMAGE} tools/kubeadm-aio
-
-Deploy the AIO environment
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-To launch the environment run:
-
-.. code:: bash
-
- export KUBEADM_IMAGE=openstackhelm/kubeadm-aio:v1.6.8
- export KUBE_VERSION=v1.6.8
- ./tools/kubeadm-aio/kubeadm-aio-launcher.sh
- export KUBECONFIG=${HOME}/.kubeadm-aio/admin.conf
-
-Once this has run without errors, you should hopefully have a Kubernetes single
-node environment running, with Helm, Calico, appropriate RBAC rules and node
-labels to get developing.
-
-Prior to launching you can also optionally set the following environment
-variables to control aspects of the CNI used:
-
-.. code:: bash
-
- export KUBE_CNI=calico # or "canal" "weave" "flannel"
- export CNI_POD_CIDR=192.168.0.0/16
-
-If you wish to use this environment as the primary Kubernetes environment on
-your host you may run the following, but note that this will wipe any previous
-client configuration you may have.
-
-.. code:: bash
-
- mkdir -p ${HOME}/.kube
- cat ${HOME}/.kubeadm-aio/admin.conf > ${HOME}/.kube/config
-
-If you wish to create dummy network devices for Neutron to manage there
-is a helper script that can set them up for you:
-
-.. code:: bash
-
- sudo docker exec kubelet /usr/bin/openstack-helm-aio-network-prep
-
-Logs
-~~~~
-
-You can get the logs from your ``kubeadm-aio`` container by running:
-
-.. code:: bash
-
- sudo docker logs -f kubeadm-aio
+.. _here: https://github.com/openstack/openstack-helm/blob/master/doc/source/install/developer/all-in-one.rst