Skip to content

openstack: warn that overlays match by exact name #1042

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

Draft
ideaship wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

openstack: warn that overlays match by exact name #1042

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
20 changes: 20 additions & 0 deletions docs/guides/configuration-guide/openstack/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,26 @@ supported, assuming that you have services using `nova.conf` running on hosts ca
Using this mechanism, overrides can be configured per-project (Nova), per-project-service (Nova scheduler service) or
per-project-service-on-specified-host (Nova services on ctl1).

:::warning

Overlay files are picked up by exact name and exact path. A file whose name or
location does not match one of the supported locations is not an error and
produces no warning — it is simply never read, and the deployment succeeds with
the settings silently having no effect.

Two examples that look right but are ignored:

* `environments/kolla/files/overlays/ml2_conf.ini` — `ml2_conf.ini` is only read
from the `neutron/` subdirectory, so a copy at the top level does nothing.
* `environments/kolla/files/overlays/neutron/ml2.conf` — a misspelling of
`ml2_conf.ini`; nothing matches `ml2.conf`.

After adding an overlay, confirm the setting actually arrived rather than
assuming it did, for example by checking the generated configuration on the
target host under `/etc/kolla/SERVICENAME/`.

:::

Overriding an option is as simple as setting the option under the relevant section. For example, to set
override `scheduler_max_attempts` in the Nova scheduler service, the operator could create
`environments/kolla/files/overlays/nova/nova-scheduler.conf` in the configuration repository with this content:
Expand Down