helm
Purpose
Helm is a package manager for Kubernetes, enabling users to define, install, and upgrade applications using charts. It simplifies managing Kubernetes resources by packaging them into reusable templates.
When to Use
Use Helm for deploying and managing applications on Kubernetes clusters, especially when handling multiple environments, versioning dependencies, or automating deployments. Ideal for DevOps workflows involving microservices, where consistent application packaging is needed, such as in CI/CD pipelines for scalable apps.
Key Capabilities
- Package applications as charts, which are directories containing YAML manifests and templates.
- Support for chart repositories, allowing versioned storage and retrieval.
- Templating engine to customize deployments with values files (e.g., YAML format for overriding parameters).
- Rollback and upgrade features for managing release lifecycles.
- Integration with Kubernetes RBAC for secure operations.
Usage Patterns
To use Helm, first ensure Kubernetes access via
or set the
environment variable (e.g.,
export KUBECONFIG=~/.kube/config
). Initialize Helm with
if needed, then add repositories and install charts. For custom deployments, create a chart with
, edit values.yaml, and install. Always specify the namespace with
flag for multi-tenant clusters.
Common Commands/API
Helm operates via CLI commands; no direct REST API exists, but it interacts with Kubernetes API server.
- Install a chart:
helm install myrelease stable/nginx --set service.type=LoadBalancer --namespace dev
- Flags: for inline overrides, for external YAML file (e.g.,
helm install --values values.yaml
- Upgrade a release:
helm upgrade myrelease stable/nginx --set replicas=3
- Use for rollback on failure.
- List releases:
helm list --all-namespaces
- Delete a release:
helm uninstall myrelease --namespace dev
- Search repositories:
Code snippet for a basic values.yaml file:
replicaCount: 2
image:
repository: nginx
tag: latest
To add a repository:
helm repo add stable https://charts.helm.sh/stable
, then update with
.
Integration Notes
Helm integrates with Kubernetes tools; ensure your cluster is accessible via the Kubernetes API. For authentication, use
for client certificates or tokens. In CI/CD (e.g., GitHub Actions), run Helm in a container with
installed: set env var like
export HELM_REPOSITORY_CONFIG=repo.yaml
. For Terraform integration, use Helm provider: define in HCL as
resource "helm_release" "nginx" { name = "myrelease" chart = "stable/nginx" set { name = "service.type" value = "LoadBalancer" } }
. Avoid conflicts by using Helm's
flag with Kubernetes operators.
Error Handling
Common errors include "chart not found" (fix by running
), permission issues (ensure RBAC via
kubectl create clusterrolebinding
), or failed hooks (check with
). For deployment failures, use
helm history release-name
to review revisions, then rollback with
helm rollback release-name 0
. If a chart install errors due to invalid values, validate YAML first with a linter like
. Always check Kubernetes events with
kubectl get events --namespace dev
for root causes.
Concrete Usage Examples
- Install a WordPress chart: Add the repo with
helm repo add bitnami https://charts.bitnami.com/bitnami
helm install mywordpress bitnami/wordpress --set wordpressUsername=admin --set wordpressPassword=$WP_PASSWORD --namespace web
- Upgrade an existing MongoDB release: First, install with
helm install mymongo bitnami/mongodb --set auth.enabled=true
helm upgrade mymongo bitnami/mongodb --set resources.requests.memory=512Mi --namespace db
Graph Relationships
- Related to: kubernetes (core dependency for deployments)
- Co-located in: devops-sre cluster (shared with tools like kubectl, terraform)
- Tagged with: helm, kubernetes, package-manager (links to similar skills in the cluster)