Skip to content

Commit 60f1bb2

Browse files
committed
feat(ansible): address documentation comments
- word choice in advanced_options - refer to correct environment key in getAnsibleVerbosity()
1 parent d0add29 commit 60f1bb2

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

doc/ansible/dev/advanced_options.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ From this data, we can see that the environment variable will be
115115
## Ansible Verbosity
116116
117117
Setting the verbosity at which `ansible-runner` is run controls how verbose the
118-
output of `ansible-playbook` will be. The normal rules for verbosity apply here
119-
where higher values means more verbose output. Acceptable values range from 0
118+
output of `ansible-playbook` will be. The normal rules for verbosity apply
119+
here, where higher values mean more output. Acceptable values range from 0
120120
(only the most severe messages are output) to 7 (all debugging messages are
121121
output).
122122

pkg/ansible/watches/watches.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ func verifyAnsiblePath(playbook string, role string) error {
256256
}
257257

258258
// if the WORKER_* environment variable is set, use that value.
259-
// Otherwise, use the value from the CLI. This is definitely
259+
// Otherwise, use defValue. This is definitely
260260
// counter-intuitive but it allows the operator admin adjust the
261261
// number of workers based on their cluster resources. While the
262262
// author may use the CLI option to specify a suggested
@@ -282,8 +282,8 @@ func getMaxWorkers(gvk schema.GroupVersionKind, defValue int) int {
282282
return maxWorkers
283283
}
284284

285-
// if the WORKER_* environment variable is set, use that value.
286-
// Otherwise, use the value from the CLI.
285+
// if the ANSIBLE_VERBOSITY_* environment variable is set, use that value.
286+
// Otherwise, use defValue.
287287
func getAnsibleVerbosity(gvk schema.GroupVersionKind, defValue int) int {
288288
envVar := strings.ToUpper(strings.Replace(
289289
fmt.Sprintf("ANSIBLE_VERBOSITY_%s_%s", gvk.Kind, gvk.Group),

0 commit comments

Comments
 (0)