External Ceph in kolla-ansible documentation bug

Bug #1954910 reported by Franciszek Przewoźny
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
kolla-ansible
Fix Released
Low
Winicius Allan
Antelope
Fix Committed
Low
Unassigned
Bobcat
Fix Committed
Low
Unassigned
Caracal
Fix Released
Low
Winicius Allan
Yoga
Fix Committed
Low
Unassigned
Zed
Fix Released
Low
Unassigned

Bug Description

This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:

- [ ] This doc is inaccurate in this way: ______
- [ ] This is a doc addition request.
- [X] I have a fix to the document that I can paste below including example:

In NOVA part:

"ceph_nova_user (by default it’s the same as ceph_cinder_user)"

Which is not true, by default it is ceph_nova_user: "nova", but should be ceph_nova_user: "{{ ceph_cinder_user }}"

If you have a troubleshooting or support issue, use the following resources:

 - The mailing list: https://lists.openstack.org
 - IRC: 'openstack' channel on OFTC

-----------------------------------
Release: 13.1.0.dev62 on 2021-10-20 09:36:35
SHA: 835cbe729555aac9583534990928e4d930405afa
Source: https://opendev.org/openstack/kolla-ansible/src/doc/source/reference/storage/external-ceph-guide.rst
URL: https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html

summary: - External Ceph in kolla-ansible
+ External Ceph in kolla-ansible documentation bug
tags: added: low-hanging-fruit
Revision history for this message
Winicius Allan (winiciusallan) wrote :

Hello o/ you think the part "should be ceph_nova_user: '{{ ceph_cinder_user }}'" must be mention in documentation or just say default value?

Revision history for this message
Franciszek Przewoźny (fprzewozn) wrote :

Hey, looking into this once again I think the change should rather be here: https://github.com/openstack/kolla-ansible/blob/3c3c5179586f4ceebd70f0fee7e127f636b1c1af/etc/kolla/globals.yml#L498 (set ceph_nova_user to {{ ceph_cinder_user }} instead of nova), and not in the docs as https://github.com/openstack/kolla-ansible/commit/c3f9ba835b1da740c9f3056dbda20a7072467757 was a change that was missing that one.

Revision history for this message
Winicius Allan (winiciusallan) wrote :

Oh, I got it. I thought the bug is in documentation instead of globals.yml. I'll assign this to me and make the necessaries changes.

Changed in kolla-ansible:
assignee: nobody → Winicius Allan (winiciusallan)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to kolla-ansible (master)
Changed in kolla-ansible:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to kolla-ansible (master)

Reviewed: https://review.opendev.org/c/openstack/kolla-ansible/+/915169
Committed: https://opendev.org/openstack/kolla-ansible/commit/21c05dcf101105b62f1b81620305438ae3d3d8b8
Submitter: "Zuul (22348)"
Branch: master

commit 21c05dcf101105b62f1b81620305438ae3d3d8b8
Author: Winicius Silva <email address hidden>
Date: Fri Apr 5 13:47:12 2024 -0300

    Change the default ceph_nova_user in globals

    The documentation[1] says that ceph_nova_user is the same as ceph_cinder_user,
    but this it not true. In globals, the variable which refer to nova user on
    ceph its setted as just "nova", instead of {{ ceph_cinder_user }}

    [1] https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html

    Closes-Bug: #1954910
    Change-Id: I0037b294fa88f129aaa98da426989a8151e6f9ea

Changed in kolla-ansible:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to kolla-ansible (stable/2023.2)

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to kolla-ansible (stable/2023.1)

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to kolla-ansible (stable/zed)

Fix proposed to branch: stable/zed
Review: https://review.opendev.org/c/openstack/kolla-ansible/+/915352

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to kolla-ansible (unmaintained/yoga)

Fix proposed to branch: unmaintained/yoga
Review: https://review.opendev.org/c/openstack/kolla-ansible/+/915353

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to kolla-ansible (stable/2023.2)

Reviewed: https://review.opendev.org/c/openstack/kolla-ansible/+/915350
Committed: https://opendev.org/openstack/kolla-ansible/commit/1ee8088f1bce692f74cddd406e071b902c14be3d
Submitter: "Zuul (22348)"
Branch: stable/2023.2

