mirror of
https://github.com/optim-enterprises-bv/openstack-helm.git
synced 2025-12-27 18:24:45 +00:00
Update remaining markdown docs to RST
There were few remaining README.md files. This commit converts them to RST. Change-Id: Ia0be0012fff33b9be5c9db3febc1e45a076701ec
This commit is contained in:
Michał Dulko
@@ -1,21 +0,0 @@
|
||||
# Openstack-Helm Gate Scripts
|
||||
|
||||
These scripts are used in the OpenStack-Helm Gates and can also be run locally to aid development and for demonstration purposes. Please note that they assume full control of a machine, and may be destructive in nature, so should only be run on a dedicated host.
|
||||
|
||||
## Usage
|
||||
|
||||
The Gate scripts use the `setup_gate.sh` as an entrypoint and are controlled by environment variables, an example of use to run the basic integration test is below:
|
||||
|
||||
``` bash
|
||||
export INTEGRATION=aio
|
||||
export INTEGRATION_TYPE=basic
|
||||
./tools/gate/setup_gate.sh
|
||||
```
|
||||
|
||||
### Supported Platforms
|
||||
|
||||
Currently supported host platforms are:
|
||||
* Ubuntu 16.04
|
||||
* CentOS 7
|
||||
|
||||
With some preparation to docker, and disabling of SELinux operation of Fedora 25 is also supported.
|
||||
28
tools/gate/README.rst
Normal file
28
tools/gate/README.rst
Normal file
@@ -0,0 +1,28 @@
|
||||
Openstack-Helm Gate Scripts
|
||||
===========================
|
||||
|
||||
These scripts are used in the OpenStack-Helm Gates and can also be run
|
||||
locally to aid development and for demonstration purposes. Please note
|
||||
that they assume full control of a machine, and may be destructive in
|
||||
nature, so should only be run on a dedicated host.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
The Gate scripts use the ``setup_gate.sh`` as an entrypoint and are
|
||||
controlled by environment variables, an example of use to run the basic
|
||||
integration test is below:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
export INTEGRATION=aio
|
||||
export INTEGRATION_TYPE=basic
|
||||
./tools/gate/setup_gate.sh
|
||||
|
||||
Supported Platforms
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Currently supported host platforms are: \* Ubuntu 16.04 \* CentOS 7
|
||||
|
||||
With some preparation to docker, and disabling of SELinux operation of
|
||||
Fedora 25 is also supported.
|
||||
@@ -1,23 +0,0 @@
|
||||
# gen-oslo-openstack-helm
|
||||
Oslo Config Generator Hack to Generate Helm Configs
|
||||
|
||||
## Usage
|
||||
|
||||
From this directory run the following commands, adjusting for the OpenStack
|
||||
project and/or branch desired as necessary.
|
||||
|
||||
``` bash
|
||||
docker build . -t gen-oslo-openstack-helm
|
||||
PROJECT=heat
|
||||
sudo rm -rf /tmp/${PROJECT} || true
|
||||
docker run -it --rm \
|
||||
-e PROJECT="${PROJECT}" \
|
||||
-e PROJECT_BRANCH="stable/newton" \
|
||||
-e PROJECT_REPO=https://git.openstack.org/openstack/${PROJECT}.git \
|
||||
-v /tmp:/tmp:rw \
|
||||
gen-oslo-openstack-helm
|
||||
```
|
||||
|
||||
This container will then drop you into a shell, at the project root with
|
||||
OpenStack-Helm formatted configuration files in the standard locations produced
|
||||
by genconfig for the project.
|
||||
26
tools/gen-oslo-openstack-helm/README.rst
Normal file
26
tools/gen-oslo-openstack-helm/README.rst
Normal file
@@ -0,0 +1,26 @@
|
||||
gen-oslo-openstack-helm
|
||||
=======================
|
||||
|
||||
Oslo Config Generator Hack to Generate Helm Configs
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
From this directory run the following commands, adjusting for the
|
||||
OpenStack project and/or branch desired as necessary.
|
||||
|
||||
.. code:: bash
|
||||
|
||||
docker build . -t gen-oslo-openstack-helm
|
||||
PROJECT=heat
|
||||
sudo rm -rf /tmp/${PROJECT} || true
|
||||
docker run -it --rm \
|
||||
-e PROJECT="${PROJECT}" \
|
||||
-e PROJECT_BRANCH="stable/newton" \
|
||||
-e PROJECT_REPO=https://git.openstack.org/openstack/${PROJECT}.git \
|
||||
-v /tmp:/tmp:rw \
|
||||
gen-oslo-openstack-helm
|
||||
|
||||
This container will then drop you into a shell, at the project root with
|
||||
OpenStack-Helm formatted configuration files in the standard locations
|
||||
produced by genconfig for the project.
|
||||
@@ -1,92 +0,0 @@
|
||||
# Kubeadm AIO Container
|
||||
|
||||
This container builds a small AIO Kubeadm based Kubernetes deployment for Development and Gating use.
|
||||
|
||||
## Instructions
|
||||
|
||||
### OS Specific Host setup:
|
||||
|
||||
#### Ubuntu:
|
||||
|
||||
From a freshly provisioned Ubuntu 16.04 LTS host run:
|
||||
``` 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:
|
||||
|
||||
``` bash
|
||||
KUBE_VERSION=v1.6.0
|
||||
HELM_VERSION=v2.3.0
|
||||
|
||||
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:
|
||||
|
||||
``` 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:
|
||||
|
||||
``` bash
|
||||
export KUBEADM_IMAGE=openstackhelm/kubeadm-aio:v1.6
|
||||
sudo docker build --pull -t ${KUBEADM_IMAGE} tools/kubeadm-aio
|
||||
```
|
||||
|
||||
### Deploy the AIO environment
|
||||
|
||||
To launch the environment run:
|
||||
|
||||
``` bash
|
||||
export KUBEADM_IMAGE=openstackhelm/kubeadm-aio:v1.6
|
||||
export KUBE_VERSION=v1.6.2
|
||||
./tools/kubeadm-aio/kubeadm-aio-launcher.sh
|
||||
export KUBECONFIG=${HOME}/.kubeadm-aio/admin.conf
|
||||
```
|
||||
|
||||
One this has run, you should hopefully have a Kubernetes single node environment
|
||||
running, with Helm, Calico, a NFS PVC provisioner and appropriate RBAC rules and
|
||||
node labels to get developing.
|
||||
|
||||
If you wish to use this environment at 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.
|
||||
|
||||
``` 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:
|
||||
|
||||
``` 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:
|
||||
|
||||
``` bash
|
||||
sudo docker logs -f kubeadm-aio
|
||||
```
|
||||
102
tools/kubeadm-aio/README.rst
Normal file
102
tools/kubeadm-aio/README.rst
Normal file
@@ -0,0 +1,102 @@
|
||||
Kubeadm AIO Container
|
||||
=====================
|
||||
|
||||
This container builds a small AIO Kubeadm based Kubernetes deployment
|
||||
for Development and Gating use.
|
||||
|
||||
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.0
|
||||
HELM_VERSION=v2.3.0
|
||||
|
||||
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
|
||||
sudo docker build --pull -t ${KUBEADM_IMAGE} tools/kubeadm-aio
|
||||
|
||||
Deploy the AIO environment
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To launch the environment then run:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
export KUBEADM_IMAGE=openstackhelm/kubeadm-aio:v1.6
|
||||
export KUBE_VERSION=v1.6.2
|
||||
./tools/kubeadm-aio/kubeadm-aio-launcher.sh
|
||||
export KUBECONFIG=${HOME}/.kubeadm-aio/admin.conf
|
||||
|
||||
One this has run, you should hopefully have a Kubernetes single node
|
||||
environment running, with Helm, Calico, a NFS PVC provisioner and
|
||||
appropriate RBAC rules and node labels to get developing.
|
||||
|
||||
If you wish to use this environment at 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
|
||||
Reference in New Issue
Block a user