diff options
author | Kenny Woodson <kwoodson@redhat.com> | 2017-03-28 13:56:00 -0400 |
---|---|---|
committer | Kenny Woodson <kwoodson@redhat.com> | 2017-03-28 17:05:49 -0400 |
commit | 611e9864e8716ca92a77745403c847c30f2f0d87 (patch) | |
tree | b9a9248d32e6024e3e58d897636b63dfce01ac60 /roles/lib_openshift/src/doc/clusterrole | |
parent | d77a9a685c3add9ef9c4d659ee47ebf35e145fe4 (diff) | |
download | openshift-611e9864e8716ca92a77745403c847c30f2f0d87.tar.gz openshift-611e9864e8716ca92a77745403c847c30f2f0d87.tar.bz2 openshift-611e9864e8716ca92a77745403c847c30f2f0d87.tar.xz openshift-611e9864e8716ca92a77745403c847c30f2f0d87.zip |
Adding clusterrole to the toolbox.
Diffstat (limited to 'roles/lib_openshift/src/doc/clusterrole')
-rw-r--r-- | roles/lib_openshift/src/doc/clusterrole | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/roles/lib_openshift/src/doc/clusterrole b/roles/lib_openshift/src/doc/clusterrole new file mode 100644 index 000000000..3d14a2dfb --- /dev/null +++ b/roles/lib_openshift/src/doc/clusterrole @@ -0,0 +1,66 @@ +# flake8: noqa +# pylint: skip-file + +DOCUMENTATION = ''' +--- +module: oc_clusterrole +short_description: Modify, and idempotently manage openshift clusterroles +description: + - Manage openshift clusterroles +options: + state: + description: + - Supported states, present, absent, list + - present - will ensure object is created or updated to the value specified + - list - will return a clusterrole + - absent - will remove a clusterrole + 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: [] + name: + description: + - Name of the object that is being queried. + required: false + default: None + aliases: [] + rules: + description: + - A list of dictionaries that have the rule parameters. + - e.g. rules=[{'apiGroups': [""], 'attributeRestrictions': None, 'verbs': ['get'], 'resources': []}] + required: false + default: None + aliases: [] +author: +- "Kenny Woodson <kwoodson@redhat.com>" +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +- name: query a list of env vars on dc + oc_clusterrole: + name: myclusterrole + state: list + +- name: Set the following variables. + oc_clusterrole: + name: myclusterrole + rules: + apiGroups: + - "" + attributeRestrictions: null + verbs: [] + resources: [] +''' |