summaryrefslogtreecommitdiffstats
path: root/roles/openshift_cluster_autoscaler/README.md
diff options
context:
space:
mode:
authorKenny Woodson <kwoodson@redhat.com>2017-10-11 13:14:27 -0400
committerKenny Woodson <kwoodson@redhat.com>2017-10-11 21:00:19 -0400
commit4526f5457d012bc14c16b844bebc3eaeaa8ff191 (patch)
tree8543cf441d2eaba83ee52d749c741faf560f7647 /roles/openshift_cluster_autoscaler/README.md
parent2fb41eea9aa4b328d7da1c5e4b7de2e717549ed7 (diff)
downloadopenshift-4526f5457d012bc14c16b844bebc3eaeaa8ff191.tar.gz
openshift-4526f5457d012bc14c16b844bebc3eaeaa8ff191.tar.bz2
openshift-4526f5457d012bc14c16b844bebc3eaeaa8ff191.tar.xz
openshift-4526f5457d012bc14c16b844bebc3eaeaa8ff191.zip
Adding support for cluster-autoscaler role
Diffstat (limited to 'roles/openshift_cluster_autoscaler/README.md')
-rw-r--r--roles/openshift_cluster_autoscaler/README.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/roles/openshift_cluster_autoscaler/README.md b/roles/openshift_cluster_autoscaler/README.md
new file mode 100644
index 000000000..d775a8a71
--- /dev/null
+++ b/roles/openshift_cluster_autoscaler/README.md
@@ -0,0 +1,58 @@
+Openshift cluster autoscaler
+================================
+
+Install the cluster autoscaler
+
+Requirements
+------------
+
+* One or more Master servers
+* A cloud provider that supports the cluster-autoscaler
+
+Role Variables
+--------------
+Check defaults/main.yml
+
+Dependencies
+------------
+
+
+Example Playbook
+----------------
+
+#!/usr/bin/ansible-playbook
+```
+---
+- hosts: masters
+ gather_facts: no
+ remote_user: root
+ tasks:
+ - name: include role autoscaler
+ include_role:
+ name: openshift_cluster_autoscaler
+ vars:
+ openshift_clusterid: opstest
+ openshift_cluster_autoscaler_aws_key: <aws_key>
+ openshift_cluster_autoscaler_aws_secret_key: <aws_secret_key>
+```
+
+
+Notes
+-----
+
+This is currently experimental software. This role allows users to install the cluster-autoscaler and the necessary authorization pieces that allow the autoscaler to function.
+
+
+This feature requires cloud provider credentials or a serviceaccount that has access to scale up/down nodes within the scaling groups.
+
+https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler
+
+License
+-------
+
+Apache License, Version 2.0
+
+Author Information
+------------------
+
+Openshift