openstack/openstack-helm
Code Issues Proposed changes

Update documentation after merger of osh-infra

Browse Source 
Change-Id: I5afe03c8a49bd7091470246ca66d9209e09a1991
This commit is contained in:
Vladimir Kozhukalov 2025-04-15 13:35:38 -05:00
parent e47ad4a791
commit 912f85d38e
5 changed files with 29 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/install/before_starting.rst
View File

@ -1,13 +1,12 @@
Before starting Before starting
=============== ===============
The OpenStack-Helm charts are published in the `openstack-helm`_ and The OpenStack-Helm charts are published in the `openstack-helm`_ helm repository.
`openstack-helm-infra`_ helm repositories. Let's enable them: Let's enable it:
.. code-block:: bash .. code-block:: bash
helm repo add openstack-helm https://tarballs.opendev.org/openstack/openstack-helm helm repo add openstack-helm https://tarballs.opendev.org/openstack/openstack-helm
helm repo add openstack-helm-infra https://tarballs.opendev.org/openstack/openstack-helm-infra
The OpenStack-Helm `plugin`_ provides some helper commands used later on. The OpenStack-Helm `plugin`_ provides some helper commands used later on.
So, let's install it: So, let's install it:
@ -17,5 +16,4 @@ So, let's install it:
helm plugin install https://opendev.org/openstack/openstack-helm-plugin helm plugin install https://opendev.org/openstack/openstack-helm-plugin
.. _openstack-helm: https://tarballs.opendev.org/openstack/openstack-helm .. _openstack-helm: https://tarballs.opendev.org/openstack/openstack-helm
.. _openstack-helm-infra: https://tarballs.opendev.org/openstack/openstack-helm-infra
.. _plugin: https://opendev.org/openstack/openstack-helm-plugin.git .. _plugin: https://opendev.org/openstack/openstack-helm-plugin.git

10
doc/source/install/kubernetes.rst
View File

