diff options
author | OpenShift Bot <eparis+openshiftbot@redhat.com> | 2017-07-18 12:02:24 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-07-18 12:02:24 -0400 |
commit | 742203529902ba278c213e326f81f667304b9625 (patch) | |
tree | fe30ee99dcf3ea34e4ade84f630bd1d794581c9a /roles/lib_openshift/src/doc | |
parent | 057a58db0949900e75cf9f602b949bacbb78158f (diff) | |
parent | 94923be737328a2f0227b70a8dc12bda7e731f1d (diff) | |
download | openshift-742203529902ba278c213e326f81f667304b9625.tar.gz openshift-742203529902ba278c213e326f81f667304b9625.tar.bz2 openshift-742203529902ba278c213e326f81f667304b9625.tar.xz openshift-742203529902ba278c213e326f81f667304b9625.zip |
Merge pull request #4669 from kwoodson/storageclass
Merged by openshift-bot
Diffstat (limited to 'roles/lib_openshift/src/doc')
-rw-r--r-- | roles/lib_openshift/src/doc/storageclass | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/roles/lib_openshift/src/doc/storageclass b/roles/lib_openshift/src/doc/storageclass new file mode 100644 index 000000000..5a7320d55 --- /dev/null +++ b/roles/lib_openshift/src/doc/storageclass @@ -0,0 +1,86 @@ +# flake8: noqa +# pylint: skip-file + +DOCUMENTATION = ''' +--- +module: oc_storageclass +short_description: Create, modify, and idempotently manage openshift storageclasses. +description: + - Manage openshift storageclass objects programmatically. +options: + state: + description: + - State represents whether to create, modify, delete, or list + 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: [] + provisioner: + description: + - Any annotations to add to the storageclass + required: false + default: 'aws-ebs' + aliases: [] + default_storage_class: + description: + - Whether or not this is the default storage class + required: false + default: False + aliases: [] + parameters: + description: + - A dictionary with the parameters to configure the storageclass. This will be based on provisioner + required: false + default: None + aliases: [] + api_version: + description: + - The api version. + required: false + default: v1 + aliases: [] +author: +- "Kenny Woodson <kwoodson@redhat.com>" +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +- name: get storageclass + run_once: true + oc_storageclass: + name: gp2 + state: list + register: registry_sc_out + +- name: create the storageclass + oc_storageclass: + run_once: true + name: gp2 + parameters: + type: gp2 + encrypted: 'true' + kmsKeyId: '<full kms key arn>' + provisioner: aws-ebs + default_storage_class: False + register: sc_out + notify: + - restart openshift master services +''' |