Skip to content

README: fix ci-aio and ci-builder setup instructions #135

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

Merged
merged 1 commit into from
Aug 17, 2022
Merged

README: fix ci-aio and ci-builder setup instructions #135

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
18 changes: 16 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,13 @@ Setup

Access the host via SSH.

Install package dependencies. On Ubuntu:

.. code-block:: console

sudo apt update
sudo apt install python3-virtualenv
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it not also be beneficial to add acl as a required package?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good question. I'm not sure where is the right place to install that package. Ansible docs suggest it happens when using become and become_user with an unprivileged user, which is not that common. Still, it might be useful to install the package in Kayobe.

In fact, we already do, just in a specific code path that you didn't hit:

# NOTE(mgoddard): The acl package is required for the setfacl command, used by
# become_user.
- name: Ensure acl package is installed
  package:
    name: acl
    cache_valid_time: "{{ apt_cache_valid_time if ansible_facts.os_family == 'Debian' else omit }}"
    update_cache: "{{ True if ansible_facts.os_family == 'Debian' else omit }}"
  become: true

So we could move that code somewhere more general.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

https://review.opendev.org/c/openstack/kayobe/+/853424


Clone the Kayobe and Kayobe configuration repositories (this one):

.. code-block:: console
Expand All @@ -246,7 +253,7 @@ Clone the Kayobe and Kayobe configuration repositories (this one):
mkdir -p src
pushd src
git clone https://github.com/stackhpc/kayobe.git -b stackhpc/wallaby
git clone https://github.com/stackhpc/stackhpc-kayobe-config -b stackhpc/wallaby
git clone https://github.com/stackhpc/stackhpc-kayobe-config -b stackhpc/wallaby kayobe-config
popd

Create a virtual environment and install Kayobe:
Expand Down Expand Up @@ -337,6 +344,13 @@ Setup

Access the host via SSH.

Install package dependencies. On Ubuntu:

.. code-block:: console

sudo apt update
sudo apt install python3-virtualenv

Clone the Kayobe and Kayobe configuration repositories (this one):

.. code-block:: console
Expand All @@ -345,7 +359,7 @@ Clone the Kayobe and Kayobe configuration repositories (this one):
mkdir -p src
pushd src
git clone https://github.com/stackhpc/kayobe.git -b stackhpc/wallaby
git clone https://github.com/stackhpc/stackhpc-kayobe-config -b stackhpc/wallaby
git clone https://github.com/stackhpc/stackhpc-kayobe-config -b stackhpc/wallaby kayobe-config
popd

Create a virtual environment and install Kayobe:
Expand Down