@ -30,7 +30,7 @@ imperative that you clone the git repositories containing the required Ansible r
mkdir ~/osh mkdir ~/osh
cd ~/osh cd ~/osh
git clone https://opendev.org/openstack/openstack-helm-infra.git git clone https://opendev.org/openstack/openstack-helm.git
git clone https://opendev.org/zuul/zuul-jobs.git git clone https://opendev.org/zuul/zuul-jobs.git
Install Ansible Install Ansible
@ -48,7 +48,7 @@ where Ansible will lookup roles
.. code-block:: bash .. code-block:: bash
export ANSIBLE_ROLES_PATH=~/osh/openstack-helm-infra/roles:~/osh/zuul-jobs/roles export ANSIBLE_ROLES_PATH=~/osh/openstack-helm/roles:~/osh/zuul-jobs/roles
To avoid setting it every time when you start a new terminal instance you can define this To avoid setting it every time when you start a new terminal instance you can define this
in the Ansible configuration file. Please see the Ansible documentation. in the Ansible configuration file. Please see the Ansible documentation.
@ -177,10 +177,10 @@ details please refer to the role `deploy-env`_ and other roles (`ensure-python`_
Processes running on the cluster nodes will be able to resolve internal Processes running on the cluster nodes will be able to resolve internal
Kubernetes domain names ``*.svc.cluster.local``. Kubernetes domain names ``*.svc.cluster.local``.
.. _deploy-env: https://opendev.org/openstack/openstack-helm-infra/src/branch/master/roles/deploy-env .. _deploy-env: https://opendev.org/openstack/openstack-helm/src/branch/master/roles/deploy-env
.. _deploy-env/defaults/main.yaml: https://opendev.org/openstack/openstack-helm-infra/src/branch/master/roles/deploy-env/defaults/main.yaml .. _deploy-env/defaults/main.yaml: https://opendev.org/openstack/openstack-helm/src/branch/master/roles/deploy-env/defaults/main.yaml
.. _zuul-jobs: https://opendev.org/zuul/zuul-jobs.git .. _zuul-jobs: https://opendev.org/zuul/zuul-jobs.git
.. _ensure-python: https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-python .. _ensure-python: https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-python
.. _ensure-pip: https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-pip .. _ensure-pip: https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-pip
.. _clear-firewall: https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/clear-firewall .. _clear-firewall: https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/clear-firewall
.. _openstack-helm-infra: https://opendev.org/openstack/openstack-helm-infra.git .. _openstack-helm: https://opendev.org/openstack/openstack-helm.git

37
doc/source/install/openstack.rst
View File

@ -29,9 +29,9 @@ First let's set environment variables that are later used in the subsequent sect
.. code-block:: bash .. code-block:: bash
export OPENSTACK_RELEASE=2024.1 export OPENSTACK_RELEASE=2025.1
# Features enabled for the deployment. This is used to look up values overrides. # Features enabled for the deployment. This is used to look up values overrides.
export FEATURES="${OPENSTACK_RELEASE} ubuntu_jammy" export FEATURES="${OPENSTACK_RELEASE} ubuntu_noble"
# Directory where values overrides are looked up or downloaded to. # Directory where values overrides are looked up or downloaded to.
export OVERRIDES_DIR=$(pwd)/overrides export OVERRIDES_DIR=$(pwd)/overrides
@ -40,7 +40,7 @@ Get values overrides
OpenStack-Helm provides values overrides for predefined feature sets and various OpenStack-Helm provides values overrides for predefined feature sets and various
OpenStack/platform versions. The overrides are stored in the OpenStack-Helm OpenStack/platform versions. The overrides are stored in the OpenStack-Helm
git repositories and OpenStack-Helm plugin provides a command to look them up git repository and OpenStack-Helm plugin provides a command to look them up
locally and download (optional) if not found. locally and download (optional) if not found.
Please read the help: Please read the help:
@ -49,26 +49,21 @@ Please read the help:
helm osh get-values-overrides --help helm osh get-values-overrides --help
For example, if you pass the feature set ``2024.1 ubuntu_jammy`` it will try to For example, if you pass the feature set ``2025.1 ubuntu_noble`` it will try to
look up the following files: look up the following files:
.. code-block:: bash .. code-block:: bash
2024.1.yaml 2025.1.yaml
ubuntu_jammy.yaml ubuntu_noble.yaml
2024.1-ubuntu_jammy.yaml 2025.1-ubuntu_noble.yaml
Let's download the values overrides for the feature set defined above: Let's download the values overrides for the feature set defined above:
.. code-block:: bash .. code-block:: bash
INFRA_OVERRIDES_URL=https://opendev.org/openstack/openstack-helm-infra/raw/branch/master/values_overrides
for chart in rabbitmq mariadb memcached openvswitch libvirt; do
helm osh get-values-overrides -d -u ${INFRA_OVERRIDES_URL} -p ${OVERRIDES_DIR} -c ${chart} ${FEATURES}
done
OVERRIDES_URL=https://opendev.org/openstack/openstack-helm/raw/branch/master/values_overrides OVERRIDES_URL=https://opendev.org/openstack/openstack-helm/raw/branch/master/values_overrides
for chart in keystone heat glance cinder placement nova neutron horizon; do for chart in rabbitmq mariadb memcached openvswitch libvirt keystone heat glance cinder placement nova neutron horizon; do
helm osh get-values-overrides -d -u ${OVERRIDES_URL} -p ${OVERRIDES_DIR} -c ${chart} ${FEATURES} helm osh get-values-overrides -d -u ${OVERRIDES_URL} -p ${OVERRIDES_DIR} -c ${chart} ${FEATURES}
done done
@ -96,7 +91,7 @@ Use the following script to deploy RabbitMQ service:
.. code-block:: bash .. code-block:: bash
helm upgrade --install rabbitmq openstack-helm-infra/rabbitmq \ helm upgrade --install rabbitmq openstack-helm/rabbitmq \
--namespace=openstack \ --namespace=openstack \
--set pod.replicas.server=1 \ --set pod.replicas.server=1 \
--timeout=600s \ --timeout=600s \
@ -114,7 +109,7 @@ Cinder rely on MariaDB for data storage.
.. code-block:: bash .. code-block:: bash
helm upgrade --install mariadb openstack-helm-infra/mariadb \ helm upgrade --install mariadb openstack-helm/mariadb \
--namespace=openstack \ --namespace=openstack \
--set pod.replicas.server=1 \ --set pod.replicas.server=1 \
$(helm osh get-values-overrides -p ${OVERRIDES_DIR} -c mariadb ${FEATURES}) $(helm osh get-values-overrides -p ${OVERRIDES_DIR} -c mariadb ${FEATURES})
@ -130,7 +125,7 @@ data retrieval and reduces the load on the database backend.
.. code-block:: bash .. code-block:: bash
helm upgrade --install memcached openstack-helm-infra/memcached \ helm upgrade --install memcached openstack-helm/memcached \
--namespace=openstack \ --namespace=openstack \
$(helm osh get-values-overrides -p ${OVERRIDES_DIR} -c memcached ${FEATURES}) $(helm osh get-values-overrides -p ${OVERRIDES_DIR} -c memcached ${FEATURES})
@ -249,7 +244,7 @@ To deploy the OpenvSwitch service use the following:
.. code-block:: bash .. code-block:: bash
helm upgrade --install openvswitch openstack-helm-infra/openvswitch \ helm upgrade --install openvswitch openstack-helm/openvswitch \
--namespace=openstack \ --namespace=openstack \
$(helm osh get-values-overrides -p ${OVERRIDES_DIR} -c openvswitch ${FEATURES}) $(helm osh get-values-overrides -p ${OVERRIDES_DIR} -c openvswitch ${FEATURES})
@ -263,7 +258,7 @@ Let's deploy the Libvirt service using the following command:
.. code-block:: bash .. code-block:: bash
helm upgrade --install libvirt openstack-helm-infra/libvirt \ helm upgrade --install libvirt openstack-helm/libvirt \
--namespace=openstack \ --namespace=openstack \
--set conf.ceph.enabled=true \ --set conf.ceph.enabled=true \
$(helm osh get-values-overrides -p ${OVERRIDES_DIR} -c libvirt ${FEATURES}) $(helm osh get-values-overrides -p ${OVERRIDES_DIR} -c libvirt ${FEATURES})
@ -388,7 +383,7 @@ That is it! Now you can use the OpenStack client. Try to run this:
In some cases it is more convenient to use the OpenStack client In some cases it is more convenient to use the OpenStack client
inside a Docker container. OpenStack-Helm provides the inside a Docker container. OpenStack-Helm provides the
`openstackhelm/openstack-client`_ image. The below is an example `quay.io/airshipit/openstack-client`_ image. The below is an example
of how to use it. of how to use it.
@ -397,7 +392,7 @@ That is it! Now you can use the OpenStack client. Try to run this:
docker run -it --rm --network host \ docker run -it --rm --network host \
-v ~/.config/openstack/clouds.yaml:/etc/openstack/clouds.yaml \ -v ~/.config/openstack/clouds.yaml:/etc/openstack/clouds.yaml \
-e OS_CLOUD=openstack_helm \ -e OS_CLOUD=openstack_helm \
docker.io/openstackhelm/openstack-client:${OPENSTACK_RELEASE} \ quay.io/airshipit/openstack-client:${OPENSTACK_RELEASE}-ubuntu_jammy \
openstack endpoint list openstack endpoint list
Remember that the container file system is ephemeral and is destroyed Remember that the container file system is ephemeral and is destroyed
@ -412,7 +407,7 @@ For convenience, you can create an executable entry point that runs the
Openstack client in a Docker container. See for example `setup-client.sh`_. Openstack client in a Docker container. See for example `setup-client.sh`_.
.. _setup-client.sh: https://opendev.org/openstack/openstack-helm/src/branch/master/tools/deployment/common/setup-client.sh .. _setup-client.sh: https://opendev.org/openstack/openstack-helm/src/branch/master/tools/deployment/common/setup-client.sh
.. _openstackhelm/openstack-client: https://hub.docker.com/r/openstackhelm/openstack-client/tags?page=&page_size=&ordering=&name= .. _quay.io/airshipit/openstack-client: https://quay.io/repository/airshipit/openstack-client?tab=tags&tag=latest
Other Openstack components (optional) Other Openstack components (optional)

4
doc/source/install/prerequisites.rst
View File

@ -240,14 +240,14 @@ Here we assume the Ceph cluster is deployed in the ``ceph`` namespace.
.. code-block:: bash .. code-block:: bash
helm upgrade --install ceph-adapter-rook openstack-helm-infra/ceph-adapter-rook \ helm upgrade --install ceph-adapter-rook openstack-helm/ceph-adapter-rook \
--namespace=openstack --namespace=openstack
helm osh wait-for-pods openstack helm osh wait-for-pods openstack
.. _Rook: https://rook.io/ .. _Rook: https://rook.io/
.. _charts: https://rook.io/docs/rook/latest-release/Helm-Charts/helm-charts/ .. _charts: https://rook.io/docs/rook/latest-release/Helm-Charts/helm-charts/
.. _ceph-rook.sh: https://opendev.org/openstack/openstack-helm-infra/src/branch/master/tools/deployment/ceph/ceph-rook.sh .. _ceph-rook.sh: https://opendev.org/openstack/openstack-helm/src/branch/master/tools/deployment/ceph/ceph-rook.sh
Node labels Node labels
----------- -----------

8
doc/source/troubleshooting/migrate-ceph-to-rook.rst
View File

@ -2,7 +2,7 @@ Migrating Ceph to Rook
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^
It may be necessary or desired to migrate an existing `Ceph`_ cluster that was It may be necessary or desired to migrate an existing `Ceph`_ cluster that was
originally deployed using the Ceph charts in `openstack-helm-infra`_ to be originally deployed using the Ceph charts in `openstack-helm`_ to be
managed by the Rook operator moving forward. This operation is not a supported managed by the Rook operator moving forward. This operation is not a supported
`Rook`_ feature, but it is possible to achieve. `Rook`_ feature, but it is possible to achieve.
@ -24,7 +24,7 @@ are based on the Rook `Troubleshooting`_ documentation and are outlined below.
pools are not named as expected. Pools must be named pools are not named as expected. Pools must be named
"<filesystem name>-metadata" and "<filesystem name>-data" in order for Rook to "<filesystem name>-metadata" and "<filesystem name>-data" in order for Rook to
use existing CephFS pools. use existing CephFS pools.
#. Delete Ceph resources deployed via the openstack-helm-infra charts, #. Delete Ceph resources deployed via the openstack-helm charts,
uninstall the charts, and remove Ceph node labels. uninstall the charts, and remove Ceph node labels.
#. Add the Rook Helm repository and deploy the Rook operator and a minimal Ceph #. Add the Rook Helm repository and deploy the Rook operator and a minimal Ceph
cluster using the Rook Helm charts. The cluster will have a new FSID and will cluster using the Rook Helm charts. The cluster will have a new FSID and will
@ -93,7 +93,7 @@ require a lot of testing prior to being implemented in production. This is a
risky operation even with testing and should be performed very carefully. risky operation even with testing and should be performed very carefully.
.. _Ceph: https://ceph.io .. _Ceph: https://ceph.io
.. _openstack-helm-infra: https://opendev.org/openstack/openstack-helm-infra .. _openstack-helm: https://opendev.org/openstack/openstack-helm
.. _Rook: https://rook.io .. _Rook: https://rook.io
.. _Troubleshooting: https://rook.io/docs/rook/latest-release/Troubleshooting/disaster-recovery/#adopt-an-existing-rook-ceph-cluster-into-a-new-kubernetes-cluster .. _Troubleshooting: https://rook.io/docs/rook/latest-release/Troubleshooting/disaster-recovery/#adopt-an-existing-rook-ceph-cluster-into-a-new-kubernetes-cluster
.. _script: https://opendev.org/openstack/openstack-helm-infra/src/tools/deployment/ceph/migrate-to-rook-ceph.sh .. _script: https://opendev.org/openstack/openstack-helm/src/tools/deployment/ceph/migrate-to-rook-ceph.sh