diff options
author | jupierce <jupierce@redhat.com> | 2017-03-01 14:09:01 -0500 |
---|---|---|
committer | jupierce <jupierce@redhat.com> | 2017-03-02 12:03:36 -0500 |
commit | 5e36d75d47b18e3ac09f33cdf65a2292a9952b20 (patch) | |
tree | 52fe5a89dcfa6a8e3e3d0dfb740f5b087e2ccfd3 /roles/lib_openshift/src/doc/policy_user | |
parent | 5a91f31b65a4bb0ec524aee9ba1c6d4e4030d8d2 (diff) | |
download | openshift-5e36d75d47b18e3ac09f33cdf65a2292a9952b20.tar.gz openshift-5e36d75d47b18e3ac09f33cdf65a2292a9952b20.tar.bz2 openshift-5e36d75d47b18e3ac09f33cdf65a2292a9952b20.tar.xz openshift-5e36d75d47b18e3ac09f33cdf65a2292a9952b20.zip |
oadm_policy_group/adm_policy_user module
Diffstat (limited to 'roles/lib_openshift/src/doc/policy_user')
-rw-r--r-- | roles/lib_openshift/src/doc/policy_user | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/roles/lib_openshift/src/doc/policy_user b/roles/lib_openshift/src/doc/policy_user new file mode 100644 index 000000000..351c9af65 --- /dev/null +++ b/roles/lib_openshift/src/doc/policy_user @@ -0,0 +1,74 @@ +# flake8: noqa +# pylint: skip-file + +DOCUMENTATION = ''' +--- +module: oc_adm_policy_user +short_description: Module to manage openshift policy for users +description: + - Manage openshift policy for users. +options: + kubeconfig: + description: + - The path for the kubeconfig file to use for authentication + required: false + default: /etc/origin/master/admin.kubeconfig + aliases: [] + namespace: + description: + - The namespace scope + required: false + default: None + aliases: [] + debug: + description: + - Turn on debug output. + required: false + default: False + aliases: [] + user: + description: + - The name of the user + required: true + default: None + aliases: [] + resource_kind: + description: + - The kind of policy to affect + required: true + default: None + choices: ["role", "cluster-role", "scc"] + aliases: [] + resource_name: + description: + - The name of the policy + required: true + default: None + aliases: [] + state: + description: + - Desired state of the policy + required: true + default: present + choices: ["present", "absent"] + aliases: [] +author: +- "Kenny Woodson <kwoodson@redhat.com>" +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +- name: oc adm policy remove-scc-from-user an-scc ausername + oc_adm_policy_user: + user: ausername + resource_kind: scc + resource_name: an-scc + state: absent + +- name: oc adm policy add-cluster-role-to-user system:build-strategy-docker ausername + oc_adm_policy_user: + user: ausername + resource_kind: cluster-role + resource_name: system:build-strategy-docker + state: present +''' |