aboutsummaryrefslogtreecommitdiff
path: root/doc/source/user
AgeCommit message (Collapse)AuthorFilesLines
2026-04-16Merge "Fix: Update outdated documentation"Zuul5-23/+26
2026-04-15kolla-toolbox: Template clouds.yaml and use itMichal Nasiadka1-8/+0
Basically Ansible heuristic obfuscation methods mark auth: that we pass to openstack.* modules as no_log_values and then obfuscates it's values in other runs (which then end up as **** e.g. auth_url, domain_id, domain name, etc) Example return: "domains": [ { "description": "The ******** domain", "id": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "is_enabled": true, "links": { "self": "********/v3/domains/********" }, "name": "Default", "options": {}, "tags": [] } This patch adds clouds.yaml to files templated for kolla-toolbox (but without the password) and only uses password from Kolla-Ansible secrets instead of storing that on disk on all of the nodes. Change-Id: I479445563d5b5dc2e45601e936d89def647da841 Signed-off-by: Michal Nasiadka <mnasiadka@gmail.com>
2026-04-12Fix: Update outdated documentationPiotr Milewski5-23/+26
Change-Id: I5dc53f74afd9a5b565201dc9d3039d82cb65dabc Signed-off-by: Piotr Milewski <vurmil@gmail.com>
2026-01-08Fix missing word in Quickstart Guideamir581181-1/+1
Add missing 'in' in the sentence linking to Virtual Environments: "This is covered Virtual Environments." -> "This is covered in Virtual Environments." Closes-Bug: #2128781 Change-Id: If81d251ff2a73d3d360b8863f98a5c334a876b45 Signed-off-by: amir58118 <sahahmadi96@gmail.com>
2025-12-19Add support for Debian Trixie (13)Michal Nasiadka1-1/+1
Remove /etc/timezone bind mount since Debian does not provide that file anymore. Depends-On: https://review.opendev.org/c/openstack/kolla/+/964793 Change-Id: If1a289068093843184f0d7b495815db006f2d563 Signed-off-by: Michal Nasiadka <mnasiadka@gmail.com>
2025-12-06Fix incorrect mariadb-recovery task name in error messageVudn1-1/+1
Closes-Bug: #2133983 Change-Id: Ib79cd622123d9b6727ab1d674f680b8e2d52ed68 Signed-off-by: Vudn <dangngocvu4@gmail.com>
2025-10-03Merge "docs: add validate-config to cli tips & tricks"Zuul1-0/+4
2025-10-03docs: add validate-config to cli tips & tricksNorman Ziegner1-0/+4
Change-Id: Iac15261a0916d14094afdd9b3cb5cba88f505d0f Signed-off-by: Norman Ziegner <n.ziegner@hzdr.de>
2025-10-02Move to for Rocky Linux 10Michal Nasiadka3-6/+6
CephAdm, Octavia, OVN and NFV jobs are not added here, because these rely on Valkey/Redis available. Ironic jobs are not added, because ipxe.efi is not packaged in EL10 and needs a followup patch. Let's Encrypt jobs are also not added, due to ssl certificate validation errors. Depends-On: https://review.opendev.org/c/openstack/kolla/+/956554 Depends-On: https://review.opendev.org/c/openstack/ansible-collection-kolla/+/961237 Change-Id: I51823808c4e4ac08ae8f080aacf6a3759589571d Signed-off-by: Michal Nasiadka <mnasiadka@gmail.com>
2025-09-25group_vars: Reorganize huge all.yml into smaller filesMichal Nasiadka2-9/+9
This will help us to trigger scenario jobs on changes in given group_vars files. Changes to Zuul config to trigger given scenarios will be posted as a follow-up. Change-Id: I3f17adf655d2d0c1fc2969153dddb0c72b11397a Signed-off-by: Michal Nasiadka <mnasiadka@gmail.com>
2025-09-17Merge "Add documentation for Kolla Ansible CLI command completion"Zuul1-0/+30
2025-09-15Remove reference to EXTRA_OPTS in documentationMatt Anson1-3/+0
Passing the contents of EXTRA_OPTS into ansible-playbook is no longer supported, so remove reference to this functionality from the documentation. Closes-Bug: #2123837 Change-Id: Ibaf8af1de66f76772a617b05467ba611d0bbd20d Signed-off-by: Matt Anson <matta@stackhpc.com>
2025-08-19update development docs after cli move to pythonBartosz Bezak1-7/+5
Follow up to [1]. [1] https://review.opendev.org/c/openstack/kolla-ansible/+/923110 Change-Id: I8a4f6c6bee01e0e12da2c15836135bc890c72cde Signed-off-by: Bartosz Bezak <bartosz@stackhpc.com>
2025-06-03Fix docs rendering errors.Michael Still3-8/+8
I was reading https://docs.openstack.org's version of the kolla-ansible advanced configuration guide and noticed some RST rendering errors. This patch corrects those errors so that the page renders correctly. Change-Id: I330678d8971d286e67f115eace1cb606d30433b6
2025-05-16Add documentation for Kolla Ansible CLI command completionMarek Buch1-0/+30
This change adds instructions to the documentation on how to enable shell command completion for the kolla-ansible CLI. It covers all necessary steps. Change-Id: I5cacf29d2fb9c0b473cf858f1c050bc70890cc42 Signed-off-by: Marek Buch <marek.buch@tietoevry.com>
2025-05-02doc: remove keystone admin port cleanupDr. Jens Harbott1-17/+0
The removal was done in Zed, which is unmaintained now, this step is no longer needed for any maintained deployment. Change-Id: I21e0f704ad1ff9bec28af397c7b099e991de7ce2
2025-03-26Drop support for Ubuntu Jammy (22.04)Pierre Riteau3-3/+2
Change-Id: Ibf97abc8bd4c2e7e734b7b1b0f8303cc8ab48123
2025-03-20Document Ubuntu Noble (24.04) as supportedPierre Riteau1-0/+1
Change-Id: Iba5bc0466019f634c57e487e1e7b8586e3071d02
2025-03-12Fix typo in prechecks commandNorman Ziegner1-2/+2
Change-Id: I1aa1299f7b932c04492d719d602efcfc38721361 Signed-off-by: Norman Ziegner <n.ziegner@hzdr.de>
2025-02-05Support reducing scope of delegated fact gatheringMark Goddard1-0/+41
When Kolla Ansible is executed with a '--limit' argument, the scope of an operation is limited to the hosts in the limit. For example: kolla-ansible deploy --limit control Due to the nature of configuring clustered software services, there are cases where we need to know information about other hosts. Most often this is related to their hostname or network addresses. To make this work, Kolla Ansible gathers facts for hosts outside of the limit using delegated fact gathering [1]. By default, Kolla Ansible gathers facts for all hosts. Because delegated facts are gathered serially in batches by the active hosts, this can take a long time when there are not many hosts in the limit. This change makes it possible to reduce the set of hosts eligible for delegated fact gathering by setting 'kolla_ansible_delegate_facts_hosts' to a list of hosts. [1] https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_delegation.html#delegating-facts Depends-On: https://review.opendev.org/c/openstack/kolla-ansible/+/899615 Change-Id: Id0bda00b81b5bc6a9a870e231335c33d9828e95f
2024-12-30Merge "Docs update - install missing dbus-1 on Noble"Zuul2-2/+2
2024-12-30Docs update - install missing dbus-1 on NobleJakub Darmach2-2/+2
Added dbus-1 package missing on Ubuntu noble to dependency install section. Closes-bug: 2092712 Change-Id: I068aa288fb4fe6f99501857960bf3e8810f10b14
2024-12-30Merge "Docs update - kolla-ansible cli parameters"Zuul4-29/+29
2024-12-30Merge "Quickstart guide - remove Ansible dependency"Zuul2-18/+0
2024-12-18Docs update - kolla-ansible cli parametersJakub Darmach4-29/+29
With rewrite of kolla-ansible CLI to Python in I9749b320d4f5eeec601a055b597dfa7d8fb97ce2 the order of parameters have to be: `kolla-ansible <action> <arguments>` Change-Id: I1bd4a7f96f77c34fb46ca21f37023dddf73e8f05 Closes-bug: 2087920
2024-11-25Quickstart guide - remove Ansible dependencyJakub Darmach2-18/+0
Removes Ansible from virtual environment dependencies install in Quick Start guide for deployment and development as it's installed as a requirement along Kolla-ansible since 2024.2 Dalmatian release. Change-Id: If929c79a59816ec46a0263b8238bede396f73c2d
2024-11-25Enhance Ceph Integration for Multiple ClustersMichal Arbet1-2/+1
This patch enhances Kolla-Ansible's existing support for multiple Ceph clusters by improving the management of custom users, pools, and cluster names. It aligns the Ceph integration more closely with the official Ceph user management guidelines [1]. Keyrings now follow the format `$cluster.client.$user.keyring`, and configurations are easier to handle when multiple Ceph clusters are in use, especially in environments with multiple availability zones. Previously, workarounds were needed for keyrings and config files, which this patch eliminates, providing a cleaner and more structured configuration approach which follows the Ceph best practices. The default Kolla setup remains unaffected by these changes, ensuring backward compatibility. Updated documentation and examples are included. [1] https://docs.ceph.com/en/latest/rados/operations/user-management/#keyring-management Change-Id: I2593b6df737b384f1a5fba22f69e851c575990b4
2024-09-11Docs: point to RMQ SLURP handing in upgrade guideMatt Crees1-0/+10
Change-Id: I7934bda26a134fe38a63716f9878a27b4f3819ce
2024-08-23CI: validate prometheus configsSven Kieske1-0/+16
check if generated prometheus config is valid via promtool. This should help prevent bugs like: https://bugs.launchpad.net/kolla-ansible/+bug/2076660 prior art: haproxy config validation: https://review.opendev.org/c/openstack/kolla-ansible/+/922840 also add some basic documentation for the `kolla-ansible validate-config` command. Signed-off-by: Sven Kieske <kieske@osism.tech> Change-Id: Ief90861b2c422e0e6c2dd9cb605c94e86c0f2ba1
2024-07-24docs: Remove Stream 8 and Jammy past referencesMichal Nasiadka1-18/+0
Change-Id: Ia7bd309479f098bc0b65ecf76dc294d893dadbc4
2024-07-03Drop OpenEuler host OS support (due to no python3.10+)Michal Nasiadka3-5/+4
ansible-core 2.16 and later requires python 3.10+ (see [1]) [1]: https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix Change-Id: Id5e10872de413e7b476c5343360d73c109b9667a
2024-07-02Use Bookworm for Debian upgrade jobs and update docsMichal Nasiadka1-7/+0
Remove Bullseye from support matrix Change-Id: If29ab064af9968784995115da6dd2cdf6e723c0b
2024-04-22CI: Add codespell to pep8Michal Nasiadka1-3/+3
Fix existing spelling errors Change-Id: Ie689cf5a344aaa630a4860448b09242333a8e119
2024-03-20Merge "fix confusing jammy upgrade docs"Zuul1-4/+4
2024-03-19Fix the ansible intro_inventory.html linksongwenping1-2/+2
Change-Id: I0f35c2ea1400ea25fdb253580c6c1b2e06ae591e
2024-03-18fix confusing jammy upgrade docsSven Kieske1-4/+4
support for jammy was added to yoga in: https://review.opendev.org/c/openstack/kolla-ansible/+/869127 it should thus be perfectly fine to directly upgrade to jammy and then upgrade to zed. Signed-off-by: Sven Kieske <kieske@osism.tech> Change-Id: Id77704f4386b48c9bfd7b684bee3fb47d2b4a93a
2024-03-14Merge "doc: Add a note about SLURP upgrades"Zuul1-0/+7
2024-03-14Merge "Bump ansible-core versions to 2.15 and 2.16"Zuul2-6/+8
2024-03-14doc: Add a note about SLURP upgradesMichal Nasiadka1-0/+7
Change-Id: I8609cf211316d8224c925d57a5e832ccff37b906
2024-03-14Bump ansible-core versions to 2.15 and 2.16Michal Nasiadka2-6/+8
Change-Id: Iab40eb92c7e4a9092471bef9d4477a4fa34f1c85
2024-03-07[doc] document --limit limitationsSven Kieske1-0/+10
there are currently known bugs in our interaction with the ansible --limit option. document those and recommend not to use this like it was agreed in the kolla meeting: https://meetings.opendev.org/meetings/kolla/2024/kolla.2024-02-21-14.00.log.txt Signed-off-by: Sven Kieske <kieske@osism.tech> Change-Id: Iaeaa8c667ce7cd677b2b3dc2096ef4e52c1f651f
2024-02-02Sync development quickstart docBartosz Bezak1-6/+20
The development quickstart document has not been updated for a while, and it has become desynchronized with the regular quickstart. Change-Id: I6b14623b73b0032df94f0f633659a1b6dfc15dea
2023-12-05Support Ansible max_fail_percentageMark Goddard1-0/+21
This allows us to continue execution until a certain proportion of hosts to fail. This can be useful at scale, where failures are common, and restarting a deployment is time-consuming. The default max failure percentage is 100, keeping the default behaviour. A global max failure percentage may be set via kolla_max_fail_percentage, and individual services may define a max failure percentage via <service>_max_fail_percentage. Note that all hosts in the inventory must be reachable for fact gathering, even those not included in a --limit. Closes-Bug: #1833737 Change-Id: I808474a75c0f0e8b539dc0421374b06cea44be4f
2023-11-29Update etcd docs and renoDr. Jens Harbott1-7/+7
Just some minor formatting and wording updates Change-Id: Ia42944512f8d14a1993bd4ae3d09f0f2ab431322
2023-11-28etcd: Add support for more scenariosJan Gutter1-0/+8
This commit addresses a few shortcomings in the etcd service: * Adding or removing etcd nodes required manual intervention. * The etcd service would have brief outages during upgrades or reconfigures because restarts weren't always serialised. This makes the etcd service follow a similar pattern to mariadb: * There is now a distiction between bootstrapping the cluster and adding / removing another member. * This more closely follows etcd's upstream bootstrapping guidelines. * The etcd role now serialises restarts internally so the kolla_serial pattern is no longer appropriate (or necessary). This does not remove the need for manual intervention in all failure modes: the documentation has been updated to address the most common issues. Note that there's repetition in the container specifications: this is somewhat deliberate. In a future cleanup, it's intended to reduce the duplication. Change-Id: I39829ba0c5894f8e549f9b83b416e6db4fafd96f
2023-11-16Merge "[doc] Fix the incorrect URL of 'Quick Start for development'"Zuul1-1/+1
2023-11-08Add support for ansible-coreMichal Nasiadka1-2/+3
Collections version taken from official Ansible 7 package [1] and limited to the same major version. [1]: https://github.com/ansible-community/ansible-build-data/blob/main/7/ansible-7.7.0.yaml Change-Id: I0f1ea9717397adc2d2c3215d74ec3759f351a57a
2023-10-13[doc] Fix the incorrect URL of 'Quick Start for development'chenxing1-1/+1
Change-Id: Ic26e5c06990b25572929bad275c0de35fa3552ec Signed-off-by: chenxing <chason.chan@foxmail.com>
2023-09-18Merge "Add genconfig to the Operating Kolla guide"Zuul1-0/+4
2023-09-12Merge "Add Quickstart Developer Guide"Zuul2-0/+341
generated by cgit v1.2.3 (git 2.39.1) at 2026-11-05 16:58:45 +0000