Skip to content

feat: simplify RGW deployment docs #2335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jackhodgkiss wants to merge 1 commit into
base: stackhpc/2025.1
Choose a base branch
from
+16 −10
Open

feat: simplify RGW deployment docs #2335

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions doc/source/configuration/cephadm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ The set of commands below configure all of these.
- "config set client.rgw rgw_keystone_accepted_admin_roles 'admin'"
- "config set client.rgw rgw_keystone_accepted_roles 'member, admin'"
- "config set client.rgw rgw_keystone_admin_domain Default"
- "config set client.rgw rgw_keystone_admin_password {{ secrets_ceph_rgw_keystone_password }}"
- "config set client.rgw rgw_keystone_admin_password {{ (lookup('file', kayobe_env_config_path ~ '/kolla/passwords.yml') | from_yaml).ceph_rgw_keystone_password }}"
Copy link
Copy Markdown
Member

@Alex-Welsh Alex-Welsh May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Default to undef?

- "config set client.rgw rgw_keystone_admin_project service"
- "config set client.rgw rgw_keystone_admin_user 'ceph_rgw'"
- "config set client.rgw rgw_keystone_api_version '3'"
Expand Down Expand Up @@ -441,15 +441,9 @@ before deploying the RADOS gateways. If you are using the Kolla load balancer
(see :ref:`RGWs-with-hyper-converged-Ceph` for more info), you can specify the
``haproxy`` and ``loadbalancer`` tags here too.

.. code:: yaml

kayobe overcloud service deploy -kt ceph-rgw,keystone,haproxy,loadbalancer

There are two options for load balancing RADOS Gateway:

1. HA with Ceph Ingress services
2. RGWs with hyper-converged Ceph (using the Kolla Ansible deployed HAProxy
load balancer)
There are two options for load balancing RADOS Gateway either HA with Ceph Ingress services or RGWs with hyper-converged Ceph (using the Kolla Ansible deployed HAProxy
load balancer).
Both of the approaches are discused in subsequent sections.
Comment on lines +444 to +446
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There is a typo in this section ("discused" instead of "discussed"). Additionally, the phrasing of the first sentence can be improved for better readability.

Note that the paragraph preceding this section (around line 437) still references secrets_ceph_rgw_keystone_password and instructs the user to store it in secrets.yml. Since this PR removes the need for that variable by using a direct lookup, that paragraph is now outdated and should be updated or removed.

Suggested change
There are two options for load balancing RADOS Gateway either HA with Ceph Ingress services or RGWs with hyper-converged Ceph (using the Kolla Ansible deployed HAProxy
load balancer).
Both of the approaches are discused in subsequent sections.
There are two options for load balancing RADOS Gateway: either HA with Ceph Ingress services, or RGWs with hyper-converged Ceph (using the Kolla Ansible deployed HAProxy
load balancer).
Both approaches are discussed in subsequent sections.


.. _RGWs-with-hyper-converged-Ceph:

Expand Down Expand Up @@ -480,6 +474,12 @@ add definitions of your Ceph hosts to Kolla ``globals.yml``:
ip: <host IP on storage net>
port: 8100

Make sure to reconfigure appropriate kolla services to complete Ceph RGW integration
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Capitalize "Kolla" to maintain consistency with the rest of the documentation, and add a period at the end of the sentence.

Suggested change
Make sure to reconfigure appropriate kolla services to complete Ceph RGW integration
Make sure to reconfigure the appropriate Kolla services to complete Ceph RGW integration.


.. code:: yaml

kayobe overcloud service deploy -kt ceph-rgw,keystone,haproxy,loadbalancer

HA with Ingress services
~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -510,6 +510,12 @@ RGWs to use the Kolla-deployed haproxy. Set the following in Kolla

enable_ceph_rgw_loadbalancer: false

Make sure to reconfigure appropriate kolla services to complete Ceph RGW integration
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Capitalize "Kolla" to maintain consistency with the rest of the documentation, and add a period at the end of the sentence.

Suggested change
Make sure to reconfigure appropriate kolla services to complete Ceph RGW integration
Make sure to reconfigure the appropriate Kolla services to complete Ceph RGW integration.


.. code:: yaml

kayobe overcloud service deploy -kt ceph-rgw,keystone,haproxy,loadbalancer

Deployment
==========

Expand Down
Loading