diff options
author | Joel Diaz <jdiaz@redhat.com> | 2017-02-10 19:30:37 +0000 |
---|---|---|
committer | Joel Diaz <jdiaz@redhat.com> | 2017-03-21 17:33:27 -0400 |
commit | 45fbfdad1b80c50276a9da3841d6e4089b109e35 (patch) | |
tree | e84fc1960065337a5c5059f833b8d57d69bf8032 /roles/lib_openshift/src/doc/user | |
parent | be09be62cf9c3ac7ef1142f494437026d72bd3e7 (diff) | |
download | openshift-45fbfdad1b80c50276a9da3841d6e4089b109e35.tar.gz openshift-45fbfdad1b80c50276a9da3841d6e4089b109e35.tar.bz2 openshift-45fbfdad1b80c50276a9da3841d6e4089b109e35.tar.xz openshift-45fbfdad1b80c50276a9da3841d6e4089b109e35.zip |
add oc_user ansible module
module to manipulate OpenShift users, and assign group membership to users
Diffstat (limited to 'roles/lib_openshift/src/doc/user')
-rw-r--r-- | roles/lib_openshift/src/doc/user | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/roles/lib_openshift/src/doc/user b/roles/lib_openshift/src/doc/user new file mode 100644 index 000000000..cae108415 --- /dev/null +++ b/roles/lib_openshift/src/doc/user @@ -0,0 +1,66 @@ +# flake8: noqa +# pylint: skip-file + +DOCUMENTATION = ''' +--- +module: oc_user +short_description: Create, modify, and idempotently manage openshift users. +description: + - Modify openshift users programmatically. +options: + state: + description: + - State controls the action that will be taken with resource + - 'present' will create or update a user to the desired state + - 'absent' will ensure user is removed + - 'list' will read and return a list of users + 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: [] + username: + description: + - Short username to query/modify. + required: false + default: None + aliases: [] + full_name: + description: + - String with the full name/description of th user. + required: false + default: None + aliases: [] + groups: + description: + - List of groups the user should be a member of. + required: false + default: [] + aliases: [] +author: +- "Joel Diaz <jdiaz@redhat.com>" +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +- name: Ensure user exists + oc_user: + state: present + username: johndoe + full_name "John Doe" + +- name: Ensure user does not exist + oc_user: + state: absent + username: johndoe +''' |