bitnamicharts/kiam
Bitnami Helm chart for Kiam
50K+
kiam is a proxy that captures AWS Metadata API requests. It allows AWS IAM roles to be set for Kubernetes workloads.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
helm install my-release oci://registry-1.docker.io/bitnamicharts/kiam
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
. NOTE: KIAM has been designed to work on a Kubernetes cluster deployed on top of AWS, although it is possible to deploy it in other environments.
Looking to use Kiam in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.
This chart bootstraps a kiam deployment on a Kubernetes cluster using the Helm package manager.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.
To install the chart with the release name my-release
:
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/kiam
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
These commands deploy a kiam application on the Kubernetes cluster in the default configuration.
Tip: List all releases using
helm list
Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources
value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
To make this process easier, the chart contains the resourcesPreset
values, which automatically sets the resources
section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset
is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
This chart can be integrated with Prometheus by setting *.metrics.enabled
(under the server
and agent
sections) to true
. This will expose Kiam native Prometheus endpoint in the service. It will have the necessary annotations to be automatically scraped by Prometheus.
Prometheus requirements
It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart or the Bitnami Kube Prometheus helm chart to easily have a working Prometheus in your cluster.
Integration with Prometheus Operator
The chart can deploy ServiceMonitor
objects for integration with Prometheus Operator installations. To do so, set the value *.metrics.serviceMonitor.enabled=true
(under the server
and agent
sections). Ensure that the Prometheus Operator CustomResourceDefinitions
are installed in the cluster or it will fail with the following error:
no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"
Install the Bitnami Kube Prometheus helm chart for having the necessary CRDs and the Prometheus Operator.
To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.
In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the server.extraEnvVars
and agent.extraEnvVars
property.
server:
extraEnvVars:
- name: LOG_LEVEL
value: error
Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the server.extraEnvVarsCM
, agent.extraEnvVarsCM
or the server.extraEnvVarsSecret
and agent.extraEnvVarsSecret
values.
If additional containers are needed in the same pod as Kiam (such as additional metrics or logging exporters), they can be defined using the sidecars
parameter.
sidecars:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts
parameter (where available), as shown in the example below:
service:
extraPorts:
- name: extraPort
port: 11311
targetPort: 11311
NOTE: This Helm chart already includes sidecar containers for the Prometheus exporters (where applicable). These can be activated by adding the
--enable-metrics=true
parameter at deployment time. Thesidecars
parameter should therefore only be used for any extra sidecar containers.
If additional init containers are needed in the same pod, they can be defined using the initContainers
parameter. Here is an example:
initContainers:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
Learn more about sidecar containers and init containers.
There are cases where you may want to deploy extra objects, such a ConfigMap containing your app's configuration or some extra deployment with a micro service used by your app. For covering this case, the chart allows adding the full specification of other objects using the extraDeploy
parameter.
This chart allows you to set your custom affinity using the server.affinity
and agent.affinity
parameters. Find more information about Pod affinity in the kubernetes documentation.
As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the server.podAffinityPreset
, agent.podAffinityPreset
, server.podAntiAffinityPreset
, agent.podAntiAffinityPreset
, or server.nodeAffinityPreset
and agent.nodeAffinityPreset
parameters.
This chart will facilitate the creation of TLS secrets for use with kiam. There are three common use cases:
By default the first use case will be applied. In the second case, a certificate and a key are needed.
The certificate files should look like the example below. There may be more than one certificate if there is a certificate chain.
-----BEGIN CERTIFICATE-----
MIID6TCCAtGgAwIBAgIJAIaCwivkeB5EMA0GCSqGSIb3DQEBCwUAMFYxCzAJBgNV
...
jScrvkiBO65F46KioCL9h5tDvomdU1aqpI/CBzhvZn1c0ZTf87tGQR8NK7v7
-----END CERTIFICATE-----
The certificate keys should look like this:
-----BEGIN RSA PRIVATE KEY-----
MIIEogIBAAKCAQEAvLYcyu8f3skuRyUgeeNpeDvYBCDcgq+LsWap6zbX5f8oLqp4
...
wrj2wDbCDCFmfqnSJ+dKI3vFLlEz44sAV8jX/kd4Y6ZTQhlLbYc=
-----END RSA PRIVATE KEY-----
If using the values file to manage the certificates, copy the above values into the server.tlsFiles.cert
, server.tlsFiles.ca
and server.tlsFiles.key
or agent.tlsFiles.cert
, agent.tlsFiles.ca
and agent.tlsFiles.key
parameters respectively.
If managing TLS secrets outside of Helm, it is possible to create a TLS secret (named kiam.local-tls
, for example) and set it using the server.tlsSecret
or agent.tlsSecret
parameters.
Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.storageClass | DEPRECATED: use global.defaultStorageClass instead | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | auto |
Name | Description | Value |
---|---|---|
kubeVersion | Force target Kubernetes version (using Helm capabilities if not set) | "" |
nameOverride | Release name override | "" |
fullnameOverride | Release full name override | "" |
commonLabels | Labels to add to all deployed objects | {} |
commonAnnotations | Annotations to add to all deployed objects | {} |
extraDeploy | Array of extra objects to deploy with the release | [] |
diagnosticMode.enabled | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | false |
diagnosticMode.command | Command to override all containers in the the deployment(s)/statefulset(s) | ["sleep"] |
diagnosticMode.args | Args to override all containers in the the deployment(s)/statefulset(s) | ["infinity"] |
Name | Description | Value |
---|---|---|
image.registry | kiam image registry | REGISTRY_NAME |
image.repository | kiam image name | REPOSITORY_NAME/kiam |
image.digest | kiam image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
image.pullPolicy | kiam image pull policy | IfNotPresent |
image.pullSecrets | Specify docker-registry secret names as an array | [] |
Name | Description | Value |
---|---|---|
server.enabled | Deploy the kiam server | true |
server.containerPort | HTTPS port to expose at container level | 8443 |
server.resourceType | Specify how to deploy the server (allowed values: daemonset and deployment ) | daemonset |
server.automountServiceAccountToken | Mount Service Account token in pod | true |
server.hostAliases | Add deployment host aliases | [] |
server.useHostNetwork | Use host networking (ports will be directly exposed in the host) | false |
server.replicaCount | Number of replicas to deploy (when server.resourceType is daemonset ) | 1 |
server.logJsonOutput | Use JSON format for logs | true |
server.logLevel | Logging level | info |
server.sslCertHostPath | Path to the host system SSL certificates (necessary for contacting the AWS metadata server) | /etc/ssl/certs |
server.podSecurityPolicy.create | Whether to create a PodSecurityPolicy. WARNING: PodSecurityPolicy is deprecated in Kubernetes v1.21 or later, unavailable in v1.25 or later | true |
server.podSecurityPolicy.allowedHostPaths | Extra host paths to allow in the PodSecurityPolicy | [] |
server.priorityClassName | Server priorityClassName | "" |
server.schedulerName | Name of the k8s scheduler (other than default) | "" |
server.topologySpreadConstraints | Topology Spread Constraints for pod assignment | [] |
server.startupProbe.enabled | Enable startupProbe | false |
server.startupProbe.initialDelaySeconds | Initial delay seconds for startupProbe | 5 |
server.startupProbe.periodSeconds | Period seconds for startupProbe | 30 |
server.startupProbe.timeoutSeconds | Timeout seconds for startupProbe | 5 |
server.startupProbe.failureThreshold | Failure threshold for startupProbe | 5 |
server.startupProbe.successThreshold | Success threshold for startupProbe | 1 |
server.livenessProbe.enabled | Enable livenessProbe | true |
server.livenessProbe.initialDelaySeconds | Initial delay seconds for livenessProbe | 5 |
server.livenessProbe.periodSeconds | Period seconds for livenessProbe | 30 |
server.livenessProbe.timeoutSeconds | Timeout seconds for livenessProbe | 5 |
server.livenessProbe.failureThreshold | Failure threshold for livenessProbe |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/kiam/README.md