diff options
author | Kenny Woodson <kwoodson@redhat.com> | 2017-01-23 11:55:27 -0500 |
---|---|---|
committer | Kenny Woodson <kwoodson@redhat.com> | 2017-01-25 14:19:08 -0500 |
commit | 9b7a409745abae6a837ff1e177e5220bcac4d938 (patch) | |
tree | fa35d2fe1877a64f7e3274c33a1bccff591e1c82 /roles/lib_openshift/src/doc | |
parent | 23524879781958ebdc69f4c68d2429db5544f8ee (diff) | |
download | openshift-9b7a409745abae6a837ff1e177e5220bcac4d938.tar.gz openshift-9b7a409745abae6a837ff1e177e5220bcac4d938.tar.bz2 openshift-9b7a409745abae6a837ff1e177e5220bcac4d938.tar.xz openshift-9b7a409745abae6a837ff1e177e5220bcac4d938.zip |
Adding oc_scale to lib_openshift.
Diffstat (limited to 'roles/lib_openshift/src/doc')
-rw-r--r-- | roles/lib_openshift/src/doc/scale | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/roles/lib_openshift/src/doc/scale b/roles/lib_openshift/src/doc/scale new file mode 100644 index 000000000..b2ffc77f9 --- /dev/null +++ b/roles/lib_openshift/src/doc/scale @@ -0,0 +1,70 @@ +# flake8: noqa +# pylint: skip-file + +DOCUMENTATION = ''' +--- +module: oc_scale +short_description: Manage openshift services through the scale parameters +description: + - Manage openshift services through scaling them. +options: + state: + description: + - State represents whether to create, modify, delete, or list + required: true + 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: [] + kind: + description: + - The kind of object to scale. + required: false + default: None + choices: + - rc + - dc + aliases: [] +author: +- "Kenny Woodson <kwoodson@redhat.com>" +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +- name: scale down a rc to 0 + oc_scale: + name: my-replication-controller + kind: rc + namespace: openshift-infra + replicas: 0 + +- name: scale up a deploymentconfig to 2 + oc_scale: + name: php + kind: dc + namespace: my-php-app + replicas: 2 +''' |