From 966ba6401443bc0e093e4b461be42473b4e16225 Mon Sep 17 00:00:00 2001 From: Kenny Woodson Date: Wed, 15 Mar 2017 17:41:32 -0400 Subject: Adding oc_volume to lib_openshift. --- roles/lib_openshift/src/doc/volume | 98 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 roles/lib_openshift/src/doc/volume (limited to 'roles/lib_openshift/src/doc/volume') diff --git a/roles/lib_openshift/src/doc/volume b/roles/lib_openshift/src/doc/volume new file mode 100644 index 000000000..cca878569 --- /dev/null +++ b/roles/lib_openshift/src/doc/volume @@ -0,0 +1,98 @@ +# 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 + 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: [] +author: +- "Kenny Woodson " +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 +''' -- cgit v1.2.3 From ed210226e0996ebb6d31ff55185ad96357bf3014 Mon Sep 17 00:00:00 2001 From: Kenny Woodson Date: Tue, 21 Mar 2017 16:53:16 -0400 Subject: Adding configmap support and adding tests. --- roles/lib_openshift/src/doc/volume | 1 + 1 file changed, 1 insertion(+) (limited to 'roles/lib_openshift/src/doc/volume') diff --git a/roles/lib_openshift/src/doc/volume b/roles/lib_openshift/src/doc/volume index cca878569..8112c79c2 100644 --- a/roles/lib_openshift/src/doc/volume +++ b/roles/lib_openshift/src/doc/volume @@ -54,6 +54,7 @@ options: - hostpath - secret - pvc + - configmap aliases: [] mount_path: description: -- cgit v1.2.3 From c7124d09eb19a0f20d8e60ccf43eccbedf1e8c29 Mon Sep 17 00:00:00 2001 From: Kenny Woodson Date: Tue, 21 Mar 2017 17:26:21 -0400 Subject: Adding configmap support. --- roles/lib_openshift/src/doc/volume | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'roles/lib_openshift/src/doc/volume') diff --git a/roles/lib_openshift/src/doc/volume b/roles/lib_openshift/src/doc/volume index 8112c79c2..1d04afeef 100644 --- a/roles/lib_openshift/src/doc/volume +++ b/roles/lib_openshift/src/doc/volume @@ -80,6 +80,12 @@ options: required: false default: None aliases: [] + configmap_name: + description: + - The name of the configmap + required: false + default: None + aliases: [] author: - "Kenny Woodson " extends_documentation_fragment: [] -- cgit v1.2.3