init-runonce error "install python-openstackclient before proceeding"

[IT OT Security]

- [X] This doc is inaccurate in this way:

In the section "Using OpenStack" in section 1 it says: pip install python3-openstackclient, when in fact it is pip install python-openstackclient.

in section 3, when I run init-runonce the application responds with the error: "Please install python-openstackclient before proceeding". I have previously installed python-openstackclient. I don't know how to continue.

Thank you.

-----------------------------------
Release: 13.1.0.dev20 on 2021-10-21 20:40:44
SHA: 5b32ae23984cd52747b37aa83bccbb63a477de73
Source: https://opendev.org/openstack/kolla-ansible/src/doc/source/user/quickstart.rst
URL: https://docs.openstack.org/kolla-ansible/latest/user/quickstart.html

[Adrian Andreias (adrian-fleio)]

python-openstackclient issue needs to be fixed, indeed.

But I don't think this is related to your issue.

I've just followed the steps in the docs and init-runonce run successfully. Note that it's a different path if you installed kolla-ansible in a virtual environment, e.g.

./env/share/kolla-ansible/init-runonce

not /usr/local/share/kolla-ansible/init-runonce

I think docs need an update on this too.

I assume you mixed installation commands in an Python virtual environment with commands you run globally.

Make sure you run init-runonce from the virtual environment path, if you installed it there.

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/kolla-ansible/+/816074

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/kolla-ansible/+/816076

[IT OT Security (itotsec)]

I am not installing kolla-ansible in a virtual environment. The path is correct. The error "Please install python-openstackclient before proceeding" is returned when running init-runonce.

[Adrian Andreias (adrian-fleio)]

This is indeed wrong on the Quick Start (fix is on the way):

pip install python3-openstackclient

but after running the correct command:

pip install python-openstackclient

init-runonce works without problems.

Does pip install python-openstackclient completes successfully?

If you're still having this issue (after successfully running pip install python-openstackclient) can you explain in detail steps to reproduce this?

[OpenStack Infra (hudson-openstack)]

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

commit 6f0783ffa7d4663b01e5fd86efd503385051348e
Author: Adrian Andreias <email address hidden>
Date: Mon Nov 1 14:24:48 2021 +0200

    docs: Fix python-openstackclient package name and init-runonce path

    Related-Bug: #1949198
    Change-Id: I2bd1a3674f8dd254b55634903a4c046293557e18
    Signed-off-by: Adrian Andreias <email address hidden>

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/xena
Review: https://review.opendev.org/c/openstack/kolla-ansible/+/817264

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/wallaby
Review: https://review.opendev.org/c/openstack/kolla-ansible/+/817265

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/victoria
Review: https://review.opendev.org/c/openstack/kolla-ansible/+/817266

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/kolla-ansible/+/817265
Committed: https://opendev.org/openstack/kolla-ansible/commit/c6a04b0f2837680b899158ac3ff49dd7dec1b3eb
Submitter: "Zuul (22348)"
Branch: stable/wallaby

commit c6a04b0f2837680b899158ac3ff49dd7dec1b3eb
Author: Adrian Andreias <email address hidden>
Date: Mon Nov 1 14:24:48 2021 +0200

    docs: Fix python-openstackclient package name and init-runonce path

    Related-Bug: #1949198
    Change-Id: I2bd1a3674f8dd254b55634903a4c046293557e18
    Signed-off-by: Adrian Andreias <email address hidden>
    (cherry picked from commit 6f0783ffa7d4663b01e5fd86efd503385051348e)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/kolla-ansible/+/817264
Committed: https://opendev.org/openstack/kolla-ansible/commit/543096c93f70fc18d885c83a197c72b42f905ae7
Submitter: "Zuul (22348)"
Branch: stable/xena

commit 543096c93f70fc18d885c83a197c72b42f905ae7
Author: Adrian Andreias <email address hidden>
Date: Mon Nov 1 14:24:48 2021 +0200

    docs: Fix python-openstackclient package name and init-runonce path

    Related-Bug: #1949198
    Change-Id: I2bd1a3674f8dd254b55634903a4c046293557e18
    Signed-off-by: Adrian Andreias <email address hidden>
    (cherry picked from commit 6f0783ffa7d4663b01e5fd86efd503385051348e)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/kolla-ansible/+/817266
Committed: https://opendev.org/openstack/kolla-ansible/commit/11451cc9efe6fbfa626a748e33b49391a00643cd
Submitter: "Zuul (22348)"
Branch: stable/victoria

commit 11451cc9efe6fbfa626a748e33b49391a00643cd
Author: Adrian Andreias <email address hidden>
Date: Mon Nov 1 14:24:48 2021 +0200

    docs: Fix python-openstackclient package name and init-runonce path

    Related-Bug: #1949198
    Change-Id: I2bd1a3674f8dd254b55634903a4c046293557e18
    Signed-off-by: Adrian Andreias <email address hidden>
    (cherry picked from commit 6f0783ffa7d4663b01e5fd86efd503385051348e)