|
| 1 | +# karpenter |
| 2 | + |
| 3 | +A Helm chart for Karpenter, an open-source node provisioning project built for Kubernetes. |
| 4 | + |
| 5 | +   |
| 6 | + |
| 7 | +## Documentation |
| 8 | + |
| 9 | +For full Karpenter documentation please checkout [https://karpenter.sh](https://karpenter.sh/docs/). |
| 10 | + |
| 11 | +## Installing the Chart |
| 12 | + |
| 13 | +You can follow the detailed installation instruction in the [documentation](https://karpenter.sh/docs/getting-started/getting-started-with-karpenter) which covers the Karpenter prerequisites and installation options. The outcome of these instructions should result in something like the following command. |
| 14 | + |
| 15 | +```bash |
| 16 | +helm upgrade --install --namespace karpenter --create-namespace \ |
| 17 | + karpenter oci://public.ecr.aws/karpenter/karpenter \ |
| 18 | + --version 0.37.0 \ |
| 19 | + --set "serviceAccount.annotations.eks\.amazonaws\.com/role-arn=${KARPENTER_IAM_ROLE_ARN}" \ |
| 20 | + --set settings.clusterName=${CLUSTER_NAME} \ |
| 21 | + --set settings.interruptionQueue=${CLUSTER_NAME} \ |
| 22 | + --wait |
| 23 | +``` |
| 24 | + |
| 25 | +### Verification |
| 26 | + |
| 27 | +As the OCI Helm chart is signed by [Cosign](https://github.com/sigstore/cosign) as part of the release process you can verify the chart before installing it by running the following command. |
| 28 | + |
| 29 | +```shell |
| 30 | +cosign verify public.ecr.aws/karpenter/karpenter:0.37.0 \ |
| 31 | + --certificate-oidc-issuer=https://token.actions.githubusercontent.com \ |
| 32 | + --certificate-identity-regexp='https://github\.com/aws/karpenter-provider-aws/\.github/workflows/release\.yaml@.+' \ |
| 33 | + --certificate-github-workflow-repository=aws/karpenter-provider-aws \ |
| 34 | + --certificate-github-workflow-name=Release \ |
| 35 | + --certificate-github-workflow-ref=refs/tags/v0.37.0 \ |
| 36 | + --annotations version=0.37.0 |
| 37 | +``` |
| 38 | + |
| 39 | +## Values |
| 40 | + |
| 41 | +| Key | Type | Default | Description | |
| 42 | +|-----|------|---------|-------------| |
| 43 | +| additionalAnnotations | object | `{}` | Additional annotations to add into metadata. | |
| 44 | +| additionalClusterRoleRules | list | `[]` | Specifies additional rules for the core ClusterRole. | |
| 45 | +| additionalLabels | object | `{}` | Additional labels to add into metadata. | |
| 46 | +| affinity | object | `{"nodeAffinity":{"requiredDuringSchedulingIgnoredDuringExecution":{"nodeSelectorTerms":[{"matchExpressions":[{"key":"karpenter.sh/nodepool","operator":"DoesNotExist"}]}]}},"podAntiAffinity":{"requiredDuringSchedulingIgnoredDuringExecution":[{"topologyKey":"kubernetes.io/hostname"}]}}` | Affinity rules for scheduling the pod. If an explicit label selector is not provided for pod affinity or pod anti-affinity one will be created from the pod selector labels. | |
| 47 | +| controller.env | list | `[]` | Additional environment variables for the controller pod. | |
| 48 | +| controller.envFrom | list | `[]` | | |
| 49 | +| controller.extraVolumeMounts | list | `[]` | Additional volumeMounts for the controller pod. | |
| 50 | +| controller.healthProbe.port | int | `8081` | The container port to use for http health probe. | |
| 51 | +| controller.image.digest | string | `"sha256:157f478f5db1fe999f5e2d27badcc742bf51cc470508b3cebe78224d0947674f"` | SHA256 digest of the controller image. | |
| 52 | +| controller.image.repository | string | `"public.ecr.aws/karpenter/controller"` | Repository path to the controller image. | |
| 53 | +| controller.image.tag | string | `"0.37.0"` | Tag of the controller image. | |
| 54 | +| controller.metrics.port | int | `8080` | The container port to use for metrics. | |
| 55 | +| controller.resources | object | `{}` | Resources for the controller pod. | |
| 56 | +| controller.sidecarContainer | list | `[]` | Additional sidecarContainer config | |
| 57 | +| controller.sidecarVolumeMounts | list | `[]` | Additional volumeMounts for the sidecar - this will be added to the volume mounts on top of extraVolumeMounts | |
| 58 | +| dnsConfig | object | `{}` | Configure DNS Config for the pod | |
| 59 | +| dnsPolicy | string | `"ClusterFirst"` | Configure the DNS Policy for the pod | |
| 60 | +| extraVolumes | list | `[]` | Additional volumes for the pod. | |
| 61 | +| fullnameOverride | string | `""` | Overrides the chart's computed fullname. | |
| 62 | +| hostNetwork | bool | `false` | Bind the pod to the host network. This is required when using a custom CNI. | |
| 63 | +| imagePullPolicy | string | `"IfNotPresent"` | Image pull policy for Docker images. | |
| 64 | +| imagePullSecrets | list | `[]` | Image pull secrets for Docker images. | |
| 65 | +| logErrorOutputPaths | list | `["stderr"]` | Log errorOutputPaths - defaults to stderr only | |
| 66 | +| logLevel | string | `"info"` | Global log level, defaults to 'info' | |
| 67 | +| logOutputPaths | list | `["stdout"]` | Log outputPaths - defaults to stdout only | |
| 68 | +| nameOverride | string | `""` | Overrides the chart's name. | |
| 69 | +| nodeSelector | object | `{"kubernetes.io/os":"linux"}` | Node selectors to schedule the pod to nodes with labels. | |
| 70 | +| podAnnotations | object | `{}` | Additional annotations for the pod. | |
| 71 | +| podDisruptionBudget.maxUnavailable | int | `1` | | |
| 72 | +| podDisruptionBudget.name | string | `"karpenter"` | | |
| 73 | +| podLabels | object | `{}` | Additional labels for the pod. | |
| 74 | +| podSecurityContext | object | `{"fsGroup":65532}` | SecurityContext for the pod. | |
| 75 | +| postInstallHook.image.digest | string | `"sha256:13a2ad1bd37ce42ee2a6f1ab0d30595f42eb7fe4a90d6ec848550524104a1ed6"` | SHA256 digest of the post-install hook image. | |
| 76 | +| postInstallHook.image.repository | string | `"public.ecr.aws/bitnami/kubectl"` | Repository path to the post-install hook. This minimally needs to have `kubectl` installed | |
| 77 | +| postInstallHook.image.tag | string | `"1.30"` | Tag of the post-install hook image. | |
| 78 | +| priorityClassName | string | `"system-cluster-critical"` | PriorityClass name for the pod. | |
| 79 | +| replicas | int | `2` | Number of replicas. | |
| 80 | +| revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain to allow rollback. | |
| 81 | +| serviceAccount.annotations | object | `{}` | Additional annotations for the ServiceAccount. | |
| 82 | +| serviceAccount.create | bool | `true` | Specifies if a ServiceAccount should be created. | |
| 83 | +| serviceAccount.name | string | `""` | The name of the ServiceAccount to use. If not set and create is true, a name is generated using the fullname template. | |
| 84 | +| serviceMonitor.additionalLabels | object | `{}` | Additional labels for the ServiceMonitor. | |
| 85 | +| serviceMonitor.enabled | bool | `false` | Specifies whether a ServiceMonitor should be created. | |
| 86 | +| serviceMonitor.endpointConfig | object | `{}` | Configuration on `http-metrics` endpoint for the ServiceMonitor. Not to be used to add additional endpoints. See the Prometheus operator documentation for configurable fields https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint | |
| 87 | +| settings | object | `{"batchIdleDuration":"1s","batchMaxDuration":"10s","clusterCABundle":"","clusterEndpoint":"","clusterName":"","featureGates":{"spotToSpotConsolidation":false},"interruptionQueue":"","isolatedVPC":false,"reservedENIs":"0","vmMemoryOverheadPercent":0.075}` | Global Settings to configure Karpenter | |
| 88 | +| settings.batchIdleDuration | string | `"1s"` | The maximum amount of time with no new ending pods that if exceeded ends the current batching window. If pods arrive faster than this time, the batching window will be extended up to the maxDuration. If they arrive slower, the pods will be batched separately. | |
| 89 | +| settings.batchMaxDuration | string | `"10s"` | The maximum length of a batch window. The longer this is, the more pods we can consider for provisioning at one time which usually results in fewer but larger nodes. | |
| 90 | +| settings.clusterCABundle | string | `""` | Cluster CA bundle for TLS configuration of provisioned nodes. If not set, this is taken from the controller's TLS configuration for the API server. | |
| 91 | +| settings.clusterEndpoint | string | `""` | Cluster endpoint. If not set, will be discovered during startup (EKS only) | |
| 92 | +| settings.clusterName | string | `""` | Cluster name. | |
| 93 | +| settings.featureGates | object | `{"spotToSpotConsolidation":false}` | Feature Gate configuration values. Feature Gates will follow the same graduation process and requirements as feature gates in Kubernetes. More information here https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features | |
| 94 | +| settings.featureGates.spotToSpotConsolidation | bool | `false` | spotToSpotConsolidation is ALPHA and is disabled by default. Setting this to true will enable spot replacement consolidation for both single and multi-node consolidation. | |
| 95 | +| settings.interruptionQueue | string | `""` | Interruption queue is the name of the SQS queue used for processing interruption events from EC2 Interruption handling is disabled if not specified. Enabling interruption handling may require additional permissions on the controller service account. Additional permissions are outlined in the docs. | |
| 96 | +| settings.isolatedVPC | bool | `false` | If true then assume we can't reach AWS services which don't have a VPC endpoint This also has the effect of disabling look-ups to the AWS pricing endpoint | |
| 97 | +| settings.reservedENIs | string | `"0"` | Reserved ENIs are not included in the calculations for max-pods or kube-reserved This is most often used in the VPC CNI custom networking setup https://docs.aws.amazon.com/eks/latest/userguide/cni-custom-network.html | |
| 98 | +| settings.vmMemoryOverheadPercent | float | `0.075` | The VM memory overhead as a percent that will be subtracted from the total memory for all instance types | |
| 99 | +| strategy | object | `{"rollingUpdate":{"maxUnavailable":1}}` | Strategy for updating the pod. | |
| 100 | +| terminationGracePeriodSeconds | string | `nil` | Override the default termination grace period for the pod. | |
| 101 | +| tolerations | list | `[{"key":"CriticalAddonsOnly","operator":"Exists"}]` | Tolerations to allow the pod to be scheduled to nodes with taints. | |
| 102 | +| topologySpreadConstraints | list | `[{"maxSkew":1,"topologyKey":"topology.kubernetes.io/zone","whenUnsatisfiable":"DoNotSchedule"}]` | Topology spread constraints to increase the controller resilience by distributing pods across the cluster zones. If an explicit label selector is not provided one will be created from the pod selector labels. | |
| 103 | +| webhook.enabled | bool | `true` | Whether to enable the webhooks and webhook permissions. | |
| 104 | +| webhook.metrics.port | int | `8001` | The container port to use for webhook metrics. | |
| 105 | +| webhook.port | int | `8443` | The container port to use for the webhook. | |
| 106 | + |
| 107 | +---------------------------------------------- |
| 108 | + |
| 109 | +Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs/). |
0 commit comments