diff options
author | Kenny Woodson <kwoodson@redhat.com> | 2017-01-26 14:16:23 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-01-26 14:16:23 -0500 |
commit | 8f2b3f132bc6cd03640c31c0c33cffb01f80138c (patch) | |
tree | 6ec0b8b4caed6279c45d14f2979390468b7772bc /roles/lib_openshift/src/doc/scale | |
parent | a44270f3dfd2c4707138891cfc485e0a82e7dd7c (diff) | |
parent | b05c1e3bb7f1cd66a326bb7784ec166c4db4395a (diff) | |
download | openshift-8f2b3f132bc6cd03640c31c0c33cffb01f80138c.tar.gz openshift-8f2b3f132bc6cd03640c31c0c33cffb01f80138c.tar.bz2 openshift-8f2b3f132bc6cd03640c31c0c33cffb01f80138c.tar.xz openshift-8f2b3f132bc6cd03640c31c0c33cffb01f80138c.zip |
Merge pull request #3183 from kwoodson/oc_scale
Adding oc_scale to lib_openshift.
Diffstat (limited to 'roles/lib_openshift/src/doc/scale')
-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..e98730911 --- /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 scale or list the current replicas + required: true + default: present + choices: ["present", "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: default + 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 +''' |