diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/admin/password-rotation.rst | 7 | ||||
| -rw-r--r-- | doc/source/contributor/ci-matrix.csv | 1 | ||||
| -rw-r--r-- | doc/source/reference/compute/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/reference/compute/zun-guide.rst | 116 | ||||
| -rw-r--r-- | doc/source/reference/containers/index.rst | 4 | ||||
| -rw-r--r-- | doc/source/reference/containers/kuryr-guide.rst | 66 | ||||
| -rw-r--r-- | doc/source/reference/message-queues/rabbitmq.rst | 31 | ||||
| -rw-r--r-- | doc/source/reference/storage/external-ceph-guide.rst | 28 |
8 files changed, 32 insertions, 222 deletions
diff --git a/doc/source/admin/password-rotation.rst b/doc/source/admin/password-rotation.rst index e5cfd0261..40f4ac9a6 100644 --- a/doc/source/admin/password-rotation.rst +++ b/doc/source/admin/password-rotation.rst @@ -11,13 +11,6 @@ variable, only the most common ones. Always back up your ``passwords.yml`` file before making any changes. Otherwise, it is easy to make unrecoverable mistakes. -.. warning:: - - This guide relies on recent changes to Kolla and Kolla-Ansible. You may - encounter errors if applying this guide to older deployments. It is - recommended that you update your containers and kolla-ansible to the latest - available versions before proceeding. - Regenerating secrets -------------------- diff --git a/doc/source/contributor/ci-matrix.csv b/doc/source/contributor/ci-matrix.csv index c49b72868..c9ba67f00 100644 --- a/doc/source/contributor/ci-matrix.csv +++ b/doc/source/contributor/ci-matrix.csv @@ -21,4 +21,3 @@ OVN;–;✅;✅;✅;✅;–;✅;✅;–;✅;–;–;Neutron ML2/OVN + OVN Octavi Prometheus + OpenSearch;–;–;–;✅;–;✅;✅;–;–;–;–;–;Fluentd, OpenSearch, Grafana, Prometheus, RabbitMQ/DB core.
Skyline;❌;–;✅;–;–;✅;–;–;–;–;–;–;"Skyline dashboard; currently disabled (SSO issues)."
Telemetry;–;–;✅;–;–;✅;–;–;–;–;✅;✅;Aodh, Ceilometer, Gnocchi.
-Zun;–;✅;✅;–;✅;✅;✅;✅;–;–;–;–;"Zun + Kuryr + Cinder LVM; etcd; dashboard."
diff --git a/doc/source/reference/compute/index.rst b/doc/source/reference/compute/index.rst index d155ffa69..b13bd2ec9 100644 --- a/doc/source/reference/compute/index.rst +++ b/doc/source/reference/compute/index.rst @@ -13,4 +13,3 @@ compute services. nova-cells-guide nova-fake-driver nova-guide - zun-guide diff --git a/doc/source/reference/compute/zun-guide.rst b/doc/source/reference/compute/zun-guide.rst deleted file mode 100644 index 8df209a73..000000000 --- a/doc/source/reference/compute/zun-guide.rst +++ /dev/null @@ -1,116 +0,0 @@ -======================= -Zun - Container service -======================= - -"Zun is an OpenStack Container service. It aims to provide an -OpenStack API for provisioning and managing containerized -workload on OpenStack." -For more details about Zun, see `OpenStack Zun Documentation -<https://docs.openstack.org/zun/latest/>`__. - -Preparation and Deployment --------------------------- - -By default Zun and its dependencies are disabled. -In order to enable Zun, you need to edit globals.yml and set the -following variables: - -.. code-block:: yaml - - enable_zun: true - enable_kuryr: true - enable_etcd: true - docker_configure_for_zun: true - containerd_configure_for_zun: true - -Docker reconfiguration requires rebootstrapping before deploy. -Make sure you understand the consequences of restarting Docker. -Please see :ref:`rebootstrapping` for details. -If it's initial deploy, then there is nothing to worry about -because it's initial bootstrapping as well and there are no -running services to affect. - -.. code-block:: console - - $ kolla-ansible bootstrap-servers - -Finally deploy: - -.. code-block:: console - - $ kolla-ansible deploy - -Verification ------------- - -#. Generate the credentials file: - - .. code-block:: console - - $ kolla-ansible post-deploy - -#. Source credentials file: - - .. code-block:: console - - $ . /etc/kolla/admin-openrc.sh - -#. Download and create a glance container image: - - .. code-block:: console - - $ docker pull cirros - $ docker save cirros | openstack image create cirros --public \ - --container-format docker --disk-format raw - -#. Create zun container: - - .. code-block:: console - - $ zun create --name test --net network=demo-net cirros ping -c4 8.8.8.8 - - .. note:: - - Kuryr does not support networks with DHCP enabled, disable DHCP in the - subnet used for zun containers. - - .. code-block:: console - - $ openstack subnet set --no-dhcp <subnet> - -#. Verify container is created: - - .. code-block:: console - - $ zun list - - +--------------------------------------+------+---------------+---------+------------+------------+-------+ - | uuid | name | image | status | task_state | addresses | ports | - +--------------------------------------+------+---------------+---------+------------+------------+-------+ - | 3719a73e-5f86-47e1-bc5f-f4074fc749f2 | test | cirros | Created | None | 172.17.0.3 | [] | - +--------------------------------------+------+---------------+---------+------------+------------+-------+ - -#. Start container: - - .. code-block:: console - - $ zun start test - Request to start container test has been accepted. - -#. Verify container: - - .. code-block:: console - - $ zun logs test - PING 8.8.8.8 (8.8.8.8): 56 data bytes - 64 bytes from 8.8.8.8: seq=0 ttl=45 time=96.396 ms - 64 bytes from 8.8.8.8: seq=1 ttl=45 time=96.504 ms - 64 bytes from 8.8.8.8: seq=2 ttl=45 time=96.721 ms - 64 bytes from 8.8.8.8: seq=3 ttl=45 time=95.884 ms - - --- 8.8.8.8 ping statistics --- - 4 packets transmitted, 4 packets received, 0% packet loss - round-trip min/avg/max = 95.884/96.376/96.721 ms - -For more information about how zun works, see -`zun, OpenStack Container service <https://docs.openstack.org/zun/latest/>`__. diff --git a/doc/source/reference/containers/index.rst b/doc/source/reference/containers/index.rst index c1bcc84d4..76afa71f8 100644 --- a/doc/source/reference/containers/index.rst +++ b/doc/source/reference/containers/index.rst @@ -2,11 +2,9 @@ Containers ========== -This section describes configuring and running container based services -including kuryr. +This section describes configuring and running container based services. .. toctree:: :maxdepth: 1 - kuryr-guide magnum-guide diff --git a/doc/source/reference/containers/kuryr-guide.rst b/doc/source/reference/containers/kuryr-guide.rst deleted file mode 100644 index f85451d57..000000000 --- a/doc/source/reference/containers/kuryr-guide.rst +++ /dev/null @@ -1,66 +0,0 @@ -============================ -Kuryr - Container networking -============================ - -"Kuryr is a Docker network plugin that uses Neutron to provide networking -services to Docker containers. It provides containerized images for the common -Neutron plugins. Kuryr requires at least Keystone and neutron. Kolla makes -kuryr deployment faster and accessible. - -Requirements -~~~~~~~~~~~~ - -* A minimum of 3 hosts for a vanilla deploy - -Preparation and Deployment -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To allow Docker daemon connect to the etcd, add the following in the -``docker.service`` file. - -.. code-block:: ini - - ExecStart= -H tcp://172.16.1.13:2375 -H unix:///var/run/docker.sock --cluster-advertise=172.16.1.13:2375 - -The IP address is host running the etcd service. ```2375``` is port that -allows Docker daemon to be accessed remotely. ```2379``` is the etcd listening -port. - -By default etcd and kuryr are disabled in the ``group_vars/all/etcd.yml`` and -``group_vars/all/kuryr.yml`` files. -In order to enable them, you need to edit the file globals.yml and set the -following variables - -.. code-block:: yaml - - enable_etcd: true - enable_kuryr: true - -Deploy the OpenStack cloud and kuryr network plugin - -.. code-block:: console - - kolla-ansible deploy - -Create a Virtual Network -~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: console - - docker network create -d kuryr --ipam-driver=kuryr --subnet=10.1.0.0/24 --gateway=10.1.0.1 docker-net1 - -To list the created network: - -.. code-block:: console - - docker network ls - -The created network is also available from OpenStack CLI: - -.. code-block:: console - - openstack network list - -For more information about how kuryr works, see -`kuryr (OpenStack Containers Networking) -<https://docs.openstack.org/kuryr/latest/>`__. diff --git a/doc/source/reference/message-queues/rabbitmq.rst b/doc/source/reference/message-queues/rabbitmq.rst index 1eed7ef14..139697633 100644 --- a/doc/source/reference/message-queues/rabbitmq.rst +++ b/doc/source/reference/message-queues/rabbitmq.rst @@ -209,3 +209,34 @@ Currently, membership changes for streams `is not entirely safe <https://github.com/rabbitmq/rabbitmq-server/discussions/14246>`__, so this script should only be used when the RabbitMQ cluster is in a known healthy state. + +Streams Retention Period +~~~~~~~~~~~~~~~~~~~~~~~~ + +When using RabbitMQ streams for fanout queues by setting +``om_enable_rabbitmq_stream_fanout: true``, users can set retention policy for +them with the use of two variables ``rabbitmq_stream_max_segment_size_bytes`` +and ``rabbitmq_stream_segment_max_age`` to avoid running out of disk space +eventually. + +Default configuration set segments of a stream queues to have maximum size of +500 MB (`RabbitMQ default <https://www.rabbitmq.com/docs/streams#declaring>`__) +and the retention time of 1800 seconds once a segment reaches the maximum size +(`oslo.messaging default +<https://docs.openstack.org/oslo.messaging/latest/configuration/opts.html#oslo_messaging_rabbit.rabbit_transient_queues_ttl>`__). +These default values will leave large number of ready messages in stream +queues even though old ones are removed by the retention policy. +So it is recommended to tune them based on how busy the cloud is. + +``rabbitmq_stream_max_segment_size_bytes`` sets the maximum size of stream +segments. This variable needs to be positive integer. + +``rabbitmq_stream_segment_max_age`` sets the retention time of segments that +reached the maximum size. This variable needs to be string with valid options +of Y, M, D, h, m, s (e.g. 24h for 24 hours). + +.. code-block:: yaml + + # Example custom retention policy configuration + rabbitmq_stream_max_segment_size_bytes: 5000 # 5 KB + rabbitmq_stream_segment_max_age: "60s" # 60 seconds diff --git a/doc/source/reference/storage/external-ceph-guide.rst b/doc/source/reference/storage/external-ceph-guide.rst index 49e64d6c3..a831015ba 100644 --- a/doc/source/reference/storage/external-ceph-guide.rst +++ b/doc/source/reference/storage/external-ceph-guide.rst @@ -312,24 +312,6 @@ for use with availability zones: * ``/etc/kolla/config/nova/<hostname2>/ceph2.conf`` * ``/etc/kolla/config/nova/<hostname2>/ceph2.client.cinder.keyring`` -If ``zun`` is enabled, and you wish to use cinder volumes with zun, -it must also be configured to allow access to Cinder volumes: - -* Enable Cinder Ceph backend for Zun in ``globals.yml``: - - .. code-block:: yaml - - zun_configure_for_cinder_ceph: "yes" - -* Copy Ceph configuration file to: - - * ``/etc/kolla/config/zun/zun-compute/ceph.conf`` - -* Copy Ceph keyring file(s) to: - - * ``/etc/kolla/config/zun/zun-compute/ceph.client.cinder.keyring`` - - Nova ---- @@ -583,13 +565,3 @@ HTTPS (443) port will be used. For example: The HAProxy frontend port is defined via ``ceph_rgw_port``, and defaults to 6780. - -Cephadm and Ceph Client Version -=============================== -When configuring Zun with Cinder volumes, kolla-ansible installs some -Ceph client packages on zun-compute hosts. You can set the version -of the Ceph packages installed by, - -* Configuring Ceph version details in ``/etc/kolla/globals.yml``: - - * ``ceph_version`` (default: ``pacific``) |