summaryrefslogtreecommitdiffstats
path: root/roles/lib_openshift/src/doc/serviceaccount_secret
diff options
context:
space:
mode:
Diffstat (limited to 'roles/lib_openshift/src/doc/serviceaccount_secret')
-rw-r--r--roles/lib_openshift/src/doc/serviceaccount_secret68
1 files changed, 68 insertions, 0 deletions
diff --git a/roles/lib_openshift/src/doc/serviceaccount_secret b/roles/lib_openshift/src/doc/serviceaccount_secret
new file mode 100644
index 000000000..ab90a3f7c
--- /dev/null
+++ b/roles/lib_openshift/src/doc/serviceaccount_secret
@@ -0,0 +1,68 @@
+# flake8: noqa
+# pylint: skip-file
+
+DOCUMENTATION = '''
+---
+module: oc_serviceaccount_secret
+short_description: Module to manage openshift service account secrets
+description:
+ - Manage openshift service account secrets programmatically.
+options:
+ state:
+ description:
+ - If present, the service account will be linked with the secret if it is not already. If absent, the service account will be unlinked from the secret if it is already linked. If list, information about the service account secrets will be gathered and returned as part of the Ansible call results.
+ required: false
+ default: present
+ choices: ["present", "absent", "list"]
+ aliases: []
+ kubeconfig:
+ description:
+ - The path for the kubeconfig file to use for authentication
+ required: false
+ default: /etc/origin/master/admin.kubeconfig
+ aliases: []
+ debug:
+ description:
+ - Turn on debug output.
+ required: false
+ default: false
+ aliases: []
+ service_account:
+ description:
+ - Name of the service account.
+ required: true
+ default: None
+ aliases: []
+ namespace:
+ description:
+ - Namespace of the service account and secret.
+ required: true
+ default: None
+ aliases: []
+ secret:
+ description:
+ - The secret that should be linked to the service account.
+ required: false
+ default: None
+ aliases: []
+author:
+- "Kenny Woodson <kwoodson@redhat.com>"
+extends_documentation_fragment: []
+'''
+
+EXAMPLES = '''
+ - name: get secrets of a service account
+ oc_serviceaccount_secret:
+ state: list
+ service_account: builder
+ namespace: default
+ register: sasecretout
+
+
+ - name: Link a service account to a specific secret
+ oc_serviceaccount_secret:
+ service_account: builder
+ secret: mynewsecret
+ namespace: default
+ register: sasecretout
+'''