content large_stringlengths 3 20.5k | url large_stringlengths 54 193 | branch large_stringclasses 4
values | source large_stringclasses 42
values | embeddings listlengths 384 384 | score float64 -0.21 0.65 |
|---|---|---|---|---|---|
auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output -h, --help help for helm --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm completion](/helm/helm\_completion.md) - generate autocompletion scripts for the specified shell \* [helm create](/helm/helm\_create.md) - create a new chart with the given name \* [helm dependency](/helm/helm\_dependency.md) - manage a chart's dependencies \* [helm env](/helm/helm\_env.md) - helm client environment information \* [helm get](/helm/helm\_get.md) - download extended information of a named release \* [helm history](/helm/helm\_history.md) - fetch release history \* [helm install](/helm/helm\_install.md) - install a chart \* [helm lint](/helm/helm\_lint.md) - examine a chart for possible issues \* [helm list](/helm/helm\_list.md) - list releases \* [helm package](/helm/helm\_package.md) - package a chart directory into a chart archive \* [helm plugin](/helm/helm\_plugin.md) - install, list, or uninstall Helm plugins \* [helm pull](/helm/helm\_pull.md) - download a chart from a repository and (optionally) unpack it in local directory \* [helm push](/helm/helm\_push.md) - push a chart to remote \* [helm registry](/helm/helm\_registry.md) - login to or logout from a registry \* [helm repo](/helm/helm\_repo.md) - add, list, remove, update, and index chart repositories \* [helm rollback](/helm/helm\_rollback.md) - roll back a release to a previous revision \* [helm search](/helm/helm\_search.md) - search for a keyword in charts \* [helm show](/helm/helm\_show.md) - show information of a chart \* [helm status](/helm/helm\_status.md) - display the status of the named release \* [helm template](/helm/helm\_template.md) - locally render templates \* [helm test](/helm/helm\_test.md) - run tests for a release \* [helm uninstall](/helm/helm\_uninstall.md) - uninstall a release \* [helm upgrade](/helm/helm\_upgrade.md) - upgrade a release \* [helm verify](/helm/helm\_verify.md) - verify that a chart at the given path has been signed and is valid \* [helm version](/helm/helm\_version.md) - print the helm version information ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm.md | main | helm | [
0.0021296602208167315,
0.07429810613393784,
-0.022605687379837036,
-0.037414804100990295,
-0.05518227443099022,
-0.05785547196865082,
0.028224701061844826,
-0.04248310998082161,
0.12536461651325226,
0.027063900604844093,
0.005711243953555822,
-0.10748787969350815,
0.05966725945472717,
0.00... | 0.051604 |
fetch release history ### Synopsis History prints historical revisions for a given release. A default maximum of 256 revisions will be returned. Setting '--max' configures the maximum length of the revision list returned. The historical release set is printed as a formatted table, e.g: $ helm history angry-bird REVISION UPDATED STATUS CHART APP VERSION DESCRIPTION 1 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 1.0 Initial install 2 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 1.0 Upgraded successfully 3 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 1.0 Rolled back to 2 4 Mon Oct 3 10:15:13 2016 deployed alpine-0.1.0 1.0 Upgraded successfully ``` helm history RELEASE\_NAME [flags] ``` ### Options ``` -h, --help help for history --max int maximum number of revision to include in history (default 256) -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_history.md | main | helm | [
0.022639025002717972,
0.08126650750637054,
-0.011773907579481602,
-0.011688446626067162,
0.02395663596689701,
-0.013073290698230267,
-0.11825353652238846,
-0.014628082513809204,
-0.019246159121394157,
0.04821362718939781,
0.014290699735283852,
-0.0019468509126454592,
-0.013865008018910885,
... | -0.015866 |
update charts/ based on the contents of Chart.yaml ### Synopsis Update the on-disk dependencies to mirror Chart.yaml. This command verifies that the required charts, as expressed in 'Chart.yaml', are present in 'charts/' and are at an acceptable version. It will pull down the latest charts that satisfy the dependencies, and clean up old dependencies. On successful update, this will generate a lock file that can be used to rebuild the dependencies to an exact version. Dependencies are not required to be represented in 'Chart.yaml'. For that reason, an update command will not remove charts unless they are (a) present in the Chart.yaml file, but (b) at the wrong version. ``` helm dependency update CHART [flags] ``` ### Options ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file -h, --help help for update --insecure-skip-tls-verify skip tls certificate checks for the chart download --key-file string identify HTTPS client using this SSL key file --keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg") --password string chart repository password where to locate the requested chart --plain-http use insecure HTTP connections for the chart download --skip-refresh do not refresh the local repository cache --username string chart repository username where to locate the requested chart --verify verify the packages against signatures ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm dependency](/helm/helm\_dependency.md) - manage a chart's dependencies ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_dependency_update.md | main | helm | [
-0.00026017194613814354,
0.01279041264206171,
0.06542100012302399,
-0.0733771026134491,
0.05436418578028679,
-0.04489900544285774,
-0.05300428345799446,
-0.056041814386844635,
0.039156753569841385,
0.055404357612133026,
0.08364169299602509,
0.027502302080392838,
-0.020063865929841995,
-0.0... | -0.051636 |
show the chart's README ### Synopsis This command inspects a chart (directory, file, or URL) and displays the contents of the README file ``` helm show readme [CHART] [flags] ``` ### Options ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored -h, --help help for readme --insecure-skip-tls-verify skip tls certificate checks for the chart download --key-file string identify HTTPS client using this SSL key file --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") --pass-credentials pass credentials to all domains --password string chart repository password where to locate the requested chart --plain-http use insecure HTTP connections for the chart download --repo string chart repository url where to locate the requested chart --username string chart repository username where to locate the requested chart --verify verify the package before using it --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm show](/helm/helm\_show.md) - show information of a chart ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_show_readme.md | main | helm | [
-0.015140273608267307,
0.055255092680454254,
-0.04963642358779907,
-0.05126192420721054,
0.017550982534885406,
-0.04453817754983902,
-0.010572841390967369,
-0.005174926016479731,
0.0026529040187597275,
0.004711843561381102,
0.015483396127820015,
-0.019898168742656708,
0.024328771978616714,
... | -0.040336 |
install a chart ### Synopsis This command installs a chart archive. The install argument must be a chart reference, a path to a packaged chart, a path to an unpacked chart directory or a URL. To override values in a chart, use either the '--values' flag and pass in a file or use the '--set' flag and pass configuration from the command line, to force a string value use '--set-string'. You can use '--set-file' to set individual values from a file when the value itself is too long for the command line or is dynamically generated. You can also use '--set-json' to set json values (scalars/objects/arrays) from the command line. Additionally, you can use '--set-json' and passing json object as a string. $ helm install -f myvalues.yaml myredis ./redis or $ helm install --set name=prod myredis ./redis or $ helm install --set-string long\_int=1234567890 myredis ./redis or $ helm install --set-file my\_script=dothings.sh myredis ./redis or $ helm install --set-json 'master.sidecars=[{"name":"sidecar","image":"myImage","imagePullPolicy":"Always","ports":[{"name":"portname","containerPort":1234}]}]' myredis ./redis or $ helm install --set-json '{"master":{"sidecars":[{"name":"sidecar","image":"myImage","imagePullPolicy":"Always","ports":[{"name":"portname","containerPort":1234}]}]}}' myredis ./redis You can specify the '--values'/'-f' flag multiple times. The priority will be given to the last (right-most) file specified. For example, if both myvalues.yaml and override.yaml contained a key called 'Test', the value set in override.yaml would take precedence: $ helm install -f myvalues.yaml -f override.yaml myredis ./redis You can specify the '--set' flag multiple times. The priority will be given to the last (right-most) set specified. For example, if both 'bar' and 'newbar' values are set for a key called 'foo', the 'newbar' value would take precedence: $ helm install --set foo=bar --set foo=newbar myredis ./redis Similarly, in the following example 'foo' is set to '["four"]': $ helm install --set-json='foo=["one", "two", "three"]' --set-json='foo=["four"]' myredis ./redis And in the following example, 'foo' is set to '{"key1":"value1","key2":"bar"}': $ helm install --set-json='foo={"key1":"value1","key2":"value2"}' --set-json='foo.key2="bar"' myredis ./redis To check the generated manifests of a release without installing the chart, the --debug and --dry-run flags can be combined. The --dry-run flag will output all generated chart manifests, including Secrets which can contain sensitive values. To hide Kubernetes Secrets use the --hide-secret flag. Please carefully consider how and when these flags are used. If --verify is set, the chart MUST have a provenance file, and the provenance file MUST pass all verification steps. There are six different ways you can express the chart you want to install: 1. By chart reference: helm install mymaria example/mariadb 2. By path to a packaged chart: helm install mynginx ./nginx-1.2.3.tgz 3. By path to an unpacked chart directory: helm install mynginx ./nginx 4. By absolute URL: helm install mynginx https://example.com/charts/nginx-1.2.3.tgz 5. By chart reference and repo url: helm install --repo https://example.com/charts/ mynginx nginx 6. By OCI registries: helm install mynginx --version 1.2.3 oci://example.com/charts/nginx CHART REFERENCES A chart reference is a convenient way of referencing a chart in a chart repository. When you use a chart reference with a repo prefix ('example/mariadb'), Helm will look in the local configuration for a chart repository named 'example', and will then look for a chart in that repository whose name is 'mariadb'. It will install the latest stable version of that chart until you specify '--devel' flag to also include development version (alpha, beta, and release candidate releases), or supply a version number with the '--version' flag. To see the list of chart repositories, use 'helm repo list'. To search for charts in a repository, use 'helm search'. ``` helm install [NAME] [CHART] [flags] ``` ### Options ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file --create-namespace create the release namespace if | https://github.com/helm/helm-www/blob/main//docs/helm/helm_install.md | main | helm | [
0.05215767025947571,
0.03068404830992222,
-0.03968830034136772,
-0.037547800689935684,
-0.04423285648226738,
0.005250632297247648,
-0.015617449767887592,
0.09973158687353134,
-0.021816642954945564,
0.027860933914780617,
0.016552072018384933,
-0.03270445019006729,
0.031103884801268578,
-0.0... | -0.017624 |
'helm repo list'. To search for charts in a repository, use 'helm search'. ``` helm install [NAME] [CHART] [flags] ``` ### Options ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file --create-namespace create the release namespace if not present --dependency-update update dependencies if they are missing before installing the chart --description string add a custom description --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored --disable-openapi-validation if set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema --dry-run string[="unset"] simulates the operation without persisting changes. Must be one of: "none" (default), "client", or "server". '--dry-run=none' executes the operation normally and persists changes (no simulation). '--dry-run=client' simulates the operation client-side only and avoids cluster connections. '--dry-run=server' simulates the operation on the server, requiring cluster connectivity. (default "none") --enable-dns enable DNS lookups when rendering templates --force-conflicts if set server-side apply will force changes against conflicts --force-replace force resource updates by replacement -g, --generate-name generate the name (and omit the NAME parameter) -h, --help help for install --hide-notes if set, do not show notes in install output. Does not affect presence in chart metadata --hide-secret hide Kubernetes Secrets when also using the --dry-run flag --insecure-skip-tls-verify skip tls certificate checks for the chart download --key-file string identify HTTPS client using this SSL key file --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") -l, --labels stringToString Labels that would be added to release metadata. Should be divided by comma. (default []) --name-template string specify template used to name the release --no-hooks prevent hooks from running during install -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) --pass-credentials pass credentials to all domains --password string chart repository password where to locate the requested chart --plain-http use insecure HTTP connections for the chart download --post-renderer postRendererString the name of a postrenderer type plugin to be used for post rendering. If it exists, the plugin will be used --post-renderer-args postRendererArgsSlice an argument to the post-renderer (can specify multiple) (default []) --render-subchart-notes if set, render subchart notes along with the parent --replace reuse the given name, only if that name is a deleted release which remains in the history. This is unsafe in production --repo string chart repository url where to locate the requested chart --rollback-on-failure if set, Helm will rollback (uninstall) the installation upon failure. The --wait flag will be default to "watcher" if --rollback-on-failure is set --server-side object updates run in the server instead of the client (default true) --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) --set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2) --set-json stringArray set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2 or using json format: {"key1": jsonval1, "key2": "jsonval2"}) --set-literal stringArray set a literal STRING value on the command line --set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) --skip-crds if set, no CRDs will be installed. By default, CRDs are installed if not already present --skip-schema-validation if set, disables JSON schema validation --take-ownership if set, install will ignore the check for helm annotations and take ownership of the existing resources --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) --username string chart repository username where to locate the requested chart -f, | https://github.com/helm/helm-www/blob/main//docs/helm/helm_install.md | main | helm | [
0.03179642930626869,
0.06537768989801407,
0.06511789560317993,
-0.024779608473181725,
0.037926845252513885,
-0.0031489029061049223,
-0.09568920731544495,
-0.03432045876979828,
0.1001269519329071,
0.03538661450147629,
0.02573106437921524,
-0.09066233783960342,
0.021211251616477966,
0.012401... | 0.020483 |
disables JSON schema validation --take-ownership if set, install will ignore the check for helm annotations and take ownership of the existing resources --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) --username string chart repository username where to locate the requested chart -f, --values strings specify values in a YAML file or a URL (can specify multiple) --verify verify the package before using it --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used --wait WaitStrategy[=watcher] if specified, will wait until all resources are in the expected state before marking the operation as successful. It will wait for as long as --timeout. Valid inputs are 'watcher' and 'legacy' (default hookOnly) --wait-for-jobs if set and --wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as --timeout ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_install.md | main | helm | [
0.007636903319507837,
0.026458796113729477,
0.043758828192949295,
-0.03777103126049042,
0.0500783808529377,
0.027149327099323273,
-0.054915886372327805,
-0.07615474611520767,
0.08974137902259827,
0.03852168843150139,
0.004018526989966631,
-0.03826714679598808,
-0.029654493555426598,
0.0063... | 0.087714 |
generate an index file given a directory containing packaged charts ### Synopsis Read the current directory, generate an index file based on the charts found and write the result to 'index.yaml' in the current directory. This tool is used for creating an 'index.yaml' file for a chart repository. To set an absolute URL to the charts, use '--url' flag. To merge the generated index with an existing index file, use the '--merge' flag. In this case, the charts found in the current directory will be merged into the index passed in with --merge, with local charts taking priority over existing charts. ``` helm repo index [DIR] [flags] ``` ### Options ``` -h, --help help for index --json output in JSON format --merge string merge the generated index into the given index --url string url of chart repository ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm repo](/helm/helm\_repo.md) - add, list, remove, update, and index chart repositories ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_repo_index.md | main | helm | [
0.009065463207662106,
0.04413846880197525,
0.007529989816248417,
-0.006345507688820362,
0.03483877331018448,
-0.0231008380651474,
0.00480234157294035,
0.04249105602502823,
0.042667463421821594,
0.03555462881922722,
0.06270689517259598,
0.005112331826239824,
0.00967206247150898,
-0.00989616... | 0.024773 |
download the values file for a named release ### Synopsis This command downloads a values file for a given release. ``` helm get values RELEASE\_NAME [flags] ``` ### Options ``` -a, --all dump all (computed) values -h, --help help for values -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) --revision int get the named release with revision ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm get](/helm/helm\_get.md) - download extended information of a named release ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_get_values.md | main | helm | [
0.032938383519649506,
0.11019157618284225,
-0.025259284302592278,
-0.033424779772758484,
0.03642510622739792,
-0.012468714267015457,
-0.024759838357567787,
0.013075611554086208,
0.07298126071691513,
0.0865786075592041,
0.05316464975476265,
-0.06839536130428314,
-0.011854753829538822,
-0.09... | 0.057475 |
download extended information of a named release ### Synopsis This command consists of multiple subcommands which can be used to get extended information about the release, including: - The values used to generate the release - The generated manifest file - The notes provided by the chart of the release - The hooks associated with the release - The metadata of the release ### Options ``` -h, --help help for get ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. \* [helm get all](/helm/helm\_get\_all.md) - download all information for a named release \* [helm get hooks](/helm/helm\_get\_hooks.md) - download all hooks for a named release \* [helm get manifest](/helm/helm\_get\_manifest.md) - download the manifest for a named release \* [helm get metadata](/helm/helm\_get\_metadata.md) - This command fetches metadata for a given release \* [helm get notes](/helm/helm\_get\_notes.md) - download the notes for a named release \* [helm get values](/helm/helm\_get\_values.md) - download the values file for a named release ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_get.md | main | helm | [
0.03154320642352104,
0.05853698030114174,
0.03653904050588608,
-0.04820152744650841,
0.05538153648376465,
-0.001164229353889823,
-0.0011154025560244918,
-0.00005350187711883336,
0.04489089921116829,
0.07629378139972687,
0.053526122123003006,
-0.053850967437028885,
-0.0019908950198441744,
-... | 0.142676 |
show the chart's values ### Synopsis This command inspects a chart (directory, file, or URL) and displays the contents of the values.yaml file ``` helm show values [CHART] [flags] ``` ### Options ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored -h, --help help for values --insecure-skip-tls-verify skip tls certificate checks for the chart download --jsonpath string supply a JSONPath expression to filter the output --key-file string identify HTTPS client using this SSL key file --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") --pass-credentials pass credentials to all domains --password string chart repository password where to locate the requested chart --plain-http use insecure HTTP connections for the chart download --repo string chart repository url where to locate the requested chart --username string chart repository username where to locate the requested chart --verify verify the package before using it --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm show](/helm/helm\_show.md) - show information of a chart ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_show_values.md | main | helm | [
-0.010015721432864666,
0.08337098360061646,
-0.05772385001182556,
-0.04945959523320198,
0.021563520655035973,
-0.04051436111330986,
-0.017149953171610832,
0.0016098872292786837,
0.019936582073569298,
-0.0010536792688071728,
0.02275434322655201,
-0.03739800304174423,
0.01643446646630764,
-0... | -0.033984 |
generate autocompletion script for fish ### Synopsis Generate the autocompletion script for Helm for the fish shell. To load completions in your current shell session: helm completion fish | source To load completions for every new session, execute once: helm completion fish > ~/.config/fish/completions/helm.fish You will need to start a new shell for this setup to take effect. ``` helm completion fish [flags] ``` ### Options ``` -h, --help help for fish --no-descriptions disable completion descriptions ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm completion](/helm/helm\_completion.md) - generate autocompletion scripts for the specified shell ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_completion_fish.md | main | helm | [
-0.0254714023321867,
0.06063589081168175,
0.011767816729843616,
-0.06109863892197609,
-0.021845396608114243,
0.01651597023010254,
0.020781036466360092,
0.00820381473749876,
0.007782590109854937,
-0.01898994855582714,
-0.02501949667930603,
-0.10282854735851288,
-0.011359049007296562,
-0.000... | 0.067181 |
run tests for a release ### Synopsis The test command runs the tests for a release. The argument this command takes is the name of a deployed release. The tests to be run are defined in the chart that was installed. ``` helm test [RELEASE] [flags] ``` ### Options ``` --filter strings specify tests by attribute (currently "name") using attribute=value syntax or '!attribute=value' to exclude a test (can specify multiple or separate values with commas: name=test1,name=test2) -h, --help help for test --logs dump the logs from test pods (this runs after all tests are complete, but before any cleanup) --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_test.md | main | helm | [
0.06412030011415482,
0.043255116790533066,
0.07398436963558197,
0.024180084466934204,
0.041968002915382385,
-0.039190396666526794,
-0.03434835746884346,
-0.020355990156531334,
0.01759946718811989,
0.05011756718158722,
0.043077025562524796,
-0.06253211945295334,
-0.03165923058986664,
-0.045... | 0.113832 |
download all information for a named release ### Synopsis This command prints a human readable collection of information about the notes, hooks, supplied values, and generated manifest file of the given release. ``` helm get all RELEASE\_NAME [flags] ``` ### Options ``` -h, --help help for all --revision int get the named release with revision --template string go template for formatting the output, eg: {{.Release.Name}} ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm get](/helm/helm\_get.md) - download extended information of a named release ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_get_all.md | main | helm | [
0.036600273102521896,
0.11279308050870895,
0.015054972842335701,
-0.04736042395234108,
0.04394037276506424,
0.009055373258888721,
-0.009643981233239174,
0.012787100858986378,
0.04329117387533188,
0.06368411332368851,
0.049517672508955,
-0.05377138778567314,
-0.031812433153390884,
-0.083142... | 0.086255 |
generate autocompletion scripts for the specified shell ### Synopsis Generate autocompletion scripts for Helm for the specified shell. ### Options ``` -h, --help help for completion ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. \* [helm completion bash](/helm/helm\_completion\_bash.md) - generate autocompletion script for bash \* [helm completion fish](/helm/helm\_completion\_fish.md) - generate autocompletion script for fish \* [helm completion powershell](/helm/helm\_completion\_powershell.md) - generate autocompletion script for powershell \* [helm completion zsh](/helm/helm\_completion\_zsh.md) - generate autocompletion script for zsh ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_completion.md | main | helm | [
0.008533571846783161,
0.07280649244785309,
0.010666884481906891,
-0.043230533599853516,
-0.004942497704178095,
-0.0012811024207621813,
0.03360004723072052,
0.0007309650536626577,
0.0478120781481266,
0.043122079223394394,
-0.006521696224808693,
-0.09848412871360779,
0.03850124776363373,
-0.... | 0.118169 |
print the helm version information ### Synopsis Show the version for Helm. This will print a representation the version of Helm. The output will look something like this: version.BuildInfo{Version:"v3.2.1", GitCommit:"fe51cd1e31e6a202cba7dead9552a6d418ded79a", GitTreeState:"clean", GoVersion:"go1.13.10"} - Version is the semantic version of the release. - GitCommit is the SHA for the commit that this version was built from. - GitTreeState is "clean" if there are no local code changes when this binary was built, and "dirty" if the binary was built from locally modified code. - GoVersion is the version of Go that was used to compile Helm. When using the --template flag the following properties are available to use in the template: - .Version contains the semantic version of Helm - .GitCommit is the git commit - .GitTreeState is the state of the git tree when Helm was built - .GoVersion contains the version of Go that Helm was compiled with For example, --template='Version: {{.Version}}' outputs 'Version: v3.2.1'. ``` helm version [flags] ``` ### Options ``` -h, --help help for version --short print the version number --template string template for version string format ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_version.md | main | helm | [
0.02709820494055748,
0.12046897411346436,
0.028545232489705086,
-0.050437379628419876,
0.09189546853303909,
-0.0055434186942875385,
-0.03312814608216286,
-0.0009440842550247908,
0.018742049112915993,
0.01880352757871151,
0.03291629999876022,
-0.01394637767225504,
-0.021614648401737213,
-0.... | 0.031201 |
login to a registry ### Synopsis Authenticate to a remote registry. For example for Github Container Registry: echo "$GITHUB\_TOKEN" | helm registry login ghcr.io -u $GITHUB\_USER --password-stdin ``` helm registry login [host] [flags] ``` ### Options ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify registry client using this SSL certificate file -h, --help help for login --insecure allow connections to TLS registry without certs --key-file string identify registry client using this SSL key file -p, --password string registry password or identity token --password-stdin read password or identity token from stdin --plain-http use insecure HTTP connections for the chart upload -u, --username string registry username ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm registry](/helm/helm\_registry.md) - login to or logout from a registry ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_registry_login.md | main | helm | [
-0.04274357482790947,
0.034363023936748505,
-0.09575618803501129,
-0.0627954751253128,
-0.016857044771313667,
0.014800562523305416,
-0.0032358868047595024,
0.06282446533441544,
0.00032610734342597425,
0.019093388691544533,
0.025594549253582954,
-0.04812268912792206,
0.061480339616537094,
0... | -0.003281 |
add, list, remove, update, and index chart repositories ### Synopsis This command consists of multiple subcommands to interact with chart repositories. It can be used to add, remove, list, and index chart repositories. ### Options ``` -h, --help help for repo ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. \* [helm repo add](/helm/helm\_repo\_add.md) - add a chart repository \* [helm repo index](/helm/helm\_repo\_index.md) - generate an index file given a directory containing packaged charts \* [helm repo list](/helm/helm\_repo\_list.md) - list chart repositories \* [helm repo remove](/helm/helm\_repo\_remove.md) - remove one or more chart repositories \* [helm repo update](/helm/helm\_repo\_update.md) - update information of available charts locally from chart repositories ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_repo.md | main | helm | [
0.019445596262812614,
0.04303716495633125,
0.003151797456666827,
-0.023032236844301224,
0.004912190139293671,
0.0008312285062856972,
-0.0044776578433811665,
-0.01219449657946825,
0.047260984778404236,
0.06689513474702835,
0.02441120520234108,
-0.049236468970775604,
0.030228266492486,
-0.05... | 0.149284 |
package a chart directory into a chart archive ### Synopsis This command packages a chart into a versioned chart archive file. If a path is given, this will look at that path for a chart (which must contain a Chart.yaml file) and then package that directory. Versioned chart archives are used by Helm package repositories. To sign a chart, use the '--sign' flag. In most cases, you should also provide '--keyring path/to/secret/keys' and '--key keyname'. $ helm package --sign ./mychart --key mykey --keyring ~/.gnupg/secring.gpg If '--keyring' is not specified, Helm usually defaults to the public keyring unless your environment is otherwise configured. ``` helm package [CHART\_PATH] [...] [flags] ``` ### Options ``` --app-version string set the appVersion on the chart to this version --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file -u, --dependency-update update dependencies from "Chart.yaml" to dir "charts/" before packaging -d, --destination string location to write the chart. (default ".") -h, --help help for package --insecure-skip-tls-verify skip tls certificate checks for the chart download --key string name of the key to use when signing. Used if --sign is true --key-file string identify HTTPS client using this SSL key file --keyring string location of a public keyring (default "~/.gnupg/pubring.gpg") --passphrase-file string location of a file which contains the passphrase for the signing key. Use "-" in order to read from stdin. --password string chart repository password where to locate the requested chart --plain-http use insecure HTTP connections for the chart download --sign use a PGP private key to sign this package --username string chart repository username where to locate the requested chart --version string set the version on the chart to this semver version ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_package.md | main | helm | [
0.046885374933481216,
0.03982171416282654,
-0.013761471025645733,
-0.0756724551320076,
0.029865117743611336,
-0.011265823617577553,
-0.002472253516316414,
0.03345121815800667,
0.054231639951467514,
0.028339261189103127,
0.05651519447565079,
-0.011606468819081783,
0.011361890472471714,
-0.0... | -0.085756 |
generate autocompletion script for zsh ### Synopsis Generate the autocompletion script for Helm for the zsh shell. To load completions in your current shell session: source <(helm completion zsh) To load completions for every new session, execute once: helm completion zsh > "${fpath[1]}/\_helm" ``` helm completion zsh [flags] ``` ### Options ``` -h, --help help for zsh --no-descriptions disable completion descriptions ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm completion](/helm/helm\_completion.md) - generate autocompletion scripts for the specified shell ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_completion_zsh.md | main | helm | [
-0.00433920044451952,
0.08488267660140991,
0.020015550777316093,
-0.02313079871237278,
0.04431113600730896,
-0.001717106788419187,
0.04895606264472008,
0.004100222606211901,
0.03268797695636749,
0.04782887175679207,
-0.029236583039164543,
-0.06588194519281387,
0.033611591905355453,
0.01212... | 0.078144 |
uninstall a release ### Synopsis This command takes a release name and uninstalls the release. It removes all of the resources associated with the last release of the chart as well as the release history, freeing it up for future use. Use the '--dry-run' flag to see which releases will be uninstalled without actually uninstalling them. ``` helm uninstall RELEASE\_NAME [...] [flags] ``` ### Options ``` --cascade string Must be "background", "orphan", or "foreground". Selects the deletion cascading strategy for the dependents. Defaults to background. (default "background") --description string add a custom description --dry-run simulate a uninstall -h, --help help for uninstall --ignore-not-found Treat "release not found" as a successful uninstall --keep-history remove all associated resources and mark the release as deleted, but retain the release history --no-hooks prevent hooks from running during uninstallation --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) --wait WaitStrategy[=watcher] if specified, will wait until all resources are in the expected state before marking the operation as successful. It will wait for as long as --timeout. Valid inputs are 'watcher' and 'legacy' (default hookOnly) ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_uninstall.md | main | helm | [
0.02217547968029976,
0.07366954535245895,
0.05573420226573944,
-0.030548566952347755,
0.1250060796737671,
-0.0038117405492812395,
-0.039969246834516525,
-0.04428042098879814,
0.027699122205376625,
0.009337612427771091,
0.08172690123319626,
0.027132803574204445,
-0.03653568774461746,
-0.021... | 0.053538 |
uninstall one or more Helm plugins ``` helm plugin uninstall ... [flags] ``` ### Options ``` -h, --help help for uninstall ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm plugin](/helm/helm\_plugin.md) - install, list, or uninstall Helm plugins ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_plugin_uninstall.md | main | helm | [
0.03598343953490257,
0.09264325350522995,
0.03453335165977478,
-0.05323394760489464,
0.03420179709792137,
-0.022891158238053322,
-0.05172467231750488,
-0.02736736834049225,
0.09325399249792099,
0.0593588650226593,
0.006822817958891392,
-0.03851861506700516,
0.00600894819945097,
-0.02695173... | 0.074904 |
search for charts in the Artifact Hub or your own hub instance ### Synopsis Search for Helm charts in the Artifact Hub or your own hub instance. Artifact Hub is a web-based application that enables finding, installing, and publishing packages and configurations for CNCF projects, including publicly available distributed charts Helm charts. It is a Cloud Native Computing Foundation sandbox project. You can browse the hub at https://artifacthub.io/ The [KEYWORD] argument accepts either a keyword string, or quoted string of rich query options. For rich query options documentation, see https://artifacthub.github.io/hub/api/?urls.primaryName=Monocular%20compatible%20search%20API#/Monocular/get\_api\_chartsvc\_v1\_charts\_search Previous versions of Helm used an instance of Monocular as the default 'endpoint', so for backwards compatibility Artifact Hub is compatible with the Monocular search API. Similarly, when setting the 'endpoint' flag, the specified endpoint must also be implement a Monocular compatible search API endpoint. Note that when specifying a Monocular instance as the 'endpoint', rich queries are not supported. For API details, see https://github.com/helm/monocular ``` helm search hub [KEYWORD] [flags] ``` ### Options ``` --endpoint string Hub instance to query for charts (default "https://hub.helm.sh") --fail-on-no-result search fails if no results are found -h, --help help for hub --list-repo-url print charts repository URL --max-col-width uint maximum column width for output table (default 50) -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm search](/helm/helm\_search.md) - search for a keyword in charts ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_search_hub.md | main | helm | [
0.03505472466349602,
0.010527336038649082,
0.020543886348605156,
-0.009320303797721863,
0.07397600263357162,
-0.005989122670143843,
-0.13546675443649292,
0.04158397391438484,
0.008922970853745937,
0.04844698682427406,
-0.033605288714170456,
-0.07550009340047836,
0.06430182605981827,
-0.006... | 0.019147 |
helm client environment information ### Synopsis Env prints out all the environment information in use by Helm. ``` helm env [flags] ``` ### Options ``` -h, --help help for env ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_env.md | main | helm | [
0.04878879338502884,
0.09858985990285873,
0.027478231117129326,
-0.04786926135420799,
0.03615942224860191,
-0.036191508173942566,
-0.0006906790076754987,
0.005117423366755247,
0.08070256561040878,
0.057765163481235504,
-0.020391741767525673,
-0.06740905344486237,
0.03741844370961189,
-0.05... | 0.088686 |
install, list, or uninstall Helm plugins ### Synopsis Manage client-side Helm plugins. ### Options ``` -h, --help help for plugin ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. \* [helm plugin install](/helm/helm\_plugin\_install.md) - install a Helm plugin \* [helm plugin list](/helm/helm\_plugin\_list.md) - list installed Helm plugins \* [helm plugin package](/helm/helm\_plugin\_package.md) - package a plugin directory into a plugin archive \* [helm plugin uninstall](/helm/helm\_plugin\_uninstall.md) - uninstall one or more Helm plugins \* [helm plugin update](/helm/helm\_plugin\_update.md) - update one or more Helm plugins \* [helm plugin verify](/helm/helm\_plugin\_verify.md) - verify that a plugin at the given path has been signed and is valid ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_plugin.md | main | helm | [
0.027855098247528076,
0.07568701356649399,
0.022913886234164238,
-0.05231121927499771,
0.014349046163260937,
-0.008839961141347885,
-0.03021186962723732,
-0.009570101276040077,
0.06916920095682144,
0.06474091112613678,
-0.0019950249698013067,
-0.057800956070423126,
0.02863483689725399,
-0.... | 0.089857 |
search repositories for a keyword in charts ### Synopsis Search reads through all of the repositories configured on the system, and looks for matches. Search of these repositories uses the metadata stored on the system. It will display the latest stable versions of the charts found. If you specify the --devel flag, the output will include pre-release versions. If you want to search using a version constraint, use --version. Examples: # Search for stable release versions matching the keyword "nginx" $ helm search repo nginx # Search for release versions matching the keyword "nginx", including pre-release versions $ helm search repo nginx --devel # Search for the latest stable release for nginx-ingress with a major version of 1 $ helm search repo nginx-ingress --version ^1.0.0 Repositories are managed with 'helm repo' commands. ``` helm search repo [keyword] [flags] ``` ### Options ``` --devel use development versions (alpha, beta, and release candidate releases), too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored --fail-on-no-result search fails if no results are found -h, --help help for repo --max-col-width uint maximum column width for output table (default 50) -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) -r, --regexp use regular expressions for searching repositories you have added --version string search using semantic versioning constraints on repositories you have added -l, --versions show the long listing, with each version of each chart on its own line, for repositories you have added ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm search](/helm/helm\_search.md) - search for a keyword in charts ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_search_repo.md | main | helm | [
-0.008257187902927399,
0.024321051314473152,
0.052707571536302567,
-0.036265596747398376,
0.0744873583316803,
0.009975219145417213,
-0.026536937803030014,
-0.06920270621776581,
0.0375845804810524,
0.06500610709190369,
0.01384138036519289,
0.000015237093066389207,
-0.026809895411133766,
-0.... | 0.056128 |
rebuild the charts/ directory based on the Chart.lock file ### Synopsis Build out the charts/ directory from the Chart.lock file. Build is used to reconstruct a chart's dependencies to the state specified in the lock file. This will not re-negotiate dependencies, as 'helm dependency update' does. If no lock file is found, 'helm dependency build' will mirror the behavior of 'helm dependency update'. ``` helm dependency build CHART [flags] ``` ### Options ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file -h, --help help for build --insecure-skip-tls-verify skip tls certificate checks for the chart download --key-file string identify HTTPS client using this SSL key file --keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg") --password string chart repository password where to locate the requested chart --plain-http use insecure HTTP connections for the chart download --skip-refresh do not refresh the local repository cache --username string chart repository username where to locate the requested chart --verify verify the packages against signatures ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm dependency](/helm/helm\_dependency.md) - manage a chart's dependencies ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_dependency_build.md | main | helm | [
-0.04243133217096329,
0.04282194375991821,
0.008248590864241123,
-0.04351288825273514,
0.03089717961847782,
0.0005553572555072606,
-0.03172629699110985,
-0.03362252190709114,
0.021665317937731743,
0.03829380124807358,
0.038894131779670715,
-0.005937024485319853,
0.014208720065653324,
-0.03... | -0.066642 |
show the chart's definition ### Synopsis This command inspects a chart (directory, file, or URL) and displays the contents of the Chart.yaml file ``` helm show chart [CHART] [flags] ``` ### Options ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored -h, --help help for chart --insecure-skip-tls-verify skip tls certificate checks for the chart download --key-file string identify HTTPS client using this SSL key file --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") --pass-credentials pass credentials to all domains --password string chart repository password where to locate the requested chart --plain-http use insecure HTTP connections for the chart download --repo string chart repository url where to locate the requested chart --username string chart repository username where to locate the requested chart --verify verify the package before using it --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm show](/helm/helm\_show.md) - show information of a chart ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_show_chart.md | main | helm | [
-0.009359939023852348,
0.05615392327308655,
-0.0460587702691555,
-0.054761793464422226,
0.018393658101558685,
-0.043383676558732986,
-0.020201439037919044,
-0.011754630133509636,
0.015016602352261543,
0.004793365020304918,
0.025238122791051865,
-0.018764710053801537,
0.018467385321855545,
... | -0.038508 |
search for a keyword in charts ### Synopsis Search provides the ability to search for Helm charts in the various places they can be stored including the Artifact Hub and repositories you have added. Use search subcommands to search different locations for charts. ### Options ``` -h, --help help for search ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. \* [helm search hub](/helm/helm\_search\_hub.md) - search for charts in the Artifact Hub or your own hub instance \* [helm search repo](/helm/helm\_search\_repo.md) - search repositories for a keyword in charts ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_search.md | main | helm | [
0.05254986882209778,
0.05527434125542641,
0.01415188703685999,
-0.034774232655763626,
0.04219130799174309,
-0.0010992155876010656,
-0.02729933150112629,
-0.012019574642181396,
0.04675671085715294,
0.03679118677973747,
0.008355725556612015,
-0.06633994728326797,
0.0825888141989708,
-0.05650... | 0.080009 |
update one or more Helm plugins ``` helm plugin update ... [flags] ``` ### Options ``` -h, --help help for update ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm plugin](/helm/helm\_plugin.md) - install, list, or uninstall Helm plugins ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_plugin_update.md | main | helm | [
0.02747253142297268,
0.06415609270334244,
0.020148584619164467,
-0.049991264939308167,
0.01175097469240427,
-0.018028590828180313,
-0.03047507256269455,
-0.011243682354688644,
0.057450372725725174,
0.07415835559368134,
0.014601127244532108,
-0.059983618557453156,
0.036799345165491104,
-0.0... | 0.063524 |
generate autocompletion script for bash ### Synopsis Generate the autocompletion script for Helm for the bash shell. To load completions in your current shell session: source <(helm completion bash) To load completions for every new session, execute once: - Linux: helm completion bash > /etc/bash\_completion.d/helm - MacOS: helm completion bash > /usr/local/etc/bash\_completion.d/helm ``` helm completion bash [flags] ``` ### Options ``` -h, --help help for bash --no-descriptions disable completion descriptions ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm completion](/helm/helm\_completion.md) - generate autocompletion scripts for the specified shell ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_completion_bash.md | main | helm | [
0.0022545817773789167,
0.06561839580535889,
0.02085909992456436,
-0.03972240537405014,
0.05011792108416557,
0.0005238693556748331,
0.06595303118228912,
0.026919174939393997,
0.016842082142829895,
0.025362618267536163,
-0.006166179198771715,
-0.04777824878692627,
0.02802865393459797,
0.0026... | 0.10732 |
verify that a chart at the given path has been signed and is valid ### Synopsis Verify that the given chart has a valid provenance file. Provenance files provide cryptographic verification that a chart has not been tampered with, and was packaged by a trusted provider. This command can be used to verify a local chart. Several other commands provide '--verify' flags that run the same validation. To generate a signed package, use the 'helm package --sign' command. ``` helm verify PATH [flags] ``` ### Options ``` -h, --help help for verify --keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg") ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_verify.md | main | helm | [
-0.016732430085539818,
0.0606338195502758,
-0.04032420367002487,
-0.08562086522579193,
0.046100616455078125,
-0.03662918508052826,
0.05266536399722099,
0.020194275304675102,
-0.015585343353450298,
-0.000018333166735828854,
0.013601403683423996,
-0.022972144186496735,
0.028377361595630646,
... | -0.060457 |
show all information of the chart ### Synopsis This command inspects a chart (directory, file, or URL) and displays all its content (values.yaml, Chart.yaml, README) ``` helm show all [CHART] [flags] ``` ### Options ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored -h, --help help for all --insecure-skip-tls-verify skip tls certificate checks for the chart download --key-file string identify HTTPS client using this SSL key file --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") --pass-credentials pass credentials to all domains --password string chart repository password where to locate the requested chart --plain-http use insecure HTTP connections for the chart download --repo string chart repository url where to locate the requested chart --username string chart repository username where to locate the requested chart --verify verify the package before using it --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm show](/helm/helm\_show.md) - show information of a chart ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_show_all.md | main | helm | [
-0.008160887286067009,
0.05474446713924408,
-0.0523785725235939,
-0.05067771300673485,
0.023551886901259422,
-0.05184086784720421,
-0.005782939959317446,
-0.01905788667500019,
0.019591419026255608,
0.015497969463467598,
0.027998436242341995,
-0.021039733663201332,
0.014135920442640781,
-0.... | -0.039905 |
upgrade a release ### Synopsis This command upgrades a release to a new version of a chart. The upgrade arguments must be a release and chart. The chart argument can be either: a chart reference('example/mariadb'), a path to a chart directory, a packaged chart, or a fully qualified URL. For chart references, the latest version will be specified unless the '--version' flag is set. To override values in a chart, use either the '--values' flag and pass in a file or use the '--set' flag and pass configuration from the command line, to force string values, use '--set-string'. You can use '--set-file' to set individual values from a file when the value itself is too long for the command line or is dynamically generated. You can also use '--set-json' to set json values (scalars/objects/arrays) from the command line. Additionally, you can use '--set-json' and passing json object as a string. You can specify the '--values'/'-f' flag multiple times. The priority will be given to the last (right-most) file specified. For example, if both myvalues.yaml and override.yaml contained a key called 'Test', the value set in override.yaml would take precedence: $ helm upgrade -f myvalues.yaml -f override.yaml redis ./redis You can specify the '--set' flag multiple times. The priority will be given to the last (right-most) set specified. For example, if both 'bar' and 'newbar' values are set for a key called 'foo', the 'newbar' value would take precedence: $ helm upgrade --set foo=bar --set foo=newbar redis ./redis You can update the values for an existing release with this command as well via the '--reuse-values' flag. The 'RELEASE' and 'CHART' arguments should be set to the original parameters, and existing values will be merged with any values set via '--values'/'-f' or '--set' flags. Priority is given to new values. $ helm upgrade --reuse-values --set foo=bar --set foo=newbar redis ./redis The --dry-run flag will output all generated chart manifests, including Secrets which can contain sensitive values. To hide Kubernetes Secrets use the --hide-secret flag. Please carefully consider how and when these flags are used. ``` helm upgrade [RELEASE] [CHART] [flags] ``` ### Options ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file --cleanup-on-fail allow deletion of new resources created in this upgrade when upgrade fails --create-namespace if --install is set, create the release namespace if not present --dependency-update update dependencies if they are missing before installing the chart --description string add a custom description --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored --disable-openapi-validation if set, the upgrade process will not validate rendered templates against the Kubernetes OpenAPI Schema --dry-run string[="unset"] simulates the operation without persisting changes. Must be one of: "none" (default), "client", or "server". '--dry-run=none' executes the operation normally and persists changes (no simulation). '--dry-run=client' simulates the operation client-side only and avoids cluster connections. '--dry-run=server' simulates the operation on the server, requiring cluster connectivity. (default "none") --enable-dns enable DNS lookups when rendering templates --force-conflicts if set server-side apply will force changes against conflicts --force-replace force resource updates by replacement -h, --help help for upgrade --hide-notes if set, do not show notes in upgrade output. Does not affect presence in chart metadata --hide-secret hide Kubernetes Secrets when also using the --dry-run flag --history-max int limit the maximum number of revisions saved per release. Use 0 for no limit (default 10) --insecure-skip-tls-verify skip tls certificate checks for the chart download -i, --install if a release by this name doesn't already exist, run an install --key-file string identify HTTPS client using this SSL | https://github.com/helm/helm-www/blob/main//docs/helm/helm_upgrade.md | main | helm | [
0.047640569508075714,
-0.002112933900207281,
-0.006973654963076115,
-0.00953708030283451,
-0.06753739714622498,
0.024060655385255814,
-0.06001690775156021,
0.12189360707998276,
-0.036726731806993484,
-0.0043844133615493774,
0.040506307035684586,
-0.022901521995663643,
-0.007827771827578545,
... | -0.007941 |
flag --history-max int limit the maximum number of revisions saved per release. Use 0 for no limit (default 10) --insecure-skip-tls-verify skip tls certificate checks for the chart download -i, --install if a release by this name doesn't already exist, run an install --key-file string identify HTTPS client using this SSL key file --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") -l, --labels stringToString Labels that would be added to release metadata. Should be separated by comma. Original release labels will be merged with upgrade labels. You can unset label using null. (default []) --no-hooks disable pre/post upgrade hooks -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) --pass-credentials pass credentials to all domains --password string chart repository password where to locate the requested chart --plain-http use insecure HTTP connections for the chart download --post-renderer postRendererString the name of a postrenderer type plugin to be used for post rendering. If it exists, the plugin will be used --post-renderer-args postRendererArgsSlice an argument to the post-renderer (can specify multiple) (default []) --render-subchart-notes if set, render subchart notes along with the parent --repo string chart repository url where to locate the requested chart --reset-then-reuse-values when upgrading, reset the values to the ones built into the chart, apply the last release's values and merge in any overrides from the command line via --set and -f. If '--reset-values' or '--reuse-values' is specified, this is ignored --reset-values when upgrading, reset the values to the ones built into the chart --reuse-values when upgrading, reuse the last release's values and merge in any overrides from the command line via --set and -f. If '--reset-values' is specified, this is ignored --rollback-on-failure if set, Helm will rollback the upgrade to previous success release upon failure. The --wait flag will be defaulted to "watcher" if --rollback-on-failure is set --server-side string must be "true", "false" or "auto". Object updates run in the server instead of the client ("auto" defaults the value from the previous chart release's method) (default "auto") --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) --set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2) --set-json stringArray set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2 or using json format: {"key1": jsonval1, "key2": "jsonval2"}) --set-literal stringArray set a literal STRING value on the command line --set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) --skip-crds if set, no CRDs will be installed when an upgrade is performed with install flag enabled. By default, CRDs are installed if not already present, when an upgrade is performed with install flag enabled --skip-schema-validation if set, disables JSON schema validation --take-ownership if set, upgrade will ignore the check for helm annotations and take ownership of the existing resources --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) --username string chart repository username where to locate the requested chart -f, --values strings specify values in a YAML file or a URL (can specify multiple) --verify verify the package before using it --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used --wait WaitStrategy[=watcher] if specified, will wait until all resources are in the expected state before marking the operation as successful. It | https://github.com/helm/helm-www/blob/main//docs/helm/helm_upgrade.md | main | helm | [
0.012587593868374825,
0.064201720058918,
-0.0699414312839508,
-0.06364192068576813,
-0.006261749193072319,
0.025835109874606133,
-0.004432612098753452,
-0.02755850739777088,
-0.034681931138038635,
0.025217078626155853,
0.03752851486206055,
0.011466886848211288,
-0.034604303538799286,
-0.07... | -0.065438 |
use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used --wait WaitStrategy[=watcher] if specified, will wait until all resources are in the expected state before marking the operation as successful. It will wait for as long as --timeout. Valid inputs are 'watcher' and 'legacy' (default hookOnly) --wait-for-jobs if set and --wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as --timeout ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_upgrade.md | main | helm | [
-0.06464170664548874,
0.03174060210585594,
-0.05997597426176071,
0.023215102031826973,
0.050419703125953674,
0.04488915950059891,
0.007388745900243521,
-0.04592942073941231,
-0.005416098050773144,
0.007203121669590473,
0.033083654940128326,
0.02424975484609604,
0.010829303413629532,
-0.021... | 0.088373 |
package a plugin directory into a plugin archive ### Synopsis This command packages a Helm plugin directory into a tarball. By default, the command will generate a provenance file signed with a PGP key. This ensures the plugin can be verified after installation. Use --sign=false to skip signing (not recommended for distribution). ``` helm plugin package [PATH] [flags] ``` ### Options ``` -d, --destination string location to write the plugin tarball. (default ".") -h, --help help for package --key string name of the key to use when signing. Used if --sign is true --keyring string location of a public keyring (default "~/.gnupg/pubring.gpg") --passphrase-file string location of a file which contains the passphrase for the signing key. Use "-" to read from stdin. --sign use a PGP private key to sign this plugin (default true) ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm plugin](/helm/helm\_plugin.md) - install, list, or uninstall Helm plugins ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_plugin_package.md | main | helm | [
-0.04871423542499542,
0.06234629079699516,
-0.03900347650051117,
-0.07087944447994232,
0.039809223264455795,
0.0003137973544653505,
0.07926119118928909,
0.09498120844364166,
-0.026765083894133568,
0.02711774967610836,
0.05050180107355118,
0.007385156583040953,
0.012871833518147469,
-0.0126... | -0.028046 |
display the status of the named release ### Synopsis This command shows the status of a named release. The status consists of: - last deployment time - k8s namespace in which the release lives - state of the release (can be: unknown, deployed, uninstalled, superseded, failed, uninstalling, pending-install, pending-upgrade or pending-rollback) - revision of the release - description of the release (can be completion message or error message) - list of resources that this release consists of - details on last test suite run, if applicable - additional notes provided by the chart ``` helm status RELEASE\_NAME [flags] ``` ### Options ``` -h, --help help for status -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) --revision int if set, display the status of the named release with revision ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_status.md | main | helm | [
0.025127844884991646,
0.07369469851255417,
-0.0020737680606544018,
-0.0276148971170187,
0.06733959913253784,
0.002171453321352601,
-0.037869442254304886,
0.015416487120091915,
-0.010377012193202972,
0.06263177841901779,
0.06971823424100876,
-0.0327722392976284,
-0.019020410254597664,
-0.04... | 0.077009 |
push a chart to remote ### Synopsis Upload a chart to a registry. If the chart has an associated provenance file, it will also be uploaded. ``` helm push [chart] [remote] [flags] ``` ### Options ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify registry client using this SSL certificate file -h, --help help for push --insecure-skip-tls-verify skip tls certificate checks for the chart upload --key-file string identify registry client using this SSL key file --password string chart repository password where to locate the requested chart --plain-http use insecure HTTP connections for the chart upload --username string chart repository username where to locate the requested chart ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_push.md | main | helm | [
-0.028906654566526413,
0.01465634722262621,
-0.06677503138780594,
-0.05069752782583237,
0.004735368303954601,
0.00589781766757369,
-0.04326373711228371,
0.05634313449263573,
0.007959691807627678,
0.03667553886771202,
0.04470330849289894,
-0.03462475910782814,
0.07666023820638657,
0.0019613... | -0.029322 |
examine a chart for possible issues ### Synopsis This command takes a path to a chart and runs a series of tests to verify that the chart is well-formed. If the linter encounters things that will cause the chart to fail installation, it will emit [ERROR] messages. If it encounters issues that break with convention or recommendation, it will emit [WARNING] messages. ``` helm lint PATH [flags] ``` ### Options ``` -h, --help help for lint --kube-version string Kubernetes version used for capabilities and deprecation checks --quiet print only warnings and errors --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) --set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2) --set-json stringArray set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2 or using json format: {"key1": jsonval1, "key2": "jsonval2"}) --set-literal stringArray set a literal STRING value on the command line --set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) --skip-schema-validation if set, disables JSON schema validation --strict fail on lint warnings -f, --values strings specify values in a YAML file or a URL (can specify multiple) --with-subcharts lint dependent charts ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_lint.md | main | helm | [
0.04393792897462845,
0.00007582551188534126,
0.020289959385991096,
-0.048741139471530914,
0.03583386540412903,
0.018075810745358467,
-0.04025893285870552,
0.05446069315075874,
0.005692360457032919,
0.02070656232535839,
-0.01395805086940527,
-0.08271165937185287,
0.011538084596395493,
-0.03... | 0.029326 |
list chart repositories ``` helm repo list [flags] ``` ### Options ``` -h, --help help for list -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm repo](/helm/helm\_repo.md) - add, list, remove, update, and index chart repositories ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_repo_list.md | main | helm | [
0.032832033932209015,
0.06326883286237717,
-0.020272282883524895,
-0.031265147030353546,
0.024943355470895767,
-0.009528514929115772,
-0.004502227995544672,
-0.0013229199685156345,
0.038836270570755005,
0.057529520243406296,
0.027032017707824707,
-0.05152944102883339,
0.024771664291620255,
... | 0.104704 |
add a chart repository ``` helm repo add [NAME] [URL] [flags] ``` ### Options ``` --allow-deprecated-repos by default, this command will not allow adding official repos that have been permanently deleted. This disables that behavior --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file --force-update replace (overwrite) the repo if it already exists -h, --help help for add --insecure-skip-tls-verify skip tls certificate checks for the repository --key-file string identify HTTPS client using this SSL key file --pass-credentials pass credentials to all domains --password string chart repository password --password-stdin read chart repository password from stdin --timeout duration time to wait for the index file download to complete (default 2m0s) --username string chart repository username ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm repo](/helm/helm\_repo.md) - add, list, remove, update, and index chart repositories ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_repo_add.md | main | helm | [
-0.03792024403810501,
0.03656645864248276,
-0.03831680119037628,
-0.04021330550312996,
0.008231271058321,
-0.02756158448755741,
-0.041633546352386475,
-0.01661350019276142,
0.011841063387691975,
0.07130146026611328,
0.05277955159544945,
-0.04119729623198509,
0.05336117744445801,
0.01573562... | -0.008021 |
locally render templates ### Synopsis Render chart templates locally and display the output. Any values that would normally be looked up or retrieved in-cluster will be faked locally. Additionally, none of the server-side testing of chart validity (e.g. whether an API is supported) is done. ``` helm template [NAME] [CHART] [flags] ``` ### Options ``` -a, --api-versions strings Kubernetes api versions used for Capabilities.APIVersions (multiple can be specified) --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file --create-namespace create the release namespace if not present --dependency-update update dependencies if they are missing before installing the chart --description string add a custom description --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored --disable-openapi-validation if set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema --dry-run string[="unset"] simulates the operation either client-side or server-side. Must be either: "client", or "server". '--dry-run=client simulates the operation client-side only and avoids cluster connections. '--dry-run=server' simulates/validates the operation on the server, requiring cluster connectivity. (default "client") --enable-dns enable DNS lookups when rendering templates --force-conflicts if set server-side apply will force changes against conflicts --force-replace force resource updates by replacement -g, --generate-name generate the name (and omit the NAME parameter) -h, --help help for template --hide-notes if set, do not show notes in install output. Does not affect presence in chart metadata --include-crds include CRDs in the templated output --insecure-skip-tls-verify skip tls certificate checks for the chart download --is-upgrade set .Release.IsUpgrade instead of .Release.IsInstall --key-file string identify HTTPS client using this SSL key file --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") --kube-version string Kubernetes version used for Capabilities.KubeVersion -l, --labels stringToString Labels that would be added to release metadata. Should be divided by comma. (default []) --name-template string specify template used to name the release --no-hooks prevent hooks from running during install --output-dir string writes the executed templates to files in output-dir instead of stdout --pass-credentials pass credentials to all domains --password string chart repository password where to locate the requested chart --plain-http use insecure HTTP connections for the chart download --post-renderer postRendererString the name of a postrenderer type plugin to be used for post rendering. If it exists, the plugin will be used --post-renderer-args postRendererArgsSlice an argument to the post-renderer (can specify multiple) (default []) --release-name use release name in the output-dir path. --render-subchart-notes if set, render subchart notes along with the parent --replace reuse the given name, only if that name is a deleted release which remains in the history. This is unsafe in production --repo string chart repository url where to locate the requested chart --rollback-on-failure if set, Helm will rollback (uninstall) the installation upon failure. The --wait flag will be default to "watcher" if --rollback-on-failure is set --server-side object updates run in the server instead of the client (default true) --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) --set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2) --set-json stringArray set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2 or using json format: {"key1": jsonval1, "key2": "jsonval2"}) --set-literal stringArray set a literal STRING value on the command line --set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) -s, --show-only stringArray only show manifests rendered from the given templates --skip-crds if set, no CRDs will be installed. By default, CRDs are | https://github.com/helm/helm-www/blob/main//docs/helm/helm_template.md | main | helm | [
0.022710764780640602,
0.07022008299827576,
0.06483881920576096,
-0.04518035426735878,
0.054827217012643814,
0.0019803831819444895,
-0.11978080868721008,
-0.0066653466783463955,
0.060561537742614746,
0.012856108136475086,
0.023660941049456596,
-0.09946431964635849,
0.003891550237312913,
0.0... | 0.043138 |
set a literal STRING value on the command line --set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) -s, --show-only stringArray only show manifests rendered from the given templates --skip-crds if set, no CRDs will be installed. By default, CRDs are installed if not already present --skip-schema-validation if set, disables JSON schema validation --skip-tests skip tests from templated output --take-ownership if set, install will ignore the check for helm annotations and take ownership of the existing resources --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) --username string chart repository username where to locate the requested chart -f, --values strings specify values in a YAML file or a URL (can specify multiple) --verify verify the package before using it --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used --wait WaitStrategy[=watcher] if specified, will wait until all resources are in the expected state before marking the operation as successful. It will wait for as long as --timeout. Valid inputs are 'watcher' and 'legacy' (default hookOnly) --wait-for-jobs if set and --wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as --timeout ``` ### Options inherited from parent commands ``` --burst-limit int client-side default throttling limit (default 100) --color string use colored output (never, auto, always) (default "auto") --colour string use colored output (never, auto, always) (default "auto") --content-cache string path to the directory containing cached content (e.g. charts) (default "~/.cache/helm/content") --debug enable verbose output --kube-apiserver string the address and the port for the Kubernetes API server --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups. --kube-as-user string username to impersonate for the operation --kube-ca-file string the certificate authority file for the Kubernetes API server connection --kube-context string name of the kubeconfig context to use --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used --kube-token string bearer token used for authentication --kubeconfig string path to the kubeconfig file -n, --namespace string namespace scope for this request --qps float32 queries per second used when communicating with the Kubernetes API, not including bursting --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json") --repository-cache string path to the directory containing cached repository indexes (default "~/.cache/helm/repository") --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") ``` ### SEE ALSO \* [helm](/helm/helm.md) - The Helm package manager for Kubernetes. ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_template.md | main | helm | [
0.05586301162838936,
0.0648764818906784,
0.008458160795271397,
-0.05273333564400673,
-0.0330820269882679,
0.04226910322904587,
-0.01792980171740055,
0.012910431250929832,
0.03845888376235962,
0.013951570726931095,
-0.022573867812752724,
-0.09694027155637741,
0.015501766465604305,
-0.016687... | 0.059523 |
Helm should work with any [conformant version of Kubernetes](https://github.com/cncf/k8s-conformance) (whether [certified](https://www.cncf.io/certification/software-conformance/) or not). This document captures information about using Helm in specific Kubernetes environments. Please contribute more details about any distros (sorted alphabetically) if desired. ## AKS Helm works with [Azure Kubernetes Service](https://docs.microsoft.com/en-us/azure/aks/kubernetes-helm). ## DC/OS Helm has been tested and is working on Mesospheres DC/OS 1.11 Kubernetes platform, and requires no additional configuration. ## EKS Helm works with Amazon Elastic Kubernetes Service (Amazon EKS): [Using Helm with Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/helm.html). ## GKE Google's GKE hosted Kubernetes platform is known to work with Helm, and requires no additional configuration. ## `scripts/local-cluster` and Hyperkube Hyperkube configured via `scripts/local-cluster.sh` is known to work. For raw Hyperkube you may need to do some manual configuration. ## IKS Helm works with [IBM Cloud Kubernetes Service](https://cloud.ibm.com/docs/containers?topic=containers-helm). ## KIND (Kubernetes IN Docker) Helm is regularly tested on [KIND](https://github.com/kubernetes-sigs/kind). ## KubeOne Helm works in clusters that are set up by KubeOne without caveats. ## Kubermatic Helm works in user clusters that are created by Kubermatic without caveats. Since seed cluster can be set up in different ways Helm support depends on their configuration. ## MicroK8s Helm can be enabled in [MicroK8s](https://microk8s.io) using the command: `microk8s.enable helm3` ## Minikube Helm is tested and known to work with [Minikube](https://github.com/kubernetes/minikube). It requires no additional configuration. ## Openshift Helm works straightforward on OpenShift Online, OpenShift Dedicated, OpenShift Container Platform (version >= 3.6) or OpenShift Origin (version >= 3.6). To learn more read [this blog](https://blog.openshift.com/getting-started-helm-openshift/) post. ## Platform9 Helm is pre-installed with [Platform9 Managed Kubernetes](https://platform9.com/managed-kubernetes/?utm\_source=helm\_distro\_notes). Platform9 provides access to all official Helm charts through the App Catalog UI and native Kubernetes CLI. Additional repositories can be manually added. Further details are available in this [Platform9 App Catalog article](https://platform9.com/support/deploying-kubernetes-apps-platform9-managed-kubernetes/?utm\_source=helm\_distro\_notes). ## Ubuntu with `kubeadm` Kubernetes bootstrapped with `kubeadm` is known to work on the following Linux distributions: - Ubuntu 16.04 - Fedora release 25 Some versions of Helm (v2.0.0-beta2) require you to `export KUBECONFIG=/etc/kubernetes/admin.conf` or create a `~/.kube/config`. ## VMware Tanzu Kubernetes Grid Helm runs on VMware Tanzu Kubernetes Grid, TKG, without needing configuration changes. The Tanzu CLI can manage installing packages for [helm-controller](https://fluxcd.io/flux/components/helm/) allowing for declaratively managing Helm chart releases. Further details available in the TKG documentation for [CLI-Managed Packages](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-packages-user-managed-index.html#package-locations-and-dependencies-5). | https://github.com/helm/helm-www/blob/main//docs/topics/kubernetes_distros.md | main | helm | [
-0.05311138927936554,
0.021399490535259247,
0.04714353010058403,
-0.06169850379228592,
0.013343988917768002,
0.014598047360777855,
-0.04538130387663841,
-0.03624799847602844,
0.06757348775863647,
0.12504956126213074,
-0.03569508343935013,
-0.039431776851415634,
0.03951624780893326,
0.00882... | 0.040639 |
This document aims to provide guidance to users for setting up and managing permissions when using the SQL storage backend. ## Introduction To handle permissions, Helm leverages the RBAC feature of Kubernetes. When using the SQL storage backend, Kubernetes' roles can't be used to determine whether or not an user can access a given resource. This document shows how to create and manage these permissions. ## Initialization The first time the Helm CLI will make connect to your database, the client will make sure that it was previously initialized. If it is not, it will take care of the necessary setup automatically. This initialization requires admin privileges on the public schema, or at least to be able to: \* create a table \* grant privileges on the public schema After the migration was run against your database, all the other roles can use the client. ## Grant privileges to a non admin user in PostgreSQL To manage permissions, the SQL backend driver leverages the [RLS](https://www.postgresql.org/docs/9.5/ddl-rowsecurity.html)(Row Security Level) feature of PostgreSQL. RLS allows all users to be able to read/write from/to the same table, without being able to manipulate the same rows if they are not explicitly allowed to. By default, any role that has not been explicitly granted with the right privileges will always return an empty list when running `helm list` and will not be able to retrieve or modify any resource in the cluster. Let's see how to grant a given role access to specific namespaces: ```sql CREATE POLICY ON releases\_v1 FOR ALL TO USING (namespace = 'default'); ``` This command will grant the permissions to read and write all resources that meet the `namespace = 'default'` condition to the role `role`. After creating this policy, the user being connected to the database on the behalf of the role `role` will therefore be able to see all the releases living in the `default` namespace when running `helm list`, and to modify and delete them. Privileges can be managed granularly with RLS, and one might be interested in restraining access given the different columns of the table: \* key \* type \* body \* name \* namespace \* version \* status \* owner \* createdAt \* modifiedAt | https://github.com/helm/helm-www/blob/main//docs/topics/permissions_sql_storage_backend.md | main | helm | [
0.04612359777092934,
-0.009617884643375874,
-0.03440079838037491,
-0.017652424052357674,
-0.036312758922576904,
0.0069467150606215,
0.03727451339364052,
-0.006843456998467445,
0.034465257078409195,
0.030668247491121292,
-0.04609858989715576,
-0.025487659499049187,
0.04678165167570114,
-0.0... | 0.016362 |
# Helm Architecture This document describes the Helm architecture at a high level. ## The Purpose of Helm Helm is a tool for managing Kubernetes packages called \_charts\_. Helm can do the following: - Create new charts from scratch - Package charts into chart archive (tgz) files - Interact with chart repositories where charts are stored - Install and uninstall charts into an existing Kubernetes cluster - Manage the release cycle of charts that have been installed with Helm For Helm, there are three important concepts: 1. The \_chart\_ is a bundle of information necessary to create an instance of a Kubernetes application. 2. The \_config\_ contains configuration information that can be merged into a packaged chart to create a releasable object. 3. A \_release\_ is a running instance of a \_chart\_, combined with a specific \_config\_. ## Components Helm is an executable which is implemented into two distinct parts: \*\*The Helm Client\*\* is a command-line client for end users. The client is responsible for the following: - Local chart development - Managing repositories - Managing releases - Interfacing with the Helm library - Sending charts to be installed - Requesting upgrading or uninstalling of existing releases \*\*The Helm Library\*\* provides the logic for executing all Helm operations. It interfaces with the Kubernetes API server and provides the following capability: - Combining a chart and configuration to build a release - Installing charts into Kubernetes, and providing the subsequent release object - Upgrading and uninstalling charts by interacting with Kubernetes The standalone Helm library encapsulates the Helm logic so that it can be leveraged by different clients. ## Implementation The Helm client and library is written in the Go programming language. The library uses the Kubernetes client library to communicate with Kubernetes. Currently, that library uses REST+JSON. It stores information in Secrets located inside of Kubernetes. It does not need its own database. Configuration files are, when possible, written in YAML. | https://github.com/helm/helm-www/blob/main//docs/topics/architecture.md | main | helm | [
-0.004011716693639755,
0.06086248904466629,
0.0223398320376873,
-0.03308514878153801,
0.02430356852710247,
0.011273234151303768,
-0.018580472096800804,
0.030202804133296013,
0.06510667502880096,
0.055905599147081375,
0.020865079015493393,
-0.012737828306853771,
0.011928046122193336,
-0.038... | 0.154906 |
Helm provides a \_hook\_ mechanism to allow chart developers to intervene at certain points in a release's life cycle. For example, you can use hooks to: - Load a ConfigMap or Secret during install before any other charts are loaded. - Execute a Job to back up a database before installing a new chart, and then execute a second job after the upgrade in order to restore data. - Run a Job before deleting a release to gracefully take a service out of rotation before removing it. Hooks work like regular templates, but they have special annotations that cause Helm to utilize them differently. In this section, we cover the basic usage pattern for hooks. ## The Available Hooks The following hooks are defined: | Annotation Value | Description | | ---------------- | ----------------------------------------------------------------------------------------------------- | | `pre-install` | Executes after templates are rendered, but before any resources are created in Kubernetes | | `post-install` | Executes after all resources are loaded into Kubernetes | | `pre-delete` | Executes on a deletion request before any resources are deleted from Kubernetes | | `post-delete` | Executes on a deletion request after all of the release's resources have been deleted | | `pre-upgrade` | Executes on an upgrade request after templates are rendered, but before any resources are updated | | `post-upgrade` | Executes on an upgrade request after all resources have been upgraded | | `pre-rollback` | Executes on a rollback request after templates are rendered, but before any resources are rolled back | | `post-rollback` | Executes on a rollback request after all resources have been modified | | `test` | Executes when the Helm test subcommand is invoked ([view test docs](/topics/chart\_tests.md)) | \_Note that the `crd-install` hook has been removed in favor of the `crds/` directory in Helm 3.\_ ## Hooks and the Release Lifecycle Hooks allow you, the chart developer, an opportunity to perform operations at strategic points in a release lifecycle. For example, consider the lifecycle for a `helm install`. By default, the lifecycle looks like this: 1. User runs `helm install foo` 2. The Helm library install API is called 3. After some verification, the library renders the `foo` templates 4. The library loads the resulting resources into Kubernetes 5. The library returns the release object (and other data) to the client 6. The client exits Helm defines two hooks for the `install` lifecycle: `pre-install` and `post-install`. If the developer of the `foo` chart implements both hooks, the lifecycle is altered like this: 1. User runs `helm install foo` 2. The Helm library install API is called 3. CRDs in the `crds/` directory are installed 4. After some verification, the library renders the `foo` templates 5. The library prepares to execute the `pre-install` hooks (loading hook resources into Kubernetes) 6. The library sorts hooks by weight (assigning a weight of 0 by default), by resource kind and finally by name in ascending order. 7. The library then loads the hook with the lowest weight first (negative to positive) 8. The library waits until the hook is "Ready" (except for CRDs) 9. The library loads the resulting resources into Kubernetes. Note that if the `--wait` flag is set, the library will wait until all resources are in a ready state and will not run the `post-install` hook until they are ready. 10. The library executes the `post-install` hook (loading hook resources) 11. The library waits until the hook is "Ready" 12. The library returns the release object (and other data) to the client 13. The client exits What does it mean to wait until a hook is ready? | https://github.com/helm/helm-www/blob/main//docs/topics/charts_hooks.md | main | helm | [
0.012274964712560177,
0.07247579842805862,
0.05979336425662041,
-0.03802205249667168,
0.061493732035160065,
-0.008430864661931992,
-0.07909015566110611,
0.0004741086158901453,
0.044595666229724884,
0.03036876767873764,
0.034046534448862076,
0.05923730880022049,
0.001200412050820887,
-0.066... | 0.043141 |
they are ready. 10. The library executes the `post-install` hook (loading hook resources) 11. The library waits until the hook is "Ready" 12. The library returns the release object (and other data) to the client 13. The client exits What does it mean to wait until a hook is ready? This depends on the resource declared in the hook. If the resource is a `Job` or `Pod` kind, Helm will wait until it successfully runs to completion. And if the hook fails, the release will fail. This is a \_blocking operation\_, so the Helm client will pause while the Job is run. For all other kinds, as soon as Kubernetes marks the resource as loaded (added or updated), the resource is considered "Ready". When many resources are declared in a hook, the resources are executed serially. If they have hook weights (see below), they are executed in weighted order. Starting from Helm 3.2.0 hook resources with same weight are installed in the same order as normal non-hook resources. Otherwise, ordering is not guaranteed. (In Helm 2.3.0 and after, they are sorted alphabetically. That behavior, though, is not considered binding and could change in the future.) It is considered good practice to add a hook weight, and set it to `0` if weight is not important. ### Hook resources are not managed with corresponding releases The resources that a hook creates are currently not tracked or managed as part of the release. Once Helm verifies that the hook has reached its ready state, it will leave the hook resource alone. Garbage collection of hook resources when the corresponding release is deleted may be added to Helm 3 in the future, so any hook resources that must never be deleted should be annotated with `helm.sh/resource-policy: keep`. Practically speaking, this means that if you create resources in a hook, you cannot rely upon `helm uninstall` to remove the resources. To destroy such resources, you need to either [add a custom `helm.sh/hook-delete-policy` annotation](#hook-deletion-policies) to the hook template file, or [set the time to live (TTL) field of a Job resource](https://kubernetes.io/docs/concepts/workloads/controllers/ttlafterfinished/). ## Writing a Hook Hooks are just Kubernetes manifest files with special annotations in the `metadata` section. Because they are template files, you can use all of the normal template features, including reading `.Values`, `.Release`, and `.Template`. For example, this template, stored in `templates/post-install-job.yaml`, declares a job to be run on `post-install`: ```yaml apiVersion: batch/v1 kind: Job metadata: name: "{{ .Release.Name }}" labels: app.kubernetes.io/managed-by: {{ .Release.Service | quote }} app.kubernetes.io/instance: {{ .Release.Name | quote }} app.kubernetes.io/version: {{ .Chart.AppVersion }} helm.sh/chart: "{{ .Chart.Name }}-{{ .Chart.Version }}" annotations: # This is what defines this resource as a hook. Without this line, the # job is considered part of the release. "helm.sh/hook": post-install "helm.sh/hook-weight": "-5" "helm.sh/hook-delete-policy": hook-succeeded spec: template: metadata: name: "{{ .Release.Name }}" labels: app.kubernetes.io/managed-by: {{ .Release.Service | quote }} app.kubernetes.io/instance: {{ .Release.Name | quote }} helm.sh/chart: "{{ .Chart.Name }}-{{ .Chart.Version }}" spec: restartPolicy: Never containers: - name: post-install-job image: "alpine:3.3" command: ["/bin/sleep","{{ default "10" .Values.sleepyTime }}"] ``` What makes this template a hook is the annotation: ```yaml annotations: "helm.sh/hook": post-install ``` One resource can implement multiple hooks: ```yaml annotations: "helm.sh/hook": post-install,post-upgrade ``` Similarly, there is no limit to the number of different resources that may implement a given hook. For example, one could declare both a secret and a config map as a pre-install hook. When subcharts declare hooks, those are also evaluated. There is no way for a top-level chart to disable the hooks declared by subcharts. It is possible to define a weight for a hook which will help build a deterministic executing | https://github.com/helm/helm-www/blob/main//docs/topics/charts_hooks.md | main | helm | [
0.0015927603235468268,
0.025073375552892685,
0.04625402018427849,
-0.03860984370112419,
0.015059216879308224,
0.011083202436566353,
-0.026031024754047394,
-0.05634919926524162,
0.130568265914917,
0.03895307704806328,
0.019319651648402214,
0.046723201870918274,
-0.044363997876644135,
-0.064... | 0.103713 |
a secret and a config map as a pre-install hook. When subcharts declare hooks, those are also evaluated. There is no way for a top-level chart to disable the hooks declared by subcharts. It is possible to define a weight for a hook which will help build a deterministic executing order. Weights are defined using the following annotation: ```yaml annotations: "helm.sh/hook-weight": "5" ``` Hook weights can be positive or negative numbers but must be represented as strings. When Helm starts the execution cycle of hooks of a particular Kind it will sort those hooks in ascending order. ### Hook deletion policies It is possible to define policies that determine when to delete corresponding hook resources. Hook deletion policies are defined using the following annotation: ```yaml annotations: "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded ``` You can choose one or more defined annotation values: | Annotation Value | Description | | ---------------------- | -------------------------------------------------------------------- | | `before-hook-creation` | Delete the previous resource before a new hook is launched (default) | | `hook-succeeded` | Delete the resource after the hook is successfully executed | | `hook-failed` | Delete the resource if the hook failed during execution | If no hook deletion policy annotation is specified, the `before-hook-creation` behavior applies by default. | https://github.com/helm/helm-www/blob/main//docs/topics/charts_hooks.md | main | helm | [
-0.004888920579105616,
0.07093241810798645,
0.08502791076898575,
-0.018208418041467667,
0.02550600655376911,
-0.016792071983218193,
-0.047197144478559494,
-0.012101654894649982,
0.05966947600245476,
0.03387337550520897,
-0.015533311292529106,
0.03819113224744797,
0.029756050556898117,
-0.0... | 0.026573 |
A chart contains a number of Kubernetes resources and components that work together. As a chart author, you may want to write some tests that validate that your chart works as expected when it is installed. These tests also help the chart consumer understand what your chart is supposed to do. A \*\*test\*\* in a helm chart lives under the `templates/` directory and is a job definition that specifies a container with a given command to run. The container should exit successfully (exit 0) for a test to be considered a success. The job definition must contain the helm test hook annotation: `helm.sh/hook: test`. Note that until Helm v3, the job definition needed to contain one of these helm test hook annotations: `helm.sh/hook: test-success` or `helm.sh/hook: test-failure`. `helm.sh/hook: test-success` is still accepted as a backwards-compatible alternative to `helm.sh/hook: test`. Example tests: - Validate that your configuration from the values.yaml file was properly injected. - Make sure your username and password work correctly - Make sure an incorrect username and password does not work - Assert that your services are up and correctly load balancing - etc. You can run the pre-defined tests in Helm on a release using the command `helm test `. For a chart consumer, this is a great way to check that their release of a chart (or application) works as expected. ## Example Test The [helm create](/helm/helm\_create.md) command will automatically create a number of folders and files. To try the helm test functionality, first create a demo helm chart. ```console $ helm create demo ``` You will now be able to see the following structure in your demo helm chart. ``` demo/ Chart.yaml values.yaml charts/ templates/ templates/tests/test-connection.yaml ``` In `demo/templates/tests/test-connection.yaml` you'll see a test you can try. You can see the helm test pod definition here: ```yaml apiVersion: v1 kind: Pod metadata: name: "{{ include "demo.fullname" . }}-test-connection" labels: {{- include "demo.labels" . | nindent 4 }} annotations: "helm.sh/hook": test spec: containers: - name: wget image: busybox command: ['wget'] args: ['{{ include "demo.fullname" . }}:{{ .Values.service.port }}'] restartPolicy: Never ``` ## Steps to Run a Test Suite on a Release First, install the chart on your cluster to create a release. You may have to wait for all pods to become active; if you test immediately after this install, it is likely to show a transitive failure, and you will want to re-test. ```console $ helm install demo demo --namespace default $ helm test demo NAME: demo LAST DEPLOYED: Mon Feb 14 20:03:16 2022 NAMESPACE: default STATUS: deployed REVISION: 1 TEST SUITE: demo-test-connection Last Started: Mon Feb 14 20:35:19 2022 Last Completed: Mon Feb 14 20:35:23 2022 Phase: Succeeded [...] ``` ## Notes - You can define as many tests as you would like in a single yaml file or spread across several yaml files in the `templates/` directory. - You are welcome to nest your test suite under a `tests/` directory like `/templates/tests/` for more isolation. - A test is a [Helm hook](/topics/charts\_hooks.md), so annotations like `helm.sh/hook-weight` and `helm.sh/hook-delete-policy` may be used with test resources. - Often the contents in the `tests/` directory does not need to be packaged and published. Consider adding `tests/` to the `.helmignore` file. | https://github.com/helm/helm-www/blob/main//docs/topics/chart_tests.md | main | helm | [
0.02941945008933544,
0.029416106641292572,
0.07851593941450119,
-0.040830329060554504,
0.04130032658576965,
0.006470487453043461,
-0.07105598598718643,
-0.02141769602894783,
0.058691442012786865,
0.032006844878196716,
0.0022628293372690678,
-0.05515361577272415,
0.00826594140380621,
-0.006... | 0.030908 |
This section explains how to create and work with Helm chart repositories. At a high level, a chart repository is a location where packaged charts can be stored and shared. The distributed community Helm chart repository is located at [Artifact Hub](https://artifacthub.io/packages/search?kind=0) and welcomes participation. But Helm also makes it possible to create and run your own chart repository. This guide explains how to do so. If you are considering creating a chart repository, you may want to consider using an [OCI registry](/topics/registries.mdx) instead. ## Prerequisites \* Go through the [Quickstart](/intro/quickstart.md) Guide \* Read through the [Charts](/topics/charts.mdx) document ## Create a chart repository A \_chart repository\_ is an HTTP server that houses an `index.yaml` file and optionally some packaged charts. When you're ready to share your charts, the preferred way to do so is by uploading them to a chart repository. As of Helm 2.2.0, client-side SSL auth to a repository is supported. Other authentication protocols may be available as plugins. Because a chart repository can be any HTTP server that can serve YAML and tar files and can answer GET requests, you have a plethora of options when it comes down to hosting your own chart repository. For example, you can use a Google Cloud Storage (GCS) bucket, Amazon S3 bucket, GitHub Pages, or even create your own web server. ### The chart repository structure A chart repository consists of packaged charts and a special file called `index.yaml` which contains an index of all of the charts in the repository. Frequently, the charts that `index.yaml` describes are also hosted on the same server, as are the [provenance files](/topics/provenance.mdx). For example, the layout of the repository `https://example.com/charts` might look like this: ``` charts/ | |- index.yaml | |- alpine-0.1.2.tgz | |- alpine-0.1.2.tgz.prov ``` In this case, the index file would contain information about one chart, the Alpine chart, and provide the download URL `https://example.com/charts/alpine-0.1.2.tgz` for that chart. It is not required that a chart package be located on the same server as the `index.yaml` file. However, doing so is often the easiest. ### The index file The index file is a yaml file called `index.yaml`. It contains some metadata about the package, including the contents of a chart's `Chart.yaml` file. A valid chart repository must have an index file. The index file contains information about each chart in the chart repository. The `helm repo index` command will generate an index file based on a given local directory that contains packaged charts. This is an example of an index file: ```yaml apiVersion: v1 entries: alpine: - created: 2016-10-06T16:23:20.499814565-06:00 description: Deploy a basic Alpine Linux pod digest: 99c76e403d752c84ead610644d4b1c2f2b453a74b921f422b9dcb8a7c8b559cd home: https://helm.sh/helm name: alpine sources: - https://github.com/helm/helm urls: - https://technosophos.github.io/tscharts/alpine-0.2.0.tgz version: 0.2.0 - created: 2016-10-06T16:23:20.499543808-06:00 description: Deploy a basic Alpine Linux pod digest: 515c58e5f79d8b2913a10cb400ebb6fa9c77fe813287afbacf1a0b897cd78727 home: https://helm.sh/helm name: alpine sources: - https://github.com/helm/helm urls: - https://technosophos.github.io/tscharts/alpine-0.1.0.tgz version: 0.1.0 nginx: - created: 2016-10-06T16:23:20.499543808-06:00 description: Create a basic nginx HTTP server digest: aaff4545f79d8b2913a10cb400ebb6fa9c77fe813287afbacf1a0b897cdffffff home: https://helm.sh/helm name: nginx sources: - https://github.com/helm/charts urls: - https://technosophos.github.io/tscharts/nginx-1.1.0.tgz version: 1.1.0 generated: 2016-10-06T16:23:20.499029981-06:00 ``` ## Hosting Chart Repositories This part shows several ways to serve a chart repository. ### Google Cloud Storage The first step is to \*\*create your GCS bucket\*\*. We'll call ours `fantastic-charts`.  Next, make your bucket public by \*\*editing the bucket permissions\*\*.  Insert this line item to \*\*make your bucket public\*\*:  Congratulations, now you have an empty GCS bucket ready to serve charts! You may upload your chart repository using the Google Cloud Storage command line tool, or using the GCS web UI. A public GCS bucket can be accessed via simple HTTPS | https://github.com/helm/helm-www/blob/main//docs/topics/chart_repository.md | main | helm | [
0.004574004095047712,
0.012837563641369343,
-0.011371757835149765,
-0.0315113328397274,
0.02679223194718361,
-0.0016962980153039098,
-0.08002835512161255,
0.024632971733808517,
0.05922089144587517,
0.06341050565242767,
0.006439744029194117,
-0.006809896323829889,
0.07214242219924927,
0.008... | -0.022189 |
to \*\*make your bucket public\*\*:  Congratulations, now you have an empty GCS bucket ready to serve charts! You may upload your chart repository using the Google Cloud Storage command line tool, or using the GCS web UI. A public GCS bucket can be accessed via simple HTTPS at this address: `https://bucket-name.storage.googleapis.com/`. ### Cloudsmith You can also set up chart repositories using Cloudsmith. Read more about chart repositories with Cloudsmith [here](https://help.cloudsmith.io/docs/helm-chart-repository) ### JFrog Artifactory Similarly, you can also set up chart repositories using JFrog Artifactory. Read more about chart repositories with JFrog Artifactory [here](https://www.jfrog.com/confluence/display/RTF/Helm+Chart+Repositories) ### GitHub Pages example In a similar way you can create charts repository using GitHub Pages. GitHub allows you to serve static web pages in two different ways: - By configuring a project to serve the contents of its `docs/` directory - By configuring a project to serve a particular branch We'll take the second approach, though the first is just as easy. The first step will be to \*\*create your gh-pages branch\*\*. You can do that locally as. ```console $ git checkout -b gh-pages ``` Or via web browser using \*\*Branch\*\* button on your GitHub repository:  Next, you'll want to make sure your \*\*gh-pages branch\*\* is set as GitHub Pages, click on your repo \*\*Settings\*\* and scroll down to \*\*GitHub pages\*\* section and set as per below:  By default \*\*Source\*\* usually gets set to \*\*gh-pages branch\*\*. If this is not set by default, then select it. You can use a \*\*custom domain\*\* there if you wish so. And check that \*\*Enforce HTTPS\*\* is ticked, so the \*\*HTTPS\*\* will be used when charts are served. In such setup you can use your default branch to store your charts code, and \*\*gh-pages branch\*\* as charts repository, e.g.: `https://USERNAME.github.io/REPONAME`. The demonstration [TS Charts](https://github.com/technosophos/tscharts) repository is accessible at `https://technosophos.github.io/tscharts/`. If you have decided to use GitHub pages to host the chart repository, check out [Chart Releaser Action](/howto/chart\_releaser\_action.md). Chart Releaser Action is a GitHub Action workflow to turn a GitHub project into a self-hosted Helm chart repo, using [helm/chart-releaser](https://github.com/helm/chart-releaser) CLI tool. ### Ordinary web servers To configure an ordinary web server to serve Helm charts, you merely need to do the following: - Put your index and charts in a directory that the server can serve - Make sure the `index.yaml` file can be accessed with no authentication requirement - Make sure `yaml` files are served with the correct content type (`text/yaml` or `text/x-yaml`) For example, if you want to serve your charts out of `$WEBROOT/charts`, make sure there is a `charts/` directory in your web root, and put the index file and charts inside of that folder. ### ChartMuseum Repository Server ChartMuseum is an open-source Helm Chart Repository server written in Go (Golang), with support for cloud storage backends, including [Google Cloud Storage](https://cloud.google.com/storage/), [Amazon S3](https://aws.amazon.com/s3/), [Microsoft Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/), [Alibaba Cloud OSS Storage](https://www.alibabacloud.com/product/oss), [Openstack Object Storage](https://developer.openstack.org/api-ref/object-store/), [Oracle Cloud Infrastructure Object Storage](https://cloud.oracle.com/storage), [Baidu Cloud BOS Storage](https://cloud.baidu.com/product/bos.html), [Tencent Cloud Object Storage](https://intl.cloud.tencent.com/product/cos), [DigitalOcean Spaces](https://www.digitalocean.com/products/spaces/), [Minio](https://min.io/), and [etcd](https://etcd.io/). You can also use the [ChartMuseum](https://chartmuseum.com/docs/#using-with-local-filesystem-storage) server to host a chart repository from a local file system. ### GitLab Package Registry With GitLab you can publish Helm charts in your project’s Package Registry. Read more about setting up a helm package repository with GitLab [here](https://docs.gitlab.com/ee/user/packages/helm\_repository/). ## Managing Chart Repositories Now that you have a chart repository, the last part of this guide explains how to maintain charts in that repository. ### Store charts in your chart repository Now that you have a chart repository, let's upload a chart and an index file to the repository. | https://github.com/helm/helm-www/blob/main//docs/topics/chart_repository.md | main | helm | [
0.012085524387657642,
-0.006532676983624697,
0.00569200050085783,
-0.04002991318702698,
0.02621433138847351,
-0.022602850571274757,
-0.07808145135641098,
0.032197508960962296,
0.03810284659266472,
0.07811915874481201,
-0.0037601462099701166,
-0.05111043155193329,
0.04791712388396263,
-0.01... | -0.058005 |
## Managing Chart Repositories Now that you have a chart repository, the last part of this guide explains how to maintain charts in that repository. ### Store charts in your chart repository Now that you have a chart repository, let's upload a chart and an index file to the repository. Charts in a chart repository must be packaged (`helm package chart-name/`) and versioned correctly (following [SemVer 2](https://semver.org/) guidelines). These next steps compose an example workflow, but you are welcome to use whatever workflow you fancy for storing and updating charts in your chart repository. Once you have a packaged chart ready, create a new directory, and move your packaged chart to that directory. ```console $ helm package docs/examples/alpine/ $ mkdir fantastic-charts $ mv alpine-0.1.0.tgz fantastic-charts/ $ helm repo index fantastic-charts --url https://fantastic-charts.storage.googleapis.com ``` The last command takes the path of the local directory that you just created and the URL of your remote chart repository and composes an `index.yaml` file inside the given directory path. Now you can upload the chart and the index file to your chart repository using a sync tool or manually. If you're using Google Cloud Storage, check out this [example workflow](/howto/chart\_repository\_sync\_example.md) using the gsutil client. For GitHub, you can simply put the charts in the appropriate destination branch. ### Add new charts to an existing repository Each time you want to add a new chart to your repository, you must regenerate the index. The `helm repo index` command will completely rebuild the `index.yaml` file from scratch, including only the charts that it finds locally. However, you can use the `--merge` flag to incrementally add new charts to an existing `index.yaml` file (a great option when working with a remote repository like GCS). Run `helm repo index --help` to learn more, Make sure that you upload both the revised `index.yaml` file and the chart. And if you generated a provenance file, upload that too. ### Share your charts with others When you're ready to share your charts, simply let someone know what the URL of your repository is. From there, they will add the repository to their helm client via the `helm repo add [NAME] [URL]` command with any name they would like to use to reference the repository. ```console $ helm repo add fantastic-charts https://fantastic-charts.storage.googleapis.com $ helm repo list fantastic-charts https://fantastic-charts.storage.googleapis.com ``` If the charts are backed by HTTP basic authentication, you can also supply the username and password here: ```console $ helm repo add fantastic-charts https://fantastic-charts.storage.googleapis.com --username my-username --password my-password $ helm repo list fantastic-charts https://fantastic-charts.storage.googleapis.com ``` \*\*Note:\*\* A repository will not be added if it does not contain a valid `index.yaml`. \*\*Note:\*\* If your helm repository is e.g. using a self signed certificate, you can use `helm repo add --insecure-skip-tls-verify ...` in order to skip the CA verification. After that, your users will be able to search through your charts. After you've updated the repository, they can use the `helm repo update` command to get the latest chart information. \*Under the hood, the `helm repo add` and `helm repo update` commands are fetching the index.yaml file and storing them in the `$XDG\_CACHE\_HOME/helm/repository/cache/` directory. This is where the `helm search` function finds information about charts.\* | https://github.com/helm/helm-www/blob/main//docs/topics/chart_repository.md | main | helm | [
0.02743297629058361,
-0.017644455656409264,
0.0036166240461170673,
-0.020694563165307045,
0.005831231828778982,
0.009323900565505028,
-0.04826068878173828,
0.06056421250104904,
0.02261294052004814,
0.0953817218542099,
0.022243458777666092,
0.008931745775043964,
0.05774262547492981,
-0.0081... | 0.021598 |
Kubernetes is an API-driven system and the API evolves over time to reflect the evolving understanding of the problem space. This is common practice across systems and their APIs. An important part of evolving APIs is a good deprecation policy and process to inform users of how changes to APIs are implemented. In other words, consumers of your API need to know in advance and in what release an API will be removed or changed. This removes the element of surprise and breaking changes to consumers. The [Kubernetes deprecation policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/) documents how Kubernetes handles the changes to its API versions. The policy for deprecation states the timeframe that API versions will be supported following a deprecation announcement. It is therefore important to be aware of deprecation announcements and know when API versions will be removed, to help minimize the effect. This is an example of an announcement [for the removal of deprecated API versions in Kubernetes 1.16](https://kubernetes.io/blog/2019/07/18/api-deprecations-in-1-16/) and was advertised a few months prior to the release. These API versions would have been announced for deprecation prior to this again. This shows that there is a good policy in place which informs consumers of API version support. Helm templates specify a [Kubernetes API group](https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-groups) when defining a Kubernetes object, similar to a Kubernetes manifest file. It is specified in the `apiVersion` field of the template and it identifies the API version of the Kubernetes object. This means that Helm users and chart maintainers need to be aware when Kubernetes API versions have been deprecated and in what Kubernetes version they will be removed. ## Chart Maintainers You should audit your charts checking for Kubernetes API versions that are deprecated or are removed in a Kubernetes version. The API versions found as due to be or that are now out of support, should be updated to the supported version and a new version of the chart released. The API version is defined by the `kind` and `apiVersion` fields. For example, here is a removed `Deployment` object API version in Kubernetes 1.16: ```yaml apiVersion: apps/v1beta1 kind: Deployment ``` ## Helm Users You should audit the charts that you use (similar to [chart maintainers](#chart-maintainers)) and identify any charts where API versions are deprecated or removed in a Kubernetes version. For the charts identified, you need to check for the latest version of the chart (which has supported API versions) or update the chart yourself. Additionally, you also need to audit any charts deployed (i.e. Helm releases) checking again for any deprecated or removed API versions. This can be done by getting details of a release using the `helm get manifest` command. The means for updating a Helm release to supported APIs depends on your findings as follows: 1. If you find deprecated API versions only then: - Perform a `helm upgrade` with a version of the chart with supported Kubernetes API versions - Add a description in the upgrade, something along the lines to not perform a rollback to a Helm version prior to this current version 2. If you find any API version(s) that is/are removed in a Kubernetes version then: - If you are running a Kubernetes version where the API version(s) are still available (for example, you are on Kubernetes 1.15 and found you use APIs that will be removed in Kubernetes 1.16): - Follow the step 1 procedure - Otherwise (for example, you are already running a Kubernetes version where some API versions reported by `helm get manifest` are no longer available): - You need to edit the release manifest that is stored in the cluster to update the | https://github.com/helm/helm-www/blob/main//docs/topics/kubernetes_apis.md | main | helm | [
-0.03599608689546585,
0.058593202382326126,
0.1270698606967926,
-0.026320403441786766,
0.05343586951494217,
-0.0015797780361026525,
-0.06898647546768188,
-0.033452119678258896,
0.11009252071380615,
0.03815791383385658,
0.006488235667347908,
0.042290881276130676,
-0.0418061800301075,
-0.027... | 0.17254 |
in Kubernetes 1.16): - Follow the step 1 procedure - Otherwise (for example, you are already running a Kubernetes version where some API versions reported by `helm get manifest` are no longer available): - You need to edit the release manifest that is stored in the cluster to update the API versions to supported APIs. See [Updating API Versions of a Release Manifest](#updating-api-versions-of-a-release-manifest) for more details > Note: In all cases of updating a Helm release with supported APIs, you should never rollback the release to a version prior to the release version with the supported APIs. > Recommendation: The best practice is to upgrade releases using deprecated API versions to supported API versions, prior to upgrading to a kubernetes cluster that removes those API versions. If you don't update a release as suggested previously, you will have an error similar to the following when trying to upgrade a release in a Kubernetes version where its API version(s) is/are removed: ``` Error: UPGRADE FAILED: current release manifest contains removed kubernetes api(s) for this kubernetes version and it is therefore unable to build the kubernetes objects for performing the diff. error from kubernetes: unable to recognize "": no matches for kind "Deployment" in version "apps/v1beta1" ``` Helm fails in this scenario because it attempts to create a diff patch between the current deployed release (which contains the Kubernetes APIs that are removed in this Kubernetes version) against the chart you are passing with the updated/supported API versions. The underlying reason for failure is that when Kubernetes removes an API version, the Kubernetes Go client library can no longer parse the deprecated objects and Helm therefore fails when calling the library. Helm unfortunately is unable to recover from this situation and is no longer able to manage such a release. See [Updating API Versions of a Release Manifest](#updating-api-versions-of-a-release-manifest) for more details on how to recover from this scenario. ## Updating API Versions of a Release Manifest The manifest is a property of the Helm release object which is stored in the data field of a Secret (default) or ConfigMap in the cluster. The data field contains a gzipped object which is base 64 encoded (there is an additional base 64 encoding for a Secret). There is a Secret/ConfigMap per release version/revision in the namespace of the release. You can use the Helm [mapkubeapis](https://github.com/helm/helm-mapkubeapis) plugin to perform the update of a release to supported APIs. Check out the readme for more details. Alternatively, you can follow these manual steps to perform an update of the API versions of a release manifest. Depending on your configuration you will follow the steps for the Secret or ConfigMap backend. - Get the name of the Secret or Configmap associated with the latest deployed release: - Secrets backend: `kubectl get secret -l owner=helm,status=deployed,name= --namespace | awk '{print $1}' | grep -v NAME` - ConfigMap backend: `kubectl get configmap -l owner=helm,status=deployed,name= --namespace | awk '{print $1}' | grep -v NAME` - Get latest deployed release details: - Secrets backend: `kubectl get secret -n -o yaml > release.yaml` - ConfigMap backend: `kubectl get configmap -n -o yaml > release.yaml` - Backup the release in case you need to restore if something goes wrong: - `cp release.yaml release.bak` - In case of emergency, restore: `kubectl apply -f release.bak -n ` - Decode the release object: - Secrets backend:`cat release.yaml | grep -oP '(?<=release: ).\*' | base64 -d | base64 -d | gzip -d > release.data.decoded` - ConfigMap backend: `cat release.yaml | grep -oP '(?<=release: ).\*' | base64 -d | gzip -d > release.data.decoded` - Change API versions of the manifests. | https://github.com/helm/helm-www/blob/main//docs/topics/kubernetes_apis.md | main | helm | [
0.05092088133096695,
0.032970625907182693,
0.09611780941486359,
-0.07439904659986496,
0.05658810958266258,
0.019639790058135986,
-0.10164959728717804,
-0.03538072481751442,
0.050430018454790115,
0.0886969268321991,
0.012130632065236568,
-0.02069510705769062,
-0.030426373705267906,
0.022900... | 0.028729 |
- Decode the release object: - Secrets backend:`cat release.yaml | grep -oP '(?<=release: ).\*' | base64 -d | base64 -d | gzip -d > release.data.decoded` - ConfigMap backend: `cat release.yaml | grep -oP '(?<=release: ).\*' | base64 -d | gzip -d > release.data.decoded` - Change API versions of the manifests. Can use any tool (e.g. editor) to make the changes. This is in the `manifest` field of your decoded release object (`release.data.decoded`) - Encode the release object: - Secrets backend: `cat release.data.decoded | gzip | base64 | base64` - ConfigMap backend: `cat release.data.decoded | gzip | base64` - Replace `data.release` property value in the deployed release file (`release.yaml`) with the new encoded release object - Apply file to namespace: `kubectl apply -f release.yaml -n ` - Perform a `helm upgrade` with a version of the chart with supported Kubernetes API versions - Add a description in the upgrade, something along the lines to not perform a rollback to a Helm version prior to this current version | https://github.com/helm/helm-www/blob/main//docs/topics/kubernetes_apis.md | main | helm | [
-0.007978728041052818,
0.046862367540597916,
0.026986006647348404,
-0.034546736627817154,
-0.0007052659639157355,
-0.0376836434006691,
-0.06037604808807373,
-0.032381266355514526,
0.012370387092232704,
0.06011351943016052,
0.02967241406440735,
-0.029531296342611313,
-0.049016766250133514,
... | 0.047965 |
For the benefit of its users, Helm defines and announces release dates in advance. This document describes the policy governing Helm's release schedule. ## Release calendar A public calendar showing the upcoming Helm releases can be found [here](https://helm.sh/calendar/release). ## Semantic versioning Helm versions are expressed as `x.y.z`, where `x` is the major version, `y` is the minor version, and `z` is the patch version, following [Semantic Versioning](https://semver.org/spec/v2.0.0.html) terminology. ## Patch releases Patch releases provide users with bug fixes and security fixes. They do not contain new features. A new patch release relating to the latest minor/major release will normally be done once a month on the second Wednesday of each month. A patch release to fix a high priority regression or security issue can be done whenever needed. A patch release will be cancelled for any of the following reasons: - if there is no new content since the previous release - if the patch release date falls within one week before the first release candidate (RC1) of an upcoming minor release - if the patch release date falls within four weeks following a minor release ## Minor releases Minor releases contain security and bug fixes as well as new features. They are backwards compatible with respect to the API and the CLI usage. To align with Kubernetes releases, a minor helm release will be done every 4 months (3 releases a year). Extra minor releases can be done if needed but will not affect the timeline of an announced future release, unless the announced release is less than 7 days away. At the same time as a release is published, the date of the next minor release will be announced and posted to Helm's main web page. ## Major releases Major releases contain breaking changes. Such releases are rare but are sometimes necessary to allow helm to continue to evolve in important new directions. Major releases can be difficult to plan. With that in mind, a final release date will only be chosen and announced once the first beta version of such a release is available. | https://github.com/helm/helm-www/blob/main//docs/topics/release_policy.md | main | helm | [
-0.013872941955924034,
0.033214107155799866,
0.12967847287654877,
-0.028001999482512474,
0.08978505432605743,
0.012175442650914192,
-0.10333503782749176,
-0.0291209127753973,
0.030694082379341125,
0.069670669734478,
0.038887035101652145,
0.0585201196372509,
-0.012645978480577469,
-0.065975... | 0.05726 |
In Kubernetes, granting roles to a user or an application-specific service account is a best practice to ensure that your application is operating in the scope that you have specified. Read more about service account permissions [in the official Kubernetes docs](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#service-account-permissions). From Kubernetes 1.6 onwards, Role-based Access Control is enabled by default. RBAC allows you to specify which types of actions are permitted depending on the user and their role in your organization. With RBAC, you can - grant privileged operations (creating cluster-wide resources, like new roles) to administrators - limit a user's ability to create resources (pods, persistent volumes, deployments) to specific namespaces, or in cluster-wide scopes (resource quotas, roles, custom resource definitions) - limit a user's ability to view resources either in specific namespaces or at a cluster-wide scope. This guide is for administrators who want to restrict the scope of a user's interaction with the Kubernetes API. ## Managing user accounts All Kubernetes clusters have two categories of users: service accounts managed by Kubernetes, and normal users. Normal users are assumed to be managed by an outside, independent service. An administrator distributing private keys, a user store like Keystone or Google Accounts, even a file with a list of usernames and passwords. In this regard, Kubernetes does not have objects which represent normal user accounts. Normal users cannot be added to a cluster through an API call. In contrast, service accounts are users managed by the Kubernetes API. They are bound to specific namespaces, and created automatically by the API server or manually through API calls. Service accounts are tied to a set of credentials stored as Secrets, which are mounted into pods allowing in-cluster processes to talk to the Kubernetes API. API requests are tied to either a normal user or a service account, or are treated as anonymous requests. This means every process inside or outside the cluster, from a human user typing `kubectl` on a workstation, to kubelets on nodes, to members of the control plane, must authenticate when making requests to the API server, or be treated as an anonymous user. ## Roles, ClusterRoles, RoleBindings, and ClusterRoleBindings In Kubernetes, user accounts and service accounts can only view and edit resources they have been granted access to. This access is granted through the use of Roles and RoleBindings. Roles and RoleBindings are bound to a particular namespace, which grant users the ability to view and/or edit resources within that namespace the Role provides them access to. At a cluster scope, these are called ClusterRoles and ClusterRoleBindings. Granting a user a ClusterRole grants them access to view and/or edit resources across the entire cluster. It is also required to view and/or edit resources at the cluster scope (namespaces, resource quotas, nodes). ClusterRoles can be bound to a particular namespace through reference in a RoleBinding. The `admin`, `edit` and `view` default ClusterRoles are commonly used in this manner. These are a few ClusterRoles available by default in Kubernetes. They are intended to be user-facing roles. They include super-user roles (`cluster-admin`), and roles with more granular access (`admin`, `edit`, `view`). | Default ClusterRole | Default ClusterRoleBinding | Description |---------------------|----------------------------|------------- | `cluster-admin` | `system:masters` group | Allows super-user access to perform any action on any resource. When used in a ClusterRoleBinding, it gives full control over every resource in the cluster and in all namespaces. When used in a RoleBinding, it gives full control over every resource in the rolebinding's namespace, including the namespace itself. | `admin` | None | Allows admin access, intended to be granted within a namespace using a RoleBinding. If used in a RoleBinding, | https://github.com/helm/helm-www/blob/main//docs/topics/rbac.md | main | helm | [
-0.012256776914000511,
-0.04118223115801811,
-0.039511147886514664,
-0.018714435398578644,
-0.0803070142865181,
0.03183818608522415,
0.09332229197025299,
-0.006311304401606321,
0.04725682735443115,
0.022123314440250397,
-0.05498048663139343,
-0.00931432843208313,
0.03149188682436943,
0.052... | 0.137476 |
in the cluster and in all namespaces. When used in a RoleBinding, it gives full control over every resource in the rolebinding's namespace, including the namespace itself. | `admin` | None | Allows admin access, intended to be granted within a namespace using a RoleBinding. If used in a RoleBinding, allows read/write access to most resources in a namespace, including the ability to create roles and rolebindings within the namespace. It does not allow write access to resource quota or to the namespace itself. | `edit` | None | Allows read/write access to most objects in a namespace. It does not allow viewing or modifying roles or rolebindings. | `view` | None | Allows read-only access to see most objects in a namespace. It does not allow viewing roles or rolebindings. It does not allow viewing secrets, since those are escalating. ## Restricting a user account's access using RBAC Now that we understand the basics of Role-based Access Control, let's discuss how an administrator can restrict a user's scope of access. ### Example: Grant a user read/write access to a particular namespace To restrict a user's access to a particular namespace, we can use either the `edit` or the `admin` role. If your charts create or interact with Roles and Rolebindings, you'll want to use the `admin` ClusterRole. Additionally, you may also create a RoleBinding with `cluster-admin` access. Granting a user `cluster-admin` access at the namespace scope provides full control over every resource in the namespace, including the namespace itself. For this example, we will create a user with the `edit` Role. First, create the namespace: ```console $ kubectl create namespace foo ``` Now, create a RoleBinding in that namespace, granting the user the `edit` role. ```console $ kubectl create rolebinding sam-edit --clusterrole edit \ --user sam \ --namespace foo ``` ### Example: Grant a user read/write access at the cluster scope If a user wishes to install a chart that installs cluster-scope resources (namespaces, roles, custom resource definitions, etc.), they will require cluster-scope write access. To do that, grant the user either `admin` or `cluster-admin` access. Granting a user `cluster-admin` access grants them access to absolutely every resource available in Kubernetes, including node access with `kubectl drain` and other administrative tasks. It is highly recommended to consider providing the user `admin` access instead, or to create a custom ClusterRole tailored to their needs. ```console $ kubectl create clusterrolebinding sam-view --clusterrole view \ --user sam $ kubectl create clusterrolebinding sam-secret-reader --clusterrole secret-reader \ --user sam ``` ### Example: Grant a user read-only access to a particular namespace You might've noticed that there is no ClusterRole available for viewing secrets. The `view` ClusterRole does not grant a user read access to Secrets due to escalation concerns. Helm stores release metadata as Secrets by default. In order for a user to run `helm list`, they need to be able to read these secrets. For that, we will create a special `secret-reader` ClusterRole. Create the file `cluster-role-secret-reader.yaml` and write the following content into the file: ```yaml apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: secret-reader rules: - apiGroups: [""] resources: ["secrets"] verbs: ["get", "watch", "list"] ``` Then, create the ClusterRole using ```console $ kubectl create -f clusterrole-secret-reader.yaml ``` Once that's done, we can grant a user read access to most resources, and then grant them read access to secrets: ```console $ kubectl create namespace foo $ kubectl create rolebinding sam-view --clusterrole view \ --user sam \ --namespace foo $ kubectl create rolebinding sam-secret-reader --clusterrole secret-reader \ --user sam \ --namespace foo ``` ### Example: Grant a user read-only access at the cluster scope In certain | https://github.com/helm/helm-www/blob/main//docs/topics/rbac.md | main | helm | [
-0.041950155049562454,
-0.09331276267766953,
-0.107829250395298,
0.0526021309196949,
-0.02021869271993637,
0.04606975242495537,
0.04791250079870224,
-0.05613957345485687,
0.0077309804037213326,
0.02942810021340847,
0.005664468742907047,
0.03941475227475166,
0.07389961928129196,
-0.02257720... | 0.139508 |
read access to secrets: ```console $ kubectl create namespace foo $ kubectl create rolebinding sam-view --clusterrole view \ --user sam \ --namespace foo $ kubectl create rolebinding sam-secret-reader --clusterrole secret-reader \ --user sam \ --namespace foo ``` ### Example: Grant a user read-only access at the cluster scope In certain scenarios, it may be beneficial to grant a user cluster-scope access. For example, if a user wants to run the command `helm list --all-namespaces`, the API requires the user has cluster-scope read access. To do that, grant the user both `view` and `secret-reader` access as described above, but with a ClusterRoleBinding. ```console $ kubectl create clusterrolebinding sam-view --clusterrole view \ --user sam $ kubectl create clusterrolebinding sam-secret-reader --clusterrole secret-reader \ --user sam ``` ## Additional Thoughts The examples shown above utilize the default ClusterRoles provided with Kubernetes. For more fine-grained control over what resources users are granted access to, have a look at [the Kubernetes documentation](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) on creating your own custom Roles and ClusterRoles. | https://github.com/helm/helm-www/blob/main//docs/topics/rbac.md | main | helm | [
0.0056173172779381275,
-0.022815514355897903,
-0.05512961372733116,
0.04994989559054375,
-0.04052085056900978,
0.051730670034885406,
0.06349779665470123,
-0.03665269911289215,
0.04709606245160103,
0.03890175372362137,
-0.012511772103607655,
-0.08286138623952866,
0.01865566521883011,
0.0256... | 0.107112 |
A library chart is a type of [Helm chart](/topics/charts.mdx) that defines chart primitives or definitions which can be shared by Helm templates in other charts. This allows users to share snippets of code that can be re-used across charts, avoiding repetition and keeping charts [DRY](https://en.wikipedia.org/wiki/Don%27t\_repeat\_yourself). The library chart was introduced in Helm 3 to formally recognize common or helper charts that have been used by chart maintainers since Helm 2. By including it as a chart type, it provides: - A means to explicitly distinguish between common and application charts - Logic to prevent installation of a common chart - No rendering of templates in a common chart which may contain release artifacts - Allow for dependent charts to use the importer's context A chart maintainer can define a common chart as a library chart and now be confident that Helm will handle the chart in a standard consistent fashion. It also means that definitions in an application chart can be shared by changing the chart type. ## Create a Simple Library Chart As mentioned previously, a library chart is a type of [Helm chart](/topics/charts.mdx). This means that you can start off by creating a scaffold chart: ```console $ helm create mylibchart Creating mylibchart ``` You will first remove all the files in `templates` directory as we will create our own templates definitions in this example. ```console $ rm -rf mylibchart/templates/\* ``` The values file will not be required either. ```console $ rm -f mylibchart/values.yaml ``` Before we jump into creating common code, lets do a quick review of some relevant Helm concepts. A [named template](/chart\_template\_guide/named\_templates.md) (sometimes called a partial or a subtemplate) is simply a template defined inside of a file, and given a name. In the `templates/` directory, any file that begins with an underscore(\_) is not expected to output a Kubernetes manifest file. So by convention, helper templates and partials are placed in a `\_\*.tpl` or `\_\*.yaml` files. In this example, we will code a common ConfigMap which creates an empty ConfigMap resource. We will define the common ConfigMap in file `mylibchart/templates/\_configmap.yaml` as follows: ```yaml {{- define "mylibchart.configmap.tpl" -}} apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name | printf "%s-%s" .Chart.Name }} data: {} {{- end -}} {{- define "mylibchart.configmap" -}} {{- include "mylibchart.util.merge" (append . "mylibchart.configmap.tpl") -}} {{- end -}} ``` The ConfigMap construct is defined in named template `mylibchart.configmap.tpl`. It is a simple ConfigMap with an empty resource, `data`. Within this file there is another named template called `mylibchart.configmap`. This named template includes another named template `mylibchart.util.merge` which will take 2 named templates as arguments, the template calling `mylibchart.configmap` and `mylibchart.configmap.tpl`. The helper function `mylibchart.util.merge` is a named template in `mylibchart/templates/\_util.yaml`. It is a handy util from [The Common Helm Helper Chart](#the-common-helm-helper-chart) because it merges the 2 templates and overrides any common parts in both: ```yaml {{- /\* mylibchart.util.merge will merge two YAML templates and output the result. This takes an array of three values: - the top context - the template name of the overrides (destination) - the template name of the base (source) \*/}} {{- define "mylibchart.util.merge" -}} {{- $top := first . -}} {{- $overrides := fromYaml (include (index . 1) $top) | default (dict ) -}} {{- $tpl := fromYaml (include (index . 2) $top) | default (dict ) -}} {{- toYaml (merge $overrides $tpl) -}} {{- end -}} ``` This is important when a chart wants to use common code that it needs to customize with its configuration. Finally, lets change the chart type to `library`. This requires editing `mylibchart/Chart.yaml` as follows: ```yaml apiVersion: v2 name: mylibchart description: A Helm | https://github.com/helm/helm-www/blob/main//docs/topics/library_charts.md | main | helm | [
-0.03090420924127102,
-0.035607922822237015,
-0.019821643829345703,
-0.04627799242734909,
0.09225212037563324,
0.038595978170633316,
-0.024977581575512886,
0.060976866632699966,
0.052569132298231125,
-0.03410390391945839,
-0.020246781408786774,
0.0398181788623333,
0.049232013523578644,
0.0... | 0.101666 |
toYaml (merge $overrides $tpl) -}} {{- end -}} ``` This is important when a chart wants to use common code that it needs to customize with its configuration. Finally, lets change the chart type to `library`. This requires editing `mylibchart/Chart.yaml` as follows: ```yaml apiVersion: v2 name: mylibchart description: A Helm chart for Kubernetes # A chart can be either an 'application' or a 'library' chart. # # Application charts are a collection of templates that can be packaged into versioned archives # to be deployed. # # Library charts provide useful utilities or functions for the chart developer. They're included as # a dependency of application charts to inject those utilities and functions into the rendering # pipeline. Library charts do not define any templates and therefore cannot be deployed. # type: application type: library # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. version: 0.1.0 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application and it is recommended to use it with quotes. appVersion: "1.16.0" ``` The library chart is now ready to be shared and its ConfigMap definition to be re-used. Before moving on, it is worth checking if Helm recognizes the chart as a library chart: ```console $ helm install mylibchart mylibchart/ Error: library charts are not installable ``` ## Use the Simple Library Chart It is time to use the library chart. This means creating a scaffold chart again: ```console $ helm create mychart Creating mychart ``` Lets clean out the template files again as we want to create a ConfigMap only: ```console $ rm -rf mychart/templates/\* ``` When we want to create a simple ConfigMap in a Helm template, it could look similar to the following: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name | printf "%s-%s" .Chart.Name }} data: myvalue: "Hello World" ``` We are however going to re-use the common code already created in `mylibchart`. The ConfigMap can be created in the file `mychart/templates/configmap.yaml` as follows: ```yaml {{- include "mylibchart.configmap" (list . "mychart.configmap") -}} {{- define "mychart.configmap" -}} data: myvalue: "Hello World" {{- end -}} ``` You can see that it simplifies the work we have to do by inheriting the common ConfigMap definition which adds standard properties for ConfigMap. In our template we add the configuration, in this case the data key `myvalue` and its value. The configuration override the empty resource of the common ConfigMap. This is feasible because of the helper function `mylibchart.util.merge` we mentioned in the previous section. To be able to use the common code, we need to add `mylibchart` as a dependency. Add the following to the end of the file `mychart/Chart.yaml`: ```yaml # My common code in my library chart dependencies: - name: mylibchart version: 0.1.0 repository: file://../mylibchart ``` This includes the library chart as a dynamic dependency from the filesystem which is at the same parent path as our application chart. As we are including the library chart as a dynamic dependency, we need to run `helm dependency update`. It will copy the library chart into your `charts/` directory. ```console $ helm dependency update mychart/ Hang tight while we grab the latest from your chart repositories... ...Successfully got an update from the "stable" chart repository Update Complete. ⎈Happy Helming!⎈ Saving 1 charts Deleting outdated charts ``` We are now ready to deploy our chart. Before installing, it is worth checking the rendered template first. ```console $ helm install | https://github.com/helm/helm-www/blob/main//docs/topics/library_charts.md | main | helm | [
0.0294851865619421,
0.01720176637172699,
0.08071102946996689,
-0.07011469453573227,
0.016584385186433792,
0.047363199293613434,
-0.058508213609457016,
0.03484659641981125,
0.08241981267929077,
0.041606657207012177,
0.005024641286581755,
-0.014365884475409985,
-0.03791552782058716,
-0.01041... | 0.055339 |
we grab the latest from your chart repositories... ...Successfully got an update from the "stable" chart repository Update Complete. ⎈Happy Helming!⎈ Saving 1 charts Deleting outdated charts ``` We are now ready to deploy our chart. Before installing, it is worth checking the rendered template first. ```console $ helm install mydemo mychart/ --debug --dry-run install.go:159: [debug] Original chart version: "" install.go:176: [debug] CHART PATH: /root/test/helm-charts/mychart NAME: mydemo LAST DEPLOYED: Tue Mar 3 17:48:47 2020 NAMESPACE: default STATUS: pending-install REVISION: 1 TEST SUITE: None USER-SUPPLIED VALUES: {} COMPUTED VALUES: affinity: {} fullnameOverride: "" image: pullPolicy: IfNotPresent repository: nginx imagePullSecrets: [] ingress: annotations: {} enabled: false hosts: - host: chart-example.local paths: [] tls: [] mylibchart: global: {} nameOverride: "" nodeSelector: {} podSecurityContext: {} replicaCount: 1 resources: {} securityContext: {} service: port: 80 type: ClusterIP serviceAccount: annotations: {} create: true name: null tolerations: [] HOOKS: MANIFEST: --- # Source: mychart/templates/configmap.yaml apiVersion: v1 data: myvalue: Hello World kind: ConfigMap metadata: labels: app: mychart chart: mychart-0.1.0 release: mydemo name: mychart-mydemo ``` This looks like the ConfigMap we want with data override of `myvalue: Hello World`. Lets install it: ```console $ helm install mydemo mychart/ NAME: mydemo LAST DEPLOYED: Tue Mar 3 17:52:40 2020 NAMESPACE: default STATUS: deployed REVISION: 1 TEST SUITE: None ``` We can retrieve the release and see that the actual template was loaded. ```console $ helm get manifest mydemo --- # Source: mychart/templates/configmap.yaml apiVersion: v1 data: myvalue: Hello World kind: ConfigMap metadata: labels: app: mychart chart: mychart-0.1.0 release: mydemo name: mychart-mydemo ``` ## Library Chart Benefits Because of their inability to act as standalone charts, library charts can leverage the following functionality: - The `.Files` object references the file paths on the parent chart, rather than the path local to the library chart - The `.Values` object is the same as the parent chart, in contrast to application [subcharts](/chart\_template\_guide/subcharts\_and\_globals.md) which receive the section of values configured under their header in the parent. ## The Common Helm Helper Chart ```markdown Note: The Common Helm Helper Chart repo on Github is no longer actively maintained, and the repo has been deprecated and archived. ``` This [chart](https://github.com/helm/charts/tree/master/incubator/common) was the original pattern for common charts. It provides utilities that reflect best practices of Kubernetes chart development. Best of all it can be used off the bat by you when developing your charts to give you handy shared code. Here is a quick way to use it. For more details, have a look at the [README](https://github.com/helm/charts/blob/master/incubator/common/README.md). Create a scaffold chart again: ```console $ helm create demo Creating demo ``` Lets use the common code from the helper chart. First, edit deployment `demo/templates/deployment.yaml` as follows: ```yaml {{- template "common.deployment" (list . "demo.deployment") -}} {{- define "demo.deployment" -}} ## Define overrides for your Deployment resource here, e.g. apiVersion: apps/v1 spec: replicas: {{ .Values.replicaCount }} selector: matchLabels: {{- include "demo.selectorLabels" . | nindent 6 }} template: metadata: labels: {{- include "demo.selectorLabels" . | nindent 8 }} {{- end -}} ``` And now the service file, `demo/templates/service.yaml` as follows: ```yaml {{- template "common.service" (list . "demo.service") -}} {{- define "demo.service" -}} ## Define overrides for your Service resource here, e.g. # metadata: # labels: # custom: label # spec: # ports: # - port: 8080 {{- end -}} ``` These templates show how inheriting the common code from the helper chart simplifies your coding down to your configuration or customization of the resources. To be able to use the common code, we need to add `common` as a dependency. Add the following to the end of the file `demo/Chart.yaml`: ```yaml dependencies: - name: common version: "^0.0.5" repository: "https://charts.helm.sh/incubator/" ``` Note: You | https://github.com/helm/helm-www/blob/main//docs/topics/library_charts.md | main | helm | [
0.0466129295527935,
0.013363569974899292,
0.0661216527223587,
-0.009557660669088364,
0.05553203448653221,
-0.014317523688077927,
-0.08071286976337433,
-0.0036404752172529697,
0.0035197508987039328,
0.0998518243432045,
0.06382101029157639,
-0.03253582864999771,
-0.0333155058324337,
-0.01225... | -0.059223 |
simplifies your coding down to your configuration or customization of the resources. To be able to use the common code, we need to add `common` as a dependency. Add the following to the end of the file `demo/Chart.yaml`: ```yaml dependencies: - name: common version: "^0.0.5" repository: "https://charts.helm.sh/incubator/" ``` Note: You will need to add the `incubator` repo to the Helm repository list (`helm repo add`). As we are including the chart as a dynamic dependency, we need to run `helm dependency update`. It will copy the helper chart into your `charts/` directory. As helper chart is using some Helm 2 constructs, you will need to add the following to `demo/values.yaml` to enable the `nginx` image to be loaded as this was updated in Helm 3 scaffold chart: ```yaml image: tag: 1.16.0 ``` You can test that the chart templates are correct prior to deploying using the `helm lint` and `helm template` commands. If it's good to go, deploy away using `helm install`! | https://github.com/helm/helm-www/blob/main//docs/topics/library_charts.md | main | helm | [
-0.044866204261779785,
0.014772738330066204,
0.06526575237512589,
-0.0308906901627779,
0.04775763675570488,
0.04114166274666786,
-0.09547001868486404,
0.05269446223974228,
0.019756624475121498,
0.07158929854631424,
0.039657168090343475,
-0.05148274078965187,
-0.004039429593831301,
0.046541... | -0.028094 |
# ESO Talks A list of talks given by people at conferences and events. Feel free to let us know if you are talking about ESO at some place! We would be happy to mention you here! ## Kubernetes Community Days UK [](https://www.youtube.com/watch?v=IsoQWxw3Nk4) ## CNCF Community Groups Canada [](https://www.youtube.com/watch?v=CsJgfHQA0SQ) ## Container Days Hamburg [](https://www.youtube.com/watch?v=\_ZDkHLRYujo) ## Kubernetes Community Days UK - 2022 [](https://www.youtube.com/watch?v=TEV13ELPhI8) ## AWS Containers from the Couch [](https://www.youtube.com/watch?v=FityN80Cpto) ## FOSDEM '23 (Containers devroom) [FOSDEM '23 (Containers devroom)](https://fosdem.org/2023/schedule/event/container\_kubernetes\_secret\_rotation/) ## Form3 .tech Podcast - Building and maintaining External Secrets Operator [Podcast and Blog](https://www.form3.tech/engineering/content/podcast-ext-secrets) ## ⚡️ Enlightning - Exploring External Secrets Operator [](https://www.youtube.com/watch?v=7uY\_qW6TWf8&ab\_channel=VMwareTanzu) ## KubeCon EU '23 - Protecting Your Crown Jewels with External Secrets Operator [](https://www.youtube.com/watch?v=upwIlUHkDf8&ab\_channel=CNCF%5BCloudNativeComputingFoundation%5D) | https://github.com/external-secrets/external-secrets/blob/main//docs/eso-talks.md | main | external-secrets | [
0.020794913172721863,
0.0567362904548645,
0.05406339094042778,
-0.05174150690436363,
0.11385273933410645,
0.026472503319382668,
0.07070300728082657,
-0.09356197714805603,
-0.009975573047995567,
0.006366808898746967,
-0.0616830550134182,
-0.09712637960910797,
-0.06594781577587128,
0.0195732... | 0.099447 |
# ESO Demos A list of demos given by people going through simple setups with ESO. Feel free to let us know if you have a demo that you want to include here! ## Manage Kubernetes Secrets With External Secrets Operator on DevOps Toolkit Viktor Farvik shows us how to use ESO with GCP provider and explores a simple workflow with the project. [](https://www.youtube.com/watch?v=SyRZe5YVCVk) ## Managing Kubernetes Secrets: Comparing External Secrets Operator and Secrets Store CSI Driver Kim Schlesinger and Daniel Hix show us how to install and use both projects, comparing their features and limitations in different situations. [](https://www.youtube.com/watch?v=EW25WpErCmA) ## GCP SM + AWS SM + Azure Key Vault Demo This was an old demo going through an old version of ESO. Most of it is still valid, but beware of CRD and breaking change differences. [](https://www.youtube.com/watch?v=L6tn1YdMkF8) ## How to manage secrets in OpenShift using Vault and External Secrets Operator Balkrishna Pandey shows us here how to use ClusterSecretStore and how to integrate ESO with Hashicorp Vault on Openshift. [](https://www.youtube.com/watch?v=N7njTq6TSx8) ## Managing Sensitive Data in Kubernetes with Sealed Secrets and External Secrets Operator (ESO) Lukonde Mwila demonstrates how ESO works and how to fetch secrets from AWS Secrets Manager into your Kubernetes cluster. [](https://www.youtube.com/watch?v=FD8zzHPbhoY) ## External Secrets Operator: A Cloud Native way to manage your secrets Charl Klein gives an overview of the external secrets project, and a walkthrough of getting ESO up and running with Azure Key Vault [](https://www.youtube.com/watch?v=phohsHfl55A) | https://github.com/external-secrets/external-secrets/blob/main//docs/eso-demos.md | main | external-secrets | [
-0.07555965334177017,
-0.017236126586794853,
0.05274759605526924,
-0.051806993782520294,
0.010235083289444447,
-0.03437202051281929,
0.02923126332461834,
0.014694239012897015,
-0.026312317699193954,
0.055525604635477066,
-0.01165563240647316,
-0.03790895268321037,
-0.008882698602974415,
-0... | 0.246922 |
External Secrets Operator integrates with [Password Depot API](https://www.password-depot.de/) to sync Password Depot to secrets held on the Kubernetes cluster. ### Authentication The API requires a username and password. ```yaml {% include 'password-depot-credentials-secret.yaml' %} ``` ### Update secret store Be sure the `passworddepot` provider is listed in the `Kind=SecretStore` and host and database are set. ```yaml {% include 'passworddepot-secret-store.yaml' %} ``` ### Creating external secret To sync a Password Depot variable to a secret on the Kubernetes cluster, a `Kind=ExternalSecret` is needed. ```yaml {% include 'passworddepot-external-secret.yaml' %} ``` #### Using DataFrom DataFrom can be used to get a variable as a JSON string and attempt to parse it. ```yaml {% include 'passworddepot-external-secret-json.yaml' %} ``` ### Getting the Kubernetes secret The operator will fetch the project variable and inject it as a `Kind=Secret`. ``` kubectl get secret passworddepot-secret-to-create -o jsonpath='{.data.secretKey}' | base64 -d ``` | https://github.com/external-secrets/external-secrets/blob/main//docs/provider-passworddepot.md | main | external-secrets | [
-0.07395230233669281,
-0.0007809133967384696,
-0.011208800598978996,
0.008899949491024017,
-0.06681355088949203,
-0.023629099130630493,
0.00598725862801075,
0.03982100635766983,
0.054425690323114395,
-0.0002529948833398521,
-0.007272662129253149,
-0.041260018944740295,
0.06408394128084183,
... | 0.034926 |
# ESO Blogs A list of blogs written by people all over the community. Feel free to let us know if you are writing about ESO at some place! We would be happy to mention you here! ## [Secrets Replication in Kubernetes with ESO](https://externalsecrets.com/blog/secrets-replication/) [@Gustavo Carvalho](https://www.linkedin.com/in/gustavo-carvalho-51427444/) describes how to use ESO to synchronize in-cluster secrets across multiple namespaces using only two manifests: `ClusterSecretStore` and `ClusterExternalSecret`. ## [Pulumi ESC and External Secrets Operator: The Perfect Solution for Today's Cloud-Native Secret Management](https://www.pulumi.com/blog/cloud-native-secret-management-with-pulumi-esc-and-external-secrets-operator/) [@Engin Diri](https://www.linkedin.com/in/engin-diri/) walks through the integration of ESO with Pulumi ESC, offering a practical guide for enhancing security from cloud-native application development to infrastructure provisioning. This blog provides a hands-on guide to setting up ESO and Pulumi ESC, and demonstrates how to use them together to manage secrets in a Kubernetes cluster. ## [From vulnerable to unhackable: secrets management in cloud-native environments](https://medium.com/@as\_mallem/from-vulnerable-to-unhackable-secrets-management-in-cloud-native-environments-cb341bd97869/) [@Saliha Mallem](https://www.linkedin.com/in/saliha-mallem/) writes about integrating ESO with IBM Cloud Secrets Manager. In her blog, she outlines the steps to deploy ESO and demonstrates how to use both the Secrets Manager API and the Vault API for seamless integration. The blog is user-friendly and easy to follow. ## [Enhancing Kubernetes Security and Flexibility with the CyberArk Conjur and ESO Integration](https://developer.cyberark.com/blog/enhancing-kubernetes-security-and-flexibility-with-the-cyberark-conjur-and-eso-integration/) [@szh](https://github.com/szh) Writes about using ESO with CyberArk Conjur. He includes detailed steps on how to set up a local environment with Docker Desktop and how to deploy ESO and Conjur OSS on it. ## [Comparing External Secrets Operator with Secret Storage CSI as Kubernetes External Secrets is Deprecated](https://mixi-developers.mixi.co.jp/compare-eso-with-secret-csi-402bf37f20bc) @riddle writes about choosing ESO when comparing with Secret Store CSI Driver in their specific use case. They show us the relevant differences between the projects when looking at their scenario and requirements while integrating with ArgoCD. [Comparing External Secrets Operator with Secret Storage CSI as Kubernetes External Secrets is Deprecated](https://mixi-developers.mixi.co.jp/compare-eso-with-secret-csi-402bf37f20bc) ## [Tutorial: Getting Started with External Secrets Operator on Kubernetes using AWS Secrets Manager](https://ptuladhar3.medium.com/getting-started-with-external-secrets-operator-on-kubernetes-using-aws-secrets-manager-6dc403d9630c) Puru writes about getting started using ESO with AWS Secrets Manager. He uses illustrations to explain ESO to new users and gets you to quickly start using ESO, as article is easy to follow along. [Getting Started with External Secrets Operator on Kubernetes using AWS Secrets Manager](https://ptuladhar3.medium.com/getting-started-with-external-secrets-operator-on-kubernetes-using-aws-secrets-manager-6dc403d9630c) ## [Tutorial: How to Set External-Secrets with Azure KeyVault](https://blog.container-solutions.com/tutorial-external-secrets-with-azure-keyvault) Gustavo writes about how to setup ESO with Azure Key Vault and adds an guide on how to make it a bit more secure with OPA (Open Policy Agent). [How to Set External-Secrets with Azure KeyVault](https://blog.container-solutions.com/tutorial-external-secrets-with-azure-keyvault) ## [Tutorial: How to Set External-Secrets with GCP Secret Manager](https://blog.container-solutions.com/tutorial-how-to-set-external-secrets-with-gcp-secret-manager) Gustavo writes about how to setup ESO with GCP Secret Manager. He also shows you how to make a simple multi tenant setup with a ClusterSecretStore. [How to Set External-Secrets with GCP Secret Manager](https://blog.container-solutions.com/tutorial-how-to-set-external-secrets-with-gcp-secret-manager) ## [Tutorial: How to Set External-Secrets with Hashicorp Vault](https://blog.container-solutions.com/tutorialexternal-secrets-with-hashicorp-vault) Gustavo writes about how to setup ESO with Hashicorp Vault. He also shows you how to make this scale with multiple replicas of the operator and leader election enabled to lead balance handling synchronization work. [How to Set External-Secrets with Hashicorp Vault](https://blog.container-solutions.com/tutorialexternal-secrets-with-hashicorp-vault) ## [Tutorial: How to Set External-Secrets with AWS](https://blog.container-solutions.com/tutorial-how-to-set-external-secrets-with-aws) Gustavo writes about how to setup ESO with AWS Secrets Manager. He also shows you how to limit access and give granular permissions with better policies and roles for your service accounts to use. [How to Set External-Secrets with AWS](https://blog.container-solutions.com/tutorial-how-to-set-external-secrets-with-aws) ## [Tutorial: How to Set External-Secrets with IBM Secrets Manager](https://0x58.medium.com/ibm-cloud-secrets-manager-and-the-external-secrets-operator-1c94234993b6) In this multi-articles series, Xavier writes about how to setup ESO with IBM Secrets Manager using the web user-interface. Xavier also shares how it is integrated into his pipeline scripts. [How to Set External-Secrets with IBM Secrets Manager](https://0x58.medium.com/ibm-cloud-secrets-manager-and-the-external-secrets-operator-1c94234993b6) ## [Kubernetes Hardening | https://github.com/external-secrets/external-secrets/blob/main//docs/eso-blogs.md | main | external-secrets | [
-0.097569040954113,
-0.094977006316185,
-0.009807262569665909,
-0.003739203792065382,
0.013583467341959476,
-0.018560301512479782,
0.013935176655650139,
-0.04807436838746071,
0.03035501018166542,
0.01961628906428814,
0.01488860510289669,
-0.05219825357198715,
0.04583872854709625,
-0.069634... | 0.25313 |
[Tutorial: How to Set External-Secrets with IBM Secrets Manager](https://0x58.medium.com/ibm-cloud-secrets-manager-and-the-external-secrets-operator-1c94234993b6) In this multi-articles series, Xavier writes about how to setup ESO with IBM Secrets Manager using the web user-interface. Xavier also shares how it is integrated into his pipeline scripts. [How to Set External-Secrets with IBM Secrets Manager](https://0x58.medium.com/ibm-cloud-secrets-manager-and-the-external-secrets-operator-1c94234993b6) ## [Kubernetes Hardening Tutorial Part 2: Network](https://blog.gitguardian.com/kubernetes-tutorial-part-2-network/) Tiexin Guo Writes about Kubernetes hardening in this series of blogs. He mentions ESO as one of the convenient options when dealing with secrets in Kubernetes, and how to use it with AWS Secret Manager using AWS credentials. [Kubernetes Hardening Tutorial Part 2: Network](https://blog.gitguardian.com/kubernetes-tutorial-part-2-network/) ## [Tutorial: How to manage secrets in OpenShift using Vault and External Secrets Operator](https://youtu.be/N7njTq6TSx8) Balkrishna Pandey published a video tutorial and a [blog post](https://goglides.io/how-to-manage-secrets-in-openshift-using-vault-and-external-secrets/1164/) on integrating HashiCorp Vault and External Secret Operator (ESO) to manage application secrets on OpenShift Cluster. In this blog, he demonstrates the strength of the `ClusterSecretStore` functionality, a cluster scoped SecretStore and is global to the Cluster that all `ExternalSecrets` can reference from all namespaces. ## [Tutorial: Leverage AWS secrets stores from EKS Fargate with External Secrets Operator](https://aws.amazon.com/blogs/containers/leverage-aws-secrets-stores-from-eks-fargate-with-external-secrets-operator/) In this AWS Containers blog post, Ryan writes about how to leverage External Secret Operator with an EKS Fargate cluster using IAM Roles for Service Accounts (IRSA). This setup supports the requirements of Fargate based workloads. [Leverage AWS secrets stores from EKS Fargate with External Secrets Operator](https://aws.amazon.com/blogs/containers/leverage-aws-secrets-stores-from-eks-fargate-with-external-secrets-operator/) ## [Cloud Native Secret Management with External Secrets Operator](https://eminalemdar.medium.com/cloud-native-secret-management-with-external-secrets-operator-2912f41f9c49) Emin writes about what problems ESO can solve and how to setup ESO on an Amazon EKS Cluster with integrations for AWS Secrets Manager using IAM Roles for Service Accounts (IRSA). In this blog post, there is also a GitHub repository with example codes for everyone to follow this demonstration. ## [External Secrets Operator Integration with HashiCorp Vault](https://eminalemdar.medium.com/external-secrets-operator-integration-with-hashicorp-vault-aff3f956237b) Emin writes about integration between External Secrets Operator and HashiCorp Vault with a demonstration on installing ESO and Vault on a Kubernetes Cluster and configuration of the permissions and other integration parts. ## [Reversing the Workflow with External Secrets Operator’s Push Secret Feature](https://medium.com/@eminalemdar/reversing-the-workflow-with-external-secrets-operators-push-secret-feature-f2a64f3db748) Emin writes about the Push Secret feature of ESO and how this new feature reverse the workflow of ESO by pushing Kubernetes secrets to external secret management providers. ## [GCP Secret Manager with self-hosted Kubernetes](https://medium.com/@jjlakis/gcp-secret-manager-with-self-hosted-kubernetes-db35d01d65f0) Jacek writes about bringing GCP secrets to on-premises cluster through External Secrets Operator integration with workload identity. ## [Injecting AWS Secrets in a Kubernetes Cluster with External Secrets Operator](https://blog.devops.dev/injecting-external-secrets-in-a-kubernetes-cluster-1e9bbe0f0d5b) Ali writes about integrating AWS Secrets Manager and Parameter Store secrets within an EKS Cluster using ESO. He shows a quick setup of the operator, and how to fetch secrets in a repeatable fashion. The guide is bundled with cool illustrations and code snippets that describe the ESO architecture and injection process ## [Encoding & Decoding Kubernetes Secrets — ESO Advanced Templating](https://blog.devops.dev/encoding-decoding-kubernetes-secrets-externalsecrets-operator-826b9680df63) Here, Ali briefly introduces templates within ESO and describes some use cases where templating can be crucial. Code snippets are included where needed too. | https://github.com/external-secrets/external-secrets/blob/main//docs/eso-blogs.md | main | external-secrets | [
-0.11520396918058395,
-0.024819742888212204,
-0.0008177668205462396,
-0.01618156023323536,
0.0024575451388955116,
-0.0206407830119133,
0.05952674522995949,
0.022329241037368774,
0.023502694442868233,
0.01931830868124962,
0.005571250803768635,
0.007181635592132807,
0.0324261374771595,
-0.05... | 0.219647 |
# [Sponsored by](https://opencollective.com/external-secrets-org) [](https://container-solutions.com) [](https://externalsecrets.com) [](https://www.form3.tech/) [](https://www.pento.io) # Introduction  \*\*External Secrets Operator\*\* is a Kubernetes operator that integrates external secret management systems like [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/), [HashiCorp Vault](https://www.vaultproject.io/), [Google Secrets Manager](https://cloud.google.com/secret-manager), [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/), [IBM Cloud Secrets Manager](https://www.ibm.com/cloud/secrets-manager), [CyberArk Secrets Manager](https://www.cyberark.com/products/secrets-management/), [Pulumi ESC](https://www.pulumi.com/product/esc/) and many more. The operator reads information from external APIs and automatically injects the values into a [Kubernetes Secret](https://kubernetes.io/docs/concepts/configuration/secret/). ### What is the goal of External Secrets Operator? The goal of External Secrets Operator is to synchronize secrets from external APIs into Kubernetes. ESO is a collection of custom API resources - `ExternalSecret`, `SecretStore` and `ClusterSecretStore` that provide a user-friendly abstraction for the external API that stores and manages the lifecycle of the secrets for you. ### Where to get started To get started, please read through [API overview](introduction/overview.md) this should give you a high-level overview to understand the API and use-cases. After that please follow one of our [guides](guides/introduction.md) to get a jump start using the operator. See our [getting started guide](introduction/getting-started.md) for installation instructions. For a complete reference of the API types please refer to our [API Reference](api/spec.md). ### How to get involved This project is driven by its users and contributors, and we welcome everybody to get involved. Join our meetings, open issues or ask questions in Slack. The success of this project depends on your input: No contribution is too small - even opinions matter! How to get involved: - Bi-weekly Development Meeting every odd week at [8:00 PM Berlin Time](https://dateful.com/time-zone-converter?t=20:00&tz=Europe/Berlin) on Wednesday ([agenda](https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA), [jitsi call](https://meet.jit.si/eso-community-meeting)) - [Kubernetes Slack #external-secrets](https://kubernetes.slack.com/messages/external-secrets) - [Contributing Process](contributing/process.md) - [Twitter](https://twitter.com/ExtSecretsOptr) ### Kicked off by  | https://github.com/external-secrets/external-secrets/blob/main//docs/index.md | main | external-secrets | [
-0.10015992820262909,
0.036055292934179306,
0.03729298338294029,
-0.0473255030810833,
0.04879956319928169,
-0.0785711407661438,
0.0260284636169672,
-0.028032943606376648,
0.08813533186912537,
-0.009639712050557137,
0.04197254404425621,
0.00826624222099781,
0.019088178873062134,
-0.00986826... | 0.219458 |
## Project Management The Code, our TODOs and Documentation is maintained on [GitHub](https://github.com/external-secrets/external-secrets). All Issues should be opened in that repository. We have a [Roadmap](roadmap.md) to track progress for our road towards GA. ## Issues Features, bugs and any issues regarding the documentation should be filed as [GitHub Issue](https://github.com/external-secrets/external-secrets/issues) in our repository. We use labels like `kind/feature`, `kind/bug`, `area/aws` to organize the issues. Issues labeled `good first issue` and `help wanted` are especially good for a first contribution. If you want to pick up an issue just leave a comment. ## Submitting a Pull Request This project uses the well-known pull request process from GitHub. To submit a pull request, fork the repository and push any changes to a branch on the copy, from there a pull request can be made in the main repo. Merging a pull request requires the following steps to be completed before the pull request will be merged: \* ideally, there is an issue that documents the problem or feature in depth. \* code must have a reasonable amount of test coverage \* tests must pass \* PR needs be reviewed and approved Once these steps are completed the PR will be merged by a code owner. We're using the pull request `assignee` feature to track who is responsible for the lifecycle of the PR: review, merging, ping on inactivity, close. We close pull requests or issues if there is no response from the author for a period of time. Feel free to reopen if you want to get back on it. \_Note:\_ Pull requests that are labelled with \_size/l\_ and above \_MUST\_ have at least \*\*TWO\*\* approvers for it to be merged. Please respect this policy to ensure the quality of code in this project. ### Triggering e2e tests We have an extensive set of e2e tests that test the integration with \*real\* cloud provider APIs. Maintainers must trigger these kind of tests manually for PRs that come from forked repositories. These tests run inside a `kind` cluster in the GitHub Actions runner: ``` /ok-to-test sha= ``` Examples: ``` /ok-to-test sha=b8ca0040200a7a05d57048d86a972fdf833b8c9b ``` #### Executing e2e tests locally You have to prepare your shell environment with the necessary variables so the e2e test runner knows what credentials to use. See `e2e/run.sh` for the variables that are passed in. If you e.g. want to test AWS integration make sure set all `AWS\_\*` variables mentioned in that file. Use [ginkgo labels](https://onsi.github.io/ginkgo/#spec-labels) to select the tests you want to execute. You have to specify `!managed` to ensure that you do not run managed tests. ``` make test.e2e GINKGO\_LABELS='gcp&&!managed' ``` #### Managed Kubernetes e2e tests There's another suite of e2e tests that integrate with managed Kubernetes offerings. They create real infrastructure at a cloud provider and deploy the controller into that environment. This is necessary to test the authentication integration ([GCP Workload Identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity), [EKS IRSA](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html)...). These tests are time intensive (~20-45min) and must be triggered manually by a maintainer when a particular provider or authentication mechanism was changed: ``` /ok-to-test-managed sha=xxxxxx provider=aws # or /ok-to-test-managed sha=xxxxxx provider=gcp # or /ok-to-test-managed sha=xxxxxx provider=azure ``` Both tests can run in parallel. Once started they add a dynamic GitHub check `integration-managed-(gcp|aws|azure)` to the PR that triggered the test. ### Executing Managed Kubernetes e2e tests locally You have to prepare your shell environment with the necessary variables so the e2e test runner knows what credentials to use. See `.github/workflows/e2e-managed.yml` for the variables that are passed in. If you e.g. want to test AWS integration make sure set all variables containing `AWS\_\*` and `TF\_VAR\_AWS\_\*` mentioned in that file. Then execute `tf.apply.aws` or `tf.apply.gcp` to | https://github.com/external-secrets/external-secrets/blob/main//docs/contributing/process.md | main | external-secrets | [
-0.1210598275065422,
-0.017070958390831947,
-0.004999219439923763,
0.02784620225429535,
0.03440576791763306,
-0.0376841239631176,
-0.005788220092654228,
0.08393824100494385,
-0.052583325654268265,
0.05818621441721916,
0.005670072045177221,
0.005833794828504324,
0.033106427639722824,
-0.031... | 0.113238 |
with the necessary variables so the e2e test runner knows what credentials to use. See `.github/workflows/e2e-managed.yml` for the variables that are passed in. If you e.g. want to test AWS integration make sure set all variables containing `AWS\_\*` and `TF\_VAR\_AWS\_\*` mentioned in that file. Then execute `tf.apply.aws` or `tf.apply.gcp` to create the infrastructure. ``` make tf.apply.aws ``` Then run the `managed` testsuite. You will need push permissions to the external-secrets ghcr repository. You can set `IMAGE\_NAME` to control which image registry is used to store the controller and e2e test images in. You also have to setup a proper Kubeconfig so the e2e test pod gets deployed into the managed cluster. ``` aws eks update-kubeconfig --name ${AWS\_CLUSTER\_NAME} or gcloud container clusters get-credentials ${GCP\_GKE\_CLUSTER} --region europe-west1-b ``` Use [ginkgo labels](https://onsi.github.io/ginkgo/#spec-labels) to select the tests you want to execute. ``` # you may have to set IMAGE\_NAME=docker.io/your-user/external-secrets make test.e2e.managed GINKGO\_LABELS='gcp' ``` ## Proposal Process Before we introduce significant changes to the project we want to gather feedback from the community to ensure that we progress in the right direction before we develop and release big changes. Significant changes include for example: \* creating new custom resources \* proposing breaking changes \* changing the behavior of the controller significantly Please create a document in the `design/` directory based on the template `000-template.md` and fill in your proposal. Open a pull request in draft mode and request feedback. Once the proposal is accepted and the pull request is merged we can create work packages and proceed with the implementation. ## Release Planning We have a [GitHub Project Board](https://github.com/orgs/external-secrets/projects/2/views/1) where we organize issues on a high level. We group issues by milestone. Once all issues of a given milestone are closed we should prepare a new feature release. Issues of the next milestone have priority over other issues - but that does not mean that no one is allowed to start working on them. Issues must be \_manually\_ added to that board (at least for now, see [GH Roadmap](https://github.com/github/roadmap/issues/286)). Milestones must be assigned manually as well. If no milestone is assigned it is basically a backlog item. It is the responsibility of the maintainers to: 1. assign new issues to the GH Project 2. add a milestone if needed 3. add appropriate labels If you would like to raise the priority of an issue for whatever reason feel free to comment on the issue or ping a maintainer. ## Support & Questions Providing support to end users is an important and difficult task. We have three different channels through which support questions arise: 1. Kubernetes Slack [#external-secrets](https://kubernetes.slack.com/archives/C017BF84G2Y) 2. [GitHub Issues](https://github.com/external-secrets/external-secrets/issues/new/choose) We use labels to identify GitHub Issues. Specifically for managing support cases we use the following labels to identify the state a support case is in: \* `triage/needs-information`: Indicates an issue needs more information in order to work on it. \* `triage/not-reproducible`: Indicates an issue can not be reproduced as described. \* `triage/support`: Indicates an issue that is a support question. ## Cutting Releases The external-secrets project is released on a as-needed basis. Feel free to open a issue to request a release. Details on how to cut a release can be found in the [release](release.md) page. | https://github.com/external-secrets/external-secrets/blob/main//docs/contributing/process.md | main | external-secrets | [
-0.008972628973424435,
-0.016532426699995995,
0.0011043112026527524,
0.02046116814017296,
0.0030245331581681967,
-0.05673368647694588,
-0.05713551864027977,
0.05166272073984146,
-0.009642918594181538,
0.07529116421937943,
0.02638711966574192,
-0.1242397353053093,
0.09036152064800262,
0.017... | 0.061807 |
# LLM Usage Policy We're not against using AI tools. They can be genuinely helpful for drafting code, catching bugs, or exploring ideas. What we don't want is the obvious copy-paste output that hasn't been reviewed, understood, or adapted to our project. You can tell when something was generated by an LLM and submitted without a second thought. The overly formal language, the generic explanations that don't quite fit the context, the boilerplate comments that add nothing, the solutions that technically work but ignore our existing patterns. That's what we're trying to avoid. If you use an LLM to help with your contribution, that's fine. Just make sure you actually read what it produced, verify it works, check it follows our coding standards, and adjust it to match how we do things here. Add your own context. Remove the fluff. Make it yours. The same goes for issues. Don't submit LLM-generated bug reports or feature requests that are verbose, generic, and obviously haven't been thought through. If an AI helped you articulate something, great, but the issue should still sound like it came from someone who actually encountered a problem or has a real use case. We value contributions from humans who understand what they're submitting, even if they had some algorithmic assistance along the way. The goal is quality and genuine engagement with the project, not quantity of AI-generated content. | https://github.com/external-secrets/external-secrets/blob/main//docs/contributing/llm-policy.md | main | external-secrets | [
-0.048722755163908005,
0.010324743576347828,
0.005672167520970106,
-0.015088709071278572,
0.09657580405473709,
0.03866780176758766,
0.00646824948489666,
0.02892393246293068,
-0.04404626414179802,
0.015482594259083271,
-0.01319785788655281,
-0.07645217329263687,
0.04566441476345062,
-0.0575... | 0.061248 |
# Contributor Burnout Mitigation Guide ## Overview This document provides a framework for identifying, preventing, and addressing contributor burnout in the External Secrets Operator (ESO) project. Based on lessons learned from past experiences and successful community outreach efforts, this guide aims to help maintain a sustainable project without the need for release pauses or drastic measures. It is everyone's responsibility to \_identify\_ burnout and inform the team at a community meeting. "See it, say it, sorted." ## Understanding Burnout ### What is Contributor Burnout? Contributor burnout occurs when the demands of maintaining an open source project exceed the available resources and energy of the maintainer team. In ESO's context, this manifests as: - Disproportionate contributor-to-user ratio: Millions of users supported by a handful of maintainers - Unsustainable workload: Everything from code review to security responses handled by the same small group - High responsibility with limited resources: Critical infrastructure component with enterprise-grade expectations ### Why ESO is Particularly Vulnerable ESO is particularly affected because: 1. Critical Infrastructure Role: Often the first component deployed in Kubernetes clusters 2. Security-Critical Nature: Due to it's nature the project demands a high focus and high attention during reviews 3. Wide Enterprise Adoption: Used by a lot of high-stakes organizations ## Early Detection Signals ### Individual Maintainer Signals Monitor for these warning signs in team members: #### Behavioral Changes - Delayed responses to issues, PRs, or community messages - Decreased participation in community meetings or discussions - Shorter, more terse communication style - Avoiding complex issues or deferring decisions consistently - Working only on "fun" tasks while avoiding maintenance work - Change in behavior and borderline violating the code of conduct during responses and user interactions #### Workload Indicators - One person handling multiple critical areas (releases, security, CI, support) - Working outside normal hours consistently to keep up - Expressing frustration about repetitive or mundane tasks #### Quality Signals - Rushing through reviews to clear backlog - Postponing or skipping testing for expedience - Technical debt accumulation due to time pressure ### Project-Level Signals #### Community Health Metrics There are a couple of things to keep an eye on for the overall health of the project and issue cadences. - Issues keep being reopened - Review times consistently increasing - Release cadence becoming irregular or delayed - Community meeting attendance declining among maintainers #### External Pressure Indicators Also keep in mind that external pressure can increase. There are time where the project sees a sudden spike in usage and times of lul as well. We need to keep monitoring influx items and pay attention to when the pressure is being put on. ## Prevention Strategies None of these things will guaranteed solutions, however, they might help. ### Workload Distribution #### Create Ownership Areas - Certain areas could be covered by the same maintainer (e.g., specific providers, testing, documentation) - Keep release and support roles on a rotation so people don't think they are in a rut - Document tribal knowledge to make it accessible to others - Take over other contributor's work by extending your own ownership area when something goes wrong. #### Automate Repetitive Tasks CI/CD pipelines can help a lot in taking away some of the menial tasks while working on the project. Immediate bot responses for triage issues could be configured using copilot, or other means like claude code github action. These responses would use the repository as a context and could give immediate valuable info to the submitter such as: - Duplicate issues - Possible solutions looking at the documentation - Link to existing documentation based on context These need | https://github.com/external-secrets/external-secrets/blob/main//docs/contributing/burnout-mitigation.md | main | external-secrets | [
0.013583973050117493,
0.031558286398649216,
0.040708307176828384,
0.04970922693610191,
0.12000342458486557,
0.013810788281261921,
0.024477753788232803,
0.00032339582685381174,
0.035803671926259995,
0.007321704179048538,
-0.029759898781776428,
-0.00023473973851650953,
-0.02628173492848873,
... | 0.235715 |
using copilot, or other means like claude code github action. These responses would use the repository as a context and could give immediate valuable info to the submitter such as: - Duplicate issues - Possible solutions looking at the documentation - Link to existing documentation based on context These need to be fine-tuned but could potentially alleviate some of the tress and pressure for the maintainers. ### Community Building It is important that we nurture an understanding and caring community. People who use ESO will have to understand that demands will lead no-where. The maintainers are offering their time and efforts to keep the project sustained. Only \_requests\_ and \_questions\_ will be answered and met with similar responses. \_Respect is earned, not given\_. The code of conduct is there for a reason and it will be enforced. People who \_demand\_ that maintainers do something and people who \_expect\_ that maintainers support their every need will be met with a brick wall. Please understand that we are doing this as a hobby and as something out of the goodness of our hearth and because we believe in open source software. That does \_NOT\_ mean that you as a user are entitled to demands. ## Community Outreach Framework Add more templates here if required for Issues ( a pinned issue on external-secrets GitHub page ), LinkedIn, blog posts on the [website](https://external-secrets.io/latest/eso-blogs/). ### Reddit Post Template ~~~markdown # 🔄 ESO Community Update: Growing Our Maintainer Team Hey r/kubernetes community! We're reaching out with an update on External Secrets Operator (ESO) and an opportunity for the community to get involved. ## Current State ESO continues to grow in adoption - we're now deployed in [specific stats] environments and serve as critical infrastructure for organizations ranging from [examples]. This growth is amazing, but it also means we need to scale our maintainer team to match. ## What We Need We're looking for contributors who can help with: - Code review and development (Go experience helpful but not required) - Provider maintenance (AWS, Azure, GCP, HashiCorp Vault, etc.) - Documentation and user guides - Issue triage and community support - Testing and quality assurance ## What We Offer - Onboarding with experienced maintainers - Flexible commitment levels - contribute what works for your schedule - Real impact on critical Kubernetes infrastructure - Learning opportunities in security, secrets management, and operator development - Recognition in a high-visibility CNCF project ## How to Get Involved 1. Fill out our [contributor interest form](https://github.com/external-secrets/external-secrets/blob/636ce0578dda4a623a681066def8998a68b051a6/CONTRIBUTOR\_LADDER.md) 2. Join our [next community meeting](https://zoom-lfx.platform.linuxfoundation.org/meetings/externalsecretsoperator?view=month) 3. Check out our [contributor guide](https://external-secrets.io/latest/contributing/devguide/) 4. Start with a [good first issue](https://github.com/orgs/external-secrets/projects/2/views/9) ## Questions? Drop them below or reach out on [Slack/Discord/GitHub Discussions]. Thanks for being part of this community! 🚀 --- \*Cross-posted to relevant communities - thanks for your patience if you see this multiple times\* ~~~ ## Conclusion This document sums up various procedures and things that we can do and we can start on. The important part is publication, visibility and outreach. There are many channel on which ESO can communicate but the most important ones are: - Slack ( [external-secrets](https://kubernetes.slack.com/archives/C017BF84G2Y), [external-secrets-dev](https://kubernetes.slack.com/archives/C047LA9MUPJ) channels ) - Reddit [Kubernetes Subreddit](https://www.reddit.com/r/kubernetes/) ( this was particulalry helpful in the past ) - HackerNews pos - LinkedIn - CNCF help channels and issue requests - Pinned Issue on GitHub page Whatever we do the most important part is visibility \_BEFORE\_ we get to this point. Before all of this, the most important part is monitoring the maintainers health and general well being. Prevention instead of escalation. ## Our reaction when things do not go as planned Contributors will come and go. | https://github.com/external-secrets/external-secrets/blob/main//docs/contributing/burnout-mitigation.md | main | external-secrets | [
-0.1252635270357132,
-0.0011700891191139817,
-0.011754229664802551,
-0.01111882645636797,
0.023724226281046867,
-0.047712091356515884,
0.0885246992111206,
0.05929981544613838,
0.02309243194758892,
0.027631735429167747,
-0.00020379669149406254,
-0.05341969057917595,
0.010079056955873966,
-0... | 0.181429 |
we do the most important part is visibility \_BEFORE\_ we get to this point. Before all of this, the most important part is monitoring the maintainers health and general well being. Prevention instead of escalation. ## Our reaction when things do not go as planned Contributors will come and go. It is perfectly normal (and even welcomed!) in an open source project. When events occur and response do not go as planned, the maintainers team will take decisions and expose them in a community meeting. Here is our DNA: Contributor's healths come first. We will never compromise humans for software. The team will try (best effort) to: - minimize impact on community - be transparent over any potential impact Maintainers stepping back from the project is perfectly \_fine\_, the project slowing down is \_fine\_. this shouldn't be seen as a negative. People need to take care of themselves first before they can take care of the project. | https://github.com/external-secrets/external-secrets/blob/main//docs/contributing/burnout-mitigation.md | main | external-secrets | [
0.021806158125400543,
0.04277452453970909,
0.05910288915038109,
0.04066430777311325,
0.12371444702148438,
-0.002303097862750292,
0.0019420520402491093,
0.04671260342001915,
0.057074401527643204,
0.025258470326662064,
-0.006850042846053839,
0.03996920958161354,
-0.015437661670148373,
-0.081... | 0.105567 |
## Getting Started You must have a working [Go environment](https://golang.org/doc/install) and then clone the repo: ```shell git clone https://github.com/external-secrets/external-secrets.git cd external-secrets ``` \_Note: many of the `make` commands use [yq](https://github.com/mikefarah/yq), version 4.2X.X or higher.\_ Our helm chart is tested using `helm-unittest`. You will need it to run tests locally if you modify the helm chart. ```shell make helm.test make helm.test.update ``` ## Building & Testing The project uses the `make` build system. It'll run code generators, tests and static code analysis. Building the operator binary and docker image: ```shell make build make docker.build IMAGE\_NAME=external-secrets IMAGE\_TAG=latest ``` Run tests and lint the code: ```shell make test make lint # OR docker run --rm -v $(pwd):/app -w /app golangci/golangci-lint:v1.49.0 golangci-lint run ``` Build the documentation: ```shell make docs ``` ## License Headers All Go source files must include the Apache License 2.0 header. The CI automatically checks license headers for new files added in pull requests using [Apache SkyWalking Eyes](https://github.com/apache/skywalking-eyes). If you need to check license headers locally, you can use the SkyWalking Eyes tool directly. The configuration is in `.licenserc.yaml` at the project root. ## Using Tilt [Tilt](https://tilt.dev) can be used to develop external-secrets. Tilt will hot-reload changes to the code and replace the running binary in the container using a process manager of its own. To run tilt, download the utility for your operating system and run `make tilt-up`. This will do two things: - downloads tilt for the current OS and ARCH under `bin/tilt` - make manifest files of your current changes and place them under `./bin/deploy/manifests/external-secrets.yaml` - run tilt with `tilt run` Hit `space` and you can observe all the pods starting up and track their output in the tilt UI. ## Installing To install the External Secret Operator into a Kubernetes Cluster run: ```shell helm repo add external-secrets https://charts.external-secrets.io helm repo update helm install external-secrets external-secrets/external-secrets ``` You can alternatively run the controller on your host system for development purposes: ```shell make crds.install make run ``` To remove the CRDs run: ```shell make crds.uninstall ``` If you need to test some other k8s integrations and need the operator to be deployed to the actual cluster while developing, you can use the following workflow: ```shell # Start a local K8S cluster with KinD kind create cluster --name external-secrets export TAG=$(make docker.tag) export IMAGE=$(make docker.imagename) # Build docker image make docker.build # Load docker image into local kind cluster kind load docker-image $IMAGE:$TAG --name external-secrets # (Optional) Pull the image from GitHub Repo to copy into kind # docker pull ghcr.io/external-secrets/external-secrets:v0.8.2 # kind load docker-image ghcr.io/external-secrets/external-secrets:v0.8.2 -n external-secrets # export TAG=v0.8.2 # Update helm charts and install to KinD cluster make helm.generate helm upgrade --install external-secrets ./deploy/charts/external-secrets/ \ --set image.repository=$IMAGE --set image.tag=$TAG \ --set webhook.image.repository=$IMAGE --set webhook.image.tag=$TAG \ --set certController.image.repository=$IMAGE --set certController.image.tag=$TAG # Command to delete the cluster when done # kind delete cluster -n external-secrets ``` !!! note "Contributing Flow" The HOW TO guide for contributing is at the [Contributing Process](process.md) page. ## Documentation We use [mkdocs material](https://squidfunk.github.io/mkdocs-material/) and [mike](https://github.com/jimporter/mike) to generate this documentation. See `/docs` for the source code and `/hack/api-docs` for the build process. When writing documentation it is advised to run the mkdocs server with livereload: ```shell make docs.serve ``` Run the following command to run a complete build. The rendered assets are available under `/site`. ```shell make docs make docs.serve ``` Open `http://localhost:8000` in your browser. Since mike uses a branch to create/update documentation, any docs operation will create a diff on your local `gh-pages` branch. When finished writing/reviewing the docs, clean up your local docs branch changes with `git branch -D gh-pages` | https://github.com/external-secrets/external-secrets/blob/main//docs/contributing/devguide.md | main | external-secrets | [
-0.01644001342356205,
0.05931052938103676,
-0.014680560678243637,
-0.026065945625305176,
-0.001230279915034771,
-0.04966418072581291,
-0.06373007595539093,
0.07359641790390015,
-0.02243831939995289,
0.014720420353114605,
0.038090407848358154,
-0.08306144922971725,
0.025061318650841713,
0.0... | -0.007959 |
`/site`. ```shell make docs make docs.serve ``` Open `http://localhost:8000` in your browser. Since mike uses a branch to create/update documentation, any docs operation will create a diff on your local `gh-pages` branch. When finished writing/reviewing the docs, clean up your local docs branch changes with `git branch -D gh-pages` | https://github.com/external-secrets/external-secrets/blob/main//docs/contributing/devguide.md | main | external-secrets | [
-0.007434027269482613,
0.014912272803485394,
0.076710544526577,
-0.015911348164081573,
-0.009466933086514473,
-0.11149965971708298,
-0.09599078446626663,
0.0038965821731835604,
0.03443710505962372,
0.08511544018983841,
0.014572164975106716,
0.08092868328094482,
-0.024007171392440796,
0.022... | -0.032916 |
# Code of Conduct ## Our Pledge We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. ## Our Standards Examples of behavior that contributes to a positive environment for our community include: \* Demonstrating empathy and kindness toward other people \* Being respectful of differing opinions, viewpoints, and experiences \* Giving and gracefully accepting constructive feedback \* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience \* Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: \* The use of sexualized language or imagery, and sexual attention or advances of any kind \* Trolling, insulting or derogatory comments, and personal or political attacks \* Public or private harassment \* Publishing others' private information, such as a physical or email address, without their explicit permission \* Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at cncf-ExternalSecretsOp-maintainers@lists.cncf.io. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. ## Enforcement Guidelines Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: ### 1. Correction \*\*Community Impact\*\*: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. \*\*Consequence\*\*: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. ### 2. Warning \*\*Community Impact\*\*: A violation through a single incident or series of actions. \*\*Consequence\*\*: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. ### 3. Temporary Ban \*\*Community Impact\*\*: A serious violation of community standards, including sustained inappropriate behavior. \*\*Consequence\*\*: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of | https://github.com/external-secrets/external-secrets/blob/main//docs/contributing/coc.md | main | external-secrets | [
0.015397134236991405,
0.06417343020439148,
-0.020421573892235756,
0.046589598059654236,
0.04096662998199463,
0.07031451910734177,
-0.003750869771465659,
-0.05185968428850174,
-0.08187077194452286,
-0.02548215165734291,
0.03921687230467796,
-0.025242220610380173,
-0.008688868954777718,
0.00... | 0.082775 |
Impact\*\*: A serious violation of community standards, including sustained inappropriate behavior. \*\*Consequence\*\*: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. ### 4. Permanent Ban \*\*Community Impact\*\*: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. \*\*Consequence\*\*: A permanent ban from any sort of public interaction within the community. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code\_of\_conduct.html][v2.0]. Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. [homepage]: https://www.contributor-covenant.org [v2.0]: https://www.contributor-covenant.org/version/2/0/code\_of\_conduct.html [Mozilla CoC]: https://github.com/mozilla/diversity [FAQ]: https://www.contributor-covenant.org/faq [translations]: https://www.contributor-covenant.org/translations | https://github.com/external-secrets/external-secrets/blob/main//docs/contributing/coc.md | main | external-secrets | [
-0.03852979093790054,
0.0639779344201088,
-0.01319311372935772,
-0.01513801421970129,
0.029038965702056885,
0.0310193058103323,
-0.004929365590214729,
-0.01967518776655197,
-0.010744547471404076,
-0.029659759253263474,
0.079765185713768,
0.0024756607599556446,
-0.01935749687254429,
0.03050... | 0.108402 |
ESO and the ESO Helm Chart have two distinct lifecycles and can be released independently. Helm Chart releases are named `external-secrets-x.y.z`. The external-secrets project is released on a as-needed basis. Feel free to open a issue to request a release. ## Multi-Module Versioning External Secrets Operator uses a multi-module structure with the following modules: - `/apis` - CRD types and interfaces - `/runtime` - Shared utilities - `/providers/v1/\*` - Individual provider modules - `/generators/v1/\*` - Individual generator modules - `/` (root) - Main module with controllers and binary \*\*All modules share the same version tag.\*\* When releasing version `v0.x.y`, a single git tag is created that applies to all modules in the repository. Go's module system automatically handles this, and consumers can reference any module using the same version tag. For example: ```go require ( github.com/external-secrets/external-secrets/apis v0.10.0 github.com/external-secrets/external-secrets/runtime v0.10.0 github.com/external-secrets/external-secrets/providers/v1/aws v0.10.0 ) ``` \*\*Important:\*\* When updating dependencies that consume ESO modules, ensure all module references use the same version to maintain compatibility. ## Release ESO When doing a release it's best to start with with the ["Create Release" issue template](https://github.com/external-secrets/external-secrets/issues/new?assignees=&labels=area%2Frelease&projects=&template=create\_release.md&title=Release+x.y), it has a checklist to go over. ⚠️ Note: when releasing multiple versions, make sure to first release the "old" version, then the newer version. Otherwise the `latest` documentation will point to the older version. Also avoid to release both versions at the same time to avoid race conditions in the CI pipeline (updating docs, GitHub Release, helm chart release). 1. Run `Create Release` Action to create a new release, pass in the desired version number to release. 1. choose the right `branch` to execute the action: use `main` when creating a new release. 2. ⚠️ make sure that CI on the relevant branch has completed the docker build/push jobs. Otherwise an old image will be promoted. 2. GitHub Release, Changelog will be created by the `release.yml` workflow which also promotes the container image. 3. update Helm Chart, see below ## Release Helm Chart 1. Update `version` and/or `appVersion` in `Chart.yaml` and run `make helm.docs helm.update.appversion helm.test.update docs.update test.crds.update` 2. push to branch and open pr 3. run `/ok-to-test-managed` commands for all cloud providers 4. merge PR if everything is green 5. CI picks up the new chart version and creates a new GitHub Release for it The following things are updated with those commands: 1. Update helm docs 2. Update the apiVersion in the snapshots for the helm tests 3. Update all the helm tests with potential added values 4. Update the stability docs with the latest minor version if exists 5. Update the CRD conformance tests The branch to create this release should be `release-chart-x.y.z`. Though be aware that release branches are \_immutable\_. This means that if there is anything that needs to be fixed, a new branch will need to be created. Also, keep an eye on `main` so nothing is merged while the chart branch is running the e2e tests. If that happens, the chart PR CANNOT be merged because we don't allow not up-to-date pull requests to be merged. And you can't update because the branch is immutable. | https://github.com/external-secrets/external-secrets/blob/main//docs/contributing/release.md | main | external-secrets | [
-0.05293493717908859,
-0.018591461703181267,
-0.01936638541519642,
-0.041238393634557724,
0.11825959384441376,
-0.046299152076244354,
-0.07237441837787628,
0.04996418580412865,
0.05265447869896889,
-0.013613160699605942,
0.09285113960504532,
0.028540680184960365,
-0.034586239606142044,
-0.... | 0.132467 |
# The road to external-secrets GA The following external-secret custom resource APIs are considered stable: \* `ExternalSecret` \* `ClusterExternalSecret` \* `SecretStore` \* `ClusterSecretStore` These CRDs are currently at `v1` and are considered production ready. Going forward, breaking changes to these APIs will be accompanied by a conversion mechanism. We have identified the following areas of work. This is subject to change while we gather feedback. We have a [GitHub Project Board](https://github.com/orgs/external-secrets/projects/2/views/1) where we organize issues and milestones on a high level. \* Conformance testing \* ✓ end to end testing with ArgoCD and Flux \* ✓ end to end testing for all project maintained providers \* API enhancements \* ✓ dataFrom key rewrites \* ✓ pushing secrets to a provider \* Documentation Improvements \* ✓ FAQ \* ✓ review multi tenancy docs \* ✓ security model for infosec teams \* ✓ security best practices guide \* ✓ provider specific guides \* Observability \* ✓ Provide Grafana Dashboard and Prometheus alerts \* ✓ add provider-level metrics \* Pentest \* ✓ SBOM | https://github.com/external-secrets/external-secrets/blob/main//docs/contributing/roadmap.md | main | external-secrets | [
-0.14809510111808777,
-0.04132499545812607,
-0.04202079772949219,
0.016686834394931793,
0.04181830957531929,
-0.07355649769306183,
-0.04727262258529663,
0.06025505065917969,
-0.012321018613874912,
0.002459057606756687,
0.01284900214523077,
-0.03549398481845856,
0.036076586693525314,
-0.032... | 0.148318 |
# API Overview ## Architecture  The External Secrets Operator extends Kubernetes with [Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/), which define where secrets live and how to synchronize them. The controller fetches secrets from an external API and creates Kubernetes [secrets](https://kubernetes.io/docs/concepts/configuration/secret/). If the secret from the external API changes, the controller will reconcile the state in the cluster and update the secrets accordingly. ## Resource model To understand the mechanics of the operator let's start with the data model. The SecretStore references a bucket of key/value pairs. But because every external API is slightly different this bucket may be e.g. an instance of an Azure KeyVault or a AWS Secrets Manager in a certain AWS Account and region. Please take a look at the provider documentation to see what the Bucket actually maps to.  ### SecretStore The idea behind the [SecretStore](../api/secretstore.md) resource is to separate concerns of authentication/access and the actual Secret and configuration needed for workloads. The ExternalSecret specifies what to fetch, the SecretStore specifies how to access. This resource is namespaced. ``` yaml {% include 'basic-secret-store.yaml' %} ``` The `SecretStore` contains references to secrets which hold credentials to access the external API. ### ExternalSecret An [ExternalSecret](../api/externalsecret.md) declares what data to fetch. It has a reference to a `SecretStore` which knows how to access that data. The controller uses that `ExternalSecret` as a blueprint to create secrets. ``` yaml {% include 'basic-external-secret.yaml' %} ``` ### ClusterSecretStore The [ClusterSecretStore](../api/clustersecretstore.md) is a global, cluster-wide SecretStore that can be referenced from all namespaces. You can use it to provide a central gateway to your secret provider. ## Behavior The External Secret Operator (ESO for brevity) reconciles `ExternalSecrets` in the following manner: 1. ESO uses `spec.secretStoreRef` to find an appropriate `SecretStore`. If it doesn't exist or the `spec.controller` field doesn't match it won't further process this ExternalSecret. 2. ESO instantiates an external API client using the specified credentials from the `SecretStore` spec. 3. ESO fetches the secrets as requested by the `ExternalSecret`, it will decode the secrets if required 5. ESO creates an `Kind=Secret` based on the template provided by `ExternalSecret.target.template`. The `Secret.data` can be templated using the secret values from the external API. 6. ESO ensures that the secret values stay in sync with the external API ## Roles and responsibilities The External Secret Operator is designed to target the following persona: \* \*\*Cluster Operator\*\*: The cluster operator is responsible for setting up the External Secret Operator, managing access policies and creating ClusterSecretStores. \* \*\*Application developer\*\*: The Application developer is responsible for defining ExternalSecrets and the application configuration Each persona will roughly map to a Kubernetes RBAC role. Depending on your environment these roles can map to a single user. \*\*Note:\*\* There is no Secret Operator that handles the lifecycle of the secret, this is out of the scope of ESO. ## Access Control The External Secrets Operator runs as a deployment in your cluster with elevated privileges. It will create/read/update secrets in all namespaces and has access to secrets stored in some external API. Ensure that the credentials you provide give ESO the least privilege necessary. Design your `SecretStore`/`ClusterSecretStore` carefully! Be sure to restrict access of application developers to read only certain keys in a shared environment. You should also consider using Kubernetes' admission control system (e.g. [OPA](https://www.openpolicyagent.org/) or [Kyverno](https://kyverno.io/)) for fine-grained access control. ## Running multiple Controller You can run multiple controllers within the cluster. One controller can be limited to only process `SecretStores` with a predefined `spec.controller` field. !!! note "Testers welcome" This is not widely tested. Please help us test the setup and/or document use-cases. | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/overview.md | main | external-secrets | [
-0.0771162137389183,
-0.00009452066296944395,
0.00029561182600446045,
0.04209037870168686,
-0.026549819856882095,
0.0018783254781737924,
-0.0039456007070839405,
-0.01801891252398491,
0.1172368973493576,
0.040792517364025116,
0.021028446033596992,
-0.004770409315824509,
0.05491049960255623,
... | 0.129883 |
control. ## Running multiple Controller You can run multiple controllers within the cluster. One controller can be limited to only process `SecretStores` with a predefined `spec.controller` field. !!! note "Testers welcome" This is not widely tested. Please help us test the setup and/or document use-cases. | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/overview.md | main | external-secrets | [
-0.03161410242319107,
-0.058706820011138916,
-0.14585082232952118,
0.07570728659629822,
0.0008360079955309629,
0.03915117681026459,
-0.042794398963451385,
0.012229261919856071,
-0.02413090504705906,
0.04544662684202194,
0.08066177368164062,
-0.004821701906621456,
0.039147235453128815,
-0.0... | 0.115921 |
# Deprecation Policy We follow the [Kubernetes Deprecation Policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/) and [API Versioning Scheme](https://kubernetes.io/docs/reference/using-api/#api-versioning): alpha, beta, GA. The project is currently in `beta` state. Please try the `beta` features and provide feedback. After the features exit beta, it may not be practical to make more changes. \* alpha \* The support for a feature may be dropped at any time without notice. \* The API may change in incompatible ways in a later software release without notice. \* The software is recommended for use only in short-lived testing clusters, due to increased risk of bugs and lack of long-term support. \* beta \* The software is well tested. Enabling a feature is considered safe. Features are enabled by default. \* The support for a feature will not be dropped, though the details may change. \* The schema and/or semantics of objects may change in incompatible ways in a subsequent beta or stable release. When this happens, migration instructions are provided. Schema changes may require deleting, editing, and re-creating API objects. The editing process may not be straightforward. The migration may require downtime for applications that rely on the feature. \* The software is not recommended for production uses. Subsequent releases may introduce incompatible changes. If you have multiple clusters which can be upgraded independently, you may be able to relax this restriction. \* GA \* The stable versions of features appear in released software for many subsequent versions. \* Use it in production ;) ## API Surface We define the following scope that is covered by our deprecation policy. We follow the [9 Rules of the Kubernetes Deprecation Policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/). ### Scope \* API Objects and fields: `.Spec`, `.Status` and `.Status.Conditions[]` \* Enums and constant values \* Controller Configuration: CLI flags & environment variables \* Metrics as defined in the [Kubernetes docs](https://kubernetes.io/docs/reference/using-api/deprecation-policy/#deprecating-a-metric) \* The following features or specific behavior: \* `ExternalSecret` [update mechanics](http://localhost:8000/api-externalsecret/#update-behavior) ### Non-Scope Everything not listed in scope is not subject to this deprecation policy and it is subject to breaking changes, updates at any point in time, and deprecation - \*\*as long as it follows the Deprecation Process listed below\*\*. This includes, but isn't limited to: \* Any feature / specific behavior not in Scope. \* Source code imports \* Helm Charts \* Release process \* Docker Images (including multi-arch builds) \* Image Signature (including provenance, providers, keys) \* OLM-specific builds ## Deprecation Process: Deprecation process is described within the [project GitHub repository](https://github.com/external-secrets/external-secrets/blob/main/DEPRECATING.md) | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/deprecation-policy.md | main | external-secrets | [
-0.022169293835759163,
0.01354540977627039,
0.1131000965833664,
-0.0058677708730101585,
0.07713443040847778,
0.017214030027389526,
-0.036013051867485046,
-0.02834372967481613,
0.006841755006462336,
0.05408463627099991,
0.019393887370824814,
0.018651533871889114,
-0.04753972217440605,
-0.00... | 0.196313 |
# Glossary This glossary includes technologies related to ESO in alphabetic order. Cluster ### What is it? A group of nodes (computers, VMs) that execute workloads in Kubernetes, i.e., run containerized applications. It's a technique that groups multiple computational resources into a single logical unit. These resources are interconnected and work together to execute tasks, process data, and store information in a way that improves application performance, ensures high availability, reduces costs, and increases scalability, as resources can be shared and distributed efficiently to meet real-time application demands. Each computer is a "node," and there's no limit to the number of nodes that can be interconnected. The structure is : Project (Clusters(Nodes(Pods))). The cluster is what provides the main advantage of Kubernetes: the ability to program and execute containers on a set of physical, virtual, on-premise, or cloud machines. Kubernetes containers are not tied to individual machines. In fact, they are abstracted across the entire cluster. ### What is it for? The cluster's function is to group multiple machines into a single, efficient system, allowing distributed applications to be executed with higher performance and scalability. In Kubernetes, it facilitates container management, reducing complexity, ensuring high availability, and reducing costs. A Kubernetes cluster typically has a master node that manages pods and the system's execution environment. ### Useful links: * [Introduction to Clusters](https://kubernetes.io/docs/concepts/cluster-administration/) * [What is a Kubernetes cluster?](https://aws.amazon.com/pt/what-is/kubernetes-cluster/) * [Kubernetes Clusters: Everything You Need to Know](https://www.atatus.com/blog/kubernetes-clusters-everything-you-need-to-know/) Docker ### What is it? Docker is an open platform for developing, shipping, and running containerized applications. It allows you to separate your applications from the infrastructure, facilitating the delivery of software quickly and efficiently, enabling the creation, sharing, and execution of containerized applications and microservices. ### What is it for? It enables infrastructure management. This significantly reduces the time between writing code and executing it in production. It simplifies complex processes such as port mapping, file system concerns, and other standard configurations, allowing you to focus on writing code. With Docker, you can develop an application and its supporting components using containers. In this context, the container becomes the unit for distributing and testing the application. Once ready, you can deploy the application to the production environment, whether it's local, cloud-based, or hybrid. ### Useful links: - [Official documentation for Docker](https://docs.docker.com/) Golang ### What is it? An open-source programming language created by Google, known for its simplicity, performance, clarity, and conciseness. ### What is it for? Used in the development of applications, backend systems, and tools, especially in cloud and Kubernetes environments. It's a language that offers concurrency mechanisms that facilitate writing programs capable of taking full advantage of multi-core machines and networks, while its innovative type system enables the construction of flexible and modular programs. Go compiles quickly to machine code and, at the same time, offers convenience with garbage collection and the power of runtime reflection. It's a compiled, statically typed language that has the agility of dynamically typed and interpreted languages. ### Useful links: * [Official documentation for Golang](https://go.dev/doc/) Helm ### What is it? A package manager for Kubernetes that facilitates the deployment and management of applications using templates called "charts." ### What is it for? Simplifies the configuration, installation, and update of applications in Kubernetes. ### Useful links: * [Official documentation for Helm](https://helm.sh/docs/) * [GitHub project](https://github.com/helm/helm) HPA ### What is it? Horizontal Pod Autoscaler (HPA) ### What is it for? It's used to control the number of Pods in a Deployment. For example, if CPU usage is too high, the HPA would increase the number of Pods. It's also possible to use the Vertical Pod Autoscaler (VPA), which would | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/glossary.md | main | external-secrets | [
0.04628754407167435,
-0.03280586749315262,
-0.014451618306338787,
-0.0018649930134415627,
0.03099668025970459,
-0.0072251721285283566,
-0.007002305705100298,
0.011675468645989895,
0.0759003609418869,
0.026420021429657936,
-0.028251538053154945,
0.029664836823940277,
0.03631114587187767,
-0... | 0.423915 |
is it? Horizontal Pod Autoscaler (HPA) ### What is it for? It's used to control the number of Pods in a Deployment. For example, if CPU usage is too high, the HPA would increase the number of Pods. It's also possible to use the Vertical Pod Autoscaler (VPA), which would increase the amount of resources for each Pod instead of increasing the number of Pods. Ingress ### What is it? In a Kubernetes cluster where all requests arrive at the same IP and port, Ingresses are responsible for directing (based on rules you define via the Kubernetes API) these requests to the appropriate Services. It can also be used for other purposes. ### What is it for? It provides a single entry point for routing traffic to internal services. ### Useful links: * [About Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) Issuer ### What is it? A component in tools like Cert-Manager for issuing certificates. ### What is it for? Manages the issuance of automatic TLS certificates for services in Kubernetes. It issues the SSL certificate for Ingresses to encrypt (with HTTPS) incoming and outgoing requests, for example. ### Useful links: * [Cert-Manager documentation](https://cert-manager.io/docs/) Kind ### What is it? Kind means "Kubernetes in Docker", so it is a tool for running local Kubernetes clusters using Docker containers as cluster "nodes." ### What is it for? Kind was initially designed for testing Kubernetes itself, but it can also be used for local development or continuous integration (CI). It enables the creation of Kubernetes clusters easily in local environments, facilitating testing and development without requiring complex infrastructure. ### Useful links: * [Official Website](https://kind.sigs.k8s.io/) Kubectl ### What is it? Kubectl is a command-line tool for communicating with the control plane of a Kubernetes cluster, using the Kubernetes API. ### What is it for? It performs operations in Kubernetes, such as creating pods and monitoring the cluster status. It allows you to interact with the Kubernetes cluster by performing operations like creating, managing, and viewing resources. It searches for a configuration file called `config` in the `$HOME/.kube` directory, which contains information about how to connect to the cluster. ### Useful links: * [Official Documentation - Kubernetes](https://kubernetes.io/docs/reference/kubectl/) Kubernetes ### What is it? A container orchestration open source platform that automates the deployment, scaling, and management of applications. ### What is it for? Ensures high availability, scalability, and monitoring of containerized applications. ### Useful links: * [Official Documentation](https://kubernetes.io/docs/) * [Project GitHub](https://github.com/kubernetes/kubernetes) Nginx ### What is it? It is an open-source HTTP web server that can also function as a reverse proxy, load balancer, content cache, TCP/UDP proxy server, and email proxy server. It is widely used due to its high performance and ability to handle large volumes of traffic. ### What is it for? Nginx is used to serve web content, manage network traffic, and balance load between servers, as well as act as a reverse proxy and content cache. It can be used to improve the scalability and performance of web applications by efficiently distributing requests across multiple servers. It has a main process that manages the configuration and several worker processes that handle request processing. The number of worker processes can be adjusted according to the number of processor cores. ### Useful Links: * [Official Documentation](https://nginx.org/en/docs/) Lint ### What is it? A static code analysis process for identifying errors, style issues, and non-compliance with best coding practices. ### What is it for? Ensures code quality, consistency, and adherence to predefined standards by identifying syntax errors, formatting issues, and poor development practices before code execution. It contributes to maintaining clean, readable, and efficient code. ### Useful Links: * [Introduction to linting](https://eslint.org/) | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/glossary.md | main | external-secrets | [
-0.06946133077144623,
0.03224426880478859,
-0.00013508423580788076,
-0.013379480689764023,
-0.03842006251215935,
-0.039482783526182175,
0.021842580288648605,
0.0315442755818367,
0.08114051073789597,
0.014343658462166786,
0.003614584682509303,
0.012342164292931557,
-0.013745082542300224,
-0... | 0.380463 |
issues, and non-compliance with best coding practices. ### What is it for? Ensures code quality, consistency, and adherence to predefined standards by identifying syntax errors, formatting issues, and poor development practices before code execution. It contributes to maintaining clean, readable, and efficient code. ### Useful Links: * [Introduction to linting](https://eslint.org/) Pod ### What is it? The smallest unit of computation in Kubernetes, which groups one or more containers. ### What is it for? Manages containers that share resources and act as a single entity in a cluster. The structure is: Project (Clusters(Nodes(Pods))). ### Useful Links: * [About Pods](https://kubernetes.io/docs/concepts/workloads/pods/) Secret ### What is it? Sensitive data we want to store, manage, and use with ESO. Tilt ### What is it? A tool that helps with local development for Kubernetes, enabling quick visualization and management of changes to applications. ### What is it for? Facilitates the development workflow in Kubernetes by automatically updating the cluster's state based on code changes. It has an interface and automates many tasks that would otherwise need to be done manually. ### Useful Links: * [Official Website](https://tilt.dev/) * [Documentation](https://docs.tilt.dev/) yq ### What is it? A tool used to manipulate YAML files in the command line, similar to jq for JSON. ### What is it for? Edits, transforms, and queries YAML files. YAML files are used to configure applications, services, or clusters. ### Useful Links: * [yq GitHub](https://github.com/mikefarah/yq) | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/glossary.md | main | external-secrets | [
-0.01607329212129116,
0.007381360977888107,
0.04361141473054886,
0.030584657564759254,
0.09058807045221329,
-0.03232666105031967,
0.01446865126490593,
0.036327704787254333,
0.010457862168550491,
0.056471243500709534,
-0.0032021731603890657,
-0.031288910657167435,
-0.004257902503013611,
-0.... | 0.339338 |
This page lists the status, timeline and policy for currently supported ESO releases and its providers. Please also see our [deprecation policy](deprecation-policy.md) that describes API versioning, deprecation and API surface. ## Supported Versions external-secrets only supports the most-up-to date, current minor version. Any other minor version releases are automatically deprecated as soon as a new minor version comes. During a minor version support time, we cover: - regular image rebuilds to update OS dependencies - regular go dependency updates We do not do test coverage for any other kubernetes version than the ones running on our test suites. As of version 0.14.x , this is the only kubernetes version that we will guarantee support for. | ESO Version | Kubernetes Version | Release Date | End of Life | |-------------|--------------------|--------------|-----------------------| | 1.2 | 1.34 | Dec 19, 2025 | Release of next minor | | 1.1 | 1.34 | Nov 21, 2025 | Release of next minor | | 1.0 | 1.34 | Nov 7, 2025 | Release of next minor | | 0.20.x | 1.34 | Sep 22, 2025 | Nov 7, 2025 | | 0.19.x | 1.33 | Aug 2, 2025 | Sep 22, 2025 | | 0.18.x | 1.33 | Jul 17, 2025 | Aug 2, 2025 | | 0.17.x | 1.33 | May 14, 2025 | Jul 17, 2025 | | 0.16.x | 1.32 | Apr 14, 2025 | May 14, 2025 | | 0.15.x | 1.32 | Mar 19, 2025 | Apr 14, 2025 | | 0.14.x | 1.32 | Feb 4, 2025 | Mar 19, 2025 | | 0.13.x | 1.19 → 1.31 | Jan 21, 2025 | Feb 4, 2025 | | 0.12.x | 1.19 → 1.31 | Dec 24, 2024 | Jan 21, 2025 | | 0.11.x | 1.19 → 1.31 | Dec 2, 2024 | Dec 24, 2024 | | 0.10.x | 1.19 → 1.31 | Aug 3, 2024 | Dec 24, 2024 | | 0.9.x | 1.19 → 1.30 | Jun 22, 2023 | Dec 2, 2024 | | 0.8.x | 1.19 → 1.28 | Mar 16, 2023 | Aug 3, 2024 | | 0.7.x | 1.19 → 1.26 | Dec 11, 2022 | Jun 22, 2023 | | 0.6.x | 1.19 → 1.24 | Oct 9, 2022 | Mar 16, 2023 | | 0.5.x | 1.19 → 1.24 | Apr 6, 2022 | Dec 11, 2022 | | 0.4.x | 1.16 → 1.24 | Feb 2, 2022 | Oct 9, 2022 | | 0.3.x | 1.16 → 1.24 | Jul 25, 2021 | Apr 6, 2022 | ## Upgrading External Secrets Operator has not reached stable 1.0 yet. This means that \*\*we treat each minor version bump as a potentially breaking change\*\*. Breaking changes may include: - API schema changes - Default behavior modifications - Deprecated feature removals - Provider authentication changes - Configuration format updates \*\*Important upgrade recommendations:\*\* 1. \*\*Plan your upgrades carefully\*\* - Always review release notes before upgrading, it could contain breaking changes information 2. \*\*Upgrade version by version\*\* - We strongly recommend upgrading one minor version at a time (e.g., 0.18.x → 0.19.x → 0.20.x) rather than skipping versions 3. \*\*Test in non-production first\*\* - Always validate upgrades in development/staging environments Until we reach v1.0, please treat minor version upgrades with the same caution you would give to major version upgrades in other projects. ## Provider Stability and Support Level The following table describes the stability level of each provider and who's responsible. | Provider | Stability | Maintainer | | -------- | --------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | [AWS Secrets Manager](https://external-secrets.io/latest/provider/aws-secrets-manager/) | stable | [external-secrets](https://github.com/external-secrets) | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/stability-support.md | main | external-secrets | [
-0.003565395949408412,
0.005528130102902651,
0.14129675924777985,
-0.05065451189875603,
0.06680000573396683,
-0.01009245403110981,
-0.10568500310182571,
-0.023206371814012527,
0.000011606467523961328,
0.04446614906191826,
0.016935955733060837,
0.023579277098178864,
-0.06883227080106735,
-0... | 0.143503 |
would give to major version upgrades in other projects. ## Provider Stability and Support Level The following table describes the stability level of each provider and who's responsible. | Provider | Stability | Maintainer | | -------- | --------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | [AWS Secrets Manager](https://external-secrets.io/latest/provider/aws-secrets-manager/) | stable | [external-secrets](https://github.com/external-secrets) | | [AWS Parameter Store](https://external-secrets.io/latest/provider/aws-parameter-store/) | stable | [external-secrets](https://github.com/external-secrets) | | [Hashicorp Vault](https://external-secrets.io/latest/provider/hashicorp-vault/) | stable | [external-secrets](https://github.com/external-secrets) | | [GCP Secret Manager](https://external-secrets.io/latest/provider/google-secrets-manager/) | stable | [external-secrets](https://github.com/external-secrets) | | [Azure Keyvault](https://external-secrets.io/latest/provider/azure-key-vault/) | stable | [external-secrets](https://github.com/external-secrets) | | [IBM Cloud Secrets Manager](https://external-secrets.io/latest/provider/ibm-secrets-manager/) | stable | [@IdanAdar](https://github.com/IdanAdar) | | [Kubernetes](https://external-secrets.io/latest/provider/kubernetes) | beta | [external-secrets](https://github.com/external-secrets) | | [Yandex Lockbox](https://external-secrets.io/latest/provider/yandex-lockbox/) | alpha | [@AndreyZamyslov](https://github.com/AndreyZamyslov) [@knelasevero](https://github.com/knelasevero) | | [GitLab Variables](https://external-secrets.io/latest/provider/gitlab-variables/) | alpha | [@Jabray5](https://github.com/Jabray5) | | Alibaba Cloud KMS | alpha | \*\*DEPRECATED\*\* | | [Oracle Vault](https://external-secrets.io/latest/provider/oracle-vault) | alpha | [@anders-swanson](https://github.com/anders-swanson) | | [Akeyless](https://external-secrets.io/latest/provider/akeyless) | stable | [external-secrets](https://github.com/external-secrets) | | [1Password](https://external-secrets.io/latest/provider/1password-automation) | alpha | [@SimSpaceCorp](https://github.com/Simspace) [@snarlysodboxer](https://github.com/snarlysodboxer) | | [1Password SDK](https://external-secrets.io/latest/provider/1password-sdk) | alpha | [@Skarlso](https://github.com/Skarlso) | | [Generic Webhook](https://external-secrets.io/latest/provider/webhook) | alpha | [@willemm](https://github.com/willemm) | | [senhasegura DevOps Secrets Management (DSM)](https://external-secrets.io/latest/provider/senhasegura-dsm) | alpha | [@lfraga](https://github.com/lfraga) | | [Doppler SecretOps Platform](https://external-secrets.io/latest/provider/doppler) | alpha | [@ryan-blunden](https://github.com/ryan-blunden/) [@nmanoogian](https://github.com/nmanoogian/) | | [Keeper Security](https://www.keepersecurity.com/) | alpha | [@ppodevlab](https://github.com/ppodevlab) | | [Scaleway](https://external-secrets.io/latest/provider/scaleway) | alpha | [@azert9](https://github.com/azert9/) | | [CyberArk Secrets Manager](https://external-secrets.io/latest/provider/conjur) | stable | [@davidh-cyberark](https://github.com/davidh-cyberark/) [@szh](https://github.com/szh) | | [Delinea](https://external-secrets.io/latest/provider/delinea) | alpha | [@michaelsauter](https://github.com/michaelsauter/) | | [Beyondtrust](https://external-secrets.io/latest/provider/beyondtrust) | alpha | [@btfhernandez](https://github.com/btfhernandez/) | | [SecretServer](https://external-secrets.io/latest/provider/secretserver) | beta | [@gmurugezan](https://github.com/gmurugezan) | | [Pulumi ESC](https://external-secrets.io/latest/provider/pulumi) | alpha | [@dirien](https://github.com/dirien) | | [Passbolt](https://external-secrets.io/latest/provider/passbolt) | alpha | \*\*UNMAINTAINED\*\* | | [Infisical](https://external-secrets.io/latest/provider/infisical) | alpha | [@akhilmhdh](https://github.com/akhilmhdh) | | [Device42](https://external-secrets.io/latest/provider/device42) | alpha | \*\*UNMAINTAINED\*\* | | [Bitwarden Secrets Manager](https://external-secrets.io/latest/provider/bitwarden-secrets-manager) | alpha | [@skarlso](https://github.com/Skarlso) | | [Previder](https://external-secrets.io/latest/provider/previder) | stable | [@previder](https://github.com/previder) | | [Cloud.ru](https://external-secrets.io/latest/provider/cloudru) | alpha | [@default23](https://github.com/default23) | | [Volcengine](https://external-secrets.io/latest/provider/volcengine) | alpha | [@kevinyancn](https://github.com/kevinyancn) | | [ngrok](https://external-secrets.io/latest/provider/ngrok) | alpha | [@jonstacks](https://github.com/jonstacks) | | [Barbican](https://external-secrets.io/latest/provider/barbican) | alpha | [@rkferreira](https://github.com/rkferreira) | | [Devolutions Server](https://external-secrets.io/latest/provider/devolutions-server) | alpha | [@rbstp](https://github.com/rbstp) | ## Provider Feature Support The following table show the support for features across different providers. | Provider | find by name | find by tags | metadataPolicy Fetch | referent authentication | store validation | push secret | DeletionPolicy Merge/Delete | | ------------------------- | :----------: | :----------: | :------------------: | :---------------------: | :--------------: | :---------: | :-------------------------: | | AWS Secrets Manager | x | x | x | x | x | x | x | | AWS Parameter Store | x | x | x | x | x | x | x | | Hashicorp Vault | x | x | x | x | x | x | x | | GCP Secret Manager | x | x | x | x | x | x | x | | Azure Keyvault | x | x | x | x | x | x | x | | Kubernetes | x | x | x | x | x | x | x | | IBM Cloud Secrets Manager | x | | x | | x | | | | Yandex Lockbox | | | | | x | | | | GitLab Variables | x | x | | | x | | | | Alibaba Cloud KMS | | | | | x | | | | Oracle Vault | | | | | x | | | | Akeyless | x | x | | x | x | x | x | | 1Password | x | x | | | x | x | x | | 1Password SDK | | | | | x | x | x | | Generic Webhook | | | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/stability-support.md | main | external-secrets | [
0.006768994964659214,
-0.05696292966604233,
-0.006283899769186974,
-0.07004579156637192,
-0.012407279573380947,
-0.03389129042625427,
-0.08359639346599579,
0.01198820024728775,
-0.08190174400806427,
-0.00973279308527708,
0.02054930478334427,
0.03808661177754402,
-0.013598483055830002,
-0.0... | 0.033271 |
| Akeyless | x | x | | x | x | x | x | | 1Password | x | x | | | x | x | x | | 1Password SDK | | | | | x | x | x | | Generic Webhook | | | | | | | x | | senhasegura DSM | | | | | x | | | | Doppler | x | | | | x | | | | Keeper Security | x | | | | x | x | | | Scaleway | x | x | | | x | x | x | | CyberArk Secrets Manager | x | x | | | x | | | | Delinea | x | | | | x | | | | Beyondtrust | x | | | | x | | | | SecretServer | x | | | | x | | | | Pulumi ESC | x | | | | x | | | | Passbolt | x | | | | x | | | | Infisical | x | | | x | x | | | | Device42 | | | | | x | | | | Bitwarden Secrets Manager | x | | | | x | x | x | | Previder | x | | | | x | | | | Cloud.ru | x | x | | x | x | | x | | Volcengine | | | | | x | | | | ngrok | | | | | x | x | | | Barbican | x | | | | x | | | | Devolutions Server | | | | | x | x | | ## Support Policy We provide technical support and security / bug fixes for the above listed versions. ### Technical support We provide assistance for deploying/upgrading etc. on a best-effort basis. You can request support through the following channels: - [Kubernetes Slack #external-secrets](https://kubernetes.slack.com/messages/external-secrets) - GitHub [Issues](https://github.com/external-secrets/external-secrets/issues) - GitHub [Discussions](https://github.com/external-secrets/external-secrets/discussions) Even though we have active maintainers and people assigned to this project, we kindly ask for patience when asking for support. We will try to get to priority issues as fast as possible, but there may be some delays. ### Helm Charts The Helm charts provided by this project are offered "as-is" and are primarily focused on providing a good user experience and ease of use. Hardened Helm charts are not a deliverable of this project. We encourage users to review the default chart values and customize them to meet their own security requirements and best practices. | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/stability-support.md | main | external-secrets | [
-0.04385252296924591,
-0.09933847188949585,
-0.03433100879192352,
-0.0436483770608902,
-0.02187585085630417,
-0.039435409009456635,
0.09330836683511734,
0.034699697047472,
-0.10180793702602386,
0.04235202819108963,
0.0886513888835907,
-0.05376254394650459,
0.10334821045398712,
-0.065557204... | 0.138935 |
## Can I manually trigger a secret refresh? You can trigger a secret refresh by using kubectl or any other kubernetes api client. You just need to change an annotation, label or the spec of the resource: ``` kubectl annotate es my-es force-sync=$(date +%s) --overwrite ``` For ClusterExternalSecrets you can refresh all corresponding ExternalSecrets by changing the `external-secrets.io/force-sync` annotation on the ClusterExternalSecret resource: ``` kubectl annotate ces my-ces external-secrets.io/force-sync=$(date +%s) --overwrite ``` ## How do I know when my secret was last synced? The last synchronization timestamp of an ExternalSecret can be retrieved from the field `refreshTime`. ``` kubectl get es my-external-secret -o yaml | grep refreshTime refreshTime: "2022-05-21T23:02:47Z" ``` The interval can be changed by the `spec.refreshInterval` in the ExternalSecret. You can also control the refresh behavior by setting `spec.refreshPolicy` to one of the following options: - `Periodic` (default): Update regularly based on refreshInterval - `CreatedOnce`: Create the Secret only once and never update it afterward - `OnChange`: Only update when the ExternalSecret's metadata or specification changes ## How do I know when the status of my secret changed the last time? Every ExternalSecret resource contains a status condition that indicates whether a secret was successfully synchronized, along with the timestamp of the last status change of the ExternalSecret (e.g. from SecretSyncedError to SecretSynced). This can be obtained from the field `lastTransitionTime`: ``` kubectl get es my-external-secret -o yaml | grep condition -A 5 conditions: - lastTransitionTime: "2022-05-21T21:02:47Z" message: Secret was synced reason: SecretSynced status: "True" type: Ready ``` ## Differences to csi-secret-store Please take a look at this [issue comment here](https://github.com/external-secrets/external-secrets/issues/478#issuecomment-964413129). ## How do I debug an external-secret that doesn't sync? First, check the status of the ExternalSecret resource using `kubectl describe`. That displays the status conditions as well as recent events. You should expect a status condition with `Type=Ready`, `Status=True`. Further you shouldn't see any events with `Type=Warning`. Read carefully if they exist. ``` kubectl describe es my-external-secret [...] Status: Conditions: Last Transition Time: 2022-05-21T21:02:47Z Message: Secret was synced Reason: SecretSynced Status: True Type: Ready Refresh Time: 2022-05-21T21:06:47Z Synced Resource Version: 1-5c833527afd7ba3f426cb0082ee7e083 Events: Type Reason Age From Message ---- ------ ---- ---- ------- Warning UpdateFailed 4m12s external-secrets secrets "yyyyyyy" already exists Normal Updated 12s (x4 over 3m12s) external-secrets Updated Secret ``` If everything looks good you should check the corresponding secret store resource that is referenced from an ExternalSecret. Again, use `kubectl describe` to show status conditions and events and look for warning signs as described above. In an ideally, the store should be validated and Ready. ``` kubectl describe css kubernetes [...] Status: Conditions: Last Transition Time: 2022-05-21T21:02:47Z Message: store validated Reason: Valid Status: True Type: Ready Events: Type Reason Age From Message ---- ------ ---- ---- ------- Normal Valid 52s (x4 over 10m) cluster-secret-store store validated Normal Valid 52s (x4 over 10m) cluster-secret-store store validated ``` If everything looks normal so far, please go ahead and ensure that the created secret has the expected value. Also, take a look at the logs of the controller. ## Upgrading from KES to ESO Migrating from KES to ESO is quite tricky! There is a tool we built to help users out available [here](https://github.com/external-secrets/kes-to-eso), and there is a small migration procedure. There are some incompatibilities between KES to ESO, and while the tool tries to cover most of them, some of them will require manual intervention. We recommend to first convert the manifest files, and actually see if the tool provides a warning about any file needed to be changed. Beware that the tool points the SecretStores to use KES Service Account, so you'll also need to tweak | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/faq.md | main | external-secrets | [
-0.05313458293676376,
-0.055223360657691956,
0.04533347859978676,
0.05228922516107559,
0.05432824790477753,
-0.005619162693619728,
-0.006309513933956623,
-0.019057629629969597,
0.12174852192401886,
0.04251386597752571,
-0.0085624223574996,
-0.07570774108171463,
0.0075674885883927345,
-0.05... | 0.089722 |
them, some of them will require manual intervention. We recommend to first convert the manifest files, and actually see if the tool provides a warning about any file needed to be changed. Beware that the tool points the SecretStores to use KES Service Account, so you'll also need to tweak that if you plan to uninstall KES after the upgrade. | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/faq.md | main | external-secrets | [
-0.10018251091241837,
0.001780047663487494,
0.06286212056875229,
-0.09681985527276993,
0.02405523508787155,
-0.03916117548942566,
-0.06045374646782875,
-0.040879495441913605,
-0.032452791929244995,
-0.014721914194524288,
0.07001941651105881,
0.01980571821331978,
-0.05462425574660301,
-0.05... | 0.047408 |
# Prerequisites To collaborate on the External Secrets Operator (ESO) project, you need to install some tools on your computer. This guide explains what each tool is, why it is needed, the recommended version, and how to install it on the corresponding operating system. ### Supported Operating Systems To collaborate on the External Secrets Operator (ESO) project, it is recommended to use Unix-based operating systems, such as Linux and macOS. ESO's development environment is primarily designed for these systems, and many of the tools and scripts used during development are built to work on them. ### Can You Develop on Windows? It is possible to use Windows for development, but there are important considerations to keep in mind. Since ESO's development environment is not optimized for Windows, compatibility issues may arise with tools like Make, Tilt, and shell scripts. The project's automation scripts and commands are written for Unix environments, using bash scripting, which might not be compatible with Windows without adaptations. This tutorial will not cover the installation and configuration of tools on Windows due to its complexity and lack of testing. --- ## Install Go (Golang) About Golang ### What is Go? Go, also known as Golang, is a programming language design at Google by Robert Griesemer, Rob Pike, and Ken Thompson. It is known for being efficient, easy to learn, and excellent for developing fast and scalable applications. ### Why is Go needed? In the **External Secrets Operator** project, Go is used to develop core parts of the code. It is required to compile, run, and contribute to the project's source code. Golang Installation ### Required Version **Minimum version:** Go 1.20 or higher. **Recommended version:** Go 1.24.1 > As of this writing, the latest version of Go is **1.24.1**As of this writing, the latest version of Go is 1.24.1 , which worked perfectly with the **External Secrets Operator** project. Previous versions failed to test the application. Before testing the project, check your Go version. ### How to Install Go Please consult the [official documentation](https://go.dev/doc/install). ## Install Helm About Helm ### What is Helm? Helm is a package manager for Kubernetes, the platform that automates deployment, scaling, and management of containerized applications. ### Why is Helm necessary? In the **External Secrets Operator** project, Helm is used to simplify the installation and management of applications within Kubernetes, automating complex configuration and deployment processes. Installing Helm ### Required Version **Recommended version:** Helm 3 (latest version of Helm 3). ### How to Install Helm Please consult the [official Helm installation guide](https://helm.sh/docs/intro/install/). --- ## Install yq About yq ### What is yq? yq is a command-line tool for reading, manipulating, and writing YAML files, which are widely used for configurations. ### Why is yq necessary? In the **External Secrets Operator** project, yq is used to automate the editing of YAML configuration files, facilitating adjustments and implementations. Installing yq ### Required Version **Recommended version:** yq v4.44.3 or higher. ### How to Install yq Please consult the [official yq repository](https://github.com/mikefarah/yq). --- ## Install jq About jq ### What is jq? jq is a command-line tool for processing and manipulating JSON data. ### Why is jq needed? In the **External Secrets Operator** project, jq is essential for working with JSON data, enabling efficient filtering and transformation of information. Installing jq ### Required Version **Recommended version:** jq 1.6 or later. ### How to Install jq Please consult the [official jq website](https://stedolan.github.io/jq/). ## Kubernetes About Kubernetes ### What is Kubernetes? Kubernetes is an open-source platform for automating the deployment, scaling, and management of containerized applications. It orchestrates containerized workloads across a cluster of machines, ensuring high availability | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/prerequisites.md | main | external-secrets | [
-0.04992774873971939,
-0.042092204093933105,
-0.036258306354284286,
-0.015582124702632427,
-0.030164411291480064,
-0.005303134210407734,
-0.0016229922184720635,
0.07616834342479706,
-0.019279152154922485,
0.00466943858191371,
-0.012868348509073257,
-0.031098905950784683,
-0.04860251769423485... | 0.20509 |
jq 1.6 or later. ### How to Install jq Please consult the [official jq website](https://stedolan.github.io/jq/). ## Kubernetes About Kubernetes ### What is Kubernetes? Kubernetes is an open-source platform for automating the deployment, scaling, and management of containerized applications. It orchestrates containerized workloads across a cluster of machines, ensuring high availability and efficient resource utilization. ### Why is Kubernetes needed? In the **External Secrets Operator** project, Kubernetes provides the infrastructure to deploy and manage containerized applications. It allows integration with cloud-native services, enabling scalability, fault tolerance, and streamlined operations in dynamic environments. To work with Kubernetes, we need to install and configure some tools first. This will be explained in the sections below. For more details, check the [official documentation](https://kubernetes.io/docs/home/). --- ## Install Docker About Docker ### What is Docker? Docker is a platform for building, deploying, and running applications in containers. Containers package an application with all its dependencies into a standard unit for development and deployment. ### Why is Docker needed? In the **External Secrets Operator** project, Docker is used to create container images and run services in isolated environments. It is essential for developing, testing, and deploying the application within a Kubernetes environment. Installing Docker ### How to Install Docker Please consult the [official Docker documentation](https://docs.docker.com/get-docker/). Required Docker Configuration ### Configure Docker for Non-Root Usage By default, Docker requires superuser (root) privileges to run. To simplify usage, it is recommended to add the current user to the `docker` group to execute commands without `sudo`. Steps to configure Docker without root on Linux ### 1. Create the docker group (if it doesn't exist): ``` sudo groupadd docker ``` ### 2. Add the current user to the docker group: ``` sudo usermod -aG docker $USER ``` ### 3. Apply group changes without logging out: ``` newgrp docker ``` ### 4. Verify Docker can run without sudo: ``` docker run hello-world ``` If the command works without errors, the configuration is successful. --- ## Install kubectl About kubectl ### What is kubectl? **kubectl** is the command-line tool for managing Kubernetes clusters. It enables running commands on the cluster, managing resources, and debugging applications. ### Why is kubectl needed? In the **External Secrets Operator** project, kubectl is used to interact with local or remote Kubernetes clusters, apply configurations, and check the state of deployed resources. Installing kubectl ### Required Version **A version compatible with the installed Kubernetes version (usually the latest stable version).** ### How to Install kubectl Please consult the [official kubectl documentation](https://kubernetes.io/docs/tasks/tools/). --- ## Install ctlptl and Create a Kind Cluster with Local Registry About ctlptl ### What is ctlptl? **ctlptl** (Control Plane Tool) is a tool for managing local Kubernetes development clusters. It simplifies the creation and management of clusters like **Kind** (Kubernetes in Docker) and the configuration of local container registries. ### Why is ctlptl necessary? In the **External Secrets Operator** project, ctlptl is used to create and manage a local Kubernetes cluster using Kind, as well as to configure a local container registry to store Docker images during development. Installing ctlptl ### Required Version **The latest available version of ctlptl.** ### How to Install ctlptl Please consult the [official ctlptl installation guide](https://github.com/tilt-dev/ctlptl/blob/main/INSTALL.md ). ### Create a Kind Cluster with Local Registry About Kind **Kind** (Kubernetes in Docker) is a tool to run local Kubernetes clusters using Docker containers as cluster nodes. How to Create a Kind Cluster with Local Registry ### 1. Create a local container registry: ``` docker run -d --restart=always -p "5000:5000" --name kind-registry registry:2 ``` ### 2. Create a Kind cluster using ctlptl and connect it to the local registry: ``` ctlptl create cluster | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/prerequisites.md | main | external-secrets | [
-0.046763788908720016,
0.012914067134261131,
0.04889989644289017,
-0.008331387303769588,
-0.0471530482172966,
0.0008317333995364606,
-0.0028082779608666897,
0.004031077492982149,
0.03865019604563713,
0.025586603209376335,
-0.06069182604551315,
-0.01080020796507597,
0.011390908621251583,
-0... | 0.185782 |
containers as cluster nodes. How to Create a Kind Cluster with Local Registry ### 1. Create a local container registry: ``` docker run -d --restart=always -p "5000:5000" --name kind-registry registry:2 ``` ### 2. Create a Kind cluster using ctlptl and connect it to the local registry: ``` ctlptl create cluster kind --registry=kind-registry ``` This will create a Kind cluster configured to use the local registry at `localhost:5000`. ### 3. Verify the cluster is running: ``` kubectl cluster-info --context kind-kind ``` ### 4. List clusters managed by ctlptl: ``` ctlptl get clusters ``` --- ## Install Tilt About Tilt ### What is Tilt? **Tilt** is a tool that accelerates development in Kubernetes environments. It automates building, deploying, and monitoring code, enabling a faster development cycle. ### Why is Tilt necessary? In the **External Secrets Operator** project, Tilt is used to develop and test code changes efficiently, reflecting updates almost instantly in the local Kubernetes environment. Installing Tilt ### Required Version * **Prerequisites:** Install Docker, kubectl, Kind, and ctlptl. * **Recommended version:** Latest available version. ### How to Install Tilt Please consult the [official Tilt installation guide](https://docs.tilt.dev/install.html). | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/prerequisites.md | main | external-secrets | [
-0.03995060548186302,
-0.003108871867880225,
0.008858665823936462,
0.005695858970284462,
-0.04129447415471077,
0.027413632720708847,
-0.04272511228919029,
-0.003461971413344145,
0.01885705627501011,
0.035897642374038696,
0.012000848539173603,
-0.09242428094148636,
0.0026202548760920763,
-0... | 0.167466 |
# Getting started External-secrets runs within your Kubernetes cluster as a deployment resource. It utilizes CustomResourceDefinitions to configure access to secret providers through SecretStore resources and manages Kubernetes secret resources with ExternalSecret resources. This tutorial is intended for those who already have the PreRequisites complete. If there is a term that you don't comprehend, we suggest you to take a look at the Glossary for a general understanding. > Note: The minimum supported version of Kubernetes is `1.16.0`. Users still running Kubernetes v1.15 or below should upgrade > to a supported version before installing external-secrets. > Note: Our CRDs have reached the 256KB limit! You have to use [server-side-apply](https://kubernetes.io/docs/reference/using-api/server-side-apply/) in all locations to install them correctly. ## Installing with Helm The default install options will automatically install and manage the CRDs as part of your helm release. If you do not want the CRDs to be automatically upgraded and managed, you must set the `installCRDs` option to `false`. (e.g. `--set installCRDs=false`) You can install those CRDs outside of `helm` using: ```bash kubectl apply -f "https://raw.githubusercontent.com/external-secrets/external-secrets//deploy/crds/bundle.yaml" --server-side ``` Uncomment the relevant line in the next steps to disable the automatic install of CRDs. ### Option 1: Install from chart repository ```bash helm repo add external-secrets https://charts.external-secrets.io helm install external-secrets \ external-secrets/external-secrets \ -n external-secrets \ --create-namespace \ # --set installCRDs=false ``` ### Option 2: Install chart from local build Build and install the Helm chart locally after cloning the repository. ```bash make helm.build helm install external-secrets \ ./bin/chart/external-secrets.tgz \ -n external-secrets \ --create-namespace \ # --set installCRDs=false ``` ### Create a secret containing your AWS credentials ```shell echo -n 'KEYID' > ./access-key echo -n 'SECRETKEY' > ./secret-access-key kubectl create secret generic awssm-secret --from-file=./access-key --from-file=./secret-access-key ``` ### Create your first SecretStore Create a file 'basic-secret-store.yaml' with the following content. ```yaml {% include 'basic-secret-store.yaml' %} ``` Apply it to create a SecretStore resource. ``` kubectl apply -f "basic-secret-store.yaml" ``` ### Create your first ExternalSecret Create a file 'basic-external-secret.yaml' with the following content. ```yaml {% include 'basic-external-secret.yaml' %} ``` Apply it to create an External Secret resource. ``` kubectl apply -f "basic-external-secret.yaml" ``` ```bash kubectl describe externalsecret example # [...] Name: example Status: Binding: Name: secret-to-be-created Conditions: Last Transition Time: 2021-02-24T16:45:23Z Message: Secret was synced Reason: SecretSynced Status: True Type: Ready Refresh Time: 2021-02-24T16:45:24Z Events: ``` For more advanced examples, please read the other [guides](../guides/introduction.md). ## Uninstalling Before continuing, ensure that all external-secret resources that have been created by users have been deleted. You can check for any existing resources with the following command: ```bash kubectl get SecretStores,ClusterSecretStores,ExternalSecrets --all-namespaces ``` Once all these resources have been deleted you are ready to uninstall external-secrets. ### Uninstalling with Helm Uninstall the helm release using the delete command. ```bash helm delete external-secrets --namespace external-secrets ``` | https://github.com/external-secrets/external-secrets/blob/main//docs/introduction/getting-started.md | main | external-secrets | [
-0.04635072499513626,
-0.00835708063095808,
0.04735825955867767,
-0.03689902648329735,
0.005501993931829929,
0.03627384826540947,
-0.029243750497698784,
0.0718458741903305,
0.0879848375916481,
0.08296714723110199,
0.004616211634129286,
-0.05627285689115524,
0.011281391605734825,
-0.0079417... | 0.053273 |
 Sync secrets from [Infisical](https://www.infisical.com) to your Kubernetes cluster using External Secrets Operator. ## Authentication In order for the operator to fetch secrets from Infisical, it needs to first authenticate with Infisical. To authenticate, you can use [Universal Auth](https://infisical.com/docs/documentation/platform/identities/universal-auth) from [Machine identities](https://infisical.com/docs/documentation/platform/identities/machine-identities). Follow the [guide here](https://infisical.com/docs/documentation/platform/identities/universal-auth) to learn how to create and obtain a pair of Client Secret and Client ID. !!! note inline end Infisical requires `system:auth-delegator` for authentication. Please follow the [guide here](https://infisical.com/docs/documentation/platform/identities/kubernetes-auth#guide) to add the required role. ## Storing Your Machine Identity Secrets Once you have generated a pair of `Client ID` and `Client Secret`, you will need to store these credentials in your cluster as a Kubernetes secret. !!! note inline end Remember to replace with your own Machine Identity credentials. ```yaml apiVersion: v1 kind: Secret metadata: name: universal-auth-credentials type: Opaque stringData: clientId: clientSecret: ``` ### Secret Store You will then need to create a generic `SecretStore`. An sample `SecretStore` has been is shown below. !!! tip inline end To get your project slug from Infisical, head over to the project settings and click the button `Copy Project Slug`. ```yaml {% include 'infisical-generic-secret-store.yaml' %} ``` !!! Note For `ClusterSecretStore`, be sure to set `namespace` in `universalAuthCredentials.clientId` and `universalAuthCredentials.clientSecret`. ## Fetching secrets For the following examples, it assumes we have a secret structure in an Infisical project with the following structure: ```plaintext /API\_KEY /DB\_PASSWORD /JSON\_BLOB /my-app /SERVICE\_PASSWORD /ADMIN\_PASSWORD ``` Where `JSON\_BLOB` is a JSON string like `{"key": "value"}`. ### Fetch Individual Secret(s) To sync one or more secrets individually, use the following YAML: ```yaml {% include 'infisical-fetch-secret.yaml' %} ``` ### Fetch All Secrets To sync all secrets from an Infisical , use the following YAML: ``` yaml {% include 'infisical-fetch-all-secrets.yaml' %} ``` ### Filtering secrets To filter secrets by `path` (path prefix) and `name` (regular expression). ``` yaml {% include 'infisical-filtered-secrets.yaml' %} ``` ## Custom CA Certificates If you are using a self-hosted Infisical instance with a self-signed certificate or a certificate signed by a private CA, you can configure the provider to trust it. ### Using caBundle (inline) You can provide the CA certificate directly as a base64-encoded PEM bundle: ```yaml apiVersion: external-secrets.io/v1 kind: SecretStore metadata: name: infisical spec: provider: infisical: hostAPI: https://my-infisical.example.com # Base64-encoded PEM certificate caBundle: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t..." auth: universalAuthCredentials: clientId: key: clientId name: universal-auth-credentials clientSecret: key: clientSecret name: universal-auth-credentials secretsScope: projectSlug: my-project environmentSlug: dev ``` ### Using caProvider (from Secret or ConfigMap) Alternatively, you can reference a Secret or ConfigMap containing the CA certificate: ```yaml apiVersion: external-secrets.io/v1 kind: SecretStore metadata: name: infisical spec: provider: infisical: hostAPI: https://my-infisical.example.com caProvider: type: Secret name: infisical-ca key: ca.crt auth: universalAuthCredentials: clientId: key: clientId name: universal-auth-credentials clientSecret: key: clientSecret name: universal-auth-credentials secretsScope: projectSlug: my-project environmentSlug: dev ``` !!! note For `ClusterSecretStore`, be sure to set `namespace` in `caProvider`. | https://github.com/external-secrets/external-secrets/blob/main//docs/provider/infisical.md | main | external-secrets | [
-0.06735307723283768,
0.023447999730706215,
0.01417854055762291,
-0.013474026694893837,
-0.051217515021562576,
0.013831336982548237,
0.05084001645445824,
-0.005193114746361971,
0.06723260134458542,
0.027195008471608162,
0.005869791842997074,
-0.07565247267484665,
0.043353237211704254,
-0.0... | 0.129323 |
 ## Azure Key vault External Secrets Operator integrates with [Azure Key vault](https://azure.microsoft.com/en-us/services/key-vault/) for secrets, certificates and Keys management. ### Authentication We support authentication with Microsoft Entra identities that can be used as Workload Identity or [AAD Pod Identity](https://azure.github.io/aad-pod-identity/docs/) as well as with Service Principal credentials. Since the [AAD Pod Identity](https://azure.github.io/aad-pod-identity/docs/) is deprecated, it is recommended to use the [Workload Identity](https://azure.github.io/azure-workload-identity) authentication. We support connecting to different cloud flavours azure supports: `PublicCloud`, `USGovernmentCloud`, `ChinaCloud`, `GermanCloud` and `AzureStackCloud` (for Azure Stack Hub/Edge). You have to specify the `environmentType` and point to the correct cloud flavour. This defaults to `PublicCloud`. For environments with non-standard endpoints (Azure Stack, Azure China with AKS Workload Identity, etc.), you can provide custom cloud configuration to override the default endpoints. See the [Custom Cloud Configuration](#custom-cloud-configuration) section below. ```yaml apiVersion: external-secrets.io/v1 kind: SecretStore metadata: name: azure-backend spec: provider: azurekv: # PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud environmentType: PublicCloud # default ``` Minimum required permissions are `Get` over secret and certificate permissions. This can be done by adding a Key Vault access policy: ```sh KUBELET\_IDENTITY\_OBJECT\_ID=$(az aks show --resource-group --name --query 'identityProfile.kubeletidentity.objectId' -o tsv) az keyvault set-policy --name kv-name-with-certs --object-id "$KUBELET\_IDENTITY\_OBJECT\_ID" --certificate-permissions get --secret-permissions get ``` #### Service Principal key authentication A service Principal client and Secret is created and the JSON keyfile is stored in a `Kind=Secret`. The `ClientID` and `ClientSecret` or `ClientCertificate` (in PEM format) should be configured for the secret. This service principal should have proper access rights to the keyvault to be managed by the operator. #### Managed Identity authentication A Managed Identity should be created in Azure, and that Identity should have proper rights to the keyvault to be managed by the operator. Use [aad-pod-identity](https://azure.github.io/aad-pod-identity/docs/) to assign the identity to external-secrets operator. To add the selector to external-secrets operator, use `podLabels` in your values.yaml in case of Helm installation of external-secrets. If there are multiple Managed Identities for different keyvaults, the operator should have been assigned all identities via [aad-pod-identity](https://azure.github.io/aad-pod-identity/docs/), then the SecretStore configuration should include the Id of the identity to be used via the `identityId` field. ```yaml {% include 'azkv-secret-store-mi.yaml' %} ``` #### Workload Identity In Microsoft Entra, Workload Identity can be Application, user-assigned Managed Identity and Service Principal. You can use [Azure AD Workload Identity Federation](https://docs.microsoft.com/en-us/azure/active-directory/develop/workload-identity-federation) to access Azure managed services like Key Vault \*\*without needing to manage secrets\*\*. You need to configure a trust relationship between your Kubernetes Cluster and Azure AD. This can be done in various ways, for instance using `terraform`, the Azure Portal or the `az` cli. We found the [azwi](https://azure.github.io/azure-workload-identity/docs/installation/azwi.html) cli very helpful. The Azure [Workload Identity Quick Start Guide](https://azure.github.io/azure-workload-identity/docs/quick-start.html) is also good place to get started. This is basically a two step process: 1. Create a Kubernetes Service Account ([guide](https://azure.github.io/azure-workload-identity/docs/quick-start.html#5-create-a-kubernetes-service-account)) ```sh azwi serviceaccount create phase sa \ --aad-application-name "${APPLICATION\_NAME}" \ --service-account-namespace "${SERVICE\_ACCOUNT\_NAMESPACE}" \ --service-account-name "${SERVICE\_ACCOUNT\_NAME}" ``` 2. Configure the trust relationship between Azure AD and Kubernetes ([guide](https://azure.github.io/azure-workload-identity/docs/quick-start.html#6-establish-federated-identity-credential-between-the-aad-application-and-the-service-account-issuer--subject)) ```sh azwi serviceaccount create phase federated-identity \ --aad-application-name "${APPLICATION\_NAME}" \ --service-account-namespace "${SERVICE\_ACCOUNT\_NAMESPACE}" \ --service-account-name "${SERVICE\_ACCOUNT\_NAME}" \ --service-account-issuer-url "${SERVICE\_ACCOUNT\_ISSUER}" ``` With these prerequisites met you can configure `ESO` to use that Service Account. You have two options: ##### Mounted Service Account You run the controller and mount that particular service account into the pod by adding the label `azure.workload.identity/use: "true"`to the pod. That grants \_everyone\_ who is able to create a secret store or reference a correctly configured one the ability to read secrets. \*\*This approach is usually not recommended\*\*. But may make sense when you want to share an identity with multiple namespaces. Also see our [Multi-Tenancy Guide](../guides/multi-tenancy.md) for design considerations. ```yaml {% include 'azkv-workload-identity-mounted.yaml' %} ``` ##### Referenced Service | https://github.com/external-secrets/external-secrets/blob/main//docs/provider/azure-key-vault.md | main | external-secrets | [
-0.0706653743982315,
0.022059183567762375,
-0.05037364363670349,
0.007158383727073669,
-0.016472293063998222,
0.028732065111398697,
0.026635771617293358,
-0.022702498361468315,
0.0908353179693222,
0.11006741225719452,
0.028468063101172447,
0.004302352666854858,
0.05055522918701172,
0.04233... | 0.069591 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.