[DOCS] Configuring the Ceph client

[Sean Schoonover]

In the ceph_clinet documentation section "Configure os_gnocchi with ceph_client" (https://opendev.org/openstack/openstack-ansible-ceph_client/src/branch/master/doc/source/configure-ceph.rst#configure-os_gnocchi-with-ceph_client) it provides this example:

```
ceph_extra_components:
  - component: gnocchi_api
    package: "{{ python_ceph_packages }}"
    client:
      - '{{ gnocchi_ceph_client }}'
    service: '{{ ceph_gnocchi_service_names }}'
```

This example will fail to place the ceph keyring file in the Gnocchi container because of a missing "name" variable under "client:".

https://opendev.org/openstack/openstack-ansible-ceph_client/commit/fdd2aaa00b appears to be where this behavior is changed.

The correct example should be:

```
ceph_extra_components:
  - component: gnocchi_api
    package: "{{ python_ceph_packages }}"
    client:
      - name: '{{ gnocchi_ceph_client }}'
    service: '{{ ceph_gnocchi_service_names }}'
```

[Sean Schoonover (seansch)]

This also effects the comment at https://opendev.org/openstack/openstack-ansible-ceph_client/src/branch/master/vars/main.yml#L62

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/openstack-ansible-ceph_client/+/904499

[Dmitriy Rabotyagov (noonedeadpunk)]

Hi,

Thanks for reporting that.

It would be really nice if you could test out if old format of ceph_extra_components works with the patch above ^

[Sean Schoonover (seansch)]

Patch looks good, I tested both the old and new format, both succeeded without any errors. Thanks!

[Dmitriy Rabotyagov (noonedeadpunk)]

Great, thanks for taking time testing the patch!

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/openstack-ansible-ceph_client/+/904499
Committed: https://opendev.org/openstack/openstack-ansible-ceph_client/commit/6bb5f7dcdbeb60fc9c3fb50437f4766cc61b954c
Submitter: "Zuul (22348)"
Branch: master

commit 6bb5f7dcdbeb60fc9c3fb50437f4766cc61b954c
Author: Dmitriy Rabotyagov <email address hidden>
Date: Tue Jan 2 16:55:03 2024 +0100

    Add backwards compatibility of ceph_components format

    With [1] we have broken compatibility of potentially provided extra components
    config without any notice.

    In order to handle this now we fix backwards compatibility along with
    adding a deprecation note on the format of ``client``.

    [1] https://review.opendev.org/c/openstack/openstack-ansible-ceph_client/+/882827

    Closes-Bug: #2047783
    Change-Id: I89b67f0f0545d799194d8486a6bb25227279af84

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/2023.2
Review: https://review.opendev.org/c/openstack/openstack-ansible-ceph_client/+/904849

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/openstack-ansible-ceph_client/+/904849
Committed: https://opendev.org/openstack/openstack-ansible-ceph_client/commit/563c3b600a239f28792860beb4b0b6da0046b54d
Submitter: "Zuul (22348)"
Branch: stable/2023.2

commit 563c3b600a239f28792860beb4b0b6da0046b54d
Author: Dmitriy Rabotyagov <email address hidden>
Date: Tue Jan 2 16:55:03 2024 +0100

    Add backwards compatibility of ceph_components format

    With [1] we have broken compatibility of potentially provided extra components
    config without any notice.

    In order to handle this now we fix backwards compatibility along with
    adding a deprecation note on the format of ``client``.

    [1] https://review.opendev.org/c/openstack/openstack-ansible-ceph_client/+/882827

    Closes-Bug: #2047783
    Change-Id: I89b67f0f0545d799194d8486a6bb25227279af84
    (cherry picked from commit 6bb5f7dcdbeb60fc9c3fb50437f4766cc61b954c)

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/2023.1
Review: https://review.opendev.org/c/openstack/openstack-ansible-ceph_client/+/917000

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/openstack-ansible-ceph_client/+/917000
Committed: https://opendev.org/openstack/openstack-ansible-ceph_client/commit/e694b9141b16d5351048050419e895314d63f1b8
Submitter: "Zuul (22348)"
Branch: stable/2023.1

commit e694b9141b16d5351048050419e895314d63f1b8
Author: Dmitriy Rabotyagov <email address hidden>
Date: Tue Jan 2 16:55:03 2024 +0100

    Add backwards compatibility of ceph_components format

    With [1] we have broken compatibility of potentially provided extra components
    config without any notice.

    In order to handle this now we fix backwards compatibility along with
    adding a deprecation note on the format of ``client``.

    [1] https://review.opendev.org/c/openstack/openstack-ansible-ceph_client/+/882827

    Closes-Bug: #2047783
    Change-Id: I89b67f0f0545d799194d8486a6bb25227279af84
    (cherry picked from commit 6bb5f7dcdbeb60fc9c3fb50437f4766cc61b954c)