diff options
| author | Ali <ibrahimaeali@gmail.com> | 2018-11-10 13:19:58 -0500 |
|---|---|---|
| committer | Toshio Kuratomi <a.badger@gmail.com> | 2018-11-12 19:31:48 -0800 |
| commit | 84db20ea07436f1ba14f980af789e379b0f71ba8 (patch) | |
| tree | fea0a2bfcc2db142a5fd922284533eb36d676de7 | |
| parent | dc21c0c0b09144340b0ba159998184eded0f7aa1 (diff) | |
| download | ansible-84db20ea07436f1ba14f980af789e379b0f71ba8.tar.gz | |
Updated documentation for the k8s module
(cherry picked from commit 0b15e1df9c8c7e2008a87b3c3073b0015312b1e4)
| -rw-r--r-- | changelogs/fragments/48474-k8s-module-docs-update.yaml | 2 | ||||
| -rw-r--r-- | lib/ansible/utils/module_docs_fragments/k8s_auth_options.py | 7 |
2 files changed, 7 insertions, 2 deletions
diff --git a/changelogs/fragments/48474-k8s-module-docs-update.yaml b/changelogs/fragments/48474-k8s-module-docs-update.yaml new file mode 100644 index 0000000000..0d985108e4 --- /dev/null +++ b/changelogs/fragments/48474-k8s-module-docs-update.yaml @@ -0,0 +1,2 @@ +minor_changes: + - k8s - updated module documentation to mention how to avoid SSL validation errors diff --git a/lib/ansible/utils/module_docs_fragments/k8s_auth_options.py b/lib/ansible/utils/module_docs_fragments/k8s_auth_options.py index 4afa1c39ac..5cee039e4e 100644 --- a/lib/ansible/utils/module_docs_fragments/k8s_auth_options.py +++ b/lib/ansible/utils/module_docs_fragments/k8s_auth_options.py @@ -56,8 +56,8 @@ options: variable. ssl_ca_cert: description: - - Path to a CA certificate used to authenticate with the API. Can also be specified via K8S_AUTH_SSL_CA_CERT - environment variable. + - Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to + avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable. verify_ssl: description: - "Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL @@ -68,4 +68,7 @@ notes: - "The OpenShift Python client wraps the K8s Python client, providing full access to all of the APIS and models available on both platforms. For API version details and additional information visit https://github.com/openshift/openshift-restclient-python" + - "To avoid SSL certificate validation errors when C(verify_ssl) is I(True), the full + certificate chain for the API server must be provided via C(ssl_ca_cert) or in the + kubeconfig file." ''' |