connection/oc - add option oc_local_env_vars (#225)

* add local env vars for connection/oc plugin

* Fix sanity tests
This commit is contained in:
Bikouo Aubin
2024-05-28 15:44:03 +02:00
committed by GitHub
parent fcc19da20a
commit 2c394132aa
3 changed files with 18 additions and 0 deletions

View File

@@ -0,0 +1,3 @@
---
minor_changes:
- connection/oc - added support of local enviroment variable that will be used for ``oc`` and may be requried for establishing connections ifself (https://github.com/openshift/community.okd/pull/225).

View File

@@ -11,6 +11,12 @@ with open("./rendereddocfragments.txt", 'w') as df_fd:
with open(sys.argv[2], 'r') as fd:
json_docs = json.load(fd)
# ansible-doc has introduced a 'doc.plugin_name' on branch 'stable-2.17'
# This change generated the following sanity tests error.
# invalid-documentation: DOCUMENTATION.plugin_name: extra keys not allowed @ data['plugin_name'].
# This will be removed from the module documentation
json_docs[sys.argv[1]]['doc'].pop('plugin_name', '')
json_docs[sys.argv[1]]['doc'].pop('collection', '')
json_docs[sys.argv[1]]['doc'].pop('filename', '')
json_docs[sys.argv[1]]['doc'].pop('has_action', '')

View File

@@ -106,6 +106,15 @@ DOCUMENTATION = """
env:
- name: K8S_AUTH_TOKEN
- name: K8S_AUTH_API_KEY
oc_local_env_vars:
description:
- Local environment variable to be passed locally to the oc command line.
- Please be aware that this passes information directly on the command line and it could expose sensitive data.
default: {}
type: dict
version_added: 4.0.0
vars:
- name: ansible_oc_local_env_vars
client_cert:
description:
- Path to a certificate used to authenticate with the API.