From 618eba57a0b75c22e5a891fbc8cf5893305aaa4c Mon Sep 17 00:00:00 2001 From: Ed Robinson Date: Thu, 3 Sep 2020 14:46:26 +0100 Subject: [PATCH] Update addon documentation --- modules/cluster/README.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/modules/cluster/README.md b/modules/cluster/README.md index f26ec272..29eb9141 100644 --- a/modules/cluster/README.md +++ b/modules/cluster/README.md @@ -85,21 +85,20 @@ specify the arn of an existing key by setting `kms_cmk_arn` ## Cluster critical add-ons -By default all addons are setup. If you want to disable this behaviour you may -by setting some or all of: -```hcl -cluster_autoscaler = false -metrics_server = false -prometheus_node_exporter = false -aws_node_termination_handler = false -nvidia_device_plugin = false -``` +| addon | variable | default | +|-------|----------|---------| +| [Cluster Autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler) | `cluster_autoscaler` | ✅ enabled | +| [AWS Node Termination Handler](https://github.com/aws/aws-node-termination-handler) | `aws_node_termination_handler` | ✅ enabled | +| [NVIDIA device plugin for Kubernetes](https://github.com/NVIDIA/k8s-device-plugin) | `nvidia_device_plugin` | ✅ enabled (but only schedules to gpu nodes) | +| [Prometheus Node Exporter](https://github.com/prometheus/node_exporter) | `prometheus_node_exporter` | ❌ disabled | +| [Kubernetes Metrics Server](https://github.com/kubernetes-sigs/metrics-server) | `metrics_server` | ❌ disabled | +| [Amazon Elastic Block Store (EBS) CSI driver](https://github.com/kubernetes-sigs/aws-ebs-csi-driver/) | `aws_ebs_csi_driver` | ❌ disabled | + +Note that setting these variables to false will not remove provisioned add-ons from an existing cluster. -Note that setting these values to false will not remove provisioned add-ons -from an existing cluster. +By default if `cluster_autoscaler` is enabled an IAM role is provisioned to provide the appropriate permissions to alter managed auto scaling groups. +If you wish to manage this IAM role externally you should set `cluster_autoscaler_iam_role_arn` -By default if the cluster autoscaler is enabled an IAM role is provisioned to -provide the appropriate permissions to alter managed auto scaling groups. If -you wish to manage this IAM role externally you should set -`cluster_autoscaler_iam_role_arn` +By default if `aws_ebs_csi_driver` is enabled an IAM role is provisioned to provide the appropriate permissions. +If you wish to manage this IAM role externally you should set `aws_ebs_csi_driver_iam_role_arn`