helmify

Helmify supports the following Kubernetes resource types:

• Workloads: Deployment, DaemonSet, StatefulSet, Job, CronJob
• Networking: Service, Ingress
• Storage: PersistentVolumeClaim
• RBAC: ServiceAccount, Role, ClusterRole, RoleBinding, ClusterRoleBinding
• Configuration: ConfigMap, Secret
• Webhooks: Certificate, Issuer, ValidatingWebhookConfiguration
• CRDs: CustomResourceDefinition

To add support for a new type of Kubernetes object in Helmify, follow these steps:

1. Implement the helmify.Processor interface. Place your implementation in the pkg/processor package.
2. Register your new processor in pkg/app/app.go.
3. Add a relevant input sample to test_data/kustomize.output to ensure it is processed correctly.

You can install Helmify using Homebrew on macOS or Linux, or by downloading the binary directly from the GitHub Releases page.

Homebrew:

brew install arttor/tap/helmify

Manual Installation:

1. Download the suitable binary for your system from the Releases page.
2. Unpack the binary.
3. Add the binary to your PATH.

Helmify converts Kubernetes manifests into Helm charts. It accepts a CHART_NAME as an optional argument (defaults to chart). You can provide manifests via stdin (piping) or via the -f flag.

Using Pipes (stdin)

# From a single file
cat my-app.yaml | helmify mychart

# From all yaml files in a directory
awk 'FNR==1 && NR!=1  {print "---"}{print}' /<my_directory>/*.yaml | helmify mychart

# From Kustomize output
kustomize build <kustomize_dir> | helmify mychart

Using Filesystem Flags

# Single file
helmify -f /my_directory/my-app.yaml mychart

# Entire directory
helmify -f /my_directory mychart

# Recursive directory scan
helmify -f /my_directory -r mychart

# Multiple sources (files and directories)
helmify -f ./first_dir -f ./second_dir/my_deployment.yaml -f ./third_dir mychart

Helmify provides two mutually exclusive ways to handle Custom Resource Definitions (CRDs). You cannot use --crd-dir and --optional-crds at the same time.

1. Using the crds/ directory: Use --crd-dir. This places CRDs into a crds directory within the chart.
   • Note: Helm does not template files in the crds/ directory. This is recommended for following Helm best practices for CRDs.
2. Using optional CRDs via values: Use --optional-crds. This enables optional CRD installation through the values.yaml file.

Helmify converts Kubernetes resources from standard input (stdin) or specified files/directories into a Helm chart.

Basic Usage: helmify [flags] CHART_NAME

• CHART_NAME is optional. If omitted, the default is chart.
• CHART_NAME can be a path, e.g., deploy/charts/mychart.

You can use helmify to convert the output of tools like Operator-SDK or Kubebuilder (e.g., Kustomize outputs) into a Helm chart. This is useful for packaging operators for distribution via Helm.

To generate a chart from a Kustomize output file, pipe the content into the helmify command followed by the desired output directory.

cat test_data/k8s-operator-kustomize.output | go run ./cmd/helmify examples/operator

You can use helmify to convert standard Kubernetes manifests (containing Deployments, Services, ConfigMaps, Secrets, etc.) into a Helm chart.

To generate a chart from a YAML file, pipe the file content into the helmify command followed by the desired output directory.

cat test_data/sample-app.yaml | go run ./cmd/helmify examples/app