Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions ansible/inventory/group_vars/all/openstack
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
###############################################################################
# OpenStack release configuration.

# Name of the current OpenStack release. Default is "2026.1".
openstack_release: "2026.1"
# Name of the current OpenStack release. Default is "master".
openstack_release: "master"

# Name of the current OpenStack branch. Default is "stable/2026.1".
# Name of the current OpenStack branch. Default is "master".
openstack_branch: >-
{% if openstack_release != 'master' %}stable/{% endif %}{{ openstack_release | lower }}

Expand Down
76 changes: 76 additions & 0 deletions doc/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,82 @@ and tasks.
Using tags is not tested in either Kayobe or Kolla-Ansible CI, and as such
should only be used if you know what you're doing. Proceed with caution.

Kolla Ansible Playbook
----------------------

Some commands that invoke Kolla Ansible support replacing the default
``site.yml`` playbook with a custom one via ``--kolla-playbook``. This may be
used to specify a playbook that replaces or extends the default playbook, and
needs to execute in the Kolla Ansible context. For example::

(kayobe) $ kayobe overcloud service deploy --kolla-playbook /path/to/playbook.yml

The playbook can be called multiple times with different ``kolla_action`` values. You must make the playbook resistant to this, for example by using the ``kolla_action`` variable to conditionally execute tasks. Examples of kolla_action values include:

- ``backup``
- ``bootstrap-servers``
- ``check``
- ``certificates``
- ``config``
- ``config_validate``
- ``deploy``
- ``deploy-containers``
- ``deploy-servers``
- ``destroy``
- ``gather-facts``
- ``migrate-container-engine``
- ``nova-libvirt-cleanup``
- ``octavia-certificates``
- ``post-deploy``
- ``precheck``
- ``prune-images``
- ``pull``
- ``rabbitmq-reset-state``
- ``reconfigure``
- ``stop``
- ``upgrade``

For example, when running ``kayobe overcloud service deploy`` the playbook will be run with ``kolla_action`` set to

- ``precheck``
- ``deploy``
- ``post-deploy``

An example of a task only running against a specific kolla_action value is shown below:

.. code-block:: yaml

---
- name: Example custom playbook with precheck and deploy tasks
hosts: all
tasks:
- name: Assert something during precheck
assert:
that:
- some_variable is defined
when: kolla_action == 'precheck'

- name: Do something during deploy
debug:
msg: "This will only run during deploy"
when: kolla_action == 'deploy'

Alternatively, you can make the playbook exit if the kolla_action value is not one that the playbook is designed to handle, removing the need for ``when`` conditions on individual tasks:

.. code-block:: yaml

---
- name: Example guarded custom playbook
hosts: all
tasks:
- name: End play if not deploying
meta: end_play
when: kolla_action != 'deploy'

- name: Do something during deploy
debug:
msg: "This will only run during deploy"

Check and diff mode
-------------------

Expand Down
4 changes: 2 additions & 2 deletions etc/kayobe/openstack.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
###############################################################################
# OpenStack release configuration.

# Name of the current OpenStack release. Default is "2026.1".
# Name of the current OpenStack release. Default is "master".
#openstack_release:

# Name of the current OpenStack branch. Default is "stable/2026.1".
# Name of the current OpenStack branch. Default is "master".
#openstack_branch:

###############################################################################
Expand Down
6 changes: 6 additions & 0 deletions releasenotes/source/2026.1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
===========================
2026.1 Series Release Notes
===========================

.. release-notes::
:branch: stable/2026.1
1 change: 1 addition & 0 deletions releasenotes/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Kayobe Release Notes
:maxdepth: 1

unreleased
2026.1
2025.2
2025.1
2024.2
Expand Down
2 changes: 1 addition & 1 deletion requirements.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
collections:
- name: https://opendev.org/openstack/ansible-collection-kolla
type: git
version: stable/2026.1
version: master
- name: community.docker
version: 5.2.0
- name: community.network
Expand Down
8 changes: 4 additions & 4 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ setenv =
OS_TEST_TIMEOUT=60
ANSIBLE_VERBOSITY=3
deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/2026.1}
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt
commands = stestr run {posargs}
Expand All @@ -42,7 +42,7 @@ commands =

[testenv:venv]
deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/2026.1}
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/test-requirements.txt
-r{toxinidir}/doc/requirements.txt
commands = {posargs}
Expand All @@ -60,7 +60,7 @@ commands =

[testenv:molecule]
deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/2026.1}
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/requirements.txt
-r{toxinidir}/molecule-requirements.txt
commands =
Expand Down Expand Up @@ -130,7 +130,7 @@ commands =

[testenv:docs]
deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/2026.1}
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt
commands =
rm -rf doc/build/html
Expand Down
8 changes: 0 additions & 8 deletions zuul.d/jobs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -71,19 +71,11 @@
required-projects:
# Include kayobe to ensure other projects can use this job.
- name: openstack/ansible-collection-kolla
# TODO(wszumski): Remove when kayobe stable/2026.1 exists.
override-checkout: stable/2026.1
- name: openstack/kayobe
- name: openstack/kayobe-config-dev
- name: openstack/kolla
# TODO(wszumski): Remove when kayobe stable/2026.1 exists.
override-checkout: stable/2026.1
- name: openstack/kolla-ansible
# TODO(wszumski): Remove when kayobe stable/2026.1 exists.
override-checkout: stable/2026.1
- name: openstack/requirements
# TODO(wszumski): Remove when kayobe stable/2026.1 exists.
override-checkout: stable/2026.1
- name: openstack/tenks
irrelevant-files:
- ^\..+
Expand Down
8 changes: 0 additions & 8 deletions zuul.d/project.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,12 @@
- kayobe-overcloud-ubuntu-noble
- kayobe-overcloud-ubuntu-noble-podman
- kayobe-overcloud-upgrade-rocky10
- kayobe-overcloud-upgrade-slurp-rocky10
- kayobe-overcloud-upgrade-slurp-ubuntu-noble
- kayobe-overcloud-upgrade-ubuntu-noble
- kayobe-seed-rocky10
- kayobe-seed-rocky10-podman
- kayobe-seed-ubuntu-noble
- kayobe-seed-ubuntu-noble-podman
- kayobe-seed-upgrade-rocky10
- kayobe-seed-upgrade-slurp-rocky10
- kayobe-seed-upgrade-slurp-ubuntu-noble
- kayobe-seed-upgrade-ubuntu-noble
- kayobe-seed-vm-rocky10
- kayobe-seed-vm-ubuntu-noble
Expand All @@ -62,16 +58,12 @@
- kayobe-overcloud-ubuntu-noble
- kayobe-overcloud-ubuntu-noble-podman
- kayobe-overcloud-upgrade-rocky10
- kayobe-overcloud-upgrade-slurp-rocky10
- kayobe-overcloud-upgrade-slurp-ubuntu-noble
- kayobe-overcloud-upgrade-ubuntu-noble
- kayobe-seed-rocky10
- kayobe-seed-rocky10-podman
- kayobe-seed-ubuntu-noble
- kayobe-seed-ubuntu-noble-podman
- kayobe-seed-upgrade-rocky10
- kayobe-seed-upgrade-slurp-rocky10
- kayobe-seed-upgrade-slurp-ubuntu-noble
- kayobe-seed-upgrade-ubuntu-noble
- kayobe-seed-vm-rocky10
- kayobe-seed-vm-ubuntu-noble
Expand Down