stable/kube2iam/README.md
As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.
Installs kube2iam to provide IAM credentials to pods based on annotations.
This chart is deprecated and no longer supported.
$ helm install stable/kube2iam
This chart bootstraps a kube2iam deployment on a Kubernetes cluster using the Helm package manager.
To install the chart with the release name my-release:
$ helm install stable/kube2iam --name my-release
The command deploys kube2iam on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.
To uninstall/delete the my-release deployment:
$ helm delete my-release
The command removes all the Kubernetes components associated with the chart and deletes the release.
The following table lists the configurable parameters of the kube2iam chart and their default values.
| Parameter | Description | Default |
|---|---|---|
affinity | affinity configuration for pod assignment | {} |
extraArgs | Additional container arguments | {} |
extraEnv | Additional container environment variables | {} |
host.ip | IP address of host | $(HOST_IP) |
host.iptables | Add iptables rule | false |
host.interface | Host interface for proxying AWS metadata | docker0 |
host.port | Port to listen on | 8181 |
image.repository | Image | jtblin/kube2iam |
image.tag | Image tag | 0.10.7 |
image.pullPolicy | Image pull policy | IfNotPresent |
image.pullSecrets | Image pull secrets | [] |
nodeSelector | node labels for pod assignment | {} |
podAnnotations | annotations to be added to pods | {} |
priorityClassName | priorityClassName to be added to pods | {} |
prometheus.metricsPort | Port to expose prometheus metrics on (if unspecified, host.port is used) | host.port |
prometheus.service.enabled | If true, create a Service resource for Prometheus | false |
prometheus.service.annotations | Annotations to be added to the service | {} |
prometheus.serviceMonitor.enabled | If true, create a Prometheus Operator ServiceMonitor resource | false |
prometheus.serviceMonitor.interval | Interval at which the metrics endpoint is scraped | 10s |
prometheus.serviceMonitor.namespace | An alternative namespace in which to install the ServiceMonitor | "" |
prometheus.serviceMonitor.labels | Labels to add to the ServiceMonitor | {} |
probe.enabled | Enable/disable pod liveness probe | true |
probe.initialDelaySeconds | Liveness probe initial delay | 30 |
probe.periodSeconds | Liveness probe check inteval | 5 |
probe.successThreshold | Liveness probe success threshold | 1 |
probe.failureThreshold | Liveness probe fail threshold | 3 |
probe.timeoutSeconds | Livenees probe timeout | 1 |
rbac.create | If true, create & use RBAC resources | false |
rbac.serviceAccountName | existing ServiceAccount to use (ignored if rbac.create=true) | default |
resources | pod resource requests & limits | {} |
updateStrategy | Strategy for DaemonSet updates (requires Kubernetes 1.6+) | OnDelete |
verbose | Enable verbose output | false |
tolerations | List of node taints to tolerate (requires Kubernetes 1.6+) | [] |
aws.secret_key | The value to use for AWS_SECRET_ACCESS_KEY | "" |
aws.access_key | The value to use for AWS_ACCESS_KEY_ID | "" |
aws.region | The AWS region to use | "" |
existingSecret | Set the AWS credentials using an existing secret | "" |
podSecurityPolicy.enabled | If true, create a podSecurityPolicy object. For the pods to use the psp, rbac.create should also be set to true | false |
podSecurityPolicy.annotations | The annotations to add to the podSecurityPolicy object | {} |
Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,
$ helm install stable/kube2iam --name my-release \
--set=extraArgs.base-role-arn=arn:aws:iam::0123456789:role/,extraArgs.default-role=kube2iam-default,host.iptables=true,host.interface=cbr0
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
$ helm install stable/kube2iam --name my-release -f values.yaml
Tip: You can use the default values.yaml