Skip to content
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.

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

Kolla-Ansible/Kayobe version enforcement #1551

Open
wants to merge 23 commits into
base: stackhpc/2024.1
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
c2f6154
Check Kayobe version playbook
assumptionsandg Feb 28, 2025
41dcf36
Fix pipefail
assumptionsandg Mar 3, 2025
0ecaf9f
Ignore linter
assumptionsandg Mar 3, 2025
7715802
Include tag option
assumptionsandg Mar 3, 2025
bcfbf89
Hook for overcloud host upgrade
assumptionsandg Mar 3, 2025
3169db8
Check on control host upgrade
assumptionsandg Mar 3, 2025
c30f721
Include remaining hooks
assumptionsandg Mar 4, 2025
ceeacc3
Clarify fail message for unexpected current versions
assumptionsandg Mar 4, 2025
10d27b9
Kolla-Ansible version check playbook
assumptionsandg Mar 5, 2025
88dba74
Add pip 24 precheck
assumptionsandg Mar 5, 2025
c46cec9
Kolla-Ansible check hooks
assumptionsandg Mar 6, 2025
303de54
Merge branch 'check-kolla-version' into check-kayobe-version
assumptionsandg Mar 6, 2025
ef48b1d
service upgrade hook
assumptionsandg Mar 6, 2025
63b6848
s/latest/expected/g
assumptionsandg Mar 6, 2025
f62fc47
Merge branch 'check-kolla-version' into check-kayobe-version
assumptionsandg Mar 6, 2025
dd8f122
Fixup Reno
assumptionsandg Mar 6, 2025
7c534cc
Add hook for host configure
assumptionsandg Mar 6, 2025
d1136a0
Include option to skip in config
assumptionsandg Mar 7, 2025
9e8980c
Make linter happy
assumptionsandg Mar 7, 2025
24a005e
Ensure commit hash is not empty
assumptionsandg Mar 7, 2025
ee2e249
Update links
assumptionsandg Mar 31, 2025
f4f7ff0
Fix playbook lint
assumptionsandg Mar 31, 2025
e39dbba
Merge branch 'stackhpc/2024.1' into check-kayobe-version
assumptionsandg Apr 9, 2025
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
2 changes: 2 additions & 0 deletions .ansible-lint-ignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ etc/kayobe/ansible/vault-generate-internal-tls.yml fqcn[action-core]
etc/kayobe/ansible/vault-generate-test-external-tls.yml fqcn[action-core]
etc/kayobe/ansible/rabbitmq-reset.yml command-instead-of-module
etc/kayobe/ansible/ubuntu-upgrade.yml syntax-check[missing-file]
etc/kayobe/ansible/check-kayobe-version.yml command-instead-of-module
etc/kayobe/ansible/check-kolla-ansible-version.yml command-instead-of-module
61 changes: 61 additions & 0 deletions etc/kayobe/ansible/check-kayobe-version.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
- name: Check Kayobe version
tags: kayobe-version-check
hosts: localhost
gather_facts: false
vars:
requirements_path: "{{ kayobe_config_path }}/../../requirements.txt"
tasks:
- name: Check version
when: stackhpc_enable_kayobe_check
block:
- name: Get package info
community.general.pip_package_info:
register: packages

- name: Check if pip is version 24.0 or newer
ansible.builtin.assert:
that: "{{ packages.packages.pip.pip[0].version is version('24.0', '>=') }}"
fail_msg: |
Pip must be 24.0 or newer to run this check. Upgrade pip by running
pip install -U pip and reinstall Kayobe by running:
pip install --force-reinstall -r {{ requirements_path }}

- name: Get installed Kayobe commit
ansible.builtin.shell:
cmd: set -o pipefail && pip freeze | grep kayobe | cut -d @ -f 3
executable: /usr/bin/bash
register: kayobe_git_commit
failed_when: kayobe_git_commit.stdout == ""

- name: Clone Kayobe
ansible.builtin.git:
repo: https://github.com/stackhpc/kayobe.git
dest: /tmp/kayobe-git
version: stackhpc/{{ openstack_release }}

- name: Get tag from Kayobe commit

