Skip to content

Commit

Permalink
docs: add notes for duplicated keys in setting files
Browse files Browse the repository at this point in the history
  • Loading branch information
kurokobo committed May 16, 2024
1 parent 22d22af commit fa072c4
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/user-guide/advanced-configuration/extra-settings.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Extra Settings
# Extra Settings

With `extra_settings` and `extra_settings_files`, you can pass multiple custom settings to AWX via the AWX Operator.

Expand All @@ -7,7 +7,10 @@ With `extra_settings` and `extra_settings_files`, you can pass multiple custom s

If you need to change the setting after the initial deployment, you need to change it on the AWX CR spec (for `extra_settings`) or corresponding ConfigMap or Secret (for `extra_settings_files`). After updating ConfigMap or Secret, you need to restart the AWX pods to apply the changes.

### Add extra settings with `extra_settings`
!!! note
If the same setting is set in both `extra_settings` and `extra_settings_files`, the setting in `extra_settings_files` will take precedence.

## Add extra settings with `extra_settings`

You can pass extra settings by specifying the pair of the setting name and value as the `extra_settings` parameter.

Expand All @@ -34,7 +37,7 @@ spec:

Note for some settings, such as `LOG_AGGREGATOR_LEVEL`, the value may need double quotes.

### Add extra settings with `extra_settings_files`
## Add extra settings with `extra_settings_files`

You can pass extra settings by specifying the additional settings files in the ConfigMaps or Secrets as the `extra_settings_files` parameter.

Expand All @@ -44,6 +47,9 @@ The settings files passed via `extra_settings_files` will be mounted as the file
| -------------------- | -------------------- | --------- |
| extra_settings_files | Extra settings files | `{}` |

!!! note
If the same setting is set in multiple files in `extra_settings_files`, it would be difficult to predict which would be adopted since these files are loaded in arbitrary order that [`glob`](https://docs.python.org/3/library/glob.html) returns. For a reliable setting, do not include the same key in more than one file.

Create ConfigMaps or Secrets that contain custom settings files (`*.py`).

```python title="custom_job_settings.py"
Expand Down

0 comments on commit fa072c4

Please sign in to comment.