From 28ac0dc3fd9e6ac2e888feb79902a64831919186 Mon Sep 17 00:00:00 2001 From: Robin Gierse Date: Fri, 16 Feb 2024 11:09:18 -0500 Subject: [PATCH] Document known issues and limitations. --- changelogs/fragments/lookups.yml | 7 ++++++- plugins/lookup/bakery.py | 2 ++ plugins/lookup/folder.py | 2 ++ plugins/lookup/folders.py | 2 ++ plugins/lookup/host.py | 2 ++ plugins/lookup/hosts.py | 2 ++ plugins/lookup/rule.py | 2 ++ plugins/lookup/rules.py | 2 ++ plugins/lookup/ruleset.py | 2 ++ plugins/lookup/rulesets.py | 2 ++ plugins/lookup/version.py | 2 ++ 11 files changed, 26 insertions(+), 1 deletion(-) diff --git a/changelogs/fragments/lookups.yml b/changelogs/fragments/lookups.yml index c9c3e4d80..1c8d0172f 100644 --- a/changelogs/fragments/lookups.yml +++ b/changelogs/fragments/lookups.yml @@ -1,4 +1,9 @@ minor_changes: - Lookup modules - Enable usage of ini files, environment and inventory variables - to configure basic settings for the lookup plugins, like the server_url and site + to configure basic settings for the lookup plugins, like e.g., the server_url or site alongside the authentication options. Refer to the module documentation for details. + +known_issues: + - Lookup modules - When using inventory variables to configure e.g., the server_url, + it is not possible to assign other variables to these variables. + This is a limitation of Ansble itself. diff --git a/plugins/lookup/bakery.py b/plugins/lookup/bakery.py index 712006101..6308bb351 100644 --- a/plugins/lookup/bakery.py +++ b/plugins/lookup/bakery.py @@ -79,6 +79,8 @@ If you need to use different permissions, you must change the command or run Ansible as another user. - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. + - It is B(NOT) possible to assign other variables to the variables mentioned in the C(vars) section! + This is a limitation of Ansible itself. """ EXAMPLES = """ diff --git a/plugins/lookup/folder.py b/plugins/lookup/folder.py index bf00737f6..a2b5db1cd 100644 --- a/plugins/lookup/folder.py +++ b/plugins/lookup/folder.py @@ -83,6 +83,8 @@ If you need to use different permissions, you must change the command or run Ansible as another user. - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. + - It is B(NOT) possible to assign other variables to the variables mentioned in the C(vars) section! + This is a limitation of Ansible itself. """ EXAMPLES = """ diff --git a/plugins/lookup/folders.py b/plugins/lookup/folders.py index 03d260728..4a18d7aaf 100644 --- a/plugins/lookup/folders.py +++ b/plugins/lookup/folders.py @@ -96,6 +96,8 @@ If you need to use different permissions, you must change the command or run Ansible as another user. - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. + - It is B(NOT) possible to assign other variables to the variables mentioned in the C(vars) section! + This is a limitation of Ansible itself. """ EXAMPLES = """ diff --git a/plugins/lookup/host.py b/plugins/lookup/host.py index 6db71d786..af9a191fc 100644 --- a/plugins/lookup/host.py +++ b/plugins/lookup/host.py @@ -89,6 +89,8 @@ If you need to use different permissions, you must change the command or run Ansible as another user. - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. + - It is B(NOT) possible to assign other variables to the variables mentioned in the C(vars) section! + This is a limitation of Ansible itself. """ EXAMPLES = """ diff --git a/plugins/lookup/hosts.py b/plugins/lookup/hosts.py index d2ac43106..50756e84a 100644 --- a/plugins/lookup/hosts.py +++ b/plugins/lookup/hosts.py @@ -86,6 +86,8 @@ If you need to use different permissions, you must change the command or run Ansible as another user. - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. + - It is B(NOT) possible to assign other variables to the variables mentioned in the C(vars) section! + This is a limitation of Ansible itself. """ EXAMPLES = """ diff --git a/plugins/lookup/rule.py b/plugins/lookup/rule.py index e6c0447ff..105f39034 100644 --- a/plugins/lookup/rule.py +++ b/plugins/lookup/rule.py @@ -83,6 +83,8 @@ If you need to use different permissions, you must change the command or run Ansible as another user. - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. + - It is B(NOT) possible to assign other variables to the variables mentioned in the C(vars) section! + This is a limitation of Ansible itself. """ EXAMPLES = """ diff --git a/plugins/lookup/rules.py b/plugins/lookup/rules.py index 9d0620b2f..c36349ea7 100644 --- a/plugins/lookup/rules.py +++ b/plugins/lookup/rules.py @@ -93,6 +93,8 @@ If you need to use different permissions, you must change the command or run Ansible as another user. - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. + - It is B(NOT) possible to assign other variables to the variables mentioned in the C(vars) section! + This is a limitation of Ansible itself. """ EXAMPLES = """ diff --git a/plugins/lookup/ruleset.py b/plugins/lookup/ruleset.py index af23d7dd8..790fd7db9 100644 --- a/plugins/lookup/ruleset.py +++ b/plugins/lookup/ruleset.py @@ -83,6 +83,8 @@ If you need to use different permissions, you must change the command or run Ansible as another user. - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. + - It is B(NOT) possible to assign other variables to the variables mentioned in the C(vars) section! + This is a limitation of Ansible itself. """ EXAMPLES = """ diff --git a/plugins/lookup/rulesets.py b/plugins/lookup/rulesets.py index fb50b21f2..10acc985d 100644 --- a/plugins/lookup/rulesets.py +++ b/plugins/lookup/rulesets.py @@ -102,6 +102,8 @@ If you need to use different permissions, you must change the command or run Ansible as another user. - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. + - It is B(NOT) possible to assign other variables to the variables mentioned in the C(vars) section! + This is a limitation of Ansible itself. """ EXAMPLES = """ diff --git a/plugins/lookup/version.py b/plugins/lookup/version.py index e603819a6..389876af2 100644 --- a/plugins/lookup/version.py +++ b/plugins/lookup/version.py @@ -79,6 +79,8 @@ If you need to use different permissions, you must change the command or run Ansible as another user. - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. + - It is B(NOT) possible to assign other variables to the variables mentioned in the C(vars) section! + This is a limitation of Ansible itself. """ EXAMPLES = """