Check warning on line 37 in etc/kayobe/ansible/check-kayobe-version.yml

View workflow job for this annotation

GitHub Actions / Ansible 2.16 lint with Python 3.12

command-instead-of-module

git used in place of git module

Check warning on line 37 in etc/kayobe/ansible/check-kayobe-version.yml

View workflow job for this annotation

GitHub Actions / Ansible 2.15 lint with Python 3.10

command-instead-of-module

git used in place of git module
ansible.builtin.command:
cmd: git describe --tags {{ kayobe_git_commit.stdout }}
chdir: /tmp/kayobe-git
register: kayobe_current_version

- name: Get latest Kayobe version
ansible.builtin.shell:
cmd: set -o pipefail && grep -o kayobe@stackhpc\/.*$ {{ requirements_path }} | cut -d @ -f 2
executable: /usr/bin/bash
register: kayobe_latest_version

- name: Check installed Kayobe version is the latest
ansible.builtin.assert:
that: "kayobe_latest_version.stdout in kayobe_current_version.stdout"
fail_msg: |
Kayobe must use the expected version before continuing.

Current Kayobe version: {{ kayobe_current_version.stdout }}
Expected Kayobe version: {{ kayobe_latest_version.stdout }}

Recreate the Kayobe environment, or install the expected version
by running: pip install --force-reinstall -r {{ requirements_path }}
success_msg: |
Kayobe running at version: {{ kayobe_current_version.stdout }}
27 changes: 27 additions & 0 deletions etc/kayobe/ansible/check-kolla-ansible-version.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
- name: Check Kolla-Ansible version
tags: kolla-ansible-version-check
hosts: localhost
gather_facts: false
tasks:
- name: Check version
when: stackhpc_enable_kolla_ansible_check
block:
- name: Get current Kolla-Ansible tag

Check warning on line 10 in etc/kayobe/ansible/check-kolla-ansible-version.yml

View workflow job for this annotation

GitHub Actions / Ansible 2.16 lint with Python 3.12

command-instead-of-module

git used in place of git module

Check warning on line 10 in etc/kayobe/ansible/check-kolla-ansible-version.yml

View workflow job for this annotation

GitHub Actions / Ansible 2.15 lint with Python 3.10

command-instead-of-module

git used in place of git module
ansible.builtin.command:
cmd: git describe --tags
chdir: "{{ lookup('ansible.builtin.env', 'KOLLA_SOURCE_PATH') }}"
register: kolla_ansible_current_version

- name: Check installed Kolla-Ansible version is the expected version
ansible.builtin.assert:
that: "stackhpc_kolla_ansible_source_version in kolla_ansible_current_version.stdout"
fail_msg: |
Kolla-Ansible must use the expected version before continuing.

Current Kolla-Ansible version: {{ kolla_ansible_current_version.stdout }}
Expected Kolla-Ansible version: {{ stackhpc_kolla_ansible_source_version }}

Upgrade Kolla-Ansible by running: kayobe control host upgrade
success_msg: |
Kolla-Ansible running at version: {{ kolla_ansible_current_version.stdout }}
8 changes: 8 additions & 0 deletions etc/kayobe/stackhpc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,14 @@ stackhpc_docker_registry_password: "{{ pulp_password }}"
# Whether or not to run CIS benchmark hardening playbooks. Default is false.
#stackhpc_enable_cis_benchmark_hardening_hook:

# Whether or not to check the installed Kayobe version when running Kayobe commands.
# Default is true.
stackhpc_enable_kayobe_check: true

# Whether or not to check the installed Kolla-Ansible version when running Kayobe commands.
# Default is true.
stackhpc_enable_kolla_ansible_check: true

###############################################################################
# Octavia Amphora image

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
features:
- |
Ansible playbooks to check the installed Kayobe/Kolla-Ansible versions
with the expected versions in Kayobe configuration. These checks
will run on Kayobe bootstrap, host and service operations.
upgrade:
- |
Checks are enabled by default which may break existing deployments using
custom forks or branches for Kayobe and Kolla-Ansible, to disable version
checks in configuration set ``stackhpc_enable_kayobe_check`` and
``stackhpc_enable_kolla_ansible_check`` to false
Loading