diff options
author | Kenny Woodson <kwoodson@redhat.com> | 2017-03-20 19:25:33 -0400 |
---|---|---|
committer | Kenny Woodson <kwoodson@redhat.com> | 2017-03-21 11:34:55 -0400 |
commit | 873ec7cda3edb0f8f479da257de168976e386f77 (patch) | |
tree | e2d8d17b0738935a19ed4ff25e7bba61f8a39207 /roles/lib_openshift/src/doc/configmap | |
parent | 789bbd3a3d944a6f459b200c9ec7239539e14510 (diff) | |
download | openshift-873ec7cda3edb0f8f479da257de168976e386f77.tar.gz openshift-873ec7cda3edb0f8f479da257de168976e386f77.tar.bz2 openshift-873ec7cda3edb0f8f479da257de168976e386f77.tar.xz openshift-873ec7cda3edb0f8f479da257de168976e386f77.zip |
Adding oc_configmap to lib_openshift.
Diffstat (limited to 'roles/lib_openshift/src/doc/configmap')
-rw-r--r-- | roles/lib_openshift/src/doc/configmap | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/roles/lib_openshift/src/doc/configmap b/roles/lib_openshift/src/doc/configmap new file mode 100644 index 000000000..8ac4a5629 --- /dev/null +++ b/roles/lib_openshift/src/doc/configmap @@ -0,0 +1,72 @@ +# flake8: noqa +# pylint: skip-file + +DOCUMENTATION = ''' +--- +module: oc_configmap +short_description: Modify, and idempotently manage openshift configmaps +description: + - Modify openshift configmaps 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 configmap + - absent - will remove the configmap + 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: [] + from_file: + description: + - A dict of key, value pairs representing the configmap key and the value represents the file path. + required: false + default: None + aliases: [] + from_literal: + description: + - A dict of key, value pairs representing the configmap key and the value represents the string content + required: false + default: None + aliases: [] +author: +- "kenny woodson <kwoodson@redhat.com>" +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +- name: create group + oc_configmap: + state: present + name: testmap + from_file: + secret: /path/to/secret + from_literal: + title: systemadmin + register: configout +''' |