diff options
author | Kenny Woodson <kwoodson@redhat.com> | 2017-03-17 16:03:49 -0400 |
---|---|---|
committer | Kenny Woodson <kwoodson@redhat.com> | 2017-03-20 11:45:49 -0400 |
commit | 171bd68cac5d19ba6178e9288a85ef122e6fbd1a (patch) | |
tree | 9f7225c192f50ed8acd4af573c81fbbc9f9afe68 /roles/lib_openshift/src/doc | |
parent | b6aa824eb212ff968cc4b925bb32c05ef2ebd61d (diff) | |
download | openshift-171bd68cac5d19ba6178e9288a85ef122e6fbd1a.tar.gz openshift-171bd68cac5d19ba6178e9288a85ef122e6fbd1a.tar.bz2 openshift-171bd68cac5d19ba6178e9288a85ef122e6fbd1a.tar.xz openshift-171bd68cac5d19ba6178e9288a85ef122e6fbd1a.zip |
Adding oc_group to lib_openshift
Diffstat (limited to 'roles/lib_openshift/src/doc')
-rw-r--r-- | roles/lib_openshift/src/doc/group | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/roles/lib_openshift/src/doc/group b/roles/lib_openshift/src/doc/group new file mode 100644 index 000000000..c5ba6ebd9 --- /dev/null +++ b/roles/lib_openshift/src/doc/group @@ -0,0 +1,56 @@ +# flake8: noqa +# pylint: skip-file + +DOCUMENTATION = ''' +--- +module: oc_group +short_description: Modify, and idempotently manage openshift groups. +description: + - Modify openshift groups programmatically. +options: + state: + description: + - Supported states, present, absent, list + - present - will ensure object is created or updated to the value specified + - list - will return a group + - absent - will remove the group + 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: [] + namespace: + description: + - The namespace where the object lives. + required: false + default: str + aliases: [] +author: +- "Joel Diaz <jdiaz@redhat.com>" +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +- name: create group + oc_group: + state: present + name: acme_org + register: group_out +''' |