commit 1ee8088f1bce692f74cddd406e071b902c14be3d
Author: Winicius Silva <email address hidden>
Date: Fri Apr 5 13:47:12 2024 -0300

    Change the default ceph_nova_user in globals

    The documentation[1] says that ceph_nova_user is the same as ceph_cinder_user,
    but this it not true. In globals, the variable which refer to nova user on
    ceph its setted as just "nova", instead of {{ ceph_cinder_user }}

    [1] https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html

    Closes-Bug: #1954910
    Change-Id: I0037b294fa88f129aaa98da426989a8151e6f9ea
    (cherry picked from commit 21c05dcf101105b62f1b81620305438ae3d3d8b8)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to kolla-ansible (stable/2023.1)

Reviewed: https://review.opendev.org/c/openstack/kolla-ansible/+/915351
Committed: https://opendev.org/openstack/kolla-ansible/commit/59465420e3c2897db094c5a84a160a7a0b0be50d
Submitter: "Zuul (22348)"
Branch: stable/2023.1

commit 59465420e3c2897db094c5a84a160a7a0b0be50d
Author: Winicius Silva <email address hidden>
Date: Fri Apr 5 13:47:12 2024 -0300

    Change the default ceph_nova_user in globals

    The documentation[1] says that ceph_nova_user is the same as ceph_cinder_user,
    but this it not true. In globals, the variable which refer to nova user on
    ceph its setted as just "nova", instead of {{ ceph_cinder_user }}

    [1] https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html

    Closes-Bug: #1954910
    Change-Id: I0037b294fa88f129aaa98da426989a8151e6f9ea
    (cherry picked from commit 21c05dcf101105b62f1b81620305438ae3d3d8b8)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to kolla-ansible (stable/zed)

Reviewed: https://review.opendev.org/c/openstack/kolla-ansible/+/915352
Committed: https://opendev.org/openstack/kolla-ansible/commit/1c66d027a349e20c5207ec96ad58f21ee5f4380e
Submitter: "Zuul (22348)"
Branch: stable/zed

commit 1c66d027a349e20c5207ec96ad58f21ee5f4380e
Author: Winicius Silva <email address hidden>
Date: Fri Apr 5 13:47:12 2024 -0300

    Change the default ceph_nova_user in globals

    The documentation[1] says that ceph_nova_user is the same as ceph_cinder_user,
    but this it not true. In globals, the variable which refer to nova user on
    ceph its setted as just "nova", instead of {{ ceph_cinder_user }}

    [1] https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html

    Closes-Bug: #1954910
    Change-Id: I0037b294fa88f129aaa98da426989a8151e6f9ea
    (cherry picked from commit 21c05dcf101105b62f1b81620305438ae3d3d8b8)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to kolla-ansible (unmaintained/yoga)

Reviewed: https://review.opendev.org/c/openstack/kolla-ansible/+/915353
Committed: https://opendev.org/openstack/kolla-ansible/commit/ed2a26e0b984e52f048479a58463be6111c1d115
Submitter: "Zuul (22348)"
Branch: unmaintained/yoga

commit ed2a26e0b984e52f048479a58463be6111c1d115
Author: Winicius Silva <email address hidden>
Date: Fri Apr 5 13:47:12 2024 -0300

    Change the default ceph_nova_user in globals

    The documentation[1] says that ceph_nova_user is the same as ceph_cinder_user,
    but this it not true. In globals, the variable which refer to nova user on
    ceph its setted as just "nova", instead of {{ ceph_cinder_user }}

    [1] https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html

    Closes-Bug: #1954910
    Change-Id: I0037b294fa88f129aaa98da426989a8151e6f9ea
    (cherry picked from commit 21c05dcf101105b62f1b81620305438ae3d3d8b8)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/kolla-ansible zed-eom

This issue was fixed in the openstack/kolla-ansible zed-eom release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/kolla-ansible 18.0.0.0rc1

This issue was fixed in the openstack/kolla-ansible 18.0.0.0rc1 release candidate.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.