diff options
author | OpenShift Bot <eparis+openshiftbot@redhat.com> | 2017-03-22 18:53:47 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-03-22 18:53:47 -0500 |
commit | 3d1f4de1f4fe36163c2b62ef2c385ac746baf598 (patch) | |
tree | 42fc0dcb0f7c4bb569079b8298e2ddefccedee7e /roles/lib_openshift/src/doc | |
parent | 763831e73432ab3db69efdbfd06a171be7d0a2af (diff) | |
parent | bfaa7976a2e3090f1b942978f340b9ffbb6b222c (diff) | |
download | openshift-3d1f4de1f4fe36163c2b62ef2c385ac746baf598.tar.gz openshift-3d1f4de1f4fe36163c2b62ef2c385ac746baf598.tar.bz2 openshift-3d1f4de1f4fe36163c2b62ef2c385ac746baf598.tar.xz openshift-3d1f4de1f4fe36163c2b62ef2c385ac746baf598.zip |
Merge pull request #3692 from kwoodson/oc_volume
Merged by openshift-bot
Diffstat (limited to 'roles/lib_openshift/src/doc')
-rw-r--r-- | roles/lib_openshift/src/doc/volume | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/roles/lib_openshift/src/doc/volume b/roles/lib_openshift/src/doc/volume new file mode 100644 index 000000000..1d04afeef --- /dev/null +++ b/roles/lib_openshift/src/doc/volume @@ -0,0 +1,105 @@ +# flake8: noqa +# pylint: skip-file + +DOCUMENTATION = ''' +--- +module: oc_volume +short_description: Create, modify, and idempotently manage openshift volumes. +description: + - Modify openshift volumes programmatically. +options: + state: + description: + - State controls the action that will be taken with resource + - 'present' will create or update and object to the desired state + - 'absent' will ensure volumes are removed + - 'list' will read the volumes + 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: [] + namespace: + description: + - The name of the namespace where the object lives + required: false + default: default + aliases: [] + kind: + description: + - The kind of object that can be managed. + default: dc + choices: + - dc + - rc + - pods + aliases: [] + mount_type: + description: + - The type of volume to be used + required: false + default: None + choices: + - emptydir + - hostpath + - secret + - pvc + - configmap + aliases: [] + mount_path: + description: + - The path to where the mount will be attached + required: false + default: None + aliases: [] + secret_name: + description: + - The name of the secret. Used when mount_type is secret. + required: false + default: None + aliases: [] + claim_size: + description: + - The size in GB of the pv claim. e.g. 100G + required: false + default: None + aliases: [] + claim_name: + description: + - The name of the pv claim + required: false + default: None + aliases: [] + configmap_name: + description: + - The name of the configmap + required: false + default: None + aliases: [] +author: +- "Kenny Woodson <kwoodson@redhat.com>" +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +- name: attach storage volumes to deploymentconfig + oc_volume: + namespace: logging + kind: dc + name: name_of_the_dc + mount_type: pvc + claim_name: loggingclaim + claim_size: 100G + vol_name: logging-storage + run_once: true +''' |