KubeIP Helm chart

This repository is the canonical source and public Helm repository for KubeIP charts. Agent source and releases are maintained in doitintl/kubeip.

Install

helm repo add kubeip https://doitintl.github.io/kubeip-helm-chart/
helm repo update
helm upgrade --install kubeip kubeip/kubeip \
  --version 0.3.0 --namespace kube-system --values my-values.yaml

Chart 0.3.0 defaults to agent 2.4.0. Set image.repository without a tag and image.tag to select another agent version. Configure cloudProvider, provider credentials, and daemonSet.nodeSelector for your cluster before installation. See the agent setup guide for provider permissions.

When using taints, set daemonSet.env.TAINT_KEY and rbac.allowNodesPatchPermission=true. daemonSet.env.WAIT_FOR_NODE_ADDRESS defaults to true. Set it to false only when workloads can start after cloud assignment without waiting for Node status to advertise the IP.

Assignment label

Chart 0.3.0 adds daemonSet.env.LABEL_ASSIGNED_ADDRESS, disabled by default. Enable it with rbac.allowNodesPatchPermission=true and select an agent image containing --label-assigned-address. Agent 2.4.0 includes this feature and is the default image.

The feature restores the v1 kubip_assigned Node label without copying or deleting other labels. IPv4 dots become hyphens. The label is removed before address release and restored after successful assignment, including agent restarts. WAIT_FOR_NODE_ADDRESS also controls waiting before setting this label.

Publishing

This follows the DoiT EKS Lens pattern: GitHub Releases host chart archives, GitHub Pages serves the index, and helm/chart-releaser-action publishes using GITHUB_TOKEN. No Docker Hub or GHCR credentials are required.

1. Edit charts/kubeip, bump its chart version, and update appVersion and the default image tag when changing the agent version.
2. Merge the validated change into main.
3. The workflow packages the chart, creates a kubeip-<chart-version> release, updates the gh-pages index, and deploys it to GitHub Pages.
4. Verify helm pull kubeip/kubeip --version <chart-version> after updating the repository.

Existing release versions are skipped on reruns. Always bump the chart version when changing chart contents. The workflow can also be dispatched manually. Artifact Hub registration is optional and separate from hosting the chart.

AWS IPAM configuration

The chart exposes daemonSet.env.AWS_IPAM_POOL_ID (empty by default) and daemonSet.env.RELEASE_ON_EXIT (true by default). IPAM requires agent 2.4.0 or later, cloudProvider=aws, an empty daemonSet.env.FILTER, and Node patch permission. Leave the pool ID empty for GCP.

For AWS IPAM, set rbac.allowNodesPatchPermission=true and use RELEASE_ON_EXIT=false when checking restart reuse. With release enabled, normal shutdown returns owned allocations to the pool. See the AWS IPAM guide for IAM permissions, retained reservations after failure, manual recovery, and the AWS test matrix.

Metrics and GCP lifecycle settings

The chart also exposes daemonSet.env.METRICS_ADDRESS (empty), RECONCILE_INTERVAL (0s), and COMPLETION_TAINT_KEY (empty). These defaults disable the new behavior. They require agent 2.4.0 or later.

For GCP drift repair, use METRICS_ADDRESS=:8080, RECONCILE_INTERVAL=30s, RELEASE_ON_EXIT=false, and rbac.allowNodesPatchPermission=true. Leave AWS_IPAM_POOL_ID and COMPLETION_TAINT_KEY empty. The metrics listener can be scraped directly on the pod IP and configured port; this chart does not install a metrics Service or Prometheus resources.

For completion taints, leave RECONCILE_INTERVAL=0s, set a completion taint distinct from TAINT_KEY, and retain RELEASE_ON_EXIT=false and Node patch permission. Configure both taints on the node-pool template. Ordinary workloads tolerate the readiness taint but not completion; workloads requiring reserved addresses tolerate neither. Completion mode retains terminal state across restarts and removes its taint only after success or confirmed pool exhaustion. It cannot be combined with IPAM or drift repair. Follow the assignment lifecycle guide for failure cases, retained addresses and state reset procedures.