summaryrefslogtreecommitdiffstats
path: root/roles/lib_openshift/src/doc/scale
diff options
context:
space:
mode:
Diffstat (limited to 'roles/lib_openshift/src/doc/scale')
-rw-r--r--roles/lib_openshift/src/doc/scale70
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
+'''