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 |
|---|---|---|---|---|---|
# External Basic Authentication ### Example 1 Use an external service (Basic Auth) located in `https://httpbin.org` ``` $ kubectl create -f ingress.yaml ingress "external-auth" created $ kubectl get ing external-auth NAME HOSTS ADDRESS PORTS AGE external-auth external-auth-01.sample.com 172.17.4.99 80 13s $ kubectl get ing external-auth -o yaml apiVersion: networking.k8s.io/v1 kind: Ingress metadata: annotations: nginx.ingress.kubernetes.io/auth-url: https://httpbin.org/basic-auth/user/passwd creationTimestamp: 2016-10-03T13:50:35Z generation: 1 name: external-auth namespace: default resourceVersion: "2068378" selfLink: /apis/networking/v1/namespaces/default/ingresses/external-auth uid: 5c388f1d-8970-11e6-9004-080027d2dc94 spec: rules: - host: external-auth-01.sample.com http: paths: - path: / pathType: Prefix backend: service: name: http-svc port: number: 80 status: loadBalancer: ingress: - ip: 172.17.4.99 $ ``` ## Test 1: no username/password (expect code 401) ```console $ curl -k http://172.17.4.99 -v -H 'Host: external-auth-01.sample.com' \* Rebuilt URL to: http://172.17.4.99/ \* Trying 172.17.4.99... \* Connected to 172.17.4.99 (172.17.4.99) port 80 (#0) > GET / HTTP/1.1 > Host: external-auth-01.sample.com > User-Agent: curl/7.50.1 > Accept: \*/\* > < HTTP/1.1 401 Unauthorized < Server: nginx/1.11.3 < Date: Mon, 03 Oct 2016 14:52:08 GMT < Content-Type: text/html < Content-Length: 195 < Connection: keep-alive < WWW-Authenticate: Basic realm="Fake Realm" < 401 Authorization Required # 401 Authorization Required --- nginx/1.11.3 \* Connection #0 to host 172.17.4.99 left intact ``` ## Test 2: valid username/password (expect code 200) ``` $ curl -k http://172.17.4.99 -v -H 'Host: external-auth-01.sample.com' -u 'user:passwd' \* Rebuilt URL to: http://172.17.4.99/ \* Trying 172.17.4.99... \* Connected to 172.17.4.99 (172.17.4.99) port 80 (#0) \* Server auth using Basic with user 'user' > GET / HTTP/1.1 > Host: external-auth-01.sample.com > Authorization: Basic dXNlcjpwYXNzd2Q= > User-Agent: curl/7.50.1 > Accept: \*/\* > < HTTP/1.1 200 OK < Server: nginx/1.11.3 < Date: Mon, 03 Oct 2016 14:52:50 GMT < Content-Type: text/plain < Transfer-Encoding: chunked < Connection: keep-alive < CLIENT VALUES: client\_address=10.2.60.2 command=GET real path=/ query=nil request\_version=1.1 request\_uri=http://external-auth-01.sample.com:8080/ SERVER VALUES: server\_version=nginx: 1.9.11 - lua: 10001 HEADERS RECEIVED: accept=\*/\* authorization=Basic dXNlcjpwYXNzd2Q= connection=close host=external-auth-01.sample.com user-agent=curl/7.50.1 x-forwarded-for=10.2.60.1 x-forwarded-host=external-auth-01.sample.com x-forwarded-port=80 x-forwarded-proto=http x-real-ip=10.2.60.1 BODY: \* Connection #0 to host 172.17.4.99 left intact -no body in request- ``` ## Test 3: invalid username/password (expect code 401) ``` curl -k http://172.17.4.99 -v -H 'Host: external-auth-01.sample.com' -u 'user:user' \* Rebuilt URL to: http://172.17.4.99/ \* Trying 172.17.4.99... \* Connected to 172.17.4.99 (172.17.4.99) port 80 (#0) \* Server auth using Basic with user 'user' > GET / HTTP/1.1 > Host: external-auth-01.sample.com > Authorization: Basic dXNlcjp1c2Vy > User-Agent: curl/7.50.1 > Accept: \*/\* > < HTTP/1.1 401 Unauthorized < Server: nginx/1.11.3 < Date: Mon, 03 Oct 2016 14:53:04 GMT < Content-Type: text/html < Content-Length: 195 < Connection: keep-alive \* Authentication problem. Ignoring this. < WWW-Authenticate: Basic realm="Fake Realm" < 401 Authorization Required # 401 Authorization Required --- nginx/1.11.3 \* Connection #0 to host 172.17.4.99 left intact ``` | https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/auth/external-auth/README.md | main | ingress-nginx | [
-0.04034440591931343,
0.046764615923166275,
-0.005645529367029667,
-0.03132931515574455,
-0.007969966158270836,
-0.04178331419825554,
0.00550901610404253,
0.017362505197525024,
0.07533898949623108,
0.06530992686748505,
-0.027836525812745094,
-0.11629095673561096,
0.00964093953371048,
0.013... | 0.140005 |
# External OAUTH Authentication ### Overview The `auth-url` and `auth-signin` annotations allow you to use an external authentication provider to protect your Ingress resources. !!! Important This annotation requires `ingress-nginx-controller v0.9.0` or greater. ### Key Detail This functionality is enabled by deploying multiple Ingress objects for a single host. One Ingress object has no special annotations and handles authentication. Other Ingress objects can then be annotated in such a way that require the user to authenticate against the first Ingress's endpoint, and can redirect `401`s to the same endpoint. Sample: ```yaml ... metadata: name: application annotations: nginx.ingress.kubernetes.io/auth-url: "https://$host/oauth2/auth" nginx.ingress.kubernetes.io/auth-signin: "https://$host/oauth2/start?rd=$escaped\_request\_uri" ... ``` ### Example: OAuth2 Proxy + Kubernetes-Dashboard This example will show you how to deploy [`oauth2\_proxy`](https://github.com/pusher/oauth2\_proxy) into a Kubernetes cluster and use it to protect the Kubernetes Dashboard using GitHub as the OAuth2 provider. #### Prepare 1. Install the kubernetes dashboard ```console kubectl create -f https://raw.githubusercontent.com/kubernetes/kops/master/addons/kubernetes-dashboard/v1.10.1.yaml ``` 2. Create a [custom GitHub OAuth application](https://github.com/settings/applications/new)  - Homepage URL is the FQDN in the Ingress rule, like `https://foo.bar.com` - Authorization callback URL is the same as the base FQDN plus `/oauth2/callback`, like `https://foo.bar.com/oauth2/callback`  3. Configure values in the file [`oauth2-proxy.yaml`](https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/docs/examples/auth/oauth-external-auth/oauth2-proxy.yaml) with the values: - OAUTH2\_PROXY\_CLIENT\_ID with the github `` - OAUTH2\_PROXY\_CLIENT\_SECRET with the github `` - OAUTH2\_PROXY\_COOKIE\_SECRET with value of `python -c 'import os,base64; print(base64.b64encode(os.urandom(16)).decode("ascii"))'` - (optional, but recommended) OAUTH2\_PROXY\_GITHUB\_USERS with GitHub usernames to allow to login - `\_\_INGRESS\_HOST\_\_` with a valid FQDN (e.g. `foo.bar.com`) - `\_\_INGRESS\_SECRET\_\_` with a Secret with a valid SSL certificate 4. Deploy the oauth2 proxy and the ingress rules by running: ```console $ kubectl create -f oauth2-proxy.yaml ``` #### Test Test the integration by accessing the configured URL, e.g. `https://foo.bar.com`    ### Example: Vouch Proxy + Kubernetes-Dashboard This example will show you how to deploy [`Vouch Proxy`](https://github.com/vouch/vouch-proxy) into a Kubernetes cluster and use it to protect the Kubernetes Dashboard using GitHub as the OAuth2 provider. #### Prepare 1. Install the kubernetes dashboard ```console kubectl create -f https://raw.githubusercontent.com/kubernetes/kops/master/addons/kubernetes-dashboard/v1.10.1.yaml ``` 2. Create a [custom GitHub OAuth application](https://github.com/settings/applications/new)  - Homepage URL is the FQDN in the Ingress rule, like `https://foo.bar.com` - Authorization callback URL is the same as the base FQDN plus `/oauth2/auth`, like `https://foo.bar.com/oauth2/auth`  3. Configure Vouch Proxy values in the file [`vouch-proxy.yaml`](https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/docs/examples/auth/oauth-external-auth/vouch-proxy.yaml) with the values: - VOUCH\_COOKIE\_DOMAIN with value of `` - OAUTH\_CLIENT\_ID with the github `` - OAUTH\_CLIENT\_SECRET with the github `` - (optional, but recommended) VOUCH\_WHITELIST with GitHub usernames to allow to login - `\_\_INGRESS\_HOST\_\_` with a valid FQDN (e.g. `foo.bar.com`) - `\_\_INGRESS\_SECRET\_\_` with a Secret with a valid SSL certificate 4. Deploy Vouch Proxy and the ingress rules by running: ```console $ kubectl create -f vouch-proxy.yaml ``` #### Test Test the integration by accessing the configured URL, e.g. `https://foo.bar.com`    | https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/auth/oauth-external-auth/README.md | main | ingress-nginx | [
-0.05267592892050743,
0.0791315883398056,
-0.01992388255894184,
-0.005119160749018192,
0.022046439349651337,
-0.034086842089891434,
0.05650218948721886,
0.02867412008345127,
0.05863749235868454,
0.04692621901631355,
-0.04033776745200157,
-0.06916137784719467,
0.053222306072711945,
0.013691... | 0.150598 |
# Client Certificate Authentication It is possible to enable Client-Certificate Authentication by adding additional annotations to your Ingress Resource. Before getting started you must have the following Certificates configured: 1. CA certificate and Key (Intermediate Certs need to be in CA) 2. Server Certificate (Signed by CA) and Key (CN should be equal the hostname you will use) 3. Client Certificate (Signed by CA) and Key For more details on the generation process, checkout the Prerequisite [docs](../../PREREQUISITES.md#client-certificate-authentication). You can have as many certificates as you want. If they're in the binary DER format, you can convert them as the following: ```bash openssl x509 -in certificate.der -inform der -out certificate.crt -outform pem ``` Then, you can concatenate them all into one file, named 'ca.crt' with the following: ```bash cat certificate1.crt certificate2.crt certificate3.crt >> ca.crt ``` \*\*Note:\*\* Make sure that the Key Size is greater than 1024 and Hashing Algorithm (Digest) is something better than md5 for each certificate generated. Otherwise you will receive an error. ## Creating Certificate Secrets There are many different ways of configuring your secrets to enable Client-Certificate Authentication to work properly. \* You can create a secret containing just the CA certificate and another Secret containing the Server Certificate which is Signed by the CA. ```bash kubectl create secret generic ca-secret --from-file=ca.crt=ca.crt kubectl create secret generic tls-secret --from-file=tls.crt=server.crt --from-file=tls.key=server.key ``` \* You can create a secret containing CA certificate along with the Server Certificate that can be used for both TLS and Client Auth. ```bash kubectl create secret generic ca-secret --from-file=tls.crt=server.crt --from-file=tls.key=server.key --from-file=ca.crt=ca.crt ``` \* If you want to also enable Certificate Revocation List verification you can create the secret also containing the CRL file in PEM format: ```bash kubectl create secret generic ca-secret --from-file=ca.crt=ca.crt --from-file=ca.crl=ca.crl ``` Note: The CA Certificate must contain the trusted certificate authority chain to verify client certificates. ## Setup Instructions 1. Add the annotations as provided in the [ingress.yaml](ingress.yaml) example to your own ingress resources as required. 2. Test by performing a curl against the Ingress Path without the Client Cert and expect a Status Code 400. 3. Test by performing a curl against the Ingress Path with the Client Cert and expect a Status Code 200. | https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/auth/client-certs/README.md | main | ingress-nginx | [
-0.029433559626340866,
0.053203266113996506,
-0.05347063019871712,
-0.034783985465765,
-0.020291713997721672,
-0.005119768902659416,
0.015197993256151676,
0.08820498734712601,
0.02672085165977478,
0.007027770858258009,
-0.05151905119419098,
-0.11631213873624802,
0.1408243328332901,
0.06799... | 0.001421 |
# Basic Authentication This example shows how to add authentication in a Ingress rule using a secret that contains a file generated with `htpasswd`. It's important the file generated is named `auth` (actually - that the secret has a key `data.auth`), otherwise the ingress-controller returns a 503. ## Create htpasswd file ```console $ htpasswd -c auth foo New password: New password: Re-type new password: Adding password for user foo ``` ## Convert htpasswd into a secret ```console $ kubectl create secret generic basic-auth --from-file=auth secret "basic-auth" created ``` ## Examine secret ```console $ kubectl get secret basic-auth -o yaml apiVersion: v1 data: auth: Zm9vOiRhcHIxJE9GRzNYeWJwJGNrTDBGSERBa29YWUlsSDkuY3lzVDAK kind: Secret metadata: name: basic-auth namespace: default type: Opaque ``` ## Using kubectl, create an ingress tied to the basic-auth secret ```console $ echo " apiVersion: networking.k8s.io/v1 kind: Ingress metadata: name: ingress-with-auth annotations: # type of authentication nginx.ingress.kubernetes.io/auth-type: basic # name of the secret that contains the user/password definitions nginx.ingress.kubernetes.io/auth-secret: basic-auth # message to display with an appropriate context why the authentication is required nginx.ingress.kubernetes.io/auth-realm: 'Authentication Required - foo' spec: ingressClassName: nginx rules: - host: foo.bar.com http: paths: - path: / pathType: Prefix backend: service: name: http-svc port: number: 80 " | kubectl create -f - ``` ## Use curl to confirm authorization is required by the ingress ``` $ curl -v http://10.2.29.4/ -H 'Host: foo.bar.com' \* Trying 10.2.29.4... \* Connected to 10.2.29.4 (10.2.29.4) port 80 (#0) > GET / HTTP/1.1 > Host: foo.bar.com > User-Agent: curl/7.43.0 > Accept: \*/\* > < HTTP/1.1 401 Unauthorized < Server: nginx/1.10.0 < Date: Wed, 11 May 2016 05:27:23 GMT < Content-Type: text/html < Content-Length: 195 < Connection: keep-alive < WWW-Authenticate: Basic realm="Authentication Required - foo" < 401 Authorization Required # 401 Authorization Required --- nginx/1.10.0 \* Connection #0 to host 10.2.29.4 left intact ``` ## Use curl with the correct credentials to connect to the ingress ``` $ curl -v http://10.2.29.4/ -H 'Host: foo.bar.com' -u 'foo:bar' \* Trying 10.2.29.4... \* Connected to 10.2.29.4 (10.2.29.4) port 80 (#0) \* Server auth using Basic with user 'foo' > GET / HTTP/1.1 > Host: foo.bar.com > Authorization: Basic Zm9vOmJhcg== > User-Agent: curl/7.43.0 > Accept: \*/\* > < HTTP/1.1 200 OK < Server: nginx/1.10.0 < Date: Wed, 11 May 2016 06:05:26 GMT < Content-Type: text/plain < Transfer-Encoding: chunked < Connection: keep-alive < Vary: Accept-Encoding < CLIENT VALUES: client\_address=10.2.29.4 command=GET real path=/ query=nil request\_version=1.1 request\_uri=http://foo.bar.com:8080/ SERVER VALUES: server\_version=nginx: 1.9.11 - lua: 10001 HEADERS RECEIVED: accept=\*/\* connection=close host=foo.bar.com user-agent=curl/7.43.0 x-request-id=e426c7829ef9f3b18d40730857c3eddb x-forwarded-for=10.2.29.1 x-forwarded-host=foo.bar.com x-forwarded-port=80 x-forwarded-proto=http x-real-ip=10.2.29.1 x-scheme=http BODY: \* Connection #0 to host 10.2.29.4 left intact -no body in request- ``` | https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/auth/basic/README.md | main | ingress-nginx | [
-0.0390070304274559,
0.06891632080078125,
-0.05002739280462265,
-0.04222170636057854,
0.00016548539861105382,
0.008535400032997131,
0.04131374880671501,
0.024939976632595062,
0.08557616919279099,
0.08974014222621918,
0.024692345410585403,
-0.09227745234966278,
0.04502721503376961,
-0.06000... | 0.086528 |
# Sticky sessions This example demonstrates how to achieve session affinity using cookies. ## Deployment Session affinity can be configured using the following annotations: |Name|Description|Value| | --- | --- | --- | |nginx.ingress.kubernetes.io/affinity|Type of the affinity, set this to `cookie` to enable session affinity|string (NGINX only supports `cookie`)| |nginx.ingress.kubernetes.io/affinity-mode|The affinity mode defines how sticky a session is. Use `balanced` to redistribute some sessions when scaling pods or `persistent` for maximum stickiness.|`balanced` (default) or `persistent`| |nginx.ingress.kubernetes.io/affinity-canary-behavior|Defines session affinity behavior of canaries. By default the behavior is `sticky`, and canaries respect session affinity configuration. Set this to `legacy` to restore original canary behavior, when session affinity parameters were not respected.|`sticky` (default) or `legacy`| |nginx.ingress.kubernetes.io/session-cookie-name|Name of the cookie that will be created|string (defaults to `INGRESSCOOKIE`)| |nginx.ingress.kubernetes.io/session-cookie-secure|Set the cookie as secure regardless the protocol of the incoming request|`"true"` or `"false"`| |nginx.ingress.kubernetes.io/session-cookie-path|Path that will be set on the cookie (required if your [Ingress paths][ingress-paths] use regular expressions)|string (defaults to the currently [matched path][ingress-paths])| |nginx.ingress.kubernetes.io/session-cookie-domain|Domain that will be set on the cookie|string| |nginx.ingress.kubernetes.io/session-cookie-samesite|`SameSite` attribute to apply to the cookie|Browser accepted values are `None`, `Lax`, and `Strict`| |nginx.ingress.kubernetes.io/session-cookie-conditional-samesite-none|Will omit `SameSite=None` attribute for older browsers which reject the more-recently defined `SameSite=None` value|`"true"` or `"false"` |nginx.ingress.kubernetes.io/session-cookie-max-age|Time until the cookie expires, corresponds to the `Max-Age` cookie directive|number of seconds| |nginx.ingress.kubernetes.io/session-cookie-expires|Legacy version of the previous annotation for compatibility with older browsers, generates an `Expires` cookie directive by adding the seconds to the current date|number of seconds| |nginx.ingress.kubernetes.io/session-cookie-change-on-failure|When set to `false` nginx ingress will send request to upstream pointed by sticky cookie even if previous attempt failed. When set to `true` and previous attempt failed, sticky cookie will be changed to point to another upstream.|`true` or `false` (defaults to `false`)| You can create the [session affinity example Ingress](ingress.yaml) to test this: ```console kubectl create -f ingress.yaml ``` ## Validation You can confirm that the Ingress works: ```console $ kubectl describe ing nginx-test Name: nginx-test Namespace: default Address: Default backend: default-http-backend:80 (10.180.0.4:8080,10.240.0.2:8080) Rules: Host Path Backends ---- ---- -------- stickyingress.example.com / nginx-service:80 () Annotations: affinity: cookie session-cookie-name: INGRESSCOOKIE session-cookie-expires: 172800 session-cookie-max-age: 172800 Events: FirstSeen LastSeen Count From SubObjectPath Type Reason Message --------- -------- ----- ---- ------------- -------- ------ ------- 7s 7s 1 {ingress-nginx-controller } Normal CREATE default/nginx-test $ curl -I http://stickyingress.example.com HTTP/1.1 200 OK Server: nginx/1.11.9 Date: Fri, 10 Feb 2017 14:11:12 GMT Content-Type: text/html Content-Length: 612 Connection: keep-alive Set-Cookie: INGRESSCOOKIE=a9907b79b248140b56bb13723f72b67697baac3d; Expires=Sun, 12-Feb-17 14:11:12 GMT; Max-Age=172800; Path=/; HttpOnly Last-Modified: Tue, 24 Jan 2017 14:02:19 GMT ETag: "58875e6b-264" Accept-Ranges: bytes ``` In the example above, you can see that the response contains a `Set-Cookie` header with the settings we have defined. This cookie is created by the Ingress-Nginx Controller, it contains a randomly generated key corresponding to the upstream used for that request (selected using [consistent hashing][consistent-hashing]) and has an `Expires` directive. If a client sends a cookie that doesn't correspond to an upstream, NGINX selects an upstream and creates a corresponding cookie. If the backend pool grows NGINX will keep sending the requests through the same server of the first request, even if it's overloaded. When the backend server is removed, the requests are re-routed to another upstream server. This does not require the cookie to be updated because the key's [consistent hash][consistent-hashing] will change. ## Caveats When you have a Service pointing to more than one Ingress, with only one containing affinity configuration, the first created Ingress will be used. This means that you can face the situation that you've configured session affinity on one Ingress and it doesn't work because the Service is pointing to another Ingress that doesn't configure this. [ingress-paths]: ../../../user-guide/ingress-path-matching.md [consistent-hashing]: https://en.wikipedia.org/wiki/Consistent\_hashing | https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/affinity/cookie/README.md | main | ingress-nginx | [
-0.020043959841132164,
0.022623566910624504,
-0.0017788633704185486,
0.027811499312520027,
-0.03922772407531738,
-0.0635431781411171,
0.07802751660346985,
-0.01105023268610239,
-0.01028812862932682,
0.013778792694211006,
-0.02399226650595665,
-0.014399770647287369,
-0.021039795130491257,
0... | 0.124281 |
configuration, the first created Ingress will be used. This means that you can face the situation that you've configured session affinity on one Ingress and it doesn't work because the Service is pointing to another Ingress that doesn't configure this. [ingress-paths]: ../../../user-guide/ingress-path-matching.md [consistent-hashing]: https://en.wikipedia.org/wiki/Consistent\_hashing | https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/affinity/cookie/README.md | main | ingress-nginx | [
-0.02819906547665596,
-0.02368440479040146,
-0.03786397725343704,
-0.045004911720752716,
-0.02705702744424343,
-0.05893285199999809,
0.12576451897621155,
-0.038791365921497345,
0.03724495321512222,
0.004613087512552738,
0.013731160201132298,
0.0015394382644444704,
0.06659002602100372,
0.04... | 0.124107 |
# Docker registry This example demonstrates how to deploy a [docker registry](https://github.com/docker/distribution) in the cluster and configure Ingress to enable access from the Internet. ## Deployment First we deploy the docker registry in the cluster: ```console kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/docs/examples/docker-registry/deployment.yaml ``` !!! Important \*\*DO NOT RUN THIS IN PRODUCTION\*\* This deployment uses `emptyDir` in the `volumeMount` which means the contents of the registry will be deleted when the pod dies. The next required step is creation of the ingress rules. To do this we have two options: with and without TLS ### Without TLS Download and edit the yaml deployment replacing `registry.` with a valid DNS name pointing to the ingress controller: ```console wget https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/docs/examples/docker-registry/ingress-without-tls.yaml ``` !!! Important Running a docker registry without TLS requires we configure our local docker daemon with the insecure registry flag. Please check [deploy a plain http registry](https://docs.docker.com/registry/insecure/#deploy-a-plain-http-registry) ### With TLS Download and edit the yaml deployment replacing `registry.` with a valid DNS name pointing to the ingress controller: ```console wget https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/docs/examples/docker-registry/ingress-with-tls.yaml ``` Deploy [kube lego](https://github.com/jetstack/kube-lego) use [Let's Encrypt](https://letsencrypt.org/) certificates or edit the ingress rule to use a secret with an existing SSL certificate. ### Testing To test the registry is working correctly we download a known image from [docker hub](https://hub.docker.com), create a tag pointing to the new registry and upload the image: ```console docker pull ubuntu:16.04 docker tag ubuntu:16.04 `registry./ubuntu:16.04` docker push `registry./ubuntu:16.04` ``` Please replace `registry.` with your domain. | https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/docker-registry/README.md | main | ingress-nginx | [
-0.05955791473388672,
0.05064330995082855,
0.023859690874814987,
-0.03299803286790848,
-0.01939411461353302,
-0.034319911152124405,
0.0002755352761596441,
0.0043959422037005424,
0.05473962798714638,
0.08907365053892136,
-0.027419015765190125,
-0.08498913049697876,
0.030177796259522438,
0.0... | 0.136272 |
# TLS termination This example demonstrates how to terminate TLS through the Ingress-Nginx Controller. ## Prerequisites You need a [TLS cert](../PREREQUISITES.md#tls-certificates) and a [test HTTP service](../PREREQUISITES.md#test-http-service) for this example. ## Deployment Create a `ingress.yaml` file. ```yaml apiVersion: networking.k8s.io/v1 kind: Ingress metadata: name: nginx-test spec: tls: - hosts: - foo.bar.com # This assumes tls-secret exists and the SSL # certificate contains a CN for foo.bar.com secretName: tls-secret ingressClassName: nginx rules: - host: foo.bar.com http: paths: - path: / pathType: Prefix backend: # This assumes http-svc exists and routes to healthy endpoints service: name: http-svc port: number: 80 ``` The following command instructs the controller to terminate traffic using the provided TLS cert, and forward un-encrypted HTTP traffic to the test HTTP service. ```console kubectl apply -f ingress.yaml ``` ## Validation You can confirm that the Ingress works. ```console $ kubectl describe ing nginx-test Name: nginx-test Namespace: default Address: 104.198.183.6 Default backend: default-http-backend:80 (10.180.0.4:8080,10.240.0.2:8080) TLS: tls-secret terminates Rules: Host Path Backends ---- ---- -------- \* http-svc:80 () Annotations: Events: FirstSeen LastSeen Count From SubObjectPath Type Reason Message --------- -------- ----- ---- ------------- -------- ------ ------- 7s 7s 1 {ingress-nginx-controller } Normal CREATE default/nginx-test 7s 7s 1 {ingress-nginx-controller } Normal UPDATE default/nginx-test 7s 7s 1 {ingress-nginx-controller } Normal CREATE ip: 104.198.183.6 7s 7s 1 {ingress-nginx-controller } Warning MAPPING Ingress rule 'default/nginx-test' contains no path definition. Assuming / $ curl 104.198.183.6 -L curl: (60) SSL certificate problem: self signed certificate More details here: http://curl.haxx.se/docs/sslcerts.html $ curl 104.198.183.6 -Lk CLIENT VALUES: client\_address=10.240.0.4 command=GET real path=/ query=nil request\_version=1.1 request\_uri=http://35.186.221.137:8080/ SERVER VALUES: server\_version=nginx: 1.9.11 - lua: 10001 HEADERS RECEIVED: accept=\*/\* connection=Keep-Alive host=35.186.221.137 user-agent=curl/7.46.0 via=1.1 google x-cloud-trace-context=f708ea7e369d4514fc90d51d7e27e91d/13322322294276298106 x-forwarded-for=104.132.0.80, 35.186.221.137 x-forwarded-proto=https BODY: ``` | https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/tls-termination/README.md | main | ingress-nginx | [
-0.06654328107833862,
0.11010245978832245,
0.0022753651719540358,
-0.03177650272846222,
-0.03335551172494888,
-0.06898020207881927,
0.03137655183672905,
-0.04464516416192055,
0.06252195686101913,
0.11155305802822113,
-0.03240470588207245,
-0.059026844799518585,
0.021920815110206604,
0.0265... | 0.067468 |
# Availability zone aware routing ## Table of Contents - [Availability zone aware routing](#availability-zone-aware-routing) - [Table of Contents](#table-of-contents) - [Summary](#summary) - [Motivation](#motivation) - [Goals](#goals) - [Non-Goals](#non-goals) - [Proposal](#proposal) - [Implementation History](#implementation-history) - [Drawbacks [optional]](#drawbacks-optional) ## Summary Teach ingress-nginx about availability zones where endpoints are running in. This way ingress-nginx pod will do its best to proxy to zone-local endpoint. ## Motivation When users run their services across multiple availability zones they usually pay for egress traffic between zones. Providers such as GCP, and Amazon EC2 usually charge extra for this feature. ingress-nginx when picking an endpoint to route request to does not consider whether the endpoint is in a different zone or the same one. That means it's at least equally likely that it will pick an endpoint from another zone and proxy the request to it. In this situation response from the endpoint to the ingress-nginx pod is considered inter-zone traffic and usually costs extra money. At the time of this writing, GCP charges $0.01 per GB of inter-zone egress traffic according to https://cloud.google.com/compute/network-pricing. According to [https://datapath.io/resources/blog/what-are-aws-data-transfer-costs-and-how-to-minimize-them/](https://web.archive.org/web/20201008160149/https://datapath.io/resources/blog/what-are-aws-data-transfer-costs-and-how-to-minimize-them/) Amazon also charges the same amount of money as GCP for cross-zone, egress traffic. This can be a lot of money depending on once's traffic. By teaching ingress-nginx about zones we can eliminate or at least decrease this cost. Arguably inter-zone network latency should also be better than cross-zone. ### Goals \* Given a regional cluster running ingress-nginx, ingress-nginx should do best-effort to pick a zone-local endpoint when proxying \* This should not impact canary feature \* ingress-nginx should be able to operate successfully if there are no zonal endpoints ### Non-Goals \* This feature inherently assumes that endpoints are distributed across zones in a way that they can handle all the traffic from ingress-nginx pod(s) in that zone \* This feature will be relying on https://kubernetes.io/docs/reference/kubernetes-api/labels-annotations-taints/#failure-domainbetakubernetesiozone, it is not this KEP's goal to support other cases ## Proposal The idea here is to have the controller part of ingress-nginx (1) detect what zone its current pod is running in and (2) detect the zone for every endpoint it knows about. After that, it will post that data as part of endpoints to Lua land. When picking an endpoint, the Lua balancer will try to pick zone-local endpoint first and if there is no zone-local endpoint then it will fall back to current behavior. Initially, this feature should be optional since it is going to make it harder to reason about the load balancing and not everyone might want that. \*\*How does controller know what zone it runs in?\*\* We can have the pod spec pass the node name using downward API as an environment variable. Upon startup, the controller can get node details from the API based on the node name. Once the node details are obtained we can extract the zone from the `failure-domain.beta.kubernetes.io/zone` annotation. Then we can pass that value to Lua land through Nginx configuration when loading `lua\_ingress.lua` module in `init\_by\_lua` phase. \*\*How do we extract zones for endpoints?\*\* We can have the controller watch create and update events on nodes in the entire cluster and based on that keep the map of nodes to zones in the memory. And when we generate endpoints list, we can access node name using `.subsets.addresses[i].nodeName` and based on that fetch zone from the map in memory and store it as a field on the endpoint. \_\_This solution assumes `failure-domain.beta.kubernetes.io/zone`\_\_ annotation does not change until the end of the node's life. Otherwise, we have to watch update events as well on the nodes and that'll add even more overhead. Alternatively, we can | https://github.com/kubernetes/ingress-nginx/blob/main//docs/enhancements/20190815-zone-aware-routing.md | main | ingress-nginx | [
-0.024422163143754005,
-0.019102906808257103,
0.016766555607318878,
0.014709153212606907,
0.052775800228118896,
0.002292625606060028,
-0.002330888994038105,
-0.004772614687681198,
0.04233092442154884,
0.05251745507121086,
-0.10382746160030365,
-0.027599230408668518,
0.011914772912859917,
-... | 0.19824 |
from the map in memory and store it as a field on the endpoint. \_\_This solution assumes `failure-domain.beta.kubernetes.io/zone`\_\_ annotation does not change until the end of the node's life. Otherwise, we have to watch update events as well on the nodes and that'll add even more overhead. Alternatively, we can get the list of nodes only when there's no node in the memory for the given node name. This is probably a better solution because then we would avoid watching for API changes on node resources. We can eagerly fetch all the nodes and build node name to zone mapping on start. From there on, it will sync during endpoint building in the main event loop if there's no existing entry for the node of an endpoint. This means an extra API call in case cluster has expanded. \*\*How do we make sure we do our best to choose zone-local endpoint?\*\* This will be done on the Lua side. For every backend, we will initialize two balancer instances: (1) with all endpoints (2) with all endpoints corresponding to the current zone for the backend. Then given the request once we choose what backend needs to serve the request, we will first try to use a zonal balancer for that backend. If a zonal balancer does not exist (i.e. there's no zonal endpoint) then we will use a general balancer. In case of zonal outages, we assume that the readiness probe will fail and the controller will see no endpoints for the backend and therefore we will use a general balancer. We can enable the feature using a configmap setting. Doing it this way makes it easier to rollback in case of a problem. ## Implementation History - initial version of KEP is shipped - proposal and implementation details are done ## Drawbacks [optional] More load on the Kubernetes API server. | https://github.com/kubernetes/ingress-nginx/blob/main//docs/enhancements/20190815-zone-aware-routing.md | main | ingress-nginx | [
0.05517018958926201,
0.017072876915335655,
0.019743764773011208,
0.01279410906136036,
0.07538040727376938,
-0.003107961732894182,
0.020060161128640175,
-0.021902641281485558,
0.114013671875,
0.03167172148823738,
-0.04951479658484459,
-0.05825949087738991,
-0.03606070205569267,
-0.084257602... | 0.143549 |
# Proposal to split containers \* All the NGINX files should live on one container \* No file other than NGINX files should exist on this container \* This includes not mounting the service account \* All the controller files should live on a different container \* Controller container should have bare minimum to work (just go program) \* ServiceAccount should be mounted just on controller \* Inside nginx container, there should be a really small http listener just able to start, stop and reload NGINX ## Roadmap (what needs to be done) \* Map what needs to be done to mount the SA just on controller container \* Map all the required files for NGINX to work \* Map all the required network calls between controller and NGINX \* eg.: Dynamic lua reconfiguration \* Map problematic features that will need attention \* SSLPassthrough today happens on controller process and needs to happen on NGINX ### Ports and endpoints on NGINX container \* Public HTTP/HTTPs port - 80 and 443 \* Lua configuration port - 10246 (HTTP) and 10247 (Stream) \* 3333 (temp) - Dataplane controller http server \* /reload - (POST) Reloads the configuration. \* "config" argument is the location of temporary file that should be used / moved to nginx.conf \* /test - (POST) Test the configuration of a given file location \* "config" argument is the location of temporary file that should be tested ### Mounting empty SA on controller container ```yaml kind: Pod apiVersion: v1 metadata: name: test spec: containers: - name: nginx image: nginx:latest ports: - containerPort: 80 - name: othernginx image: alpine:latest command: ["/bin/sh"] args: ["-c", "while true; do date; sleep 3; done"] volumeMounts: - mountPath: /var/run/secrets/kubernetes.io/serviceaccount name: emptysecret volumes: - name: emptysecret emptyDir: sizeLimit: 1Mi ``` ### Mapped folders on NGINX configuration \*\*WARNING\*\* We need to be aware of inter mount containers and inode problems. If we mount a file instead of a directory, it may take time to reflect the file value on the target container \* "/etc/nginx/lua/?.lua;/etc/nginx/lua/vendor/?.lua;;"; - Lua scripts \* "/var/log/nginx" - NGINX logs \* "/tmp/nginx (nginx.pid)" - NGINX pid directory / file, fcgi socket, etc \* " /etc/nginx/geoip" - GeoIP database directory - OK - /etc/ingress-controller/geoip \* /etc/nginx/mime.types - Mime types \* /etc/ingress-controller/ssl - SSL directory (fake cert, auth cert) \* /etc/ingress-controller/auth - Authentication files \* /etc/nginx/modsecurity - Modsecurity configuration \* /etc/nginx/owasp-modsecurity-crs - Modsecurity rules \* /etc/nginx/tickets.key - SSL tickets - OK - /etc/ingress-controller/tickets.key \* /etc/nginx/opentelemetry.toml - OTEL config - OK - /etc/ingress-controller/telemetry \* /etc/nginx/opentracing.json - Opentracing config - OK - /etc/ingress-controller/telemetry \* /etc/nginx/modules - NGINX modules \* /etc/nginx/fastcgi\_params (maybe) - fcgi params \* /etc/nginx/template - Template, may be used by controller only ##### List of modules ``` ngx\_http\_auth\_digest\_module.so ngx\_http\_modsecurity\_module.so ngx\_http\_brotli\_filter\_module.so ngx\_http\_opentracing\_module.so ngx\_http\_brotli\_static\_module.so ngx\_stream\_geoip2\_module.so ngx\_http\_geoip2\_module.so ``` ##### List of files that may be removed ``` -rw-r--r-- 1 www-data www-data 1077 Jun 23 19:44 fastcgi.conf -rw-r--r-- 1 www-data www-data 1077 Jun 23 19:44 fastcgi.conf.default -rw-r--r-- 1 www-data www-data 1007 Jun 23 19:44 fastcgi\_params -rw-r--r-- 1 www-data www-data 1007 Jun 23 19:44 fastcgi\_params.default drwxr-xr-x 2 www-data www-data 4096 Jun 23 19:34 geoip -rw-r--r-- 1 www-data www-data 2837 Jun 23 19:44 koi-utf -rw-r--r-- 1 www-data www-data 2223 Jun 23 19:44 koi-win drwxr-xr-x 6 www-data www-data 4096 Sep 19 14:13 lua -rw-r--r-- 1 www-data www-data 5349 Jun 23 19:44 mime.types -rw-r--r-- 1 www-data www-data 5349 Jun 23 19:44 mime.types.default drwxr-xr-x 2 www-data www-data 4096 Jun 23 19:44 modsecurity drwxr-xr-x 2 www-data www-data 4096 Jun 23 19:44 modules -rw-r--r-- 1 www-data www-data 18275 Oct 1 21:28 nginx.conf -rw-r--r-- 1 www-data www-data 2656 Jun 23 19:44 nginx.conf.default -rwx------ 1 www-data www-data 420 Oct 1 21:28 | https://github.com/kubernetes/ingress-nginx/blob/main//docs/enhancements/20231001-split-containers.md | main | ingress-nginx | [
-0.08871787041425705,
0.0032024052925407887,
-0.04346594586968422,
-0.04399733990430832,
0.004406537860631943,
-0.013620046898722649,
0.012243373319506645,
0.04735300689935684,
-0.0731414407491684,
0.003203806234523654,
0.014671663753688335,
-0.03928066045045853,
-0.02956506237387657,
0.03... | -0.049337 |
www-data 5349 Jun 23 19:44 mime.types.default drwxr-xr-x 2 www-data www-data 4096 Jun 23 19:44 modsecurity drwxr-xr-x 2 www-data www-data 4096 Jun 23 19:44 modules -rw-r--r-- 1 www-data www-data 18275 Oct 1 21:28 nginx.conf -rw-r--r-- 1 www-data www-data 2656 Jun 23 19:44 nginx.conf.default -rwx------ 1 www-data www-data 420 Oct 1 21:28 opentelemetry.toml -rw-r--r-- 1 www-data www-data 2 Oct 1 21:28 opentracing.json drwxr-xr-x 7 www-data www-data 4096 Jun 23 19:44 owasp-modsecurity-crs -rw-r--r-- 1 www-data www-data 636 Jun 23 19:44 scgi\_params -rw-r--r-- 1 www-data www-data 636 Jun 23 19:44 scgi\_params.default drwxr-xr-x 2 www-data www-data 4096 Sep 19 14:13 template -rw-r--r-- 1 www-data www-data 664 Jun 23 19:44 uwsgi\_params -rw-r--r-- 1 www-data www-data 664 Jun 23 19:44 uwsgi\_params.default -rw-r--r-- 1 www-data www-data 3610 Jun 23 19:44 win-utf ``` | https://github.com/kubernetes/ingress-nginx/blob/main//docs/enhancements/20231001-split-containers.md | main | ingress-nginx | [
-0.08948564529418945,
0.05481184273958206,
-0.07432081550359726,
-0.01368478313088417,
0.09326110780239105,
-0.09823142737150192,
-0.02160373516380787,
-0.03302974998950958,
0.017375504598021507,
0.012951716780662537,
0.07973648607730865,
0.009173120371997356,
0.056987058371305466,
0.03346... | 0.050793 |
# Remove static SSL configuration mode ## Table of Contents - [Summary](#summary) - [Motivation](#motivation) - [Goals](#goals) - [Non-Goals](#non-goals) - [Proposal](#proposal) - [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints) - [Drawbacks](#drawbacks) - [Alternatives](#alternatives) ## Summary Since release [0.19.0](https://github.com/kubernetes/ingress-nginx/releases/tag/nginx-0.19.0) is possible to configure SSL certificates without the need of NGINX reloads (thanks to lua) and after release [0.24.0](https://github.com/kubernetes/ingress-nginx/releases/tag/nginx-0.24.0) the default enabled mode is dynamic. ## Motivation The static configuration implies reloads, something that affects the majority of the users. ### Goals - Deprecation of the flag `--enable-dynamic-certificates`. - Cleanup of the codebase. ### Non-Goals - Features related to certificate authentication are not changed in any way. ## Proposal - Remove static SSL configuration ### Implementation Details/Notes/Constraints - Deprecate the flag Move the directives `ssl\_certificate` and `ssl\_certificate\_key` from each server block to the `http` section. These settings are required to avoid NGINX errors in the logs. - Remove any action of the flag `--enable-dynamic-certificates` ## Drawbacks ## Alternatives Keep both implementations | https://github.com/kubernetes/ingress-nginx/blob/main//docs/enhancements/20190724-only-dynamic-ssl.md | main | ingress-nginx | [
-0.05003218352794647,
0.10191576182842255,
0.04527665674686432,
0.048019763082265854,
0.0017830501310527325,
-0.017666954547166824,
-0.008000382222235203,
-0.02306872233748436,
0.0361919142305851,
-0.01141752116382122,
-0.0229084100574255,
-0.0036023652646690607,
0.020425058901309967,
0.07... | 0.062836 |
# Kubernetes Enhancement Proposals (KEPs) A Kubernetes Enhancement Proposal (KEP) is a way to propose, communicate and coordinate on new efforts for the Kubernetes project. For this reason, the `ingress-nginx` project is adopting it. ## Quick start for the KEP process Follow the process outlined in the [KEP template](YYYYMMDD-kep-template.md) ### Do I have to use the KEP process? No... but we hope that you will. Over time having a rich set of KEPs in one place will make it easier for people to track what is going on in the community and find a structured historic record. KEPs are only required when the changes are wide ranging and impact most of the project. ### Why would I want to use the KEP process? Our aim with KEPs is to clearly communicate new efforts to the Kubernetes contributor community. As such, we want to build a well curated set of clear proposals in a common format with useful metadata. Benefits to KEP users (in the limit): \* Exposure on a kubernetes blessed web site that is findable via web search engines. \* Cross indexing of KEPs so that users can find connections and the current status of any KEP. \* A clear process with approvers and reviewers for making decisions. This will lead to more structured decisions that stick as there is a discoverable record around the decisions. We are inspired by IETF RFCs, Python PEPs, and Rust RFCs. | https://github.com/kubernetes/ingress-nginx/blob/main//docs/enhancements/README.md | main | ingress-nginx | [
-0.09145357459783554,
0.048168934881687164,
0.1030547246336937,
-0.0579318143427372,
0.04902167618274689,
-0.010820471681654453,
-0.011459624394774437,
-0.05156996473670006,
0.044423121958971024,
0.04848421737551689,
-0.07147534936666489,
-0.06074875593185425,
-0.034161172807216644,
-0.011... | 0.200358 |
# Title This is the title of the KEP. Keep it simple and descriptive. A good title can help communicate what the KEP is and should be considered as part of any review. The title should be lowercased and spaces/punctuation should be replaced with `-`. To get started with this template: 1. \*\*Make a copy of this template.\*\* Create a copy of this template and name it `YYYYMMDD-my-title.md`, where `YYYYMMDD` is the date the KEP was first drafted. 1. \*\*Fill out the "overview" sections.\*\* This includes the Summary and Motivation sections. These should be easy if you've preflighted the idea of the KEP in an issue. 1. \*\*Create a PR.\*\* Assign it to folks that are sponsoring this process. 1. \*\*Create an issue\*\* When filing an enhancement tracking issue, please ensure to complete all fields in the template. 1. \*\*Merge early.\*\* Avoid getting hung up on specific details and instead aim to get the goal of the KEP merged quickly. The best way to do this is to just start with the "Overview" sections and fill out details incrementally in follow on PRs. View anything marked as a `provisional` as a working document and subject to change. Aim for single topic PRs to keep discussions focused. If you disagree with what is already in a document, open a new PR with suggested changes. The canonical place for the latest set of instructions (and the likely source of this file) is [here](YYYYMMDD-kep-template.md). The `Metadata` section above is intended to support the creation of tooling around the KEP process. This will be a YAML section that is fenced as a code block. See the KEP process for details on each of these items. ## Table of Contents A table of contents is helpful for quickly jumping to sections of a KEP and for highlighting any additional information provided beyond the standard KEP template. Ensure the TOC is wrapped with `<!-- toc --&rt<!-- /toc --&rt` tags, and then generate with `hack/update-toc.sh`. - [Summary](#summary) - [Motivation](#motivation) - [Goals](#goals) - [Non-Goals](#non-goals) - [Proposal](#proposal) - [User Stories [optional]](#user-stories-optional) - [Story 1](#story-1) - [Story 2](#story-2) - [Implementation Details/Notes/Constraints [optional]](#implementation-detailsnotesconstraints-optional) - [Risks and Mitigations](#risks-and-mitigations) - [Design Details](#design-details) - [Test Plan](#test-plan) - [Removing a deprecated flag](#removing-a-deprecated-flag) - [Implementation History](#implementation-history) - [Drawbacks [optional]](#drawbacks-optional) - [Alternatives [optional]](#alternatives-optional) ## Summary The `Summary` section is incredibly important for producing high quality user-focused documentation such as release notes or a development roadmap. It should be possible to collect this information before implementation begins in order to avoid requiring implementers to split their attention between writing release notes and implementing the feature itself. A good summary is probably at least a paragraph in length. ## Motivation This section is for explicitly listing the motivation, goals and non-goals of this KEP. Describe why the change is important and the benefits to users. The motivation section can optionally provide links to [experience reports][] to demonstrate the interest in a KEP within the wider Kubernetes community. [experience reports]: https://github.com/golang/go/wiki/ExperienceReports ### Goals List the specific goals of the KEP. How will we know that this has succeeded? ### Non-Goals What is out of scope for this KEP? Listing non-goals helps to focus discussion and make progress. ## Proposal This is where we get down to the nitty gritty of what the proposal actually is. ### User Stories [optional] Detail the things that people will be able to do if this KEP is implemented. Include as much detail as possible so that people can understand the "how" of the system. The goal here is to make this feel real for users without getting bogged down. #### Story 1 #### Story | https://github.com/kubernetes/ingress-nginx/blob/main//docs/enhancements/YYYYMMDD-kep-template.md | main | ingress-nginx | [
-0.06991018354892731,
0.14223633706569672,
0.06347537785768509,
-0.05171864852309227,
-0.0019241764675825834,
0.04708117991685867,
-0.001815342460758984,
0.012726720422506332,
-0.09050697833299637,
0.025860628113150597,
-0.019924692809581757,
-0.06451646238565445,
0.0018713376484811306,
-0... | 0.113931 |
the things that people will be able to do if this KEP is implemented. Include as much detail as possible so that people can understand the "how" of the system. The goal here is to make this feel real for users without getting bogged down. #### Story 1 #### Story 2 ### Implementation Details/Notes/Constraints [optional] What are the caveats to the implementation? What are some important details that didn't come across above. Go in to as much detail as necessary here. This might be a good place to talk about core concepts and how they relate. ### Risks and Mitigations What are the risks of this proposal and how do we mitigate. Think broadly. For example, consider both security and how this will impact the larger kubernetes ecosystem. How will security be reviewed and by whom? How will UX be reviewed and by whom? Consider including folks that also work outside project. ## Design Details ### Test Plan \*\*Note:\*\* \*Section not required until targeted at a release.\* Consider the following in developing a test plan for this enhancement: - Will there be e2e and integration tests, in addition to unit tests? - How will it be tested in isolation vs with other components? No need to outline all of the test cases, just the general strategy. Anything that would count as tricky in the implementation and anything particularly challenging to test should be called out. All code is expected to have adequate tests (eventually with coverage expectations). Please adhere to the [Kubernetes testing guidelines][testing-guidelines] when drafting this test plan. [testing-guidelines]: https://git.k8s.io/community/contributors/devel/sig-testing/testing.md #### Removing a deprecated flag - Announce deprecation and support policy of the existing flag - Two versions passed since introducing the functionality which deprecates the flag (to address version skew) - Address feedback on usage/changed behavior, provided on GitHub issues - Deprecate the flag ## Implementation History Major milestones in the life cycle of a KEP should be tracked in `Implementation History`. Major milestones might include - the `Summary` and `Motivation` sections being merged signaling acceptance - the `Proposal` section being merged signaling agreement on a proposed design - the date implementation started - the first Kubernetes release where an initial version of the KEP was available - the version of Kubernetes where the KEP graduated to general availability - when the KEP was retired or superseded ## Drawbacks [optional] Why should this KEP \_not\_ be implemented. ## Alternatives [optional] Similar to the `Drawbacks` section the `Alternatives` section is used to highlight and record other possible approaches to delivering the value proposed by a KEP. | https://github.com/kubernetes/ingress-nginx/blob/main//docs/enhancements/YYYYMMDD-kep-template.md | main | ingress-nginx | [
-0.039968930184841156,
0.1004980280995369,
0.11347176134586334,
-0.08111210912466049,
-0.014206109568476677,
0.011074705049395561,
-0.009375018998980522,
0.034646350890398026,
-0.04792289808392525,
0.022088320925831795,
-0.040794387459754944,
-0.05444280430674553,
-0.01346980594098568,
-0.... | 0.181947 |
# Ingress NGINX - Code Overview This document provides an overview of Ingress NGINX code. ## Core Golang code This part of the code is responsible for the main logic of Ingress NGINX. It contains all the logics that parses [Ingress Objects](https://kubernetes.io/docs/concepts/services-networking/ingress/), [annotations](https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-annotation), watches Endpoints and turn them into usable nginx.conf configuration. ### Core Sync Logics: Ingress-nginx has an internal model of the ingresses, secrets and endpoints in a given cluster. It maintains two copies of that: 1. One copy is the currently running configuration model 2. Second copy is the one generated in response to some changes in the cluster The sync logic diffs the two models and if there's a change it tries to converge the running configuration to the new one. There are static and dynamic configuration changes. All endpoints and certificate changes are handled dynamically by posting the payload to an internal NGINX endpoint that is handled by Lua. --- The following parts of the code can be found: ### Entrypoint The `main` package is responsible for starting ingress-nginx program, which can be found in [cmd/nginx](https://github.com/kubernetes/ingress-nginx/tree/main/cmd/nginx) directory. ### Version Is the package of the code responsible for adding `version` subcommand, and can be found in [version](https://github.com/kubernetes/ingress-nginx/tree/main/version) directory. ### Internal code This part of the code contains the internal logics that compose Ingress NGINX Controller, and it's split into: #### Admission Controller Contains the code of [Kubernetes Admission Controller](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/) which validates the syntax of ingress objects before accepting it. This code can be found in [internal/admission/controller](https://github.com/kubernetes/ingress-nginx/tree/main/internal/admission/controller) directory. #### File functions Contains auxiliary codes that deal with files, such as generating the SHA1 checksum of a file, or creating required directories. This code can be found in [internal/file](https://github.com/kubernetes/ingress-nginx/blob/main/internal/file) directory. #### Ingress functions Contains all the logics from Ingress-Nginx Controller, with some examples being: \* Expected Golang structures that will be used in templates and other parts of the code - [internal/ingress/types.go](https://github.com/kubernetes/ingress-nginx/blob/main/internal/ingress/types.go). \* supported annotations and its parsing logics - [internal/ingress/annotations](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/annotations). \* reconciliation loops and logics - [internal/ingress/controller](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/controller) \* defaults - define the default struct - [internal/ingress/defaults](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/defaults). \* Error interface and types implementation - [internal/ingress/errors](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/errors) \* Metrics collectors for Prometheus exporting - [internal/ingress/metric](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/metric). \* Resolver - Extracts information from a controller - [internal/ingress/resolver](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/resolver). \* Ingress Object status publisher - [internal/ingress/status](https://github.com/kubernetes/ingress-nginx/tree/main/internal/ingress/status). And other parts of the code that will be written in this document in a future. #### K8s functions Contains helper functions for parsing Kubernetes objects. This part of the code can be found in [internal/k8s](https://github.com/kubernetes/ingress-nginx/tree/main/internal/k8s) directory. #### Networking functions Contains helper functions for networking, such as IPv4 and IPv6 parsing, SSL certificate parsing, etc. This part of the code can be found in [internal/net](https://github.com/kubernetes/ingress-nginx/tree/main/internal/net) directory. #### NGINX functions Contains helper function to deal with NGINX, such as verify if it's running and reading it's configuration file parts. This part of the code can be found in [internal/nginx](https://github.com/kubernetes/ingress-nginx/tree/main/internal/nginx) directory. #### Tasks / Queue Contains the functions responsible for the sync queue part of the controller. This part of the code can be found in [internal/task](https://github.com/kubernetes/ingress-nginx/tree/main/internal/task) directory. #### Other parts of internal Other parts of internal code might not be covered here, like runtime and watch but they can be added in a future. ## E2E Test The e2e tests code is in [test](https://github.com/kubernetes/ingress-nginx/tree/main/test) directory. ## Other programs Describe here `kubectl plugin`, `dbg`, `waitshutdown` and cover the hack scripts. ### kubectl plugin It contains kubectl plugin for inspecting your ingress-nginx deployments. This part of code can be found in [cmd/plugin](https://github.com/kubernetes/ingress-nginx/tree/main/cmd/plugin) directory Detail functions flow and available flow can be found in [kubectl-plugin](https://github.com/kubernetes/ingress-nginx/blob/main/docs/kubectl-plugin.md) ## Deploy files This directory contains the `yaml` deploy files used as examples or references in the docs | https://github.com/kubernetes/ingress-nginx/blob/main//docs/developer-guide/code-overview.md | main | ingress-nginx | [
-0.05814354494214058,
0.023868946358561516,
0.04210592806339264,
0.013132086023688316,
0.02536623924970627,
-0.021882297471165657,
0.028062809258699417,
-0.062103502452373505,
0.09031684696674347,
0.024823660030961037,
-0.02317957580089569,
-0.015921518206596375,
0.018084557726979256,
-0.0... | 0.23448 |
kubectl plugin It contains kubectl plugin for inspecting your ingress-nginx deployments. This part of code can be found in [cmd/plugin](https://github.com/kubernetes/ingress-nginx/tree/main/cmd/plugin) directory Detail functions flow and available flow can be found in [kubectl-plugin](https://github.com/kubernetes/ingress-nginx/blob/main/docs/kubectl-plugin.md) ## Deploy files This directory contains the `yaml` deploy files used as examples or references in the docs to deploy Ingress NGINX and other components. Those files are in [deploy](https://github.com/kubernetes/ingress-nginx/tree/main/deploy) directory. ## Helm Chart Used to generate the Helm chart published. Code is in [charts/ingress-nginx](https://github.com/kubernetes/ingress-nginx/tree/main/charts/ingress-nginx). ## Documentation/Website The documentation used to generate the website https://kubernetes.github.io/ingress-nginx/ This code is available in [docs](https://github.com/kubernetes/ingress-nginx/tree/main/docs) and it's main "language" is `Markdown`, used by [mkdocs](https://github.com/kubernetes/ingress-nginx/blob/main/mkdocs.yml) file to generate static pages. ## Container Images Container images used to run ingress-nginx, or to build the final image. ### Base Images Contains the `Dockerfiles` and scripts used to build base images that are used in other parts of the repo. They are present in [images](https://github.com/kubernetes/ingress-nginx/tree/main/images) repo. Some examples: \* [nginx](https://github.com/kubernetes/ingress-nginx/tree/main/images/nginx) - The base NGINX image ingress-nginx uses is not a vanilla NGINX. It bundles many libraries together and it is a job in itself to maintain that and keep things up-to-date. \* [custom-error-pages](https://github.com/kubernetes/ingress-nginx/tree/main/images/custom-error-pages) - Used on the custom error page examples. There are other images inside this directory. ### Ingress Controller Image The image used to build the final ingress controller, used in deploy scripts and Helm charts. This is NGINX with some Lua enhancement. We do dynamic certificate, endpoints handling, canary traffic split, custom load balancing etc at this component. One can also add new functionalities using Lua plugin system. The files are in [rootfs](https://github.com/kubernetes/ingress-nginx/tree/main/rootfs) directory and contains: \* The Dockerfile \* [nginx config](https://github.com/kubernetes/ingress-nginx/tree/main/rootfs/etc/nginx) #### Ingress NGINX Lua Scripts Ingress NGINX uses Lua Scripts to enable features like hot reloading, rate limiting and monitoring. Some are written using the [OpenResty](https://openresty.org/en/) helper. The directory containing Lua scripts is [rootfs/etc/nginx/lua](https://github.com/kubernetes/ingress-nginx/tree/main/rootfs/etc/nginx/lua). #### Nginx Go template file One of the functions of Ingress NGINX is to turn [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) objects into nginx.conf file. To do so, the final step is to apply those configurations in [nginx.tmpl](https://github.com/kubernetes/ingress-nginx/tree/main/rootfs/etc/nginx/template) turning it into a final nginx.conf file. | https://github.com/kubernetes/ingress-nginx/blob/main//docs/developer-guide/code-overview.md | main | ingress-nginx | [
-0.06847695261240005,
0.05289166793227196,
0.017885472625494003,
-0.024768078699707985,
0.03290858119726181,
0.005897598806768656,
-0.01988743618130684,
-0.012780679389834404,
0.09372325986623764,
0.07433400303125381,
0.005459424573928118,
-0.04806813597679138,
-0.028220603242516518,
-0.04... | 0.185878 |
Developing for Ingress-Nginx Controller This document explains how to get started with developing for Ingress-Nginx Controller. For the really new contributors, who want to contribute to the INGRESS-NGINX project, but need help with understanding some basic concepts, that are needed to work with the Kubernetes ingress resource, here is a link to the [New Contributors Guide](https://github.com/kubernetes/ingress-nginx/blob/main/NEW\_CONTRIBUTOR.md). This guide contains tips on how a http/https request travels, from a browser or a curl command, to the webserver process running inside a container, in a pod, in a Kubernetes cluster, but enters the cluster via a ingress resource. For those who are familiar with those basic networking concepts like routing of a packet with regards to a http request, termination of connection, reverseproxy etc. etc., you can skip this and move on to the sections below. (or read it anyways just for context and also provide feedbacks if any) ## Prerequisites Install [Go 1.14](https://golang.org/dl/) or later. !!! note The project uses [Go Modules](https://go.dev/wiki/Modules#modules) Install [Docker](https://docs.docker.com/engine/install/) (v19.03.0 or later with experimental feature on) Install [kubectl](https://kubernetes.io/docs/tasks/tools/) (1.24.0 or higher) Install [Kind](https://kind.sigs.k8s.io/) Install [Helm](https://helm.sh/) Install jq Install make !!! important The majority of make tasks run as docker containers ## Quick Start 1. Fork the repository 2. Clone the repository to any location in your work station 3. Add a `GO111MODULE` environment variable with `export GO111MODULE=on` 4. Run `go mod download` to install dependencies ### Local build Start a local Kubernetes cluster using [kind](https://kind.sigs.k8s.io/), build and deploy the ingress controller ```console make dev-env ``` - If you are working on the v1.x.x version of this controller, and you want to create a cluster with kubernetes version 1.22, then please visit the [documentation for kind](https://kind.sigs.k8s.io/docs/user/configuration/#a-note-on-cli-parameters-and-configuration-files), and look for how to set a custom image for the kind node (image: kindest/node...), in the kind config file. ### Testing \*\*Run go unit tests\*\* ```console make test ``` \*\*Run unit-tests for lua code\*\* ```console make lua-test ``` Lua tests are located in the directory `rootfs/etc/nginx/lua/test` !!! important Test files must follow the naming convention `\_test.lua` or it will be ignored \*\*Run e2e test suite\*\* ```console make kind-e2e-test ``` To limit the scope of the tests to execute, we can use the environment variable `FOCUS` ```console FOCUS="no-auth-locations" make kind-e2e-test ``` !!! note The variable `FOCUS` defines Ginkgo [Focused Specs](https://onsi.github.io/ginkgo/#focused-specs) Valid values are defined in the describe definition of the e2e tests like [Default Backend](https://github.com/kubernetes/ingress-nginx/blob/main/test/e2e/defaultbackend/default\_backend.go#L29) The complete list of tests can be found [here](../e2e-tests.md) \*\*Run Helm unit tests\*\* ```console make helm-test ``` ### Custom docker image In some cases, it can be useful to build a docker image and publish such an image to a private or custom registry location. This can be done setting two environment variables, `REGISTRY` and `TAG` ```console export TAG="dev" export REGISTRY="$USER" make build image ``` and then publish such version with ```console docker push $REGISTRY/controller:$TAG ``` | https://github.com/kubernetes/ingress-nginx/blob/main//docs/developer-guide/getting-started.md | main | ingress-nginx | [
-0.05609467253088951,
0.0569368451833725,
0.009625105187296867,
-0.011367419734597206,
-0.0027232025749981403,
-0.03227215260267258,
0.06776492297649384,
-0.013800053857266903,
0.04458841681480408,
0.05438007786870003,
0.005054667592048645,
-0.029451915994286537,
-0.01543839368969202,
-0.0... | 0.188348 |
# Helm 4 Overview Helm v4 represents a significant evolution from v3, introducing breaking changes, new architectural patterns, and enhanced functionality while maintaining backwards compatibility for charts. For more information about the planned Helm 4 release phases, see [Path to Helm v4](https://helm.sh/blog/path-to-helm-v4/). ## What's New This section provides an overview of what's new in Helm 4, including breaking changes, major new features, and other improvements. For complete technical details, see the [Full Changelog](./changelog.md). ### Summary - \*\*New features\*\*: Wasm-based plugins, kstatus watcher, OCI digest support, multi-doc values, JSON arguments - \*\*Architecture changes\*\*: Plugin system completely redesigned, package restructuring, CLI flag renaming, move to versioned packages, chart v3 support, content-based caching - \*\*Modernization\*\*: slog migration, Go 1.24 update, dependency cleanup - \*\*Security\*\*: Enhanced OCI/registry support, TLS improvements ### Breaking Changes #### Post-renderers implemented as plugins Post-renderers are implemented as plugins. With this change, it is no longer possible to pass an executable directly to `helm render --post-renderer`, but a plugin name must be passed. This might require updates to any existing post-renderer workflows. #### Registry login does not accept full URLs The `helm registry login` command must be done with the domain name only in v4. This is so login can be scoped at different levels on a registry in the future. ### New Features #### Plugin System Overhaul Helm 4 introduces an optional WebAssembly-based runtime for enhanced security and expanded capabilities. Existing plugins continue to work, but the new runtime opens up more of Helm's core behavior for plugin customization. Helm 4 launches with three plugin types: CLI plugins, getter plugins, and post-renderer plugins, plus a system that enables new plugin types for customizing additional core functionality. See [HIP-0026 plugin system](https://github.com/helm/community/blob/main/hips/hip-0026.md) and [Helm 4 example plugins](https://github.com/scottrigby/h4-example-plugins). :::tip Existing plugins work as before. The new WebAssembly runtime is optional but recommended for enhanced security. ::: #### Better resource monitoring New kstatus integration shows detailed status of your deployments. Test with complex applications to see if it catches issues better. #### Enhanced OCI Support Install charts by digest for better supply chain security. For example, `helm install myapp oci://registry.example.com/charts/app@sha256:abc123...`. Charts with non-matching digests are not installed. #### Multi-Document Values Split complex values across multiple YAML files. Perfect for testing different environment configs. #### Server-Side Apply Better conflict resolution when multiple tools manage the same resources. Test in environments with operators or other controllers. #### Custom Template Functions Extend Helm's templating with your own functions through plugins. Great for organization-specific templating needs. #### Post-Renderers as Plugins Post-renderers are implemented as plugins, providing better integration and more capabilities. #### Stable SDK API API breaking changes are now complete. Test it, break it, give us feedback! The API also enables additional chart versions, opening possibilities for new features in the upcoming Charts v3. #### Charts v3 Coming soon. v2 charts continue to work unchanged. ### Improvements #### Performance Faster dependency resolution and new content-based chart caching. #### Error Messages Clearer, more helpful error output. #### Registry Authentication Better OAuth and token support for private registries. #### CLI Flags renamed Some common CLI flags are renamed to better clarify their operation. The existing flags remain, but emit a deprecated warning: - `--atomic` → `--rollback-on-failure` - `--force` → `--force-replace` Update any automation that uses these renamed CLI flags. ## Upgrading to Helm 4 While we work hard to make Helm 4 rock-solid for everyone, Helm 4 is brand new. To that end, before upgrading, we've added some tips below for specific things to look out for when testing Helm 4 with your existing workflows. As always, we welcome all feedback about what works, what breaks, and what | https://github.com/helm/helm-www/blob/main//docs/overview.md | main | helm | [
0.019372086971998215,
0.08121636509895325,
0.057621296495199203,
-0.06672202050685883,
0.1043972447514534,
-0.004559780936688185,
-0.11751911789178848,
0.033705759793519974,
-0.023335164412856102,
0.05415298417210579,
0.021924450993537903,
0.016571618616580963,
-0.041455525904893875,
-0.04... | 0.153896 |
to make Helm 4 rock-solid for everyone, Helm 4 is brand new. To that end, before upgrading, we've added some tips below for specific things to look out for when testing Helm 4 with your existing workflows. As always, we welcome all feedback about what works, what breaks, and what could be better. ### High Priority \* Test your existing charts and releases to verify that they still work with v4. \* Test all 3 plugin types (CLI, getter, post-renderer). \* Try building WebAssembly plugins with the new runtime (see [example plugins](https://github.com/scottrigby/h4-example-plugins)) \* SDK users: test the now-stable API. Try to break it and share your feedback. \* Test your CI/CD pipelines and fix any script errors from the renamed CLI flags. \* Test your post-renderer integrations. \* Test registry authentication and chart installation in your OCI workflows. ### Other \* Test other new features, including multi-document values, digest-based installs, and custom template functions. \* Test the performance of Helm 4 with large, complex charts to see if it is noticeably faster for your workloads. \* Try breaking things intentionally to see if the updated error messages are helpful. ### Feedback \* What other plugin types would you like to see added to customize Helm core functionality? \* With the API supporting additional chart versions, what new features would you want in Charts v3? ## How to Give Feedback Find issues? Have suggestions? We want to hear from you before the November release: ### GitHub Issues Review the [list of open issues and feature requests](https://github.com/helm/helm/issues) in the Helm repo. Add comments on the existing items, or [create new](https://github.com/helm/helm/issues/new/choose) issues and requests. ### Community Slack Join [Kubernetes Slack](https://slack.kubernetes.io/) channels: - `#helm-dev` for development discussions - `#helm-users` for user support and testing feedback ### Weekly Dev Meetings Join live discussion with maintainers every Thursday 9:30am PT on [Zoom](https://zoom.us/j/696660622?pwd=MGsraXZ1UkVlTkJLc1B5U05KN053QT09). For more options, see the Helm community [communication details](https://github.com/helm/community/blob/main/communication.md). | https://github.com/helm/helm-www/blob/main//docs/overview.md | main | helm | [
0.03142576292157173,
0.05271167680621147,
0.05878844112157822,
-0.07577695697546005,
0.048774655908346176,
-0.0360865481197834,
-0.14828994870185852,
0.02238391526043415,
-0.05669451877474785,
0.0194312185049057,
-0.013586794026196003,
-0.0615546852350235,
0.015452397055923939,
-0.00774727... | -0.006504 |
# Helm 4 Full Changelog \*\*Scope\*\*: 290 PRs from (`v4.0.0-rc.1`) compared to `v3.19.0` \*\*v4-only\*\*: 257 PRs (33 backported to v3 excluded) See the [Overview](/overview.md) for an actionable summary of these changes. ## New Features New features in Helm 4 that were not backported to v3 | PR | Date | Author | Title | |---|---|---|---| | #31435 | 2025-11-03 | matheuscscp | Introduce a context for canceling wait operations | | #31389 | 2025-10-30 | TerryHowe | chore: fix pkg/registry warnings to reduce noise | | #31338 | 2025-10-21 | yzewei | Add loongarch64 support | | #31351 | 2025-10-21 | gjenkins8 | feat: `helm version` print Kubernetes (client-go) version | | #31376 | 2025-10-21 | benoittgt | Do not ignore \*.yml file on linting while accepting \*.yaml | | #31362 | 2025-10-21 | fabiocarneiro | Clarify the intent of the resource instructions | | #31392 | 2025-10-16 | TerryHowe | feature: create copilot structured context | | #31295 | 2025-10-13 | TerryHowe | Fix make helm list show all by default | | #31372 | 2025-10-10 | mattfarina | Enable Releases To Have Multiple Versions | | #31254 | 2025-09-23 | benoittgt | Warn when we fallback to a different version on `helm pull` | | #31275 | 2025-09-10 | benoittgt | Extend --skip-schema-validation for lint command | | #31116 | 2025-09-02 | banjoh | chore: check if go modules are tidy before build | | #31217 | 2025-09-01 | scottrigby | BREAKING CHANGE: [HIP-0026] Move Postrenderer to a plugin type | | #31196 | 2025-08-31 | scottrigby | BREAKING CHANGE: [HIP-0026] Remove unnecessary file i/o operations from signing and verifying | | #31176 | 2025-08-30 | scottrigby | BREAKING CHANGE: [HIP-0026] Plugin packaging, signing, and verification | | #31194 | 2025-08-28 | gjenkins8 | BREAKING CHANGE: [HIP-0026] Plugin extism/v1 runtime | | #30812 | 2025-08-27 | gjenkins8 | BREAKING CHANGE: HIP-0023: Helm support server-side apply | | #31174 | 2025-08-26 | scottrigby | BREAKING CHANGE: [HIP-0026] Plugin tarball support for HTTP and local installers | | #31172 | 2025-08-26 | scottrigby | BREAKING CHANGE: [HIP-0026] Plugin OCI installer | | #31146 | 2025-08-23 | scottrigby | BREAKING CHANGE: [HIP-0026] Plugin types and plugin apiVersion v1 | | #31145 | 2025-08-22 | scottrigby | BREAKING CHANGE: [HIP-0026] Plugin runtime interface | | #31142 | 2025-08-21 | gjenkins8 | BREAKING CHANGE: [HIP-0026] Move pkg/plugin -> internal/plugin | | #31030 | 2025-08-14 | gjenkins8 | BREAKING CHANGE: HIP-0023: Kube client support server-side apply | | #12624 | 2025-08-13 | papdaniel | show crds command output separated by document separator | | #13111 | 2025-08-13 | rawtaz | style(pkg/chartutil): add missing dots and indentation to defaultValues | | #31076 | 2025-08-11 | matheuscscp | pkg/registry: Login option for passing TLS config in memory | | #31034 | 2025-08-05 | Mazafard | Feat: Add color output functionality and tests for release statuses | | #31057 | 2025-07-18 | danilobuerger | Pass credentials when either chart repo or repo dont specify a port but it matches the default port of that scheme | | #31019 | 2025-07-17 | zachburg | Return early when linting if the `templates/` directory does not exist | | #31011 | 2025-07-17 | yalosev | feature: add labels to metadata | | #31015 | 2025-07-17 | zachburg | Add linter support for the `crds/` directory | | #13154 | 2025-07-10 | carloslima | Allow post-renderer to process hooks | | #13586 | 2025-06-04 | jessesimpson36 | feat: add formatting for errors to make multiline stacktraces in helm templates | | #30553 | 2025-05-07 | Zhanweelee | feat: Add mustToYaml and | https://github.com/helm/helm-www/blob/main//docs/changelog.md | main | helm | [
0.009220835752785206,
0.07090350240468979,
0.04099885746836662,
-0.02977793477475643,
0.09122549742460251,
0.014160492457449436,
-0.06714023649692535,
-0.016343319788575172,
0.06499473005533218,
0.06299496442079544,
0.02563561499118805,
-0.03135986998677254,
-0.023534907028079033,
-0.07940... | 0.087147 |
support for the `crds/` directory | | #13154 | 2025-07-10 | carloslima | Allow post-renderer to process hooks | | #13586 | 2025-06-04 | jessesimpson36 | feat: add formatting for errors to make multiline stacktraces in helm templates | | #30553 | 2025-05-07 | Zhanweelee | feat: Add mustToYaml and mustToJson template functions | | #30734 | 2025-04-21 | ipaqsa | feat(pkg/engine): add support for custom template funcs | | #13283 | 2025-04-14 | win-t | adding support for JSON Schema 2020 | | #30751 | 2025-04-13 | benoittgt | Add detailed debug logging for resource readiness states | | #30708 | 2025-04-11 | benoittgt | Migrate pkg to slog | | #13604 | 2025-04-05 | AustinAbro321 | Introduce kstatus watcher | | #13617 | 2025-02-27 | AustinAbro321 | BREAKING CHANGE: Refactor cmd/helm to allow library usage | | #30571 | 2025-02-24 | yardenshoham | feat: error out when post-renderer produces no output | | #13655 | 2025-02-20 | LuBingtan | feat: support multi-document values files | | #13471 | 2025-02-19 | wangjingcun | Use a more direct and less error-prone return value | | #30294 | 2025-02-19 | Zhanweelee | Supports json arguments | | #13538 | 2025-01-17 | godhanipayal | Add Contextual Error Messages to RunWithContext | | #12588 | 2024-11-22 | rynowak | Make the authorizer and registry authorizer configurable | ## Bug Fixes Fixes in Helm 4 that were not backported to v3 | PR | Date | Author | Title | |---|---|---|---| | #31323 | 2025-10-29 | mattfarina | Reproducible chart archive builds | | #31411 | 2025-10-29 | banjoh | fix: reinstate logger parameter to actions package | | #31204 | 2025-10-22 | benoittgt | Avoid panic in helm.sh/helm/v3/pkg/chartutil.ValidateAgainstSchema | | #31337 | 2025-10-22 | rachelvweber | Fixing rollback and uninstall client WaitStrategy | | #31393 | 2025-10-21 | benoittgt | Return errors during upgrade when the deletion of resources fails | | #31406 | 2025-10-21 | jessesimpson36 | fix: kube client should return empty results objects instead of nil | | #31375 | 2025-10-13 | TerryHowe | fix: release info time parsing | | #31349 | 2025-10-07 | TerryHowe | fix: flakey lint test on shuffle | | #31327 | 2025-10-07 | TerryHowe | fix: broken `--html` flag to coverage script | | #31354 | 2025-10-07 | TerryHowe | fix: flake upgrade test | | #31227 | 2025-10-03 | evankanderson | Use filepath.Path when handling directory names | | #31307 | 2025-10-02 | TerryHowe | fix: Ignore absolute path when RepoUrl is provided | | #31334 | 2025-09-30 | fleaz | Fix typo in bug-report issue template | | #31330 | 2025-09-25 | mattfarina | Restore lint rule for excluding meaningless name | | #31320 | 2025-09-25 | kosiew | provenance: allow RSA signing when ed25519 keys are present (switch to ProtonMail/go-crypto) | | #31285 | 2025-09-12 | bennsimon | fix: remove leftover debugging line that outputs invalid YAML for helm template command | | #31277 | 2025-09-11 | benoittgt | Fix deprecation warning for spf13/pflag from 1.0.7 to 1.0.10 | | #31272 | 2025-09-09 | TerryHowe | fix: idea gitignore entry | | #31252 | 2025-09-05 | kamilswiec | fix:chartfile tests - semver2 error message | | #31199 | 2025-09-05 | TerryHowe | fix: flaky registry data race on mockdns close | | #31200 | 2025-09-05 | TerryHowe | fix: installer action goroutine count | | #31222 | 2025-09-03 | benoittgt | Prevent failing `helm push` on ghcr.io using standard GET auth token flow | | #31191 | 2025-08-26 | TerryHowe | fix: send logging to stderr | | #31138 | 2025-08-19 | https://github.com/helm/helm-www/blob/main//docs/changelog.md | main | helm | [
-0.0993601605296135,
0.005702516529709101,
-0.028625687584280968,
-0.024165939539670944,
0.01107876654714346,
-0.00508950836956501,
-0.11666857451200485,
0.09078314900398254,
-0.05171620100736618,
0.03164416551589966,
-0.01562858372926712,
-0.11387711018323898,
-0.01907063089311123,
-0.006... | 0.101216 |
| #31200 | 2025-09-05 | TerryHowe | fix: installer action goroutine count | | #31222 | 2025-09-03 | benoittgt | Prevent failing `helm push` on ghcr.io using standard GET auth token flow | | #31191 | 2025-08-26 | TerryHowe | fix: send logging to stderr | | #31138 | 2025-08-19 | islewis | fix(helm-lint): Add HTTP/HTTPS URL support for json schema references | | #31152 | 2025-08-18 | TerryHowe | fix: enable shuffle in Makefile for unit tests | | #12968 | 2025-08-13 | sjeandeaux | helm uninstall dry run support `--ignore-not-found` | | #31126 | 2025-08-12 | paologallinaharbur | fix(transport): leverage same tls config | | #31109 | 2025-08-06 | carlossg | fix: prevent panic when ChartDownloader.getOciURI | | #31074 | 2025-07-18 | joejulian | add missing template directory to badcrdfile testdata | | #31042 | 2025-07-10 | TerryHowe | fix: test teardown dns data race | | #30898 | 2025-07-06 | AshmitBhardwaj | Fix issue 13198 | | #31021 | 2025-07-05 | zachburg | Update tests in create\_test.go and package\_test.go to work in a temp directory | | #31024 | 2025-07-03 | gjenkins8 | fix: 'TestRunLinterRule' stateful test | | #30900 | 2025-06-23 | unguiculus | Add timeout flag to repo add and update commands | | #30981 | 2025-06-15 | TerryHowe | fix: lint test SetEnv errors | | #30973 | 2025-06-12 | manslaughter03 | fix: wrap run release test error in case GetPodLogs failed. | | #30972 | 2025-06-10 | TerryHowe | fix: kube client create mutex | | #30958 | 2025-06-06 | TerryHowe | fix: repo update cmd mutex | | #30955 | 2025-06-04 | carloslima | Fix tests deleting XDG\_DATA\_HOME | | #30939 | 2025-06-03 | TerryHowe | fix: action hooks delete policy mutex | | #12581 | 2025-06-03 | MichaelMorrisEst | Consider full GroupVersionKind when matching resources | | #30930 | 2025-05-28 | benoittgt | Fix flaky TestFindChartURL due to non-deterministic map iteration | | #30884 | 2025-05-21 | mattfarina | Reverting fix "renders int as float" | | #30862 | 2025-05-20 | OmriSteiner | fix: correctly concat absolute URIs in repo cache | | #30864 | 2025-05-16 | jessesimpson36 | fix: remove duplicate error message | | #30842 | 2025-05-15 | ayushontop | Fix : No repository is not an error,use the helm repo list command ,if there is no repository,it should not be an error #30606 | | #30800 | 2025-04-25 | mmorel-35 | fix: dep fs errors | | #30803 | 2025-04-25 | mattfarina | Fixing windows build | | #30783 | 2025-04-23 | rpolishchuk | fix: chart icon presence test | | #30777 | 2025-04-23 | ryanhockstad | fix: null merge | | #9175 | 2025-04-23 | dastrobu | fix: copy dependencies on aliasing to avoid sharing chart references on multiply aliased dependencies | | #12382 | 2025-04-20 | edbmiller | fix(pkg/lint): unmarshals Chart.yaml strictly | | #30766 | 2025-04-17 | benoittgt | Fix main branch by defining wait strategy parameter on hooks | | #30718 | 2025-04-16 | klihub | Allow signing multiple charts with a single passphrase from stdin. | | #30752 | 2025-04-16 | benoittgt | Bump golangci lint to last major version and fix static-check errors | | #30737 | 2025-04-11 | rpolishchuk | fix: order dependent test | | #9318 | 2025-04-07 | wahabmk | Fix issue with helm pull failing if pulling from a repository that redirects to another domain | | #13119 | 2025-04-05 | idsulik | fix(concurrency): Use channel for repoFailList errors in updateCharts | | #30618 | 2025-03-04 | AustinAbro321 | Fix namespace flag not registering | | #30590 | | https://github.com/helm/helm-www/blob/main//docs/changelog.md | main | helm | [
-0.08596859872341156,
0.010301214642822742,
-0.012947366572916508,
-0.029772000387310982,
0.018313409760594368,
-0.048999737948179245,
-0.05475827306509018,
0.03692888841032982,
0.00584559328854084,
0.0008797697373665869,
0.030112531036138535,
-0.08954209089279175,
0.046637341380119324,
-0... | 0.06452 |
| Fix issue with helm pull failing if pulling from a repository that redirects to another domain | | #13119 | 2025-04-05 | idsulik | fix(concurrency): Use channel for repoFailList errors in updateCharts | | #30618 | 2025-03-04 | AustinAbro321 | Fix namespace flag not registering | | #30590 | 2025-03-01 | SantalScript | fix:add proxy support when mTLS configured | | #30572 | 2025-02-25 | yardenshoham | fix: error when more than one post-renderer is specified | | #30576 | 2025-02-23 | felipecrs | Fix flaky TestDedupeRepos | | #30562 | 2025-02-20 | robertsirc | fixing error handling from a previous PR | | #13656 | 2025-02-03 | gjenkins8 | fix: Bind repotest server to `localhost` | | #13633 | 2025-01-17 | mattfarina | Ensuring the file paths are clean prior to passing to securejoin | | #13425 | 2024-11-15 | MathieuCesbron | Fix typo "re-use" to "reuse" | ## Refactor/Cleanup Code quality improvements and modernization | PR | Date | Author | Title | |---|---|---|---| | #31440 | 2025-10-29 | mattfarina | Updating Go and golangci-lint versions | | #31408 | 2025-10-21 | AndiDog | Improve error message when plugin source cannot be determined or a non-directory is passed | | #31390 | 2025-10-21 | TerryHowe | fix: improve pkg/cmd/list test coverage | | #31365 | 2025-10-21 | reddaisyy | refactor: use reflect.TypeFor | | #31395 | 2025-10-21 | wyrapeseed | chore: fix some comment format | | #31401 | 2025-10-17 | TerryHowe | refactor: remove unused err from pkg/registry/client.go | | #31391 | 2025-10-15 | TerryHowe | chore: rename test registry | | #31302 | 2025-10-13 | TerryHowe | fix: helm verify Run signature | | #31270 | 2025-10-13 | TerryHowe | chore: registry utils clean up | | #31383 | 2025-10-13 | dirkmueller | Avoid accessing .Items on nil object | | #31379 | 2025-10-13 | TerryHowe | fix: clean up coverage script temp file | | #30980 | 2025-10-10 | gjenkins8 | cleanup: Remove/consolidate redundant kube client Interfaces | | #30712 | 2025-10-10 | gjenkins8 | cleanup: Remove extra lint/rules.Template functions | | #30833 | 2025-10-09 | gjenkins8 | refactor/cleanup: Replace action 'DryRun' string with DryRunStrategy type + deprecations | | #31326 | 2025-10-07 | TerryHowe | Update sign tests to use testify | | #31312 | 2025-10-01 | gjenkins8 | Remove unused 'Settings' from plugin schema | | #31143 | 2025-09-25 | TerryHowe | fix: remove redundant error check | | #31249 | 2025-09-25 | banjoh | chore: add additional logging to plugin installer | | #31321 | 2025-09-24 | juejinyuxitu | chore: fix some typos in comment | | #31297 | 2025-09-22 | TerryHowe | fix: hide notes in helm test command | | #31315 | 2025-09-22 | benoittgt | Remove unused golangci-lint rules that produce warning | | #31294 | 2025-09-19 | TerryHowe | Remove implicit support for helm lint current directory | | #31301 | 2025-09-19 | TerryHowe | chore: remove helm version `--client` option | | #31303 | 2025-09-18 | mattfarina | Update the action interfaces for chart apiversions | | #31198 | 2025-09-16 | TerryHowe | refactor: replace pkg/engine regular expressions with parser | | #31293 | 2025-09-16 | TerryHowe | chore: remove pkg/time which is no longer needed | | #31287 | 2025-09-16 | miledxz | improve fileutil test coverage | | #31292 | 2025-09-16 | reddaisyy | refactor: use strings.builder | | #31286 | 2025-09-12 | yajianggroup | refactor: use strings.CutPrefix | | #31258 | 2025-09-08 | StephanieHhnbrg | Refactor unreachableKubeClient for testing into failingKubeClient | | #31259 | 2025-09-07 | StephanieHhnbrg | Adapt test-coverage command to | https://github.com/helm/helm-www/blob/main//docs/changelog.md | main | helm | [
-0.08408103883266449,
-0.051363505423069,
0.006072599440813065,
0.0130650969222188,
0.018144207075238228,
-0.02713814005255699,
-0.056482668966054916,
-0.008746067062020302,
-0.0022083085495978594,
0.07387879490852356,
0.00398592371493578,
-0.0774078369140625,
0.056340258568525314,
-0.0310... | -0.038858 |
test coverage | | #31292 | 2025-09-16 | reddaisyy | refactor: use strings.builder | | #31286 | 2025-09-12 | yajianggroup | refactor: use strings.CutPrefix | | #31258 | 2025-09-08 | StephanieHhnbrg | Refactor unreachableKubeClient for testing into failingKubeClient | | #31259 | 2025-09-07 | StephanieHhnbrg | Adapt test-coverage command to be able to run for a certain package | | #31225 | 2025-09-02 | mattfarina | BREAKING CHANGE: Move lint pkg to be part of each chart version | | #31220 | 2025-09-02 | gjenkins8 | BREAKING CHANGE: refactor: utilize `pluginTypesIndex` for config unmarshalling | | #31219 | 2025-09-02 | gjenkins8 | BREAKING CHANGE: Remove 'SetupPluginEnv' | | #31216 | 2025-09-02 | mattfarina | BREAKING CHANGE: Move to versioned packages | | #31224 | 2025-09-01 | gjenkins8 | fix: Adjust PostRenderer plugin output to value | | #31218 | 2025-09-01 | gjenkins8 | BREAKING CHANGE: Remove legacy Command/Hooks from v1 Subprocess (#23) | | #31151 | 2025-08-30 | TerryHowe | fix: make file whitespace | | #31178 | 2025-08-28 | mattfarina | Add content cache to helm env | | #31165 | 2025-08-22 | mattfarina | BREAKING CHANGE: Initial addition of content based cache | | #13629 | 2025-08-22 | gjenkins8 | BREAKING CHANGE: Rename 'atomic' -> 'rollback-on-failure' | | #31175 | 2025-08-21 | cuiweixie | pkg/register: refactor to use atomic.Uint64 | | #31132 | 2025-08-19 | joemicky | refactor: replace []byte(fmt.Sprintf) with fmt.Appendf | | #31133 | 2025-08-14 | joemicky | refactor: replace HasPrefix+TrimPrefix with CutPrefix | | #31134 | 2025-08-14 | joemicky | refactor: omit unnecessary reassignment | | #11700 | 2025-08-13 | suzaku | Refactor, use sort.Slice to reduce boilerplate code | | #31058 | 2025-08-07 | farazkhawaja | Add test coverage for get\_values/metadata.go | | #31107 | 2025-08-06 | Pavanipogula | test(pkg/kube): Add unit tests to wait and roundtripper files. | | #31106 | 2025-08-05 | irikeish | test(pkg/kube): add test for Client.isReachable | | #30982 | 2025-08-05 | gjenkins8 | BREAKING CHANGE: Rename 'force' to 'force-replace' | | #31094 | 2025-08-04 | mikelolasagasti | chore(deps): remove phayes/freeport module | | #31101 | 2025-07-30 | banjoh | feat: switch yaml library to go.yaml.in/yaml/v3 | | #31081 | 2025-07-25 | mattfarina | BREAKING CHANGE: Initial addition of v3 charts | | #31079 | 2025-07-22 | gjenkins8 | cleanup: Remove plugin deprecated 'UseTunnelDeprecated' | | #31060 | 2025-07-18 | yumeiyin | refactor: replace Split in loops with more efficient SplitSeq | | #31065 | 2025-07-15 | TerryHowe | chore: improve OCI debug logging | | #31033 | 2025-07-14 | navinag1989 | test: increase test coverage for pkg/cli/options.go file | | #31029 | 2025-07-07 | gjenkins8 | chore(refactor): Privatize 'k8sYamlStruct' | | #31023 | 2025-07-03 | gjenkins8 | BREAKING CHANGE: Remove deprecated '--create-pods' flag | | #31009 | 2025-07-02 | tpresa | test: increase test coverage for pkg/pusher | | #31018 | 2025-07-01 | mattfarina | Move logging setup to be configurable | | #30909 | 2025-06-03 | jinjiadu | refactor: replace HasPrefix+TrimPrefix with CutPrefix | | #30809 | 2025-06-03 | mmorel-35 | chore: enable usetesting linter | | #30865 | 2025-05-22 | mmorel-35 | refactor: update json-patch import path and add gomodguard settings | | #30871 | 2025-05-20 | gjenkins8 | Run test OCI registry localhost | | #30866 | 2025-05-20 | mmorel-35 | chore: enable thelper linter | | #30863 | 2025-05-16 | mattfarina | Adding test for list command | | #30850 | 2025-05-12 | yetyear | refactor: use maps.Copy for cleaner map handling | | #30829 | 2025-05-09 | TerryHowe | Increase pkg/time test coverage | | #30810 | 2025-05-08 | mmorel-35 | chore: enable | https://github.com/helm/helm-www/blob/main//docs/changelog.md | main | helm | [
-0.07243969291448593,
-0.017423899844288826,
0.022793907672166824,
0.020444359630346298,
0.033747367560863495,
0.0503745973110199,
-0.04952150583267212,
0.013084452599287033,
-0.08305148780345917,
0.062023621052503586,
0.054769400507211685,
-0.06317847222089767,
-0.0033686202950775623,
-0.... | -0.057877 |
| | #30863 | 2025-05-16 | mattfarina | Adding test for list command | | #30850 | 2025-05-12 | yetyear | refactor: use maps.Copy for cleaner map handling | | #30829 | 2025-05-09 | TerryHowe | Increase pkg/time test coverage | | #30810 | 2025-05-08 | mmorel-35 | chore: enable usestdlibvars linter | | #30844 | 2025-05-08 | TerryHowe | fix: rename slave replica | | #30827 | 2025-05-06 | findnature | refactor: use slices.Contains to simplify code | | #13460 | 2025-04-23 | justenstall | fix: replace "github.com/pkg/errors" with stdlib "errors" package | | #30788 | 2025-04-23 | stephenpmurray | ref(helm): Export Chart Not Found error | | #30781 | 2025-04-22 | mmorel-35 | chore: remove `github.com/hashicorp/go-multierror` dependency | | #13578 | 2025-04-18 | gjenkins8 | refactor: Remove ChartRepository `[]ChartPaths` | | #30760 | 2025-04-16 | robertsirc | adding slog debug to a few points | | #30713 | 2025-04-11 | gjenkins8 | cleanup: Remove Helm v2 template lint rules | | #30749 | 2025-04-11 | mattfarina | BREAKING CHANGE: Removing the alpine test chart | | #30686 | 2025-04-11 | mattfarina | BREAKING CHANGE: Remove deprecated code | | #30736 | 2025-04-09 | robertsirc | manually updating go.mod file | | #13458 | 2025-04-05 | thudi | BREAKING CHANGE: #13449 Resolves: Replacing NewSimpleClientSet to NewClientSet due to deprecation | | #30684 | 2025-03-21 | twz123 | Remove ClientOptResolver from OCI Client | | #30603 | 2025-03-21 | robertsirc | converting inline log to slog | | #30699 | 2025-03-21 | mattfarina | Error when failed repo update. | | #30592 | 2025-02-28 | robertsirc | changing from log to slog | | #30589 | 2025-02-26 | mattfarina | BREAKING CHANGE: Move pkg/release to pkg/release/v1 to support v3 charts | | #30586 | 2025-02-25 | mattfarina | BREAKING CHANGE: Move pkg/chart to pkg/chart/v2 to prepare for v3 charts | | #30585 | 2025-02-25 | robertsirc | removing old apis | | #30580 | 2025-02-24 | mattfarina | BREAKING CHANGE: Move pkg/releaseutil to pkg/release/util | | #11112 | 2025-02-22 | felipecrs | perf(dep-up): do not update the same repo multiple times | | #30567 | 2025-02-21 | mattfarina | BREAKING CHANGE: Moving chartutil to chart/util | | #30566 | 2025-02-21 | robertsirc | remove unused config.go | | #30470 | 2025-02-19 | gjenkins8 | Cleanup `repotest.Server` constructors | | #30550 | 2025-02-19 | mattfarina | Moving to SetOut and SetErr for Cobra | | #30546 | 2025-02-19 | hugehope | refactor: using slices.Contains to simplify the code | | #13535 | 2025-02-05 | gjenkins8 | refactor: tlsutil use options pattern | | #13665 | 2025-02-05 | gjenkins8 | chore: Remove unused `WaitAndGetCompletedPodPhase` | | #13579 | 2025-02-05 | gjenkins8 | refactor: Remove duplicate `FindChartIn\*RepoURL` functions | | #13516 | 2025-01-24 | TerryHowe | chore: fix problems with latest lint | | #13494 | 2025-01-18 | gjenkins8 | BREAKING CHANGE: Remove deprecated `repo add --no-update` flag | | #13602 | 2025-01-17 | crystalstall | refactor: using slices.Contains to simplify the code | | #13600 | 2025-01-14 | gjenkins8 | cleanup: `NewShowWithConfig` -> `NewShow` | | #13601 | 2025-01-09 | gjenkins8 | cleanup: Remove superseded 'lint/rules.Values' function | | #13611 | 2025-01-07 | mattfarina | BREAKING CHANGE: Updating the internal version to v4 | | #13576 | 2025-01-07 | gjenkins8 | refactor: Consolidate lint package Run() functions | | #13577 | 2025-01-07 | gjenkins8 | refactor: Remove redundant `NewPullWithOpts` | | #13599 | 2025-01-07 | gjenkins8 | cleanup: `ProcessDependenciesWithMerge` -> `ProcessDependencies` | | #13573 | 2024-12-27 | mattfarina | BREAKING CHANGE: Updating to helm.sh/helm/v4 | | #13444 | 2024-12-07 | justenstall | | https://github.com/helm/helm-www/blob/main//docs/changelog.md | main | helm | [
-0.07433319836854935,
0.037147458642721176,
0.004497180692851543,
-0.027884740382432938,
0.08510958403348923,
0.021323053166270256,
-0.07881386578083038,
0.045715074986219406,
-0.03218434378504753,
0.09759856760501862,
0.06226164847612381,
-0.07851655036211014,
0.010442008264362812,
-0.057... | 0.02981 |
Consolidate lint package Run() functions | | #13577 | 2025-01-07 | gjenkins8 | refactor: Remove redundant `NewPullWithOpts` | | #13599 | 2025-01-07 | gjenkins8 | cleanup: `ProcessDependenciesWithMerge` -> `ProcessDependencies` | | #13573 | 2024-12-27 | mattfarina | BREAKING CHANGE: Updating to helm.sh/helm/v4 | | #13444 | 2024-12-07 | justenstall | refactor(status): remove --show-desc and --show-resources flags | ## Other Infrastructure and project management improvements | PR | Date | Author | Title | |---|---|---|---| | #31197 | 2025-09-03 | tzchenxixi | chore: fix function name | | #31150 | 2025-08-18 | TerryHowe | Feature add stale pr workflow | | #31149 | 2025-08-18 | TerryHowe | fix: stale issue workflow | | #31077 | 2025-07-21 | gaspergrom | fix: LFX health score badge link | | #31047 | 2025-07-10 | jingchanglu | chore: fix typo in pkg/repo/chartrepo.go | | #31004 | 2025-06-26 | andreped | fix(docs): Typofix in README | | #31002 | 2025-06-26 | curlwget | chore: fix function in comment | | #30912 | 2025-06-17 | Bhargavkonidena | Fix #30893 - issue templates | | #30957 | 2025-06-04 | acceptacross | chore: fix some function names in comment | | #30914 | 2025-05-27 | benoittgt | Fix dependabot upgrade of jsonschema to v6.0.2 | | #30904 | 2025-05-23 | benoittgt | [Doc] Help users avoid specifying URL scheme and path with `helm registry` | | #30882 | 2025-05-20 | caniszczyk | Add new LFX Insights Health Score Badge | | #30872 | 2025-05-20 | benoittgt | Bump golangci-lint version to match last golangci-lint-action | | #30824 | 2025-05-05 | adharsh277 | Fix bug in .golangci.yml configuration | | #30786 | 2025-04-25 | mmorel-35 | refactor: reorganize .golangci.yml for better clarity and structure | | #30785 | 2025-04-23 | mmorel-35 | fix: govulncheck workflow | | #30784 | 2025-04-22 | scottrigby | chore(OWNERS): Add TerryHowe as Triage Maintainer | | #30773 | 2025-04-18 | wangcundashang | chore: fix function name in comment | | #30754 | 2025-04-16 | mattfarina | Simplify the JSON Schema checking | | #30693 | 2025-03-20 | linghuying | chore: make function comment match function name | | #30665 | 2025-03-13 | mattfarina | Updating to 0.37.0 for x/net | | #30611 | 2025-03-04 | gjenkins8 | chore: Remove 'coveralls' | | #30612 | 2025-03-04 | gjenkins8 | fix: Fix go report card badge reference/link | | #30508 | 2025-02-19 | eimhin-rover | Update version option description with more accurate info | | #30497 | 2025-02-12 | robertsirc | adding-my-key | | #30295 | 2025-02-07 | edithturn | Add Percona to the list of organizations using Helm | | #13653 | 2025-01-23 | petercover | chore: fix some comments | | #13625 | 2025-01-13 | shahbazaamir | ading info to install helm , referring the documentation | | #13563 | 2024-12-21 | gjenkins8 | Run `build-test` action on `dev-v3` branch | | #13552 | 2024-12-20 | gjenkins8 | Fix `dependabot.yml` `target-branch` typo | | #13529 | 2024-12-15 | godhanipayal | Adding Oracle to the adopters list | | #13509 | 2024-12-06 | gjenkins8 | Dependabot update `dev-v3` branch go modules | | #13212 | 2024-12-01 | mbianchidev | Update ADOPTERS.md | | #13465 | 2024-11-20 | banjoh | Add precommit config to .gitignore | | #13443 | 2024-11-15 | mattfarina | Updating docs around v3 and v4 | ## v4 Changes Also Backported to v3 These PRs were included in v4 but were also backported to v3 releases ### New Features (Backported) | PR | Date | Author | Title | |---|---|---|---| | #30696 | 2025-03-24 | benoittgt | Inform about time spent waiting resources | https://github.com/helm/helm-www/blob/main//docs/changelog.md | main | helm | [
-0.042093828320503235,
0.007195263635367155,
0.04444272443652153,
-0.040414486080408096,
0.0858483761548996,
0.0015079666627570987,
-0.02404743805527687,
0.03309573978185654,
0.008577574975788593,
0.08281072229146957,
0.04989807680249214,
0.016752637922763824,
-0.022825652733445168,
-0.084... | -0.002732 |
and v4 | ## v4 Changes Also Backported to v3 These PRs were included in v4 but were also backported to v3 releases ### New Features (Backported) | PR | Date | Author | Title | |---|---|---|---| | #30696 | 2025-03-24 | benoittgt | Inform about time spent waiting resources to be ready in slog format | | #12912 | 2025-03-11 | hegerdes | feat: add httproute from gateway-api to create chart template | | #10309 | 2025-02-21 | Bez625 | Add hook annotation to output hook logs to client on error | | #13481 | 2025-02-18 | banjoh | feat: Enable CPU and memory profiling | | #12690 | 2025-01-01 | TerryHowe | feat: OCI install by digest | | #13232 | 2024-12-20 | dnskr | ref(create): don't render empty resource fields | | #12962 | 2024-12-04 | stevehipwell | feat: Added multi-platform plugin hook support | | #13343 | 2024-11-19 | niladrih | Add annotations and dependencies to get metadata output | ### Bug Fixes (Backported) | PR | Date | Author | Title | |---|---|---|---| | #31064 | 2025-09-05 | kamilswiec | lint: throw warning when chart version is not semverv2 | | #31156 | 2025-08-22 | estroz | fix: set repo authorizer in registry.Client.Resolve() | | #30992 | 2025-08-18 | TerryHowe | fix: force bearer oauth for if registry requests bearer auth | | #31115 | 2025-08-18 | banjoh | fix: use username and password if provided | | #30891 | 2025-08-13 | gjenkins8 | fix: Port pluginCommand & command warning | | #31050 | 2025-08-08 | heyLu | Fix `helm pull` untar dir check with repo urls | | #31078 | 2025-07-24 | 8tomat8 | fix: k8s version parsing to match original | | #30979 | 2025-06-17 | TerryHowe | fix: OAuth username password login for v4 | | #30917 | 2025-06-01 | TerryHowe | fix: add debug logging to oci transport | | #30937 | 2025-05-30 | TerryHowe | fix: legacy docker support broken for login | | #30928 | 2025-05-28 | TerryHowe | fix: plugin installer test with no Internet | | #30905 | 2025-05-23 | robertsirc | forward porting 30902 | | #30894 | 2025-05-23 | benoittgt | Prevent push cmd failure in 3.18 by handling version tag resolution in ORAS memory store | | #30697 | 2025-04-17 | p-se | Fix --take-ownership for custom resources - closes #30622 | | #30673 | 2025-04-16 | nvanthao | fix: Process all hook deletions on failure | | #30701 | 2025-04-11 | zanuka | updates mutate and validate web hook configs | | #13583 | 2025-01-15 | jiashengz | fix: check group for resource info match | ### Refactor/Cleanup (Backported) | PR | Date | Author | Title | |---|---|---|---| | #30677 | 2025-04-18 | dongjiang1989 | chore: Update Golang to v1.24 | | #30741 | 2025-04-11 | benoittgt | Bumps github.com/distribution/distribution/v3 from 3.0.0-rc.3 to 3.0.0 | | #13382 | 2025-02-03 | TerryHowe | chore(oci): migrate to ORAS Golang library v2 | | #13546 | 2024-12-19 | mattfarina | Update to Go 1.23 | | #13499 | 2024-12-06 | gjenkins8 | Shadow ORAS remote.Client interface | ### Other (Backported) | PR | Date | Author | Title | |---|---|---|---| | #30775 | 2025-04-19 | benoittgt | Bump toml | | #13533 | 2025-01-24 | althmoha | fix: (toToml) renders int as float | | #13581 | 2024-12-31 | ldlb9527 | Upgrade golang.org/x/net to v0.33.0 to address CVE-2024-45338 | | https://github.com/helm/helm-www/blob/main//docs/changelog.md | main | helm | [
-0.0062639969401061535,
-0.01778426766395569,
-0.058311931788921356,
0.008055517449975014,
0.03702830895781517,
0.020736664533615112,
-0.1263660043478012,
0.03826059401035309,
-0.022356407716870308,
0.024766288697719574,
0.02939051017165184,
0.012785423547029495,
-0.03522179275751114,
-0.0... | 0.069119 |
althmoha | fix: (toToml) renders int as float | | #13581 | 2024-12-31 | ldlb9527 | Upgrade golang.org/x/net to v0.33.0 to address CVE-2024-45338 | | https://github.com/helm/helm-www/blob/main//docs/changelog.md | main | helm | [
-0.026292625814676285,
0.018337013199925423,
-0.03455234318971634,
-0.03726048767566681,
0.007471786346286535,
-0.000019749008060898632,
-0.006650161929428577,
0.0433168038725853,
-0.06354281306266785,
0.0025960891507565975,
0.06603431701660156,
-0.16661715507507324,
-0.06265264004468918,
... | 0.026906 |
This guide covers how you can quickly get started using Helm. ## Prerequisites The following prerequisites are required for a successful and properly secured use of Helm. 1. A Kubernetes cluster 2. Deciding what security configurations to apply to your installation, if any 3. Installing and configuring Helm. ### Install Kubernetes or have access to a cluster - You must have Kubernetes installed. For the latest release of Helm, we recommend the latest stable release of Kubernetes, which in most cases is the second-latest minor release. - You should also have a local configured copy of `kubectl`. See the [Helm Version Support Policy](https://helm.sh/docs/topics/version\_skew/) for the maximum version skew supported between Helm and Kubernetes. ## Install Helm Download a binary release of the Helm client. You can use tools like `homebrew`, or look at [the official releases page](https://github.com/helm/helm/releases). For more details, or for other options, see [the installation guide](/intro/install.mdx). ## Initialize a Helm Chart Repository Once you have Helm ready, you can add a chart repository. Check [Artifact Hub](https://artifacthub.io/packages/search?kind=0) for available Helm chart repositories. ```console $ helm repo add bitnami https://charts.bitnami.com/bitnami ``` Once this is installed, you will be able to list the charts you can install: ```console $ helm search repo bitnami NAME CHART VERSION APP VERSION DESCRIPTION bitnami/bitnami-common 0.0.9 0.0.9 DEPRECATED Chart with custom templates used in ... bitnami/airflow 8.0.2 2.0.0 Apache Airflow is a platform to programmaticall... bitnami/apache 8.2.3 2.4.46 Chart for Apache HTTP Server bitnami/aspnet-core 1.2.3 3.1.9 ASP.NET Core is an open-source framework create... # ... and many more ``` ## Install an Example Chart To install a chart, you can run the `helm install` command. Helm has several ways to find and install a chart, but the easiest is to use the `bitnami` charts. ```console $ helm repo update # Make sure we get the latest list of charts $ helm install bitnami/mysql --generate-name NAME: mysql-1612624192 LAST DEPLOYED: Sat Feb 6 16:09:56 2021 NAMESPACE: default STATUS: deployed REVISION: 1 TEST SUITE: None NOTES: ... ``` In the example above, the `bitnami/mysql` chart was released, and the name of our new release is `mysql-1612624192`. You get a simple idea of the features of this MySQL chart by running `helm show chart bitnami/mysql`. Or you could run `helm show all bitnami/mysql` to get all information about the chart. Whenever you install a chart, a new release is created. So one chart can be installed multiple times into the same cluster. And each can be independently managed and upgraded. The `helm install` command is a very powerful command with many capabilities. To learn more about it, check out the [Using Helm Guide](/intro/using\_helm.mdx) ## Learn About Releases It's easy to see what has been released using Helm: ```console $ helm list NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION mysql-1612624192 default 1 2021-02-06 16:09:56.283059 +0100 CET deployed mysql-8.3.0 8.0.23 ``` The `helm list` (or `helm ls`) function will show you a list of all deployed releases. ## Uninstall a Release To uninstall a release, use the `helm uninstall` command: ```console $ helm uninstall mysql-1612624192 release "mysql-1612624192" uninstalled ``` This will uninstall `mysql-1612624192` from Kubernetes, which will remove all resources associated with the release as well as the release history. If the flag `--keep-history` is provided, release history will be kept. You will be able to request information about that release: ```console $ helm status mysql-1612624192 Status: UNINSTALLED ... ``` Because Helm tracks your releases even after you've uninstalled them, you can audit a cluster's history, and even undelete a release (with `helm rollback`). ## Reading the Help Text To learn more about the available Helm commands, use `helm help` or | https://github.com/helm/helm-www/blob/main//docs/intro/quickstart.md | main | helm | [
0.045351799577474594,
0.03391338139772415,
0.05031687021255493,
-0.08876898884773254,
0.021194959059357643,
0.051013313233852386,
-0.0865422934293747,
0.040229640901088715,
0.031569961458444595,
0.06149730458855629,
-0.02268981747329235,
-0.05315621942281723,
0.00373472785577178,
-0.048478... | 0.039642 |
```console $ helm status mysql-1612624192 Status: UNINSTALLED ... ``` Because Helm tracks your releases even after you've uninstalled them, you can audit a cluster's history, and even undelete a release (with `helm rollback`). ## Reading the Help Text To learn more about the available Helm commands, use `helm help` or type a command followed by the `-h` flag: ```console $ helm get -h ``` | https://github.com/helm/helm-www/blob/main//docs/intro/quickstart.md | main | helm | [
0.06247452273964882,
0.04346255213022232,
-0.0012779366225004196,
0.008639438077807426,
0.09475498646497726,
0.005065880715847015,
0.007976476103067398,
-0.0339282862842083,
0.03582269325852394,
0.044717442244291306,
0.056640513241291046,
0.024307237938046455,
0.02972855418920517,
-0.00751... | 0.042308 |
This part of the Best Practices Guide focuses on templates. ## Structure of `templates/` The `templates/` directory should be structured as follows: - Template files should have the extension `.yaml` if they produce YAML output. The extension `.tpl` may be used for template files that produce no formatted content. - Template file names should use dashed notation (`my-example-configmap.yaml`), not camelcase. - Each resource definition should be in its own template file. - Template file names should reflect the resource kind in the name. e.g. `foo-pod.yaml`, `bar-svc.yaml` ## Names of Defined Templates Defined templates (templates created inside a `{{ define }} ` directive) are globally accessible. That means that a chart and all of its subcharts will have access to all of the templates created with `{{ define }}`. For that reason, \_all defined template names should be namespaced.\_ Correct: ```yaml {{- define "nginx.fullname" }} {{/\* ... \*/}} {{ end -}} ``` Incorrect: ```yaml {{- define "fullname" -}} {{/\* ... \*/}} {{ end -}} ``` It is highly recommended that new charts are created via `helm create` command as the template names are automatically defined as per this best practice. ## Formatting Templates Templates should be indented using \_two spaces\_ (never tabs). Template directives should have whitespace after the opening braces and before the closing braces: Correct: ``` {{ .foo }} {{ print "foo" }} {{- print "bar" -}} ``` Incorrect: ``` {{.foo}} {{print "foo"}} {{-print "bar"-}} ``` Templates should chomp whitespace where possible: ```yaml foo: {{- range .Values.items }} {{ . }} {{ end -}} ``` Blocks (such as control structures) may be indented to indicate flow of the template code. ``` {{ if $foo -}} {{- with .Bar }}Hello{{ end -}} {{- end -}} ``` However, since YAML is a whitespace-oriented language, it is often not possible for code indentation to follow that convention. ## Whitespace in Generated Templates It is preferable to keep the amount of whitespace in generated templates to a minimum. In particular, numerous blank lines should not appear adjacent to each other. But occasional empty lines (particularly between logical sections) is fine. This is best: ```yaml apiVersion: batch/v1 kind: Job metadata: name: example labels: first: first second: second ``` This is okay: ```yaml apiVersion: batch/v1 kind: Job metadata: name: example labels: first: first second: second ``` But this should be avoided: ```yaml apiVersion: batch/v1 kind: Job metadata: name: example labels: first: first second: second ``` ## Comments (YAML Comments vs. Template Comments) Both YAML and Helm Templates have comment markers. YAML comments: ```yaml # This is a comment type: sprocket ``` Template Comments: ```yaml {{- /\* This is a comment. \*/}} type: frobnitz ``` Template comments should be used when documenting features of a template, such as explaining a defined template: ```yaml {{- /\* mychart.shortname provides a 6 char truncated version of the release name. \*/}} {{ define "mychart.shortname" -}} {{ .Release.Name | trunc 6 }} {{- end -}} ``` Inside of templates, YAML comments may be used when it is useful for Helm users to (possibly) see the comments during debugging. ```yaml # This may cause problems if the value is more than 100Gi memory: {{ .Values.maxMem | quote }} ``` The comment above is visible when the user runs `helm install --debug`, while comments specified in `{{- /\* \*/}}` sections are not. Beware of adding `#` YAML comments on template sections containing Helm values that may be required by certain template functions. For example, if `required` function is introduced to the above example, and `maxMem` is unset, then a `#` YAML comment will introduce a rendering error. Correct: `helm template` does not render | https://github.com/helm/helm-www/blob/main//docs/chart_best_practices/templates.md | main | helm | [
-0.043443463742733,
0.04709970951080322,
0.029723888263106346,
-0.016898300498723984,
0.0320332832634449,
-0.0030337017960846424,
-0.013887596316635609,
0.03001413866877556,
0.007720820140093565,
0.021329281851649284,
0.022752288728952408,
0.0005042118136771023,
-0.022744031623005867,
0.03... | 0.027461 |
of adding `#` YAML comments on template sections containing Helm values that may be required by certain template functions. For example, if `required` function is introduced to the above example, and `maxMem` is unset, then a `#` YAML comment will introduce a rendering error. Correct: `helm template` does not render this block ```yaml {{- /\* # This may cause problems if the value is more than 100Gi memory: {{ required "maxMem must be set" .Values.maxMem | quote }} \*/ -}} ``` Incorrect: `helm template` returns `Error: execution error at (templates/test.yaml:2:13): maxMem must be set` ```yaml # This may cause problems if the value is more than 100Gi # memory: {{ required .Values.maxMem "maxMem must be set" | quote }} ``` Review [Debugging Templates](/chart\_template\_guide/debugging.md) for another example of this behavior of how YAML comments are left intact. ## Use of JSON in Templates and Template Output YAML is a superset of JSON. In some cases, using a JSON syntax can be more readable than other YAML representations. For example, this YAML is closer to the normal YAML method of expressing lists: ```yaml arguments: - "--dirname" - "/foo" ``` But it is easier to read when collapsed into a JSON list style: ```yaml arguments: ["--dirname", "/foo"] ``` Using JSON for increased legibility is good. However, JSON syntax should not be used for representing more complex constructs. When dealing with pure JSON embedded inside of YAML (such as init container configuration), it is of course appropriate to use the JSON format. | https://github.com/helm/helm-www/blob/main//docs/chart_best_practices/templates.md | main | helm | [
-0.04389666020870209,
0.0510038398206234,
0.06676016747951508,
0.03842337056994438,
0.05273282900452614,
-0.01800748147070408,
-0.04514498636126518,
0.02909691631793976,
0.024761969223618507,
0.01442645862698555,
-0.0016856846632435918,
0.0022176357451826334,
0.025704793632030487,
-0.00571... | 0.005755 |
This part of the Best Practices Guide explains general conventions. ## Chart Names Chart names must be lower case letters and numbers. Words \_may\_ be separated with dashes (-): Examples: ``` drupal nginx-lego aws-cluster-autoscaler ``` Neither uppercase letters nor underscores can be used in chart names. Dots should not be used in chart names. ## Version Numbers Wherever possible, Helm uses [SemVer 2](https://semver.org) to represent version numbers. (Note that Docker image tags do not necessarily follow SemVer, and are thus considered an unfortunate exception to the rule.) When SemVer versions are stored in Kubernetes labels, we conventionally alter the `+` character to an `\_` character, as labels do not allow the `+` sign as a value. ## Formatting YAML YAML files should be indented using \_two spaces\_ (and never tabs). ## Usage of the Words Helm and Chart There are a few conventions for using the words \_Helm\_ and \_helm\_. - \_Helm\_ refers to the project as a whole - `helm` refers to the client-side command - The term `chart` does not need to be capitalized, as it is not a proper noun - However, `Chart.yaml` does need to be capitalized because the file name is case sensitive When in doubt, use \_Helm\_ (with an uppercase 'H'). | https://github.com/helm/helm-www/blob/main//docs/chart_best_practices/conventions.md | main | helm | [
0.0030759861692786217,
0.04583313316106796,
0.08004043251276016,
-0.050323840230703354,
0.02709709107875824,
-0.0024644958321005106,
-0.025636231526732445,
0.0028696225490421057,
0.0609087236225605,
0.01818469539284706,
0.03192353621125221,
-0.04547524079680443,
0.010038322769105434,
-0.03... | 0.067902 |
This section of the Best Practices Guide deals with creating and using Custom Resource Definition objects. When working with Custom Resource Definitions (CRDs), it is important to distinguish two different pieces: - There is a declaration of a CRD. This is the YAML file that has the kind `CustomResourceDefinition` - Then there are resources that \_use\_ the CRD. Say a CRD defines `foo.example.com/v1`. Any resource that has `apiVersion: example.com/v1` and kind `Foo` is a resource that uses the CRD. ## Install a CRD Declaration Before Using the Resource Helm is optimized to load as many resources into Kubernetes as fast as possible. By design, Kubernetes can take an entire set of manifests and bring them all online (this is called the reconciliation loop). But there's a difference with CRDs. For a CRD, the declaration must be registered before any resources of that CRDs kind(s) can be used. And the registration process sometimes takes a few seconds. ### Method 1: Let `helm` Do It For You With the arrival of Helm 3, we removed the old `crd-install` hooks for a more simple methodology. There is now a special directory called `crds` that you can create in your chart to hold your CRDs. These CRDs are not templated, but will be installed by default when running a `helm install` for the chart. If the CRD already exists, it will be skipped with a warning. If you wish to skip the CRD installation step, you can pass the `--skip-crds` flag. #### Some caveats (and explanations) There is no support at this time for upgrading or deleting CRDs using Helm. This was an explicit decision after much community discussion due to the danger for unintentional data loss. Furthermore, there is currently no community consensus around how to handle CRDs and their lifecycle. As this evolves, Helm will add support for those use cases. The `--dry-run` flag of `helm install` and `helm upgrade` is not currently supported for CRDs. The purpose of "Dry Run" is to validate that the output of the chart will actually work if sent to the server. But CRDs are a modification of the server's behavior. Helm cannot install the CRD on a dry run, so the discovery client will not know about that Custom Resource (CR), and validation will fail. You can alternatively move the CRDs to their own chart or use `helm template` instead. Another important point to consider in the discussion around CRD support is how the rendering of templates is handled. One of the distinct disadvantages of the `crd-install` method used in Helm 2 was the inability to properly validate charts due to changing API availability (a CRD is actually adding another available API to your Kubernetes cluster). If a chart installed a CRD, `helm` no longer had a valid set of API versions to work against. This is also the reason behind removing templating support from CRDs. With the new `crds` method of CRD installation, we now ensure that `helm` has completely valid information about the current state of the cluster. ### Method 2: Separate Charts Another way to do this is to put the CRD definition in one chart, and then put any resources that use that CRD in \_another\_ chart. In this method, each chart must be installed separately. However, this workflow may be more useful for cluster operators who have admin access to a cluster | https://github.com/helm/helm-www/blob/main//docs/chart_best_practices/custom_resource_definitions.md | main | helm | [
-0.037634268403053284,
0.02736932598054409,
0.054796747863292694,
-0.04218379035592079,
-0.00429950375109911,
0.002433347748592496,
-0.015916230157017708,
-0.006464766804128885,
0.14543980360031128,
0.01862075738608837,
-0.011587701737880707,
-0.03743840754032135,
0.011649778112769127,
-0.... | 0.075779 |
more useful for cluster operators who have admin access to a cluster | https://github.com/helm/helm-www/blob/main//docs/chart_best_practices/custom_resource_definitions.md | main | helm | [
0.0018718722276389599,
-0.0009257983765564859,
-0.03403153270483017,
0.015071477741003036,
-0.04764113202691078,
-0.023851415142416954,
0.05893728882074356,
-0.04227073863148689,
-0.056776516139507294,
0.013863813132047653,
-0.002984630176797509,
-0.01998363994061947,
-0.004236212931573391,
... | 0.204227 |
This part of the Best Practices Guide discusses formatting the Pod and PodTemplate portions in chart manifests. The following (non-exhaustive) list of resources use PodTemplates: - Deployment - ReplicationController - ReplicaSet - DaemonSet - StatefulSet ## Images A container image should use a fixed tag or the SHA of the image. It should not use the tags `latest`, `head`, `canary`, or other tags that are designed to be "floating". Images \_may\_ be defined in the `values.yaml` file to make it easy to swap out images. ```yaml image: {{ .Values.redisImage | quote }} ``` An image and a tag \_may\_ be defined in `values.yaml` as two separate fields: ```yaml image: "{{ .Values.redisImage }}:{{ .Values.redisTag }}" ``` ## ImagePullPolicy `helm create` sets the `imagePullPolicy` to `IfNotPresent` by default by doing the following in your `deployment.yaml`: ```yaml imagePullPolicy: {{ .Values.image.pullPolicy }} ``` And `values.yaml`: ```yaml image: pullPolicy: IfNotPresent ``` Similarly, Kubernetes defaults the `imagePullPolicy` to `IfNotPresent` if it is not defined at all. If you want a value other than `IfNotPresent`, simply update the value in `values.yaml` to your desired value. ## PodTemplates Should Declare Selectors All PodTemplate sections should specify a selector. For example: ```yaml selector: matchLabels: app.kubernetes.io/name: MyName template: metadata: labels: app.kubernetes.io/name: MyName ``` This is a good practice because it makes the relationship between the set and the pod. But this is even more important for sets like Deployment. Without this, the \_entire\_ set of labels is used to select matching pods, and this will break if you use labels that change, like version or release date. | https://github.com/helm/helm-www/blob/main//docs/chart_best_practices/pods.md | main | helm | [
0.02379487082362175,
0.03863820433616638,
0.04008729010820389,
0.0052765002474188805,
0.036688726395368576,
0.0052325730212032795,
-0.011282828636467457,
0.027842268347740173,
0.03143814578652382,
0.04754345864057541,
0.021024204790592194,
-0.007918079383671284,
-0.007018555421382189,
-0.0... | 0.049006 |
This part of the best practices guide covers using values. In this part of the guide, we provide recommendations on how you should structure and use your values, with focus on designing a chart's `values.yaml` file. ## Naming Conventions Variable names should begin with a lowercase letter, and words should be separated with camelcase: Correct: ```yaml chicken: true chickenNoodleSoup: true ``` Incorrect: ```yaml Chicken: true # initial caps may conflict with built-ins chicken-noodle-soup: true # do not use hyphens in the name ``` Note that all of Helm's built-in variables begin with an uppercase letter to easily distinguish them from user-defined values: `.Release.Name`, `.Capabilities.KubeVersion`. ## Flat or Nested Values YAML is a flexible format, and values may be nested deeply or flattened. Nested: ```yaml server: name: nginx port: 80 ``` Flat: ```yaml serverName: nginx serverPort: 80 ``` In most cases, flat should be favored over nested. The reason for this is that it is simpler for template developers and users. For optimal safety, a nested value must be checked at every level: ``` {{ if .Values.server }} {{ default "none" .Values.server.name }} {{ end }} ``` For every layer of nesting, an existence check must be done. But for flat configuration, such checks can be skipped, making the template easier to read and use. ``` {{ default "none" .Values.serverName }} ``` When there are a large number of related variables, and at least one of them is non-optional, nested values may be used to improve readability. ## Make Types Clear YAML's type coercion rules are sometimes counterintuitive. For example, `foo: false` is not the same as `foo: "false"`. Large integers like `foo: 12345678` will get converted to scientific notation in some cases. The easiest way to avoid type conversion errors is to be explicit about strings, and implicit about everything else. Or, in short, \_quote all strings\_. Often, to avoid the integer casting issues, it is advantageous to store your integers as strings as well, and use `{{ int $value }}` in the template to convert from a string back to an integer. In most cases, explicit type tags are respected, so `foo: !!string 1234` should treat `1234` as a string. \_However\_, the YAML parser consumes tags, so the type data is lost after one parse. ## Consider How Users Will Use Your Values There are three potential sources of values: - A chart's `values.yaml` file - A values file supplied by `helm install -f` or `helm upgrade -f` - The values passed to a `--set` or `--set-string` flag on `helm install` or `helm upgrade` When designing the structure of your values, keep in mind that users of your chart may want to override them via either the `-f` flag or with the `--set` option. Since `--set` is more limited in expressiveness, the first guidelines for writing your `values.yaml` file is \_make it easy to override from `--set`\_. For this reason, it's often better to structure your values file using maps. Difficult to use with `--set`: ```yaml servers: - name: foo port: 80 - name: bar port: 81 ``` The above cannot be expressed with `--set` in Helm `<=2.4`. In Helm 2.5, accessing the port on foo is `--set servers[0].port=80`. Not only is it harder for the user to figure out, but it is prone to errors if at some later time the order of the `servers` is changed. Easy to use: ```yaml servers: foo: port: 80 bar: port: 81 ``` Accessing foo's port is much more obvious: `--set servers.foo.port=80`. ## Document `values.yaml` Every defined property in `values.yaml` should be documented. The documentation string should begin with the name of | https://github.com/helm/helm-www/blob/main//docs/chart_best_practices/values.md | main | helm | [
0.009218594990670681,
0.05258296802639961,
0.03384982421994209,
-0.05580974370241165,
0.0029610558412969112,
0.0027133242692798376,
-0.029305171221494675,
0.026228532195091248,
0.05198309198021889,
0.024718645960092545,
0.012636667117476463,
-0.04078206047415733,
0.01453839149326086,
-0.03... | 0.011975 |
later time the order of the `servers` is changed. Easy to use: ```yaml servers: foo: port: 80 bar: port: 81 ``` Accessing foo's port is much more obvious: `--set servers.foo.port=80`. ## Document `values.yaml` Every defined property in `values.yaml` should be documented. The documentation string should begin with the name of the property that it describes, and then give at least a one-sentence description. Incorrect: ```yaml # the host name for the webserver serverHost: example serverPort: 9191 ``` Correct: ```yaml # serverHost is the host name for the webserver serverHost: example # serverPort is the HTTP listener port for the webserver serverPort: 9191 ``` Beginning each comment with the name of the parameter it documents makes it easy to grep out documentation, and will enable documentation tools to reliably correlate doc strings with the parameters they describe. | https://github.com/helm/helm-www/blob/main//docs/chart_best_practices/values.md | main | helm | [
-0.012953406199812889,
0.00608457624912262,
0.013330100104212761,
-0.02001481130719185,
-0.06142733618617058,
-0.08654078841209412,
-0.005371674429625273,
-0.026457656174898148,
0.020371098071336746,
0.024869924411177635,
0.013541112653911114,
0.023076627403497696,
0.02458888292312622,
-0.... | 0.057534 |
This part of the Best Practices Guide discusses the best practices for using labels and annotations in your chart. ## Is it a Label or an Annotation? An item of metadata should be a label under the following conditions: - It is used by Kubernetes to identify this resource - It is useful to expose to operators for the purpose of querying the system. For example, we suggest using `helm.sh/chart: NAME-VERSION` as a label so that operators can conveniently find all of the instances of a particular chart to use. If an item of metadata is not used for querying, it should be set as an annotation instead. Helm hooks are always annotations. ## Standard Labels The following table defines common labels that Helm charts use. Helm itself never requires that a particular label be present. Labels that are marked REC are recommended, and \_should\_ be placed onto a chart for global consistency. Those marked OPT are optional. These are idiomatic or commonly in use, but are not relied upon frequently for operational purposes. Name|Status|Description -----|------|---------- `app.kubernetes.io/name` | REC | This should be the app name, reflecting the entire app. Usually `{{ template "name" . }}` is used for this. This is used by many Kubernetes manifests, and is not Helm-specific. `helm.sh/chart` | REC | This should be the chart name and version: `{{ .Chart.Name }}-{{ .Chart.Version \| replace "+" "\_" }}`. `app.kubernetes.io/managed-by` | REC | This should always be set to `{{ .Release.Service }}`. It is for finding all things managed by Helm. `app.kubernetes.io/instance` | REC | This should be the `{{ .Release.Name }}`. It aids in differentiating between different instances of the same application. `app.kubernetes.io/version` | OPT | The version of the app and can be set to `{{ .Chart.AppVersion }}`. `app.kubernetes.io/component` | OPT | This is a common label for marking the different roles that pieces may play in an application. For example, `app.kubernetes.io/component: frontend`. `app.kubernetes.io/part-of` | OPT | When multiple charts or pieces of software are used together to make one application. For example, application software and a database to produce a website. This can be set to the top level application being supported. You can find more information on the Kubernetes labels, prefixed with `app.kubernetes.io`, in the [Kubernetes documentation](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/). | https://github.com/helm/helm-www/blob/main//docs/chart_best_practices/labels.md | main | helm | [
0.04153015464544296,
0.09798572957515717,
0.0361538864672184,
-0.04599105194211006,
0.035922907292842865,
0.06681569665670395,
0.02830001898109913,
0.015884727239608765,
0.08843007683753967,
0.034156836569309235,
-0.006902412045747042,
-0.08508644253015518,
-0.0017906425055116415,
-0.01938... | 0.09389 |
This part of the Best Practices Guide discusses the creation and formatting of RBAC resources in chart manifests. RBAC resources are: - ServiceAccount (namespaced) - Role (namespaced) - ClusterRole - RoleBinding (namespaced) - ClusterRoleBinding ## YAML Configuration RBAC and ServiceAccount configuration should happen under separate keys. They are separate things. Splitting these two concepts out in the YAML disambiguates them and makes this clearer. ```yaml rbac: # Specifies whether RBAC resources should be created create: true serviceAccount: # Specifies whether a ServiceAccount should be created create: true # The name of the ServiceAccount to use. # If not set and create is true, a name is generated using the fullname template name: ``` This structure can be extended for more complex charts that require multiple ServiceAccounts. ```yaml someComponent: serviceAccount: create: true name: anotherComponent: serviceAccount: create: true name: ``` ## RBAC Resources Should be Created by Default `rbac.create` should be a boolean value controlling whether RBAC resources are created. The default should be `true`. Users who wish to manage RBAC access controls themselves can set this value to `false` (in which case see below). ## Using RBAC Resources `serviceAccount.name` should be set to the name of the ServiceAccount to be used by access-controlled resources created by the chart. If `serviceAccount.create` is true, then a ServiceAccount with this name should be created. If the name is not set, then a name is generated using the `fullname` template, If `serviceAccount.create` is false, then it should not be created, but it should still be associated with the same resources so that manually-created RBAC resources created later that reference it will function correctly. If `serviceAccount.create` is false and the name is not specified, then the default ServiceAccount is used. The following helper template should be used for the ServiceAccount. ```yaml {{/\* Create the name of the service account to use \*/}} {{- define "mychart.serviceAccountName" -}} {{- if .Values.serviceAccount.create -}} {{ default (include "mychart.fullname" .) .Values.serviceAccount.name }} {{- else -}} {{ default "default" .Values.serviceAccount.name }} {{- end -}} {{- end -}} ``` | https://github.com/helm/helm-www/blob/main//docs/chart_best_practices/rbac.md | main | helm | [
-0.04291640967130661,
-0.1000421941280365,
-0.07252445071935654,
0.03639553487300873,
-0.017672790214419365,
0.04225187376141548,
0.049169450998306274,
-0.003087129443883896,
0.010718245059251785,
0.0022039844188839197,
0.05314888060092926,
-0.004442101810127497,
0.08171951025724411,
0.030... | 0.110893 |
Helm Plugins allow users to extend the core feature set of Helm, without requiring every new feature to be written in Go and added to Helm core. They can be written in any programming language, and can be added and removed from a Helm installation without breaking Helm core functionality. ## Plugin Types Helm currently has 3 types of Plugins: - [CLI plugins](#cli-plugins): allow users to add additional `helm` CLI sub-commands - [Getter plugins](#getter-plugins): allow users to use Charts and even other Plugins in locations Helm core doesn't have built-in support for - [Postrenderer plugins](#postrenderer-plugins): allow users to modify Chart rendered manifests before being sent to the Kubernetes API Starting with Helm 4, the plugin system is set up to more easily allow adding additional plugin types, which would allow users to modify other areas of Helm functionality. ### CLI plugins What is the advantage of using a plugin to create `helm` CLI subcommands as opposed to using separate scripts, or tools with their own standalone commands? The main reason is plugins that add `helm` CLI sub-commands can leverage Helm-specific configuration, context, and functionality that standalone scripts and tools would otherwise need to develop themselves. They can allow a more seamless extension of `helm` CLI user workflows. ### Getter Plugins Helm has build-in support for working with [Charts](/glossary/index.mdx#chart) and Plugins on your local filesystem or stored as artifacts in [OCI Registries](/topics/registries.mdx). Charts can additionally be stored in [HTTP repositories](/topics/chart\_repository.md), and plugins can additionally be stored in VCS repositories like Git. Helm Getter plugins allow you to extend this storage and download behavior to support other storage locations. There are community Getter plugins for storing Charts and Plugins in [s3 buckets](/community/related#helm-plugins), and elsewhere. You will want to use getter plugins if you need additional storage options for your Helm workflows. ### PostRenderer plugins Helm allows users to configure charts by supplying custom values. These user-provided values are what Charts use to render the manifests that allow Helm to manage your applications in Kubernetes. If you write your own charts, you can update the templates whenever you need additional configurability for your rendered manifests. However, if you are using community charts that you don't own, post-rendering allows you to modify the manifests after the charts have rendered them but before Helm uses them to manage your Kubernetes resources. Starting with Helm 4, postrenderer plugins are the way to do this. ## Plugin API Versions Starting with Helm 4, the `plugin.yaml` file included with every plugin now has an `apiVersion` field, currently at `v1`. Legacy plugins (prior to API versioning) will still be supported throughout the life of Helm 4, so your existing plugins from Helm 3 will still work until Helm 5. However, you should ask authors of your favorite plugins to update their plugins to the new versioning system. If you are a plugin developer, read more about this in the [Plugins Developer Guide](/plugins/developer/index.mdx). ## Plugin Runtimes Helm currently supports 2 plugin runtimes: - Subprocess runtime - Wasm runtime See the relevant information about each runtime in either the [Plugins User Guide](/plugins/user/index.md) or [Plugins Developer Guide](/plugins/developer/index.mdx). ## File structure All of the files for a plugin live within a single directory, which is used for developing, packaging, and installing. Inside the plugin's directory, Helm expects this structure: ``` example-plugin ├── plugin.yaml # REQUIRED ├── plugin.sh # OPTIONAL for Subprocess runtime └── plugin.wasm # REQUIRED for Wasm runtime ``` - The only required file is [plugin.yaml](#pluginyaml). - [Subprocess runtime](#plugin-runtimes) can optionally contain one or more custom executable files containing your plugin code (can be Node, Python, Go, etc). For this runtime, you | https://github.com/helm/helm-www/blob/main//docs/plugins/overview.md | main | helm | [
-0.06164153665304184,
0.011512136086821556,
0.056431759148836136,
-0.036426518112421036,
0.02783820778131485,
0.024657858535647392,
-0.07254935801029205,
0.0237722285091877,
0.04917716234922409,
0.016161052510142326,
0.04599558934569359,
-0.041784971952438354,
-0.029393058270215988,
0.0219... | 0.111674 |
# REQUIRED ├── plugin.sh # OPTIONAL for Subprocess runtime └── plugin.wasm # REQUIRED for Wasm runtime ``` - The only required file is [plugin.yaml](#pluginyaml). - [Subprocess runtime](#plugin-runtimes) can optionally contain one or more custom executable files containing your plugin code (can be Node, Python, Go, etc). For this runtime, you can alternatively call any executable already available in the user's PATH, directly from the `plugin.yaml` [runtime configuration](#runtime-configuration) `platformCommand` field. - For [Wasm runtime](#plugin-runtimes), you will need to include a `.wasm` file. This is your plugin code (can be Node, Python, Go, etc) compiled to Wasm. ## Plugin.yaml The `plugin.yaml` file is required for a plugin. It is a YAML file containing metadata and configuration for the plugin. ### Metadata Information ```yaml apiVersion: REQUIRED - The Plugin API version. Must be "v1" type: REQUIRED - The versioned Plugin Type. Can be "cli/v1", "getter/v1", or "postrenderer/v1" name: REQUIRED - The name of the plugin version: REQUIRED - The version of the plugin runtime: REQUIRED - The runtime for the plugin. Can be "subprocess" or "extism/v1" (Wasm) sourceURL: OPTIONAL - A URL pointing to the source code for your plugin config: DEPENDS ON PLUGIN TYPE runtimeConfig: DEPENDS ON RUNTIME ``` - The `config` field is for [Plugin Type Configuration](#plugin-type-configuration), with a structure that differs per [Plugin Type](#plugin-types) as defined by the `type` field. - The `runtimeConfig` field is for [Runtime Configuration](#runtime-configuration), with a structure that differs per [Runtime](#plugin-runtimes) as defined by the `runtime` field. - 💡 While the `sourceURL` field is optional, plugin authors are strongly encouraged to point to the plugin source code because it helps plugin users understand what the code does, and contribute to the plugin if it accepts open source contributions. ### Plugin Type Configuration The `config` field of [plugin.yaml](#pluginyaml) has different options per [Plugin Type](#plugin-types). A plugin's type is defined by the `type` field. #### CLI Plugin Configuration If `type` field is `cli/v1`, it is a [CLI Plugin type](#cli-plugins), and the following plugin type configurations are allowed: ```yaml usage: OPTIONAL - The single-line usage text shown in help shortHelp: The short description shown in the 'helm help' output longHelp: The long message shown in the 'helm help ' output ignoreFlags: Ignores any flags passed in from Helm ``` - `usage` is optional. Defaults to "helm PLUGIN\_NAME [flags]" if not overridden with a custom usage string. For recommended syntax, see [spf13/cobra.command.Command] Use field comment: https://pkg.go.dev/github.com/spf13/cobra#Command - `ignoreFlags` switch tells Helm to not pass flags to the plugin. So if a plugin is called with `helm myplugin --foo` and `ignoreFlags: true`, then `--foo` is silently discarded. #### Getter Plugin Configuration If `type` field is `getter/v1`, it is a [Getter Plugin type](#cli-plugins), and the following plugin type configurations are allowed: ```yaml protocols: The list of schemes from the charts URL that this plugin supports. ``` #### Postrenderer Plugin Configuration If `type` field is `postrenderer/v1`, it is a [Postrenderer Plugin type](#cli-plugins), and does not have any configuration options. ### Runtime Configuration The `runtimeConfig` field of [plugin.yaml](#pluginyaml) has different options per [Plugin Runtime](#plugin-runtimes). A plugin's runtime is defined by the `runtime` field. #### Subprocess Runtime Configuration If the `runtime` field is `subprocess`, it is a [Subprocess Runtime](#plugin-runtimes) plugin and the following runtime configurations are allowed: ```yaml runtimeconfig: platformCommand: # Configure command to run based on the platform - os: OS match, can be empty or omitted to match any OS arch: Architecture match, can be empty or omitted to match any architecture command: Plugin command to execute args: Plugin command arguments platformHooks: # Configure plugin lifecycle hooks based on the platform install: # Install lifecycle commands - os: OS match, can be empty | https://github.com/helm/helm-www/blob/main//docs/plugins/overview.md | main | helm | [
-0.023263368755578995,
-0.05083101987838745,
-0.06576180458068848,
-0.02198486216366291,
0.002628117799758911,
-0.048126351088285446,
-0.007835867814719677,
0.07201997935771942,
-0.027117162942886353,
0.01738874986767769,
0.0048949820920825005,
-0.024963971227407455,
-0.060213495045900345,
... | 0.104862 |
empty or omitted to match any OS arch: Architecture match, can be empty or omitted to match any architecture command: Plugin command to execute args: Plugin command arguments platformHooks: # Configure plugin lifecycle hooks based on the platform install: # Install lifecycle commands - os: OS match, can be empty or omitted to match any OS arch: Architecture match, can be empty or omitted to match any architecture command: Plugin install command to execute args: Plugin install command arguments update: # Update lifecycle commands - os: OS match, can be empty or omitted to match any OS arch: Architecture match, can be empty or omitted to match any architecture command: Plugin update command to execute args: Plugin update command arguments delete: # Delete lifecycle commands - os: OS match, can be empty or omitted to match any OS arch: Architecture match, can be empty or omitted to match any architecture command: Plugin delete command to execute args: Plugin delete command arguments protocolCommands: # Obsolete/deprecated - protocols: [] # Protocols are the list of schemes from the charts URL. platformCommand: [] # Same structure as "platformCommand" above ``` - ⚠️ `protocolCommands` is marked `obsolete/deprecated`, and will be removed in future versions of the plugin system after `apiVersion: v1`. It only applies to the "getter/v1" plugin type. This is a compatibility hangover from the old plugin downloader mechanism, which was extended to support multiple protocols in a given plugin. The command supplied in PlatformCommand should implement protocol specific logic by inspecting the download URL. #### Wasm Runtime Configuration If the `runtime` field is `extism/v1`, it is a [Wasm Runtime](#plugin-runtimes) plugin and the following runtime configurations are allowed: ```yaml runtimeconfig: memory: # Describes the limits on the memory the plugin may be allocated maxPages: The max amount of pages the plugin can allocate. One page is 64Kib. e.g. 16 pages would require 1MiB. Default is 4 pages (256KiB). maxHttpResponseBytes: The max size of an Extism HTTP response in bytes. Default is 4096 bytes (4KiB). maxVarBytes: The max size of all Extism vars in bytes. Default is 4096 bytes (4KiB). config: {} # A free-form map that can be passed to the plugin. allowedHosts: [] # An optional set of hosts this plugin can communicate with. Defaults to no hosts allowed. fileSystem: createTempDir: Whether to create a temporary directory on the filesystem. Can be "true" or "false". timeout: The timeout in milliseconds for the plugin to execute hostFunctions: HostFunction names exposed in Helm the plugin may access. See https://extism.org/docs/concepts/host-functions/ entryFuncName: The name of entry function name to call in the plugin. Defaults to "helm\_plugin\_main". ``` - `allowedHosts` only has an effect if the plugin makes HTTP requests. If not specified, then no hosts are allowed. | https://github.com/helm/helm-www/blob/main//docs/plugins/overview.md | main | helm | [
-0.01749977469444275,
0.006272193510085344,
-0.016549497842788696,
-0.02327384240925312,
0.02808678336441517,
-0.05721791088581085,
-0.016290318220853806,
-0.022396374493837357,
-0.016706887632608414,
0.00450202077627182,
0.0426139272749424,
-0.10522636771202087,
-0.05937473103404045,
-0.0... | 0.138223 |
For an overview of Helm Plugin concepts, how to read their structure, and how to understand what their configurations mean for you as a user, read the [Plugins Overview](/plugins/overview.md). This section focuses on using Helm Plugins as an end-user. ## Finding Plugins You can already find [Helm Plugins on ArtifactHub](https://artifacthub.io/packages/search?kind=6). The Helm 4 Plugin system is brand new. In the near future, you should be able to search plugins by type and runtime on ArtifactHub. Stay tuned for updates on this! ## Plugin Security Depending on the plugin runtime, you should inspect any plugin from third parties before running on your system. - Subprocess runtime has as much access to your system as the user running the commands. Be sure to carefully inspect the plugin code before installing a plugin, uninstalling a plugin, or running any helm commands that could also run these plugins. - Wasm runtime, by contrast, runs in a secure sandbox with only the access to your system that you explicitly approve. This plugin runtime has much stronger controls and an inherently higher level of built-in safety. You should still inspect `plugin.yaml` to know what permissions the plugin is requesting. In both cases, it is highly recommended to verify the provenance of even a Wasm runtime plugin before installing it, so that you can trust where it is downloaded from and who created it. This not only protects you from accidentally installing plugins from spoofed URL attacks, but also network hijacking attacks. Plugin verification allows you to cryptographically ensure a chart has not been compromised before you install it. See the `--verify` flag in `helm plugin install --help`. You may also verify the provenance of already installed plugins with `helm plugin verify --help`, in case verification was bypassed during installation (for development purposes), as well as to help provide you with security compliance information at any time. The `helm plugin list` command also includes high-level provenance information at a glance. ## Installing Plugins Helm has a build-in command to install plugins that defaults to secure installation. However, be sure to read [Plugin Security](#plugin-security) to understand what to check before installing. See `helm plugin install --help` for more information. ## Listing Installed Plugins The command to list plugins includes the plugin's name, version, type, API version, provenance, and source. See `helm plugin list --help` for more information. ## Uninstalling Plugins Uninstalling plugins is intended to be straightforward and easy. However, be sure to read [Plugin Security](#plugin-security) to understand the risks of uninstalling as well. See `helm plugin uninstall --help`. | https://github.com/helm/helm-www/blob/main//docs/plugins/user/index.md | main | helm | [
-0.023507585749030113,
0.027825821191072464,
-0.00606260122731328,
-0.05255015194416046,
0.04617372527718544,
-0.0311350729316473,
-0.07573103904724121,
0.03728247806429863,
-0.031094282865524292,
0.034092266112565994,
0.0050970702432096004,
-0.050052616745233536,
0.007594509981572628,
-0.... | 0.131261 |
Control structures (called "actions" in template parlance) provide you, the template author, with the ability to control the flow of a template's generation. Helm's template language provides the following control structures: - `if`/`else` for creating conditional blocks - `with` to specify a scope - `range`, which provides a "for each"-style loop In addition to these, it provides a few actions for declaring and using named template segments: - `define` declares a new named template inside of your template - `template` imports a named template - `block` declares a special kind of fillable template area In this section, we'll talk about `if`, `with`, and `range`. The others are covered in the "Named Templates" section later in this guide. ## If/Else The first control structure we'll look at is for conditionally including blocks of text in a template. This is the `if`/`else` block. The basic structure for a conditional looks like this: ``` {{ if PIPELINE }} # Do something {{ else if OTHER PIPELINE }} # Do something else {{ else }} # Default case {{ end }} ``` Notice that we're now talking about \_pipelines\_ instead of values. The reason for this is to make it clear that control structures can execute an entire pipeline, not just evaluate a value. A pipeline is evaluated as \_false\_ if the value is: - a boolean false - a numeric zero - an empty string - a `nil` (empty or null) - an empty collection (`map`, `slice`, `tuple`, `dict`, `array`) Under all other conditions, the condition is true. Let's add a simple conditional to our ConfigMap. We'll add another setting if the drink is set to coffee: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" drink: {{ .Values.favorite.drink | default "tea" | quote }} food: {{ .Values.favorite.food | upper | quote }} {{ if eq .Values.favorite.drink "coffee" }}mug: "true"{{ end }} ``` Since we commented out `drink: coffee` in our last example, the output should not include a `mug: "true"` flag. But if we add that line back into our `values.yaml` file, the output should look like this: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: eyewitness-elk-configmap data: myvalue: "Hello World" drink: "coffee" food: "PIZZA" mug: "true" ``` ## Controlling Whitespace While we're looking at conditionals, we should take a quick look at the way whitespace is controlled in templates. Let's take the previous example and format it to be a little easier to read: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" drink: {{ .Values.favorite.drink | default "tea" | quote }} food: {{ .Values.favorite.food | upper | quote }} {{ if eq .Values.favorite.drink "coffee" }} mug: "true" {{ end }} ``` Initially, this looks good. But if we run it through the template engine, we'll get an unfortunate result: ```console $ helm install --dry-run --debug ./mychart SERVER: "localhost:44134" CHART PATH: /Users/mattbutcher/Code/Go/src/helm.sh/helm/\_scratch/mychart Error: YAML parse error on mychart/templates/configmap.yaml: error converting YAML to JSON: yaml: line 9: did not find expected key ``` What happened? We generated incorrect YAML because of the whitespacing above. ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: eyewitness-elk-configmap data: myvalue: "Hello World" drink: "coffee" food: "PIZZA" mug: "true" ``` `mug` is incorrectly indented. Let's simply out-dent that one line, and re-run: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" drink: {{ .Values.favorite.drink | default "tea" | quote }} food: {{ .Values.favorite.food | upper | quote }} {{ if eq .Values.favorite.drink "coffee" }} mug: "true" {{ end }} ``` When we sent that, we'll get YAML that is | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/control_structures.md | main | helm | [
-0.051713813096284866,
0.10612323880195618,
0.026767412200570107,
-0.02238049916923046,
0.014854035340249538,
0.03932737186551094,
-0.04785193130373955,
0.06250471621751785,
0.025232290849089622,
-0.036225806921720505,
-0.02304881438612938,
-0.03636932373046875,
-0.03257131949067116,
-0.05... | 0.117541 |
v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" drink: {{ .Values.favorite.drink | default "tea" | quote }} food: {{ .Values.favorite.food | upper | quote }} {{ if eq .Values.favorite.drink "coffee" }} mug: "true" {{ end }} ``` When we sent that, we'll get YAML that is valid, but still looks a little funny: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: telling-chimp-configmap data: myvalue: "Hello World" drink: "coffee" food: "PIZZA" mug: "true" ``` Notice that we received a few empty lines in our YAML. Why? When the template engine runs, it \_removes\_ the contents inside of `{{` and `}}`, but it leaves the remaining whitespace exactly as is. YAML ascribes meaning to whitespace, so managing the whitespace becomes pretty important. Fortunately, Helm templates have a few tools to help. First, the curly brace syntax of template declarations can be modified with special characters to tell the template engine to chomp whitespace. `{{- ` (with the dash and space added) indicates that whitespace should be chomped left, while ` -}}` means whitespace to the right should be consumed. \_Be careful! Newlines are whitespace!\_ > Make sure there is a space between the `-` and the rest of your directive. > `{{- 3 }}` means "trim left whitespace and print 3" while `{{-3 }}` means > "print -3". Using this syntax, we can modify our template to get rid of those new lines: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" drink: {{ .Values.favorite.drink | default "tea" | quote }} food: {{ .Values.favorite.food | upper | quote }} {{- if eq .Values.favorite.drink "coffee" }} mug: "true" {{- end }} ``` Just for the sake of making this point clear, let's adjust the above, and substitute an `\*` for each whitespace that will be deleted following this rule. An `\*` at the end of the line indicates a newline character that would be removed ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" drink: {{ .Values.favorite.drink | default "tea" | quote }} food: {{ .Values.favorite.food | upper | quote }}\* \*\*{{- if eq .Values.favorite.drink "coffee" }} mug: "true"\* \*\*{{- end }} ``` Keeping that in mind, we can run our template through Helm and see the result: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: clunky-cat-configmap data: myvalue: "Hello World" drink: "coffee" food: "PIZZA" mug: "true" ``` Be careful with the chomping modifiers. It is easy to accidentally do things like this: ```yaml food: {{ .Values.favorite.food | upper | quote }} {{- if eq .Values.favorite.drink "coffee" -}} mug: "true" {{- end -}} ``` That will produce `food: "PIZZA"mug: "true"` because it consumed newlines on both sides. > For the details on whitespace control in templates, see the [Official Go > template documentation](https://godoc.org/text/template) Finally, sometimes it's easier to tell the template system how to indent for you instead of trying to master the spacing of template directives. For that reason, you may sometimes find it useful to use the `indent` function (`{{ indent 2 "mug:true" }}`). ## Modifying scope using `with` The next control structure to look at is the `with` action. This controls variable scoping. Recall that `.` is a reference to \_the current scope\_. So `.Values` tells the template to find the `Values` object in the current scope. The syntax for `with` is similar to a simple `if` statement: ``` {{ with PIPELINE }} # restricted scope {{ end }} ``` Scopes can be changed. `with` can allow you to set the current scope (`.`) to a particular object. For example, we've been | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/control_structures.md | main | helm | [
-0.009928536601364613,
0.04751993343234062,
0.06462083011865616,
0.04036716744303703,
0.05493960902094841,
-0.04440421238541603,
0.03277537226676941,
-0.004190822597593069,
0.060433950275182724,
0.004359218757599592,
0.05249229073524475,
-0.042909979820251465,
-0.011603642255067825,
-0.025... | 0.034261 |
object in the current scope. The syntax for `with` is similar to a simple `if` statement: ``` {{ with PIPELINE }} # restricted scope {{ end }} ``` Scopes can be changed. `with` can allow you to set the current scope (`.`) to a particular object. For example, we've been working with `.Values.favorite`. Let's rewrite our ConfigMap to alter the `.` scope to point to `.Values.favorite`: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" {{- with .Values.favorite }} drink: {{ .drink | default "tea" | quote }} food: {{ .food | upper | quote }} {{- end }} ``` Note that we removed the `if` conditional from the previous exercise because it is now unnecessary - the block after `with` only executes if the value of `PIPELINE` is not empty. Notice that now we can reference `.drink` and `.food` without qualifying them. That is because the `with` statement sets `.` to point to `.Values.favorite`. The `.` is reset to its previous scope after `{{ end }}`. But here's a note of caution! Inside of the restricted scope, you will not be able to access the other objects from the parent scope using `.`. This, for example, will fail: ```yaml {{- with .Values.favorite }} drink: {{ .drink | default "tea" | quote }} food: {{ .food | upper | quote }} release: {{ .Release.Name }} {{- end }} ``` It will produce an error because `Release.Name` is not inside of the restricted scope for `.`. However, if we swap the last two lines, all will work as expected because the scope is reset after `{{ end }}`. ```yaml {{- with .Values.favorite }} drink: {{ .drink | default "tea" | quote }} food: {{ .food | upper | quote }} {{- end }} release: {{ .Release.Name }} ``` Or, we can use `$` for accessing the object `Release.Name` from the parent scope. `$` is mapped to the root scope when template execution begins and it does not change during template execution. The following would work as well: ```yaml {{- with .Values.favorite }} drink: {{ .drink | default "tea" | quote }} food: {{ .food | upper | quote }} release: {{ $.Release.Name }} {{- end }} ``` After looking at `range`, we will take a look at template variables, which offer one solution to the scoping issue above. ## Looping with the `range` action Many programming languages have support for looping using `for` loops, `foreach` loops, or similar functional mechanisms. In Helm's template language, the way to iterate through a collection is to use the `range` operator. To start, let's add a list of pizza toppings to our `values.yaml` file: ```yaml favorite: drink: coffee food: pizza pizzaToppings: - mushrooms - cheese - peppers - onions - pineapple ``` Now we have a list (called a `slice` in templates) of `pizzaToppings`. We can modify our template to print this list into our ConfigMap: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" {{- with .Values.favorite }} drink: {{ .drink | default "tea" | quote }} food: {{ .food | upper | quote }} {{- end }} toppings: |- {{- range .Values.pizzaToppings }} - {{ . | title | quote }} {{- end }} ``` We can use `$` for accessing the list `Values.pizzaToppings` from the parent scope. `$` is mapped to the root scope when template execution begins and it does not change during template execution. The following would work as well: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" {{- with .Values.favorite }} drink: {{ | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/control_structures.md | main | helm | [
-0.03532418981194496,
0.06509815156459808,
0.036379799246788025,
0.028505461290478706,
-0.005342231597751379,
-0.005100198555737734,
0.08078226447105408,
0.0008930031326599419,
-0.03932841867208481,
-0.04851901903748512,
-0.008860835805535316,
-0.06131662055850029,
-0.00730672525241971,
0.... | 0.048644 |
`Values.pizzaToppings` from the parent scope. `$` is mapped to the root scope when template execution begins and it does not change during template execution. The following would work as well: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" {{- with .Values.favorite }} drink: {{ .drink | default "tea" | quote }} food: {{ .food | upper | quote }} toppings: |- {{- range $.Values.pizzaToppings }} - {{ . | title | quote }} {{- end }} {{- end }} ``` Let's take a closer look at the `toppings:` list. The `range` function will "range over" (iterate through) the `pizzaToppings` list. But now something interesting happens. Just like `with` sets the scope of `.`, so does a `range` operator. Each time through the loop, `.` is set to the current pizza topping. That is, the first time, `.` is set to `mushrooms`. The second iteration it is set to `cheese`, and so on. We can send the value of `.` directly down a pipeline, so when we do `{{ . | title | quote }}`, it sends `.` to `title` (title case function) and then to `quote`. If we run this template, the output will be: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: edgy-dragonfly-configmap data: myvalue: "Hello World" drink: "coffee" food: "PIZZA" toppings: |- - "Mushrooms" - "Cheese" - "Peppers" - "Onions" - "Pineapple" ``` Now, in this example we've done something tricky. The `toppings: |-` line is declaring a multi-line string. So our list of toppings is actually not a YAML list. It's a big string. Why would we do this? Because the data in ConfigMaps `data` is composed of key/value pairs, where both the key and the value are simple strings. To understand why this is the case, take a look at the [Kubernetes ConfigMap docs](https://kubernetes.io/docs/concepts/configuration/configmap/). For us, though, this detail doesn't matter much. > The `|-` marker in YAML takes a multi-line string. This can be a useful > technique for embedding big blocks of data inside of your manifests, as > exemplified here. Sometimes it's useful to be able to quickly make a list inside of your template, and then iterate over that list. Helm templates have a function to make this easy: `tuple`. In computer science, a tuple is a list-like collection of fixed size, but with arbitrary data types. This roughly conveys the way a `tuple` is used. ```yaml sizes: |- {{- range tuple "small" "medium" "large" }} - {{ . }} {{- end }} ``` The above will produce this: ```yaml sizes: |- - small - medium - large ``` In addition to lists and tuples, `range` can be used to iterate over collections that have a key and a value (like a `map` or `dict`). We'll see how to do that in the next section when we introduce template variables. | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/control_structures.md | main | helm | [
-0.023526014760136604,
0.07721076905727386,
0.041576847434043884,
0.045299630612134933,
-0.007963964715600014,
-0.02655060775578022,
0.016420450061559677,
-0.00495110685005784,
0.00685823243111372,
-0.06282106041908264,
0.011237992905080318,
-0.02576608955860138,
-0.013594378717243671,
-0.... | 0.016154 |
In this section we are going to look at Helm's tool for providing instructions to your chart users. At the end of a `helm install` or `helm upgrade`, Helm can print out a block of helpful information for users. This information is highly customizable using templates. To add installation notes to your chart, simply create a `templates/NOTES.txt` file. This file is plain text, but it is processed like a template, and has all the normal template functions and objects available. Let's create a simple `NOTES.txt` file: ``` Thank you for installing {{ .Chart.Name }}. Your release is named {{ .Release.Name }}. To learn more about the release, try: $ helm status {{ .Release.Name }} $ helm get all {{ .Release.Name }} ``` Now if we run `helm install rude-cardinal ./mychart` we will see this message at the bottom: ``` RESOURCES: ==> v1/Secret NAME TYPE DATA AGE rude-cardinal-secret Opaque 1 0s ==> v1/ConfigMap NAME DATA AGE rude-cardinal-configmap 3 0s NOTES: Thank you for installing mychart. Your release is named rude-cardinal. To learn more about the release, try: $ helm status rude-cardinal $ helm get all rude-cardinal ``` Using `NOTES.txt` this way is a great way to give your users detailed information about how to use their newly installed chart. Creating a `NOTES.txt` file is strongly recommended, though it is not required. | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/notes_files.md | main | helm | [
0.06389274448156357,
0.08161087334156036,
0.050438567996025085,
-0.030617257580161095,
0.018052520230412483,
0.030862025916576385,
-0.030256254598498344,
0.0730506107211113,
-0.01312339585274458,
0.047787558287382126,
0.037857912480831146,
-0.02224687859416008,
0.011082638055086136,
-0.026... | 0.00579 |
The `.helmignore` file is used to specify files you don't want to include in your helm chart. If this file exists, the `helm package` command will ignore all the files that match the pattern specified in the `.helmignore` file while packaging your application. This can help in avoiding unnecessary or sensitive files or directories from being added in your helm chart. The `.helmignore` file supports Unix shell glob matching, relative path matching, and negation (prefixed with !). Only one pattern per line is considered. Here is an example `.helmignore` file: ``` # comment # Match any file or path named .helmignore .helmignore # Match any file or path named .git .git # Match any text file \*.txt # Match only directories named mydir mydir/ # Match only text files in the top-level directory /\*.txt # Match only the file foo.txt in the top-level directory /foo.txt # Match any file named ab.txt, ac.txt, or ad.txt a[b-d].txt # Match any file under subdir matching temp\* \*/temp\* \*/\*/temp\* temp? ``` Some notable differences from .gitignore: - The '\*\*' syntax is not supported. - The globbing library is Go's 'filepath.Match', not fnmatch(3) - Trailing spaces are always ignored (there is no supported escape sequence) - There is no support for '\!' as a special leading sequence. - It does not exclude itself by default, you have to add an explicit entry for `.helmignore` \*\*We'd love your help\*\* making this document better. To add, correct, or remove information, [file an issue](https://github.com/helm/helm-www/issues) or send us a pull request. | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/helm_ignore_file.md | main | helm | [
-0.0051025873981416225,
0.07723940908908844,
0.04913991317152977,
-0.020509619265794754,
0.10485952347517014,
-0.0379398874938488,
-0.006383489351719618,
0.07999978959560394,
0.08138840645551682,
0.015809230506420135,
0.0334666408598423,
-0.02672152779996395,
0.052159812301397324,
-0.02751... | 0.032593 |
In the previous section we looked at several ways to create and access named templates. This makes it easy to import one template from within another template. But sometimes it is desirable to import a \_file that is not a template\_ and inject its contents without sending the contents through the template renderer. Helm provides access to files through the `.Files` object. Before we get going with the template examples, though, there are a few things to note about how this works: - It is okay to add extra files to your Helm chart. These files will be bundled. Be careful, though. Charts must be smaller than 1M because of the storage limitations of Kubernetes objects. - Some files cannot be accessed through the `.Files` object, usually for security reasons. - Files in `templates/` cannot be accessed. - Files excluded using `.helmignore` cannot be accessed. - Files outside of a Helm application [subchart](/chart\_template\_guide/subcharts\_and\_globals.md), including those of the parent, cannot be accessed - Charts do not preserve UNIX mode information, so file-level permissions will have no impact on the availability of a file when it comes to the `.Files` object. - [Basic example](#basic-example) - [Path helpers](#path-helpers) - [Glob patterns](#glob-patterns) - [ConfigMap and Secrets utility functions](#configmap-and-secrets-utility-functions) - [Encoding](#encoding) - [Lines](#lines) ## Basic example With those caveats behind, let's write a template that reads three files into our ConfigMap. To get started, we will add three files to the chart, putting all three directly inside of the `mychart/` directory. `config1.toml`: ```toml message = "Hello from config 1" ``` `config2.toml`: ```toml message = "This is config 2" ``` `config3.toml`: ```toml message = "Goodbye from config 3" ``` Each of these is a simple TOML file (think old-school Windows INI files). We know the names of these files, so we can use a `range` function to loop through them and inject their contents into our ConfigMap. ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: {{- $files := .Files }} {{- range tuple "config1.toml" "config2.toml" "config3.toml" }} {{ . }}: |- {{ $files.Get . }} {{- end }} ``` This ConfigMap uses several of the techniques discussed in previous sections. For example, we create a `$files` variable to hold a reference to the `.Files` object. We also use the `tuple` function to create a list of files that we loop through. Then we print each file name (`{{ . }}: |-`) followed by the contents of the file `{{ $files.Get . }}`. Running this template will produce a single ConfigMap with the contents of all three files: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: quieting-giraf-configmap data: config1.toml: |- message = "Hello from config 1" config2.toml: |- message = "This is config 2" config3.toml: |- message = "Goodbye from config 3" ``` ## Path helpers When working with files, it can be very useful to perform some standard operations on the file paths themselves. To help with this, Helm imports many of the functions from Go's [path](https://golang.org/pkg/path/) package for your use. They are all accessible with the same names as in the Go package, but with a lowercase first letter. For example, `Base` becomes `base`, etc. The imported functions are: - Base - Dir - Ext - IsAbs - Clean ## Glob patterns As your chart grows, you may find you have a greater need to organize your files more, and so we provide a `Files.Glob(pattern string)` method to assist in extracting certain files with all the flexibility of [glob patterns](https://godoc.org/github.com/gobwas/glob). `.Glob` returns a `Files` type, so you may call any of the `Files` methods on the returned object. For example, | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/accessing_files.md | main | helm | [
-0.006689264439046383,
0.06393342465162277,
0.026257287710905075,
-0.02990383468568325,
0.0620613619685173,
0.04175986349582672,
-0.07404259592294693,
0.08802473545074463,
0.05005119368433952,
0.03895182907581329,
-0.017835000529885292,
-0.022157952189445496,
-0.00021347939036786556,
-0.00... | 0.048581 |
have a greater need to organize your files more, and so we provide a `Files.Glob(pattern string)` method to assist in extracting certain files with all the flexibility of [glob patterns](https://godoc.org/github.com/gobwas/glob). `.Glob` returns a `Files` type, so you may call any of the `Files` methods on the returned object. For example, imagine the directory structure: ``` foo/: foo.txt foo.yaml bar/: bar.go bar.conf baz.yaml ``` You have multiple options with Globs: ```yaml {{ $currentScope := .}} {{ range $path, $\_ := .Files.Glob "\*\*.yaml" }} {{- with $currentScope}} {{ .Files.Get $path }} {{- end }} {{ end }} ``` Or ```yaml {{ range $path, $\_ := .Files.Glob "\*\*.yaml" }} {{ $.Files.Get $path }} {{ end }} ``` ## ConfigMap and Secrets utility functions (Available Helm 2.0.2 and after) It is very common to want to place file content into both ConfigMaps and Secrets, for mounting into your pods at run time. To help with this, we provide a couple utility methods on the `Files` type. For further organization, it is especially useful to use these methods in conjunction with the `Glob` method. Given the directory structure from the [Glob](#glob-patterns) example above: ```yaml --- apiVersion: v1 kind: ConfigMap metadata: name: conf data: {{ (.Files.Glob "foo/\*").AsConfig | indent 2 }} --- apiVersion: v1 kind: Secret metadata: name: very-secret type: Opaque data: {{ (.Files.Glob "bar/\*").AsSecrets | indent 2 }} ``` ## Encoding You can import a file and have the template base-64 encode it to ensure successful transmission: ```yaml apiVersion: v1 kind: Secret metadata: name: {{ .Release.Name }}-secret type: Opaque data: token: |- {{ .Files.Get "config1.toml" | b64enc }} ``` The above will take the same `config1.toml` file we used before and encode it: ```yaml # Source: mychart/templates/secret.yaml apiVersion: v1 kind: Secret metadata: name: lucky-turkey-secret type: Opaque data: token: |- bWVzc2FnZSA9ICJIZWxsbyBmcm9tIGNvbmZpZyAxIgo= ``` ## Lines Sometimes it is desirable to access each line of a file in your template. We provide a convenient `Lines` method for this. You can loop through `Lines` using a `range` function: ```yaml data: some-file.txt: {{ range .Files.Lines "foo/bar.txt" }} {{ . }}{{ end }} ``` There is no way to pass files external to the chart during `helm install`. So if you are asking users to supply data, it must be loaded using `helm install -f` or `helm install --set`. This discussion wraps up our dive into the tools and techniques for writing Helm templates. In the next section we will see how you can use one special file, `templates/NOTES.txt`, to send post-installation instructions to the users of your chart. | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/accessing_files.md | main | helm | [
-0.030799008905887604,
0.05169129744172096,
-0.0077511221170425415,
0.034382183104753494,
0.006111102178692818,
-0.002449778141453862,
0.04801219329237938,
0.014137971214950085,
0.012178921140730381,
0.0011083040153607726,
0.04012630507349968,
0.027367355301976204,
-0.03951696678996086,
0.... | 0.043215 |
Objects are passed into a template from the template engine. And your code can pass objects around (we'll see examples when we look at the `with` and `range` statements). There are even a few ways to create new objects within your templates, like with the `tuple` function we'll see later. Objects can be simple, and have just one value. Or they can contain other objects or functions. For example, the `Release` object contains several objects (like `Release.Name`) and the `Files` object has a few functions. In the previous section, we use `{{ .Release.Name }}` to insert the name of a release into a template. `Release` is one of the top-level objects that you can access in your templates. - `Release`: This object describes the release itself. It has several objects inside of it: - `Release.Name`: The release name - `Release.Namespace`: The namespace to be released into (if the manifest doesn’t override) - `Release.IsUpgrade`: This is set to `true` if the current operation is an upgrade or rollback. - `Release.IsInstall`: This is set to `true` if the current operation is an install. - `Release.Revision`: The revision number for this release. On install, this is 1, and it is incremented with each upgrade and rollback. - `Release.Service`: The service that is rendering the present template. On Helm, this is always `Helm`. - `Values`: Values passed into the template from the `values.yaml` file and from user-supplied files. By default, `Values` is empty. - `Chart`: The contents of the `Chart.yaml` file. Any data in `Chart.yaml` will be accessible here. For example `{{ .Chart.Name }}-{{ .Chart.Version }}` will print out the `mychart-0.1.0`. - The available fields are listed in the [Charts Guide](/topics/charts.mdx#the-chartyaml-file) - `Subcharts`: This provides access to the scope (.Values, .Charts, .Releases etc.) of subcharts to the parent. For example `.Subcharts.mySubChart.myValue` to access the `myValue` in the `mySubChart` chart. - `Files`: This provides access to all non-special files in a chart. While you cannot use it to access templates, you can use it to access other files in the chart. See the section [Accessing Files](/chart\_template\_guide/accessing\_files.md) for more. - `Files.Get` is a function for getting a file by name (`.Files.Get config.ini`) - `Files.GetBytes` is a function for getting the contents of a file as an array of bytes instead of as a string. This is useful for things like images. - `Files.Glob` is a function that returns a list of files whose names match the given shell glob pattern. - `Files.Lines` is a function that reads a file line-by-line. This is useful for iterating over each line in a file. - `Files.AsSecrets` is a function that returns the file bodies as Base 64 encoded strings. - `Files.AsConfig` is a function that returns file bodies as a YAML map. - `Capabilities`: This provides information about what capabilities the Kubernetes cluster supports. - `Capabilities.APIVersions` is a set of versions. - `Capabilities.APIVersions.Has $version` indicates whether a version (e.g., `batch/v1`) or resource (e.g., `apps/v1/Deployment`) is available on the cluster. - `Capabilities.KubeVersion` and `Capabilities.KubeVersion.Version` is the Kubernetes version. - `Capabilities.KubeVersion.Major` is the Kubernetes major version. - `Capabilities.KubeVersion.Minor` is the Kubernetes minor version. - `Capabilities.HelmVersion` is the object containing the Helm Version details, it is the same output of `helm version`. - `Capabilities.HelmVersion.Version` is the current Helm version in semver format. - `Capabilities.HelmVersion.GitCommit` is the Helm git sha1. - `Capabilities.HelmVersion.GitTreeState` is the state of the Helm git tree. - `Capabilities.HelmVersion.GoVersion` is the version of the Go compiler used. - `Template`: Contains information about the current template that is being executed - `Template.Name`: A namespaced file path to the current template (e.g. `mychart/templates/mytemplate.yaml`) - `Template.BasePath`: The namespaced path to the templates directory | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/builtin_objects.md | main | helm | [
-0.02345837466418743,
0.06946708261966705,
-0.0020587437320500612,
0.07722150534391403,
0.01709219254553318,
0.013575526885688305,
0.01899602822959423,
0.04004852473735809,
0.014094263315200806,
0.03462410718202591,
0.030447378754615784,
0.033548254519701004,
-0.052631594240665436,
-0.1023... | 0.147549 |
the state of the Helm git tree. - `Capabilities.HelmVersion.GoVersion` is the version of the Go compiler used. - `Template`: Contains information about the current template that is being executed - `Template.Name`: A namespaced file path to the current template (e.g. `mychart/templates/mytemplate.yaml`) - `Template.BasePath`: The namespaced path to the templates directory of the current chart (e.g. `mychart/templates`). The built-in values always begin with a capital letter. This is in keeping with Go's naming convention. When you create your own names, you are free to use a convention that suits your team. Some teams, like many whose charts you may see on [Artifact Hub](https://artifacthub.io/packages/search?kind=0), choose to use only initial lower case letters in order to distinguish local names from those built-in. In this guide, we follow that convention. | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/builtin_objects.md | main | helm | [
0.03369562327861786,
0.06806401163339615,
0.016872810199856758,
-0.05767747759819031,
-0.021425459533929825,
-0.014983204193413258,
-0.02840368263423443,
0.0675758644938469,
0.08595836907625198,
-0.010557208210229874,
0.039515018463134766,
-0.01670740358531475,
0.029147133231163025,
0.0229... | 0.025826 |
To this point we have been working only with one chart. But charts can have dependencies, called \_subcharts\_, that also have their own values and templates. In this section we will create a subchart and see the different ways we can access values from within templates. Before we dive into the code, there are a few important details to learn about application subcharts. 1. A subchart is considered "stand-alone", which means a subchart can never explicitly depend on its parent chart. 2. For that reason, a subchart cannot access the values of its parent. 3. A parent chart can override values for subcharts. 4. Helm has a concept of \_global values\_ that can be accessed by all charts. > These limitations do not all necessarily apply to [library charts](/topics/library\_charts.md), which are designed to provide standardized helper functionality. As we walk through the examples in this section, many of these concepts will become clearer. ## Creating a Subchart For these exercises, we'll start with the `mychart/` chart we created at the beginning of this guide, and we'll add a new chart inside of it. ```console $ cd mychart/charts $ helm create mysubchart Creating mysubchart $ rm -rf mysubchart/templates/\* ``` Notice that just as before, we deleted all of the base templates so that we can start from scratch. In this guide, we are focused on how templates work, not on managing dependencies. But the [Charts Guide](/topics/charts.mdx) has more information on how subcharts work. ## Adding Values and a Template to the Subchart Next, let's create a simple template and values file for our `mysubchart` chart. There should already be a `values.yaml` in `mychart/charts/mysubchart`. We'll set it up like this: ```yaml dessert: cake ``` Next, we'll create a new ConfigMap template in `mychart/charts/mysubchart/templates/configmap.yaml`: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-cfgmap2 data: dessert: {{ .Values.dessert }} ``` Because every subchart is a \_stand-alone chart\_, we can test `mysubchart` on its own: ```console $ helm install --generate-name --dry-run --debug mychart/charts/mysubchart SERVER: "localhost:44134" CHART PATH: /Users/mattbutcher/Code/Go/src/helm.sh/helm/\_scratch/mychart/charts/mysubchart NAME: newbie-elk TARGET NAMESPACE: default CHART: mysubchart 0.1.0 MANIFEST: --- # Source: mysubchart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: newbie-elk-cfgmap2 data: dessert: cake ``` ## Overriding Values from a Parent Chart Our original chart, `mychart` is now the \_parent\_ chart of `mysubchart`. This relationship is based entirely on the fact that `mysubchart` is within `mychart/charts`. Because `mychart` is a parent, we can specify configuration in `mychart` and have that configuration pushed into `mysubchart`. For example, we can modify `mychart/values.yaml` like this: ```yaml favorite: drink: coffee food: pizza pizzaToppings: - mushrooms - cheese - peppers - onions mysubchart: dessert: ice cream ``` Note the last two lines. Any directives inside of the `mysubchart` section will be sent to the `mysubchart` chart. So if we run `helm install --generate-name --dry-run --debug mychart`, one of the things we will see is the `mysubchart` ConfigMap: ```yaml # Source: mychart/charts/mysubchart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: unhinged-bee-cfgmap2 data: dessert: ice cream ``` The value at the top level has now overridden the value of the subchart. There's an important detail to notice here. We didn't change the template of `mychart/charts/mysubchart/templates/configmap.yaml` to point to `.Values.mysubchart.dessert`. From that template's perspective, the value is still located at `.Values.dessert`. As the template engine passes values along, it sets the scope. So for the `mysubchart` templates, only values specifically for `mysubchart` will be available in `.Values`. Sometimes, though, you do want certain values to be available to all of the templates. This is accomplished using global chart values. ## Global Chart Values Global values are values that can be accessed from any chart or subchart by | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/subcharts_and_globals.md | main | helm | [
-0.0046153804287314415,
0.003246941603720188,
0.06655223667621613,
-0.031595587730407715,
0.04549890384078026,
0.01778343878686428,
-0.06475772708654404,
0.08025426417589188,
0.05014842376112938,
-0.002001172164455056,
-0.02622516267001629,
-0.003548199078068137,
0.0625944584608078,
0.0054... | -0.027664 |
only values specifically for `mysubchart` will be available in `.Values`. Sometimes, though, you do want certain values to be available to all of the templates. This is accomplished using global chart values. ## Global Chart Values Global values are values that can be accessed from any chart or subchart by exactly the same name. Globals require explicit declaration. You can't use an existing non-global as if it were a global. The Values data type has a reserved section called `Values.global` where global values can be set. Let's set one in our `mychart/values.yaml` file. ```yaml favorite: drink: coffee food: pizza pizzaToppings: - mushrooms - cheese - peppers - onions mysubchart: dessert: ice cream global: salad: caesar ``` Because of the way globals work, both `mychart/templates/configmap.yaml` and `mysubchart/templates/configmap.yaml` should be able to access that value as `{{ .Values.global.salad }}`. `mychart/templates/configmap.yaml`: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: salad: {{ .Values.global.salad }} ``` `mysubchart/templates/configmap.yaml`: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-cfgmap2 data: dessert: {{ .Values.dessert }} salad: {{ .Values.global.salad }} ``` Now if we run a dry run install, we'll see the same value in both outputs: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: silly-snake-configmap data: salad: caesar --- # Source: mychart/charts/mysubchart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: silly-snake-cfgmap2 data: dessert: ice cream salad: caesar ``` Globals are useful for passing information like this, though it does take some planning to make sure the right templates are configured to use globals. ## Sharing Templates with Subcharts Parent charts and subcharts can share templates. Any defined block in any chart is available to other charts. For example, we can define a simple template like this: ```yaml {{- define "labels" }}from: mychart{{ end }} ``` Recall how the labels on templates are \_globally shared\_. Thus, the `labels` chart can be included from any other chart. While chart developers have a choice between `include` and `template`, one advantage of using `include` is that `include` can dynamically reference templates: ```yaml {{ include $mytemplate }} ``` The above will dereference `$mytemplate`. The `template` function, in contrast, will only accept a string literal. ## Avoid Using Blocks The Go template language provides a `block` keyword that allows developers to provide a default implementation which is overridden later. In Helm charts, blocks are not the best tool for overriding because if multiple implementations of the same block are provided, the one selected is unpredictable. The suggestion is to instead use `include`. | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/subcharts_and_globals.md | main | helm | [
0.017010275274515152,
-0.023364627733826637,
-0.0027224398218095303,
-0.005398536566644907,
-0.010089509189128876,
0.027734650298953056,
-0.03628510609269142,
0.034664127975702286,
0.004552782513201237,
-0.07179591059684753,
0.011763373389840126,
-0.04354122281074524,
-0.008150960318744183,
... | -0.07621 |
In this section of the guide, we'll create a chart and then add a first template. The chart we created here will be used throughout the rest of the guide. To get going, let's take a brief look at a Helm chart. ## Charts As described in the [Charts Guide](/topics/charts.mdx), Helm charts are structured like this: ``` mychart/ Chart.yaml values.yaml charts/ templates/ ... ``` The `templates/` directory is for template files. When Helm evaluates a chart, it will send all of the files in the `templates/` directory through the template rendering engine. It then collects the results of those templates and sends them on to Kubernetes. The `values.yaml` file is also important to templates. This file contains the \_default values\_ for a chart. These values may be overridden by users during `helm install` or `helm upgrade`. The `Chart.yaml` file contains a description of the chart. You can access it from within a template. The `charts/` directory \_may\_ contain other charts (which we call \_subcharts\_). Later in this guide we will see how those work when it comes to template rendering. ## A Starter Chart For this guide, we'll create a simple chart called `mychart`, and then we'll create some templates inside of the chart. ```console $ helm create mychart Creating mychart ``` ### A Quick Glimpse of `mychart/templates/` If you take a look at the `mychart/templates/` directory, you'll notice a few files already there. - `NOTES.txt`: The "help text" for your chart. This will be displayed to your users when they run `helm install`. - `deployment.yaml`: A basic manifest for creating a Kubernetes [deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) - `service.yaml`: A basic manifest for creating a [service endpoint](https://kubernetes.io/docs/concepts/services-networking/service/) for your deployment - `\_helpers.tpl`: A place to put template helpers that you can re-use throughout the chart And what we're going to do is... \_remove them all!\_ That way we can work through our tutorial from scratch. We'll actually create our own `NOTES.txt` and `\_helpers.tpl` as we go. ```console $ rm -rf mychart/templates/\* ``` When you're writing production grade charts, having basic versions of these charts can be really useful. So in your day-to-day chart authoring, you probably won't want to remove them. ## A First Template The first template we are going to create will be a `ConfigMap`. In Kubernetes, a ConfigMap is simply an object for storing configuration data. Other things, like pods, can access the data in a ConfigMap. Because ConfigMaps are basic resources, they make a great starting point for us. Let's begin by creating a file called `mychart/templates/configmap.yaml`: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: mychart-configmap data: myvalue: "Hello World" ``` \*\*TIP:\*\* Template names do not follow a rigid naming pattern. However, we recommend using the extension `.yaml` for YAML files and `.tpl` for helpers. The YAML file above is a bare-bones ConfigMap, having the minimal necessary fields. By virtue of the fact that this file is in the `mychart/templates/` directory, it will be sent through the template engine. It is just fine to put a plain YAML file like this in the `mychart/templates/` directory. When Helm reads this template, it will simply send it to Kubernetes as-is. With this simple template, we now have an installable chart. And we can install it like this: ```console $ helm install full-coral ./mychart NAME: full-coral LAST DEPLOYED: Tue Nov 1 17:36:01 2016 NAMESPACE: default STATUS: DEPLOYED REVISION: 1 TEST SUITE: None ``` Using Helm, we can retrieve the release and see the actual template that was loaded. ```console $ helm get manifest full-coral --- # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: mychart-configmap data: myvalue: "Hello World" ``` The `helm get | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/getting_started.md | main | helm | [
0.03149084374308586,
0.049237702041864395,
0.03415633738040924,
-0.03489815071225166,
0.048719871789216995,
0.04152751713991165,
-0.05507427081465721,
0.0499899722635746,
0.09292611479759216,
0.020893007516860962,
-0.0020240633748471737,
-0.02889719232916832,
0.007187189068645239,
-0.03873... | 0.050477 |
NAMESPACE: default STATUS: DEPLOYED REVISION: 1 TEST SUITE: None ``` Using Helm, we can retrieve the release and see the actual template that was loaded. ```console $ helm get manifest full-coral --- # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: mychart-configmap data: myvalue: "Hello World" ``` The `helm get manifest` command takes a release name (`full-coral`) and prints out all of the Kubernetes resources that were uploaded to the server. Each file begins with `---` to indicate the start of a YAML document, and then is followed by an automatically generated comment line that tells us what template file generated this YAML document. From there on, we can see that the YAML data is exactly what we put in our `configmap.yaml` file. Now we can uninstall our release: `helm uninstall full-coral`. ### Adding a Simple Template Call Hard-coding the `name:` into a resource is usually considered to be bad practice. Names should be unique to a release. So we might want to generate a name field by inserting the release name. \*\*TIP:\*\* The `name:` field is limited to 63 characters because of limitations to the DNS system. For that reason, release names are limited to 53 characters. Kubernetes 1.3 and earlier limited to only 24 characters (thus 14 character names). Let's alter `configmap.yaml` accordingly. ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" ``` The big change comes in the value of the `name:` field, which is now `{{ .Release.Name }}-configmap`. > A template directive is enclosed in `{{` and `}}` blocks. The template directive `{{ .Release.Name }}` injects the release name into the template. The values that are passed into a template can be thought of as \_namespaced objects\_, where a dot (`.`) separates each namespaced element. The leading dot before `Release` indicates that we start with the top-most namespace for this scope (we'll talk about scope in a bit). So we could read `.Release.Name` as "start at the top namespace, find the `Release` object, then look inside of it for an object called `Name`". The `Release` object is one of the built-in objects for Helm, and we'll cover it in more depth later. But for now, it is sufficient to say that this will display the release name that the library assigns to our release. Now when we install our resource, we'll immediately see the result of using this template directive: ```console $ helm install clunky-serval ./mychart NAME: clunky-serval LAST DEPLOYED: Tue Nov 1 17:45:37 2016 NAMESPACE: default STATUS: DEPLOYED REVISION: 1 TEST SUITE: None ``` You can run `helm get manifest clunky-serval` to see the entire generated YAML. Note that the ConfigMap inside Kubernetes name is `clunky-serval-configmap` instead of `mychart-configmap` previously. At this point, we've seen templates at their most basic: YAML files that have template directives embedded in `{{` and `}}`. In the next part, we'll take a deeper look into templates. But before moving on, there's one quick trick that can make building templates faster: When you want to test the template rendering, but not actually install anything, you can use `helm install --debug --dry-run goodly-guppy ./mychart`. This will render the templates. But instead of installing the chart, it will return the rendered template to you so you can see the output: ```console $ helm install --debug --dry-run goodly-guppy ./mychart install.go:149: [debug] Original chart version: "" install.go:166: [debug] CHART PATH: /Users/ninja/mychart NAME: goodly-guppy LAST DEPLOYED: Thu Dec 26 17:24:13 2019 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: | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/getting_started.md | main | helm | [
0.04186772555112839,
0.08515006303787231,
0.08272778242826462,
-0.010847232304513454,
0.08110589534044266,
-0.05091496929526329,
-0.030087227001786232,
-0.018999598920345306,
0.07255648076534271,
0.027641167864203453,
0.04884907230734825,
-0.037395063787698746,
-0.021479744464159012,
-0.03... | 0.102401 |
./mychart install.go:149: [debug] Original chart version: "" install.go:166: [debug] CHART PATH: /Users/ninja/mychart NAME: goodly-guppy LAST DEPLOYED: Thu Dec 26 17:24:13 2019 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: [] nameOverride: "" nodeSelector: {} podSecurityContext: {} replicaCount: 1 resources: {} securityContext: {} service: port: 80 type: ClusterIP serviceAccount: create: true name: null tolerations: [] HOOKS: MANIFEST: --- # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: goodly-guppy-configmap data: myvalue: "Hello World" ``` Using `--dry-run` will make it easier to test your code, but it won't ensure that Kubernetes itself will accept the templates you generate. It's best not to assume that your chart will install just because `--dry-run` works. In the [Chart Template Guide](/chart\_template\_guide/index.mdx), we take the basic chart we defined here and explore the Helm template language in detail. And we'll get started with built-in objects. | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/getting_started.md | main | helm | [
0.019839776679873466,
0.024375062435865402,
0.028055410832166672,
0.011294032447040081,
-0.002773899585008621,
-0.0306299589574337,
-0.0009710821323096752,
0.0024222612846642733,
0.025276295840740204,
0.05186742916703224,
0.06768839806318283,
-0.06278342753648758,
-0.0010122054954990745,
0... | 0.051991 |
Most of this guide has been focused on writing the template language. Here, we'll look at the YAML format. YAML has some useful features that we, as template authors, can use to make our templates less error prone and easier to read. ## Scalars and Collections According to the [YAML spec](https://yaml.org/spec/1.2/spec.html), there are two types of collections, and many scalar types. The two types of collections are maps and sequences: ```yaml map: one: 1 two: 2 three: 3 sequence: - one - two - three ``` Scalar values are individual values (as opposed to collections) ### Scalar Types in YAML In Helm's dialect of YAML, the scalar data type of a value is determined by a complex set of rules, including the Kubernetes schema for resource definitions. But when inferring types, the following rules tend to hold true. If an integer or float is an unquoted bare word, it is typically treated as a numeric type: ```yaml count: 1 size: 2.34 ``` But if they are quoted, they are treated as strings: ```yaml count: "1" # <-- string, not int size: '2.34' # <-- string, not float ``` The same is true of booleans: ```yaml isGood: true # bool answer: "true" # string ``` The word for an empty value is `null` (not `nil`). Note that `port: "80"` is valid YAML, and will pass through both the template engine and the YAML parser, but will fail if Kubernetes expects `port` to be an integer. In some cases, you can force a particular type inference using YAML node tags: ```yaml coffee: "yes, please" age: !!str 21 port: !!int "80" ``` In the above, `!!str` tells the parser that `age` is a string, even if it looks like an int. And `port` is treated as an int, even though it is quoted. ## Strings in YAML Much of the data that we place in YAML documents are strings. YAML has more than one way to represent a string. This section explains the ways and demonstrates how to use some of them. There are three "inline" ways of declaring a string: ```yaml way1: bare words way2: "double-quoted strings" way3: 'single-quoted strings' ``` All inline styles must be on one line. - Bare words are unquoted, and are not escaped. For this reason, you have to be careful what characters you use. - Double-quoted strings can have specific characters escaped with `\`. For example `"\"Hello\", she said"`. You can escape line breaks with `\n`. - Single-quoted strings are "literal" strings, and do not use the `\` to escape characters. The only escape sequence is `''`, which is decoded as a single `'`. In addition to the one-line strings, you can declare multi-line strings: ```yaml coffee: | Latte Cappuccino Espresso ``` The above will treat the value of `coffee` as a single string equivalent to `Latte\nCappuccino\nEspresso\n`. Note that the first line after the `|` must be correctly indented. So we could break the example above by doing this: ```yaml coffee: | Latte Cappuccino Espresso ``` Because `Latte` is incorrectly indented, we'd get an error like this: ``` Error parsing file: error converting YAML to JSON: yaml: line 7: did not find expected key ``` In templates, it is sometimes safer to put a fake "first line" of content in a multi-line document just for protection from the above error: ```yaml coffee: | # Commented first line Latte Cappuccino Espresso ``` Note that whatever that first line is, it will be preserved in the output of the string. So if you are, for example, using this technique to inject a file's contents into a ConfigMap, the | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/yaml_techniques.md | main | helm | [
-0.01030562724918127,
0.04307999461889267,
0.06582555919885635,
-0.0352957658469677,
-0.017268668860197067,
0.028838979080319405,
-0.02285044826567173,
-0.02159612439572811,
0.14373531937599182,
-0.006756508257240057,
-0.005041750147938728,
-0.04974840581417084,
-0.023814110085368156,
-0.0... | 0.100797 |
from the above error: ```yaml coffee: | # Commented first line Latte Cappuccino Espresso ``` Note that whatever that first line is, it will be preserved in the output of the string. So if you are, for example, using this technique to inject a file's contents into a ConfigMap, the comment should be of the type expected by whatever is reading that entry. ### Controlling Spaces in Multi-line Strings In the example above, we used `|` to indicate a multi-line string. But notice that the content of our string was followed with a trailing `\n`. If we want the YAML processor to strip off the trailing newline, we can add a `-` after the `|`: ```yaml coffee: |- Latte Cappuccino Espresso ``` Now the `coffee` value will be: `Latte\nCappuccino\nEspresso` (with no trailing `\n`). Other times, we might want all trailing whitespace to be preserved. We can do this with the `|+` notation: ```yaml coffee: |+ Latte Cappuccino Espresso another: value ``` Now the value of `coffee` will be `Latte\nCappuccino\nEspresso\n\n\n`. Indentation inside of a text block is preserved, and results in the preservation of line breaks, too: ```yaml coffee: |- Latte 12 oz 16 oz Cappuccino Espresso ``` In the above case, `coffee` will be `Latte\n 12 oz\n 16 oz\nCappuccino\nEspresso`. ### Indenting and Templates When writing templates, you may find yourself wanting to inject the contents of a file into the template. As we saw in previous chapters, there are two ways of doing this: - Use `{{ .Files.Get "FILENAME" }}` to get the contents of a file in the chart. - Use `{{ include "TEMPLATE" . }}` to render a template and then place its contents into the chart. When inserting files into YAML, it's good to understand the multi-line rules above. Often times, the easiest way to insert a static file is to do something like this: ```yaml myfile: | {{ .Files.Get "myfile.txt" | indent 2 }} ``` Note how we do the indentation above: `indent 2` tells the template engine to indent every line in "myfile.txt" with two spaces. Note that we do not indent that template line. That's because if we did, the file content of the first line would be indented twice. ### Folded Multi-line Strings Sometimes you want to represent a string in your YAML with multiple lines, but want it to be treated as one long line when it is interpreted. This is called "folding". To declare a folded block, use `>` instead of `|`: ```yaml coffee: > Latte Cappuccino Espresso ``` The value of `coffee` above will be `Latte Cappuccino Espresso\n`. Note that all but the last line feed will be converted to spaces. You can combine the whitespace controls with the folded text marker, so `>-` will replace or trim all newlines. Note that in the folded syntax, indenting text will cause lines to be preserved. ```yaml coffee: >- Latte 12 oz 16 oz Cappuccino Espresso ``` The above will produce `Latte\n 12 oz\n 16 oz\nCappuccino Espresso`. Note that both the spacing and the newlines are still there. ## Embedding Multiple Documents in One File It is possible to place more than one YAML document into a single file. This is done by prefixing a new document with `---` and ending the document with `...` ```yaml --- document: 1 ... --- document: 2 ... ``` In many cases, either the `---` or the `...` may be omitted. Some files in Helm cannot contain more than one doc. If, for example, more than one document is provided inside of a `values.yaml` file, only the first will be used. Template files, however, may have | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/yaml_techniques.md | main | helm | [
-0.06799507886171341,
0.0020937968511134386,
0.01564960926771164,
-0.0002328589907847345,
-0.03234757110476494,
-0.010705421678721905,
0.0721200555562973,
0.06808548420667648,
-0.02661866508424282,
-0.024208595976233482,
0.032726824283599854,
-0.06480971723794937,
0.04690118879079819,
-0.0... | 0.121488 |
2 ... ``` In many cases, either the `---` or the `...` may be omitted. Some files in Helm cannot contain more than one doc. If, for example, more than one document is provided inside of a `values.yaml` file, only the first will be used. Template files, however, may have more than one document. When this happens, the file (and all of its documents) is treated as one object during template rendering. But then the resulting YAML is split into multiple documents before it is fed to Kubernetes. We recommend only using multiple documents per file when it is absolutely necessary. Having multiple documents in a file can be difficult to debug. ## YAML is a Superset of JSON Because YAML is a superset of JSON, any valid JSON document \_should\_ be valid YAML. ```json { "coffee": "yes, please", "coffees": [ "Latte", "Cappuccino", "Espresso" ] } ``` The above is another way of representing this: ```yaml coffee: yes, please coffees: - Latte - Cappuccino - Espresso ``` And the two can be mixed (with care): ```yaml coffee: "yes, please" coffees: [ "Latte", "Cappuccino", "Espresso"] ``` All three of these should parse into the same internal representation. While this means that files such as `values.yaml` may contain JSON data, Helm does not treat the file extension `.json` as a valid suffix. ## YAML Anchors The YAML spec provides a way to store a reference to a value, and later refer to that value by reference. YAML refers to this as "anchoring": ```yaml coffee: "yes, please" favorite: &favoriteCoffee "Cappuccino" coffees: - Latte - \*favoriteCoffee - Espresso ``` In the above, `&favoriteCoffee` sets a reference to `Cappuccino`. Later, that reference is used as `\*favoriteCoffee`. So `coffees` becomes `Latte, Cappuccino, Espresso`. While there are a few cases where anchors are useful, there is one aspect of them that can cause subtle bugs: The first time the YAML is consumed, the reference is expanded and then discarded. So if we were to decode and then re-encode the example above, the resulting YAML would be: ```yaml coffee: yes, please favorite: Cappuccino coffees: - Latte - Cappuccino - Espresso ``` Because Helm and Kubernetes often read, modify, and then rewrite YAML files, the anchors will be lost. | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/yaml_techniques.md | main | helm | [
-0.021673941984772682,
0.08700753003358841,
0.08666479587554932,
-0.00788738951086998,
0.06626932322978973,
-0.008971478790044785,
-0.05041943117976189,
0.024528035894036293,
0.1546427458524704,
0.005127951502799988,
-0.008679669350385666,
-0.006525272969156504,
-0.0035990586038678885,
-0.... | 0.071181 |
It is time to move beyond one template, and begin to create others. In this section, we will see how to define \_named templates\_ in one file, and then use them elsewhere. A \_named template\_ (sometimes called a \_partial\_ or a \_subtemplate\_) is simply a template defined inside of a file, and given a name. We'll see two ways to create them, and a few different ways to use them. In the [Flow Control](/chart\_template\_guide/control\_structures.md) section we introduced three actions for declaring and managing templates: `define`, `template`, and `block`. In this section, we'll cover those three actions, and also introduce a special-purpose `include` function that works similarly to the `template` action. An important detail to keep in mind when naming templates: \*\*template names are global\*\*. If you declare two templates with the same name, whichever one is loaded last will be the one used. Because templates in subcharts are compiled together with top-level templates, you should be careful to name your templates with \_chart-specific names\_. One popular naming convention is to prefix each defined template with the name of the chart: `{{ define "mychart.labels" }}`. By using the specific chart name as a prefix we can avoid any conflicts that may arise due to two different charts that implement templates of the same name. This behavior also applies to different versions of a chart. If you have `mychart` version `1.0.0` that defines a template one way, and a `mychart` version `2.0.0` that modifies the existing named template, it will use the one that was loaded last. You can work around this issue by also adding a version in the name of the chart: `{{ define "mychart.v1.labels" }}` and `{{ define "mychart.v2.labels" }}`. ## Partials and `\_` files So far, we've used one file, and that one file has contained a single template. But Helm's template language allows you to create named embedded templates, that can be accessed by name elsewhere. Before we get to the nuts-and-bolts of writing those templates, there is file naming convention that deserves mention: \* Most files in `templates/` are treated as if they contain Kubernetes manifests \* The `NOTES.txt` is one exception \* But files whose name begins with an underscore (`\_`) are assumed to \_not\_ have a manifest inside. These files are not rendered to Kubernetes object definitions, but are available everywhere within other chart templates for use. These files are used to store partials and helpers. In fact, when we first created `mychart`, we saw a file called `\_helpers.tpl`. That file is the default location for template partials. ## Declaring and using templates with `define` and `template` The `define` action allows us to create a named template inside of a template file. Its syntax goes like this: ```yaml {{- define "MY.NAME" }} # body of template here {{- end }} ``` For example, we can define a template to encapsulate a Kubernetes block of labels: ```yaml {{- define "mychart.labels" }} labels: generator: helm date: {{ now | htmlDate }} {{- end }} ``` Now we can embed this template inside of our existing ConfigMap, and then include it with the `template` action: ```yaml {{- define "mychart.labels" }} labels: generator: helm date: {{ now | htmlDate }} {{- end }} apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap {{- template "mychart.labels" }} data: myvalue: "Hello World" {{- range $key, $val := .Values.favorite }} {{ $key }}: {{ $val | quote }} {{- end }} ``` When the template engine reads this file, it will store away the reference to `mychart.labels` until `template "mychart.labels"` is called. Then it will render that template inline. So the | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/named_templates.md | main | helm | [
-0.08279820531606674,
0.01876172050833702,
0.07086183875799179,
0.0037044319324195385,
0.00524125574156642,
0.054613880813121796,
-0.0724480152130127,
0.06829988956451416,
0.06517674028873444,
-0.024219857528805733,
-0.04016602411866188,
-0.034157894551754,
0.0011319537879899144,
0.0064822... | 0.056022 |
"Hello World" {{- range $key, $val := .Values.favorite }} {{ $key }}: {{ $val | quote }} {{- end }} ``` When the template engine reads this file, it will store away the reference to `mychart.labels` until `template "mychart.labels"` is called. Then it will render that template inline. So the result will look like this: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: running-panda-configmap labels: generator: helm date: 2016-11-02 data: myvalue: "Hello World" drink: "coffee" food: "pizza" ``` Note: a `define` does not produce output unless it is called with a template, as in this example. Conventionally, Helm charts put these templates inside of a partials file, usually `\_helpers.tpl`. Let's move this function there: ```yaml {{/\* Generate basic labels \*/}} {{- define "mychart.labels" }} labels: generator: helm date: {{ now | htmlDate }} {{- end }} ``` By convention, `define` functions should have a simple documentation block (`{{/\* ... \*/}}`) describing what they do. Even though this definition is in `\_helpers.tpl`, it can still be accessed in `configmap.yaml`: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap {{- template "mychart.labels" }} data: myvalue: "Hello World" {{- range $key, $val := .Values.favorite }} {{ $key }}: {{ $val | quote }} {{- end }} ``` As mentioned above, \*\*template names are global\*\*. As a result of this, if two templates are declared with the same name the last occurrence will be the one that is used. Since templates in subcharts are compiled together with top-level templates, it is best to name your templates with \_chart specific names\_. A popular naming convention is to prefix each defined template with the name of the chart: `{{ define "mychart.labels" }}`. ## Setting the scope of a template In the template we defined above, we did not use any objects. We just used functions. Let's modify our defined template to include the chart name and chart version: ```yaml {{/\* Generate basic labels \*/}} {{- define "mychart.labels" }} labels: generator: helm date: {{ now | htmlDate }} chart: {{ .Chart.Name }} version: {{ .Chart.Version }} {{- end }} ``` If we render this, we will get an error like this: ```console $ helm install --dry-run moldy-jaguar ./mychart Error: unable to build kubernetes objects from release manifest: error validating "": error validating data: [unknown object type "nil" in ConfigMap.metadata.labels.chart, unknown object type "nil" in ConfigMap.metadata.labels.version] ``` To see what rendered, re-run with `--disable-openapi-validation`: `helm install --dry-run --disable-openapi-validation moldy-jaguar ./mychart`. The result will not be what we expect: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: moldy-jaguar-configmap labels: generator: helm date: 2021-03-06 chart: version: ``` What happened to the name and version? They weren't in the scope for our defined template. When a named template (created with `define`) is rendered, it will receive the scope passed in by the `template` call. In our example, we included the template like this: ```yaml {{- template "mychart.labels" }} ``` No scope was passed in, so within the template we cannot access anything in `.`. This is easy enough to fix, though. We simply pass a scope to the template: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap {{- template "mychart.labels" . }} ``` Note that we pass `.` at the end of the `template` call. We could just as easily pass `.Values` or `.Values.favorite` or whatever scope we want. But what we want is the top-level scope. In the context of the named template, `$` will refer to the scope you passed in and not some global scope. Now when we execute this template with `helm install --dry-run --debug plinking-anaco ./mychart`, we get this: | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/named_templates.md | main | helm | [
0.007286531385034323,
0.10455573350191116,
0.040258221328258514,
0.006291765719652176,
0.04072250798344612,
0.017787707969546318,
0.005159509833902121,
0.01307178195565939,
0.052121348679065704,
-0.02993904799222946,
0.008326134644448757,
-0.026053352281451225,
-0.023985275998711586,
-0.07... | -0.01474 |
or whatever scope we want. But what we want is the top-level scope. In the context of the named template, `$` will refer to the scope you passed in and not some global scope. Now when we execute this template with `helm install --dry-run --debug plinking-anaco ./mychart`, we get this: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: plinking-anaco-configmap labels: generator: helm date: 2021-03-06 chart: mychart version: 0.1.0 ``` Now `{{ .Chart.Name }}` resolves to `mychart`, and `{{ .Chart.Version }}` resolves to `0.1.0`. ## The `include` function Say we've defined a simple template that looks like this: ```yaml {{- define "mychart.app" -}} app\_name: {{ .Chart.Name }} app\_version: "{{ .Chart.Version }}" {{- end -}} ``` Now say I want to insert this both into the `labels:` section of my template, and also the `data:` section: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap labels: {{ template "mychart.app" . }} data: myvalue: "Hello World" {{- range $key, $val := .Values.favorite }} {{ $key }}: {{ $val | quote }} {{- end }} {{ template "mychart.app" . }} ``` If we render this, we will get an error like this: ```console $ helm install --dry-run measly-whippet ./mychart Error: unable to build kubernetes objects from release manifest: error validating "": error validating data: [ValidationError(ConfigMap): unknown field "app\_name" in io.k8s.api.core.v1.ConfigMap, ValidationError(ConfigMap): unknown field "app\_version" in io.k8s.api.core.v1.ConfigMap] ``` To see what rendered, re-run with `--disable-openapi-validation`: `helm install --dry-run --disable-openapi-validation measly-whippet ./mychart`. The output will not be what we expect: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: measly-whippet-configmap labels: app\_name: mychart app\_version: "0.1.0" data: myvalue: "Hello World" drink: "coffee" food: "pizza" app\_name: mychart app\_version: "0.1.0" ``` Note that the indentation on `app\_version` is wrong in both places. Why? Because the template that is substituted in has the text aligned to the left. Because `template` is an action, and not a function, there is no way to pass the output of a `template` call to other functions; the data is simply inserted inline. To work around this case, Helm provides an alternative to `template` that will import the contents of a template into the present pipeline where it can be passed along to other functions in the pipeline. Here's the example above, corrected to use `indent` to indent the `mychart.app` template correctly: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap labels: {{ include "mychart.app" . | indent 4 }} data: myvalue: "Hello World" {{- range $key, $val := .Values.favorite }} {{ $key }}: {{ $val | quote }} {{- end }} {{ include "mychart.app" . | indent 2 }} ``` Now the produced YAML is correctly indented for each section: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: edgy-mole-configmap labels: app\_name: mychart app\_version: "0.1.0" data: myvalue: "Hello World" drink: "coffee" food: "pizza" app\_name: mychart app\_version: "0.1.0" ``` > It is considered preferable to use `include` over `template` in Helm templates > simply so that the output formatting can be handled better for YAML documents. Sometimes we want to import content, but not as templates. That is, we want to import files verbatim. We can achieve this by accessing files through the `.Files` object described in the next section. | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/named_templates.md | main | helm | [
0.03782517462968826,
0.05817186459898949,
0.09421022981405258,
0.01497680228203535,
0.061465971171855927,
-0.015987541526556015,
0.009423535317182541,
0.034138645976781845,
0.0067309169098734856,
0.018024202436208725,
0.02107585035264492,
-0.04137679934501648,
-0.017301183193922043,
0.0227... | 0.009903 |
The Helm template language is implemented in the strongly typed Go programming language. For that reason, variables in templates are \_typed\_. For the most part, variables will be exposed as one of the following types: - string: A string of text - bool: a `true` or `false` - int: An integer value (there are also 8, 16, 32, and 64 bit signed and unsigned variants of this) - float64: a 64-bit floating point value (there are also 8, 16, and 32 bit varieties of this) - a byte slice (`[]byte`), often used to hold (potentially) binary data - struct: an object with properties and methods - a slice (indexed list) of one of the previous types - a string-keyed map (`map[string]interface{}`) where the value is one of the previous types There are many other types in Go, and sometimes you will have to convert between them in your templates. The easiest way to debug an object's type is to pass it through `printf "%T"` in a template, which will print the type. Also see the `typeOf` and `kindOf` functions. | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/data_types.md | main | helm | [
0.04056200012564659,
0.11497721821069717,
0.013780280016362667,
0.011829908937215805,
0.004968242719769478,
0.02758735790848732,
0.02541687898337841,
0.04122094810009003,
0.002912450348958373,
-0.027562621980905533,
0.019459422677755356,
-0.01095360517501831,
-0.06236077472567558,
0.041278... | 0.116161 |
Debugging templates can be tricky because the rendered templates are sent to the Kubernetes API server, which may reject the YAML files for reasons other than formatting. There are a few commands that can help you debug. - `helm lint` is your go-to tool for verifying that your chart follows best practices - `helm template --debug` will test rendering chart templates locally. - `helm install --dry-run --debug` will also render your chart locally without installing it, but will also check if conflicting resources are already running on the cluster. Setting `--dry-run=server` will additionally execute any `lookup` in your chart towards the server. - `helm get manifest`: This is a good way to see what templates are installed on the server. When your YAML is failing to parse, but you want to see what is generated, one easy way to retrieve the YAML is to comment out the problem section in the template, and then re-run `helm install --dry-run --debug`: ```yaml apiVersion: v2 # some: problem section # {{ .Values.foo | quote }} ``` The above will be rendered and returned with the comments intact: ```yaml apiVersion: v2 # some: problem section # "bar" ``` This provides a quick way of viewing the generated content without YAML parse errors blocking. | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/debugging.md | main | helm | [
0.03920499235391617,
0.04428136348724365,
0.13121911883354187,
-0.03406552970409393,
0.06206374987959862,
-0.02343890815973282,
-0.11989785730838776,
-0.006770165637135506,
0.05783507972955704,
0.047356799244880676,
-0.0002671151014510542,
-0.06915275007486343,
-0.04543420299887657,
-0.050... | -0.002311 |
With functions, pipelines, objects, and control structures under our belts, we can turn to one of the more basic ideas in many programming languages: variables. In templates, they are less frequently used. But we will see how to use them to simplify code, and to make better use of `with` and `range`. In an earlier example, we saw that this code will fail: ```yaml {{- with .Values.favorite }} drink: {{ .drink | default "tea" | quote }} food: {{ .food | upper | quote }} release: {{ .Release.Name }} {{- end }} ``` `Release.Name` is not inside of the scope that's restricted in the `with` block. One way to work around scoping issues is to assign objects to variables that can be accessed without respect to the present scope. In Helm templates, a variable is a named reference to another object. It follows the form `$name`. Variables are assigned with a special assignment operator: `:=`. We can rewrite the above to use a variable for `Release.Name`. ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" {{- $relname := .Release.Name -}} {{- with .Values.favorite }} drink: {{ .drink | default "tea" | quote }} food: {{ .food | upper | quote }} release: {{ $relname }} {{- end }} ``` Notice that before we start the `with` block, we assign `$relname := .Release.Name`. Now inside of the `with` block, the `$relname` variable still points to the release name. Running that will produce this: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: viable-badger-configmap data: myvalue: "Hello World" drink: "coffee" food: "PIZZA" release: viable-badger ``` Variables are particularly useful in `range` loops. They can be used on list-like objects to capture both the index and the value: ```yaml toppings: |- {{- range $index, $topping := .Values.pizzaToppings }} {{ $index }}: {{ $topping }} {{- end }} ``` Note that `range` comes first, then the variables, then the assignment operator, then the list. This will assign the integer index (starting from zero) to `$index` and the value to `$topping`. Running it will produce: ```yaml toppings: |- 0: mushrooms 1: cheese 2: peppers 3: onions ``` For data structures that have both a key and a value, we can use `range` to get both. For example, we can loop through `.Values.favorite` like this: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: {{ .Release.Name }}-configmap data: myvalue: "Hello World" {{- range $key, $val := .Values.favorite }} {{ $key }}: {{ $val | quote }} {{- end }} ``` Now on the first iteration, `$key` will be `drink` and `$val` will be `coffee`, and on the second, `$key` will be `food` and `$val` will be `pizza`. Running the above will generate this: ```yaml # Source: mychart/templates/configmap.yaml apiVersion: v1 kind: ConfigMap metadata: name: eager-rabbit-configmap data: myvalue: "Hello World" drink: "coffee" food: "pizza" ``` Variables are normally not "global". They are scoped to the block in which they are declared. Earlier, we assigned `$relname` in the top level of the template. That variable will be in scope for the entire template. But in our last example, `$key` and `$val` will only be in scope inside of the `{{ range... }}{{ end }}` block. However, there is one variable that will always point to the root context: - `$` -. This can be very useful when you are looping in a range and you need to know the chart's release name. An example illustrating this: ```yaml {{- range .Values.tlsSecrets }} --- apiVersion: v1 kind: Secret metadata: name: {{ .name }} labels: # Many helm templates would use `.` below, but that will not work, | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/variables.md | main | helm | [
-0.00692763039842248,
0.10820578783750534,
0.05053931474685669,
0.028704803436994553,
-0.014204529114067554,
0.017524929717183113,
0.02418106608092785,
0.020130371674895287,
0.0378529392182827,
-0.03105725720524788,
0.032160378992557526,
-0.005867341533303261,
-0.032996147871017456,
0.0090... | 0.057377 |
useful when you are looping in a range and you need to know the chart's release name. An example illustrating this: ```yaml {{- range .Values.tlsSecrets }} --- apiVersion: v1 kind: Secret metadata: name: {{ .name }} labels: # Many helm templates would use `.` below, but that will not work, # however `$` will work here app.kubernetes.io/name: {{ template "fullname" $ }} # I cannot reference .Chart.Name, but I can do $.Chart.Name helm.sh/chart: "{{ $.Chart.Name }}-{{ $.Chart.Version }}" app.kubernetes.io/instance: "{{ $.Release.Name }}" # Value from appVersion in Chart.yaml app.kubernetes.io/version: "{{ $.Chart.AppVersion }}" app.kubernetes.io/managed-by: "{{ $.Release.Service }}" type: kubernetes.io/tls data: tls.crt: {{ .certificate }} tls.key: {{ .key }} {{- end }} ``` So far we have looked at just one template declared in just one file. But one of the powerful features of the Helm template language is its ability to declare multiple templates and use them together. We'll turn to that in the next section. | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/variables.md | main | helm | [
0.05411377549171448,
0.1072353795170784,
0.06580597907304764,
-0.023452870547771454,
0.03435457497835159,
0.023840250447392464,
0.019866986200213432,
0.002378263743594289,
0.13090337812900543,
-0.009749806486070156,
0.017815470695495605,
-0.04979700967669487,
0.0015087838983163238,
-0.0143... | -0.000592 |
This guide is intended to give you, the chart developer, a strong understanding of how to use Helm's template language. The guide focuses on the technical aspects of template development. But there are many things this guide has not covered when it comes to the practical day-to-day development of charts. Here are some useful pointers to other documentation that will help you as you create new charts: - The CNCF [Artifact Hub](https://artifacthub.io/packages/search?kind=0) is an indispensable source of charts. - The Kubernetes [Documentation](https://kubernetes.io/docs/home/) provides detailed examples of the various resource kinds that you can use, from ConfigMaps and Secrets to DaemonSets and Deployments. - The Helm [Charts Guide](/topics/charts.mdx) explains the workflow of using charts. - The Helm [Chart Hooks Guide](/topics/charts\_hooks.md) explains how to create lifecycle hooks. - The Helm [Charts Tips and Tricks](/howto/charts\_tips\_and\_tricks.md) article provides some useful tips for writing charts. - The [Sprig documentation](https://github.com/Masterminds/sprig) documents more than sixty of the template functions. - The [Go template docs](https://godoc.org/text/template) explain the template syntax in detail. - The [Schelm tool](https://github.com/databus23/schelm) is a nice helper utility for debugging charts. Sometimes it's easier to ask a few questions and get answers from experienced developers. The best place to do this is in the [Kubernetes Slack](https://kubernetes.slack.com) Helm channels: - [#helm-users](https://kubernetes.slack.com/messages/helm-users) - [#helm-dev](https://kubernetes.slack.com/messages/helm-dev) - [#charts](https://kubernetes.slack.com/messages/charts) Finally, if you find errors or omissions in this document, want to suggest some new content, or would like to contribute, visit [The Helm Project](https://github.com/helm/helm-www). | https://github.com/helm/helm-www/blob/main//docs/chart_template_guide/wrapping_up.md | main | helm | [
0.011021994054317474,
0.02722698450088501,
0.04661722108721733,
-0.04785694181919098,
0.02318653091788292,
0.049011245369911194,
-0.04329242929816246,
0.05844046548008919,
0.02295359969139099,
0.05493086576461792,
-0.014040767215192318,
-0.05113859102129936,
0.004985482431948185,
-0.021241... | 0.102726 |
This guide describes how to use [Chart Releaser Action](https://github.com/marketplace/actions/helm-chart-releaser) to automate releasing charts through GitHub pages. 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. ## Repository Changes Create a Git repository under your GitHub organization. You could give the name of the repository as `helm-charts`, though other names are also acceptable. The sources of all the charts can be placed under the `main` branch. The charts should be placed under `/charts` directory at the top-level of the directory tree. There should be another branch named `gh-pages` to publish the charts. The changes to that branch will be automatically created by the Chart Releaser Action described here. However, you can create that `gh-branch` and add `README.md` file, which is going to be visible to the users visiting the page. You can add instruction in the `README.md` for charts installation like this (replace ``, ``, and ``): ``` ## Usage [Helm](https://helm.sh) must be installed to use the charts. Please refer to Helm's [documentation](https://helm.sh/docs) to get started. Once Helm has been set up correctly, add the repo as follows: helm repo add https://.github.io/helm-charts If you had already added this repo earlier, run `helm repo update` to retrieve the latest versions of the packages. You can then run `helm search repo ` to see the charts. To install the chart: helm install my- / To uninstall the chart: helm uninstall my- ``` The charts will be published to a website with URL like this: https://.github.io/helm-charts ## GitHub Actions Workflow Create GitHub Actions workflow file in the `main` branch at `.github/workflows/release.yml` ``` name: Release Charts on: push: branches: - main jobs: release: permissions: contents: write runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 - name: Configure Git run: | git config user.name "$GITHUB\_ACTOR" git config user.email "$GITHUB\_ACTOR@users.noreply.github.com" - name: Run chart-releaser uses: helm/chart-releaser-action@v1.6.0 env: CR\_TOKEN: "${{ secrets.GITHUB\_TOKEN }}" ``` The above configuration uses [@helm/chart-releaser-action](https://github.com/helm/chart-releaser-action) to turn your GitHub project into a self-hosted Helm chart repo. It does this - during every push to main - by checking each chart in your project, and whenever there's a new chart version, creates a corresponding GitHub release named for the chart version, adds Helm chart artifacts to the release, and creates or updates an `index.yaml` file with metadata about those releases, which is then hosted on GitHub pages. The Chart Releaser Action version number used in the above example is `v1.6.0`. You can change it to the [latest available version](https://github.com/helm/chart-releaser-action/releases). Note: The Chart Releaser Action is almost always used in tandem with the [Helm Testing Action](https://github.com/marketplace/actions/helm-chart-testing) and [Kind Action](https://github.com/marketplace/actions/kind-cluster). | https://github.com/helm/helm-www/blob/main//docs/howto/chart_releaser_action.md | main | helm | [
0.01996789127588272,
-0.029262015596032143,
-0.019263558089733124,
-0.04247938096523285,
0.03329586610198021,
0.01247325912117958,
-0.07941971719264984,
0.0525425523519516,
0.016955502331256866,
0.09972050040960312,
0.03077828697860241,
0.024682074785232544,
0.06141636148095131,
-0.0340991... | 0.005901 |
This guide covers some of the tips and tricks Helm chart developers have learned while building production-quality charts. ## Know Your Template Functions Helm uses [Go templates](https://godoc.org/text/template) for templating your resource files. While Go ships several built-in functions, we have added many others. First, we added all of the functions in the [Sprig library](https://masterminds.github.io/sprig/), except `env` and `expandenv`, for security reasons. We also added two special template functions: `include` and `required`. The `include` function allows you to bring in another template, and then pass the results to other template functions. The `required` function allows you to declare a particular values entry as required for template rendering. If the value is empty, the template rendering will fail with a user submitted error message. ### Using the 'include' Function Go provides a way of including one template in another using a built-in `template` directive. However, the built-in function cannot be used in Go template pipelines. To make it possible to include a template, and then perform an operation on that template's output, Helm has a special `include` function: ``` {{ include "toYaml" $value | indent 2 }} ``` The above includes a template called `toYaml`, passes it `$value`, and then passes the output of that template to the `indent` function. Because YAML ascribes significance to indentation levels and whitespace, this is one great way to include snippets of code, but handle indentation in a relevant context. This template snippet includes a template called `mytpl`, then lowercases the result, then wraps that in double quotes. ```yaml value: {{ include "mytpl" . | lower | quote }} ``` ### Using the 'required' function Go provides a `missingkey` template option to control behavior when a map is indexed with a key that's not present in the map. There may be situations where a chart developer wants to enforce this behavior for select values in the `values.yaml` file. The `required` function gives developers the ability to declare a value entry as required for template rendering. If the entry is empty in `values.yaml`, the template will not render and will return an error message supplied by the developer. For example: ``` {{ required "A valid foo is required!" .Values.foo }} ``` The above will render the template when `.Values.foo` is defined, but will fail to render and exit when `.Values.foo` is undefined. The following example of the `required` function declares an entry for `.Values.who` is required, and will print an error message when that entry is missing: ```yaml value: {{ required "A valid .Values.who entry required!" .Values.who }} ``` ## Quote Strings, Don't Quote Integers When you are working with string data, you are always safer quoting the strings than leaving them as bare words: ```yaml name: {{ .Values.MyName | quote }} ``` But when working with integers \_do not quote the values.\_ That can, in many cases, cause parsing errors inside of Kubernetes. ```yaml port: {{ .Values.Port }} ``` This remark does not apply to env variables values which are expected to be string, even if they represent integers: ```yaml env: - name: HOST value: "http://host" - name: PORT value: "1234" ``` ## Using the 'tpl' Function The `tpl` function allows developers to evaluate strings as templates inside a template. This is useful to pass a template string as a value to a chart or render external configuration files. Syntax: `{{ tpl TEMPLATE\_STRING VALUES }}` Examples: ```yaml # values template: "{{ .Values.name }}" name: "Tom" # template {{ tpl .Values.template . }} # output Tom ``` Rendering an external configuration file: ```yaml # external configuration file conf/app.conf firstName={{ .Values.firstName }} lastName={{ .Values.lastName }} # values firstName: | https://github.com/helm/helm-www/blob/main//docs/howto/charts_tips_and_tricks.md | main | helm | [
0.024703258648514748,
0.0876886174082756,
0.033337440341711044,
-0.03699028491973877,
0.05592818185687065,
0.048817094415426254,
-0.05845841392874718,
0.06238044798374176,
0.005571137182414532,
-0.018460066989064217,
0.0291203111410141,
-0.02924797683954239,
-0.001824912615120411,
0.023382... | -0.00767 |
external configuration files. Syntax: `{{ tpl TEMPLATE\_STRING VALUES }}` Examples: ```yaml # values template: "{{ .Values.name }}" name: "Tom" # template {{ tpl .Values.template . }} # output Tom ``` Rendering an external configuration file: ```yaml # external configuration file conf/app.conf firstName={{ .Values.firstName }} lastName={{ .Values.lastName }} # values firstName: Peter lastName: Parker # template {{ tpl (.Files.Get "conf/app.conf") . }} # output firstName=Peter lastName=Parker ``` ## Creating Image Pull Secrets Image pull secrets are essentially a combination of \_registry\_, \_username\_, and \_password\_. You may need them in an application you are deploying, but to create them requires running `base64` a couple of times. We can write a helper template to compose the Docker configuration file for use as the Secret's payload. Here is an example: First, assume that the credentials are defined in the `values.yaml` file like so: ```yaml imageCredentials: registry: quay.io username: someone password: sillyness email: someone@host.com ``` We then define our helper template as follows: ``` {{- define "imagePullSecret" }} {{- with .Values.imageCredentials }} {{- printf "{\"auths\":{\"%s\":{\"username\":\"%s\",\"password\":%s,\"email\":\"%s\",\"auth\":\"%s\"}}}" .registry .username (.password | quote) .email (printf "%s:%s" .username .password | b64enc) | b64enc }} {{- end }} {{- end }} ``` Finally, we use the helper template in a larger template to create the Secret manifest: ```yaml apiVersion: v1 kind: Secret metadata: name: myregistrykey type: kubernetes.io/dockerconfigjson data: .dockerconfigjson: {{ template "imagePullSecret" . }} ``` ## Automatically Roll Deployments Often times ConfigMaps or Secrets are injected as configuration files in containers or there are other external dependency changes that require rolling pods. Depending on the application a restart may be required should those be updated with a subsequent `helm upgrade`, but if the deployment spec itself didn't change the application keeps running with the old configuration resulting in an inconsistent deployment. The `sha256sum` function can be used to ensure a deployment's annotation section is updated if another file changes: ```yaml kind: Deployment spec: template: metadata: annotations: checksum/config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }} [...] ``` NOTE: If you're adding this to a library chart you won't be able to access your file in `$.Template.BasePath`. Instead you can reference your definition with `{{ include ("mylibchart.configmap") . | sha256sum }}`. In the event you always want to roll your deployment, you can use a similar annotation step as above, instead replacing with a random string so it always changes and causes the deployment to roll: ```yaml kind: Deployment spec: template: metadata: annotations: rollme: {{ randAlphaNum 5 | quote }} [...] ``` Each invocation of the template function will generate a unique random string. This means that if it's necessary to sync the random strings used by multiple resources, all relevant resources will need to be in the same template file. Both of these methods allow your Deployment to leverage the built in update strategy logic to avoid taking downtime. NOTE: In the past we recommended using the `--recreate-pods` flag as another option. This flag has been marked as deprecated in Helm 3 in favor of the more declarative method above. ## Tell Helm Not To Uninstall a Resource Sometimes there are resources that should not be uninstalled when Helm runs a `helm uninstall`. Chart developers can add an annotation to a resource to prevent it from being uninstalled. ```yaml kind: Secret metadata: annotations: helm.sh/resource-policy: keep [...] ``` The annotation `helm.sh/resource-policy: keep` instructs Helm to skip deleting this resource when a helm operation (such as `helm uninstall`, `helm upgrade` or `helm rollback`) would result in its deletion. \_However\_, this resource becomes orphaned. Helm will no longer manage it in any way. This can lead to problems if using `helm install | https://github.com/helm/helm-www/blob/main//docs/howto/charts_tips_and_tricks.md | main | helm | [
-0.10118314623832703,
0.06768808513879776,
-0.035582851618528366,
-0.047157272696495056,
-0.022416170686483383,
-0.022912856191396713,
0.04059531167149544,
0.11384092271327972,
0.0010378940496593714,
-0.006471175700426102,
0.006923376116901636,
-0.055982574820518494,
0.03225330263376236,
-... | 0.027959 |
`helm.sh/resource-policy: keep` instructs Helm to skip deleting this resource when a helm operation (such as `helm uninstall`, `helm upgrade` or `helm rollback`) would result in its deletion. \_However\_, this resource becomes orphaned. Helm will no longer manage it in any way. This can lead to problems if using `helm install --replace` on a release that has already been uninstalled, but has kept resources. ## Using "Partials" and Template Includes Sometimes you want to create some reusable parts in your chart, whether they're blocks or template partials. And often, it's cleaner to keep these in their own files. 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 `\_helpers.tpl` file. ## Complex Charts with Many Dependencies Many of the charts in the CNCF [Artifact Hub](https://artifacthub.io/packages/search?kind=0) are "building blocks" for creating more advanced applications. But charts may be used to create instances of large-scale applications. In such cases, a single umbrella chart may have multiple subcharts, each of which functions as a piece of the whole. The current best practice for composing a complex application from discrete parts is to create a top-level umbrella chart that exposes the global configurations, and then use the `charts/` subdirectory to embed each of the components. ## YAML is a Superset of JSON According to the YAML specification, YAML is a superset of JSON. That means that any valid JSON structure ought to be valid in YAML. This has an advantage: Sometimes template developers may find it easier to express a datastructure with a JSON-like syntax rather than deal with YAML's whitespace sensitivity. As a best practice, templates should follow a YAML-like syntax \_unless\_ the JSON syntax substantially reduces the risk of a formatting issue. ## Be Careful with Generating Random Values There are functions in Helm that allow you to generate random data, cryptographic keys, and so on. These are fine to use. But be aware that during upgrades, templates are re-executed. When a template run generates data that differs from the last run, that will trigger an update of that resource. ## Install or Upgrade a Release with One Command Helm provides a way to perform an install-or-upgrade as a single command. Use `helm upgrade` with the `--install` command. This will cause Helm to see if the release is already installed. If not, it will run an install. If it is, then the existing release will be upgraded. ```console $ helm upgrade --install --values ``` | https://github.com/helm/helm-www/blob/main//docs/howto/charts_tips_and_tricks.md | main | helm | [
-0.05624696612358093,
0.09520439803600311,
0.08911294490098953,
-0.052204031497240067,
0.08225014060735703,
0.014654990285634995,
-0.034083109349012375,
-0.02638726681470871,
0.1007571667432785,
0.026868605986237526,
0.03660937398672104,
-0.021962320432066917,
0.02682122029364109,
-0.01477... | 0.047277 |
\*Note: This example is specifically for a Google Cloud Storage (GCS) bucket which serves a chart repository.\* ## Prerequisites \* Install the [gsutil](https://cloud.google.com/storage/docs/gsutil) tool. \*We rely heavily on the gsutil rsync functionality\* \* Be sure to have access to the Helm binary \* \_Optional: We recommend you set [object versioning](https://cloud.google.com/storage/docs/gsutil/addlhelp/ObjectVersioningandConcurrencyControl#top\_of\_page) on your GCS bucket in case you accidentally delete something.\_ ## Set up a local chart repository directory Create a local directory like we did in [the chart repository guide](/topics/chart\_repository.md), and place your packaged charts in that directory. For example: ```console $ mkdir fantastic-charts $ mv alpine-0.1.0.tgz fantastic-charts/ ``` ## Generate an updated index.yaml Use Helm to generate an updated index.yaml file by passing in the directory path and the url of the remote repository to the `helm repo index` command like this: ```console $ helm repo index fantastic-charts/ --url https://fantastic-charts.storage.googleapis.com ``` This will generate an updated index.yaml file and place it in the `fantastic-charts/` directory. ## Sync your local and remote chart repositories Upload the contents of the directory to your GCS bucket by running `scripts/sync-repo.sh` and pass in the local directory name and the GCS bucket name. For example: ```console $ pwd /Users/me/code/go/src/helm.sh/helm $ scripts/sync-repo.sh fantastic-charts/ fantastic-charts Getting ready to sync your local directory (fantastic-charts/) to a remote repository at gs://fantastic-charts Verifying Prerequisites.... Thumbs up! Looks like you have gsutil. Let's continue. Building synchronization state... Starting synchronization Would copy file://fantastic-charts/alpine-0.1.0.tgz to gs://fantastic-charts/alpine-0.1.0.tgz Would copy file://fantastic-charts/index.yaml to gs://fantastic-charts/index.yaml Are you sure you would like to continue with these changes?? [y/N]} y Building synchronization state... Starting synchronization Copying file://fantastic-charts/alpine-0.1.0.tgz [Content-Type=application/x-tar]... Uploading gs://fantastic-charts/alpine-0.1.0.tgz: 740 B/740 B Copying file://fantastic-charts/index.yaml [Content-Type=application/octet-stream]... Uploading gs://fantastic-charts/index.yaml: 347 B/347 B Congratulations your remote chart repository now matches the contents of fantastic-charts/ ``` ## Updating your chart repository You'll want to keep a local copy of the contents of your chart repository or use `gsutil rsync` to copy the contents of your remote chart repository to a local directory. For example: ```console $ gsutil rsync -d -n gs://bucket-name local-dir/ # the -n flag does a dry run Building synchronization state... Starting synchronization Would copy gs://bucket-name/alpine-0.1.0.tgz to file://local-dir/alpine-0.1.0.tgz Would copy gs://bucket-name/index.yaml to file://local-dir/index.yaml $ gsutil rsync -d gs://bucket-name local-dir/ # performs the copy actions Building synchronization state... Starting synchronization Copying gs://bucket-name/alpine-0.1.0.tgz... Downloading file://local-dir/alpine-0.1.0.tgz: 740 B/740 B Copying gs://bucket-name/index.yaml... Downloading file://local-dir/index.yaml: 346 B/346 B ``` Helpful Links: \* Documentation on [gsutil rsync](https://cloud.google.com/storage/docs/gsutil/commands/rsync#description) \* [The Chart Repository Guide](/topics/chart\_repository.md) \* Documentation on [object versioning and concurrency control](https://cloud.google.com/storage/docs/gsutil/addlhelp/ObjectVersioningandConcurrencyControl#overview) in Google Cloud Storage | https://github.com/helm/helm-www/blob/main//docs/howto/chart_repository_sync_example.md | main | helm | [
-0.030049119144678116,
-0.00757767865434289,
-0.009463260881602764,
-0.0009305590065196157,
0.05711705982685089,
-0.0025530687998980284,
-0.06213457137346268,
-0.0060684289783239365,
0.04848058149218559,
0.07070795446634293,
0.020009851083159447,
-0.018159987404942513,
0.062466587871313095,
... | -0.06361 |
download the manifest for a named release ### Synopsis This command fetches the generated manifest for a given release. A manifest is a YAML-encoded representation of the Kubernetes resources that were generated from this release's chart(s). If a chart is dependent on other charts, those resources will also be included in the manifest. ``` helm get manifest RELEASE\_NAME [flags] ``` ### Options ``` -h, --help help for manifest --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_manifest.md | main | helm | [
0.069304920732975,
0.0579669252038002,
0.06166458874940872,
-0.06627584993839264,
0.05848192051053047,
-0.0030052175279706717,
-0.005966201424598694,
0.010885866358876228,
0.06946350634098053,
0.05979521945118904,
0.01535546313971281,
-0.06666021049022675,
-0.013004625216126442,
-0.0346754... | 0.108551 |
login to or logout from a registry ### Synopsis This command consists of multiple subcommands to interact with registries. ### Options ``` -h, --help help for registry ``` ### 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 registry login](/helm/helm\_registry\_login.md) - login to a registry \* [helm registry logout](/helm/helm\_registry\_logout.md) - 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.md | main | helm | [
0.03208918869495392,
0.05668433755636215,
-0.01929553970694542,
-0.04697093740105629,
-0.02752833627164364,
0.001234258059412241,
0.02236168272793293,
0.00641781697049737,
0.06817951053380966,
0.04595201835036278,
-0.0019799445290118456,
-0.059631142765283585,
0.03592846915125847,
-0.02931... | 0.125002 |
verify that a plugin at the given path has been signed and is valid ### Synopsis This command verifies that a Helm plugin has a valid provenance file, and that the provenance file is signed by a trusted PGP key. It supports both: - Plugin tarballs (.tgz or .tar.gz files) - Installed plugin directories For installed plugins, use the path shown by 'helm env HELM\_PLUGINS' followed by the plugin name. For example: helm plugin verify ~/.local/share/helm/plugins/example-cli To generate a signed plugin, use the 'helm plugin package --sign' command. ``` helm plugin 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 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_verify.md | main | helm | [
-0.058465853333473206,
0.05596766620874405,
-0.04584495723247528,
-0.06711133569478989,
0.06146905943751335,
-0.012482964433729649,
0.037871088832616806,
0.03358331322669983,
-0.026571042835712433,
0.022399818524718285,
0.015577196143567562,
-0.039729658514261246,
-0.0051650661043822765,
0... | -0.072893 |
generate autocompletion script for powershell ### Synopsis Generate the autocompletion script for powershell. To load completions in your current shell session: PS C:\> helm completion powershell | Out-String | Invoke-Expression To load completions for every new session, add the output of the above command to your powershell profile. ``` helm completion powershell [flags] ``` ### Options ``` -h, --help help for powershell --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_powershell.md | main | helm | [
0.033414702862501144,
0.06401848793029785,
0.0024293307214975357,
0.00013992335880175233,
0.03954696282744408,
0.04762745648622513,
0.0578208863735199,
-0.02911253087222576,
0.020729580894112587,
0.06732223927974701,
-0.03611181676387787,
-0.07256294041872025,
0.019479600712656975,
-0.0017... | 0.077067 |
remove one or more chart repositories ``` helm repo remove [REPO1 [REPO2 ...]] [flags] ``` ### Options ``` -h, --help help for remove ``` ### 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_remove.md | main | helm | [
0.019703436642885208,
0.08196442574262619,
0.028529686853289604,
-0.05310702696442604,
0.023029712960124016,
-0.03283962234854698,
-0.008329898118972778,
-0.04554136097431183,
0.07303542643785477,
0.05915779620409012,
0.01664942502975464,
-0.03997063636779785,
0.02831019088625908,
-0.03229... | 0.067028 |
This command fetches metadata for a given release ``` helm get metadata RELEASE\_NAME [flags] ``` ### Options ``` -h, --help help for metadata -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) --revision int specify release 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_metadata.md | main | helm | [
0.06763490289449692,
0.08818715065717697,
-0.014566979371011257,
-0.021436769515275955,
0.04161509498953819,
-0.030461419373750687,
-0.023740733042359352,
-0.006690708454698324,
0.07168246060609818,
0.05864882096648216,
0.028251513838768005,
-0.09157124161720276,
0.019066201522946358,
-0.0... | 0.081721 |
show information of a chart ### Synopsis This command consists of multiple subcommands to display information about a chart ### Options ``` -h, --help help for show ``` ### 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 show all](/helm/helm\_show\_all.md) - show all information of the chart \* [helm show chart](/helm/helm\_show\_chart.md) - show the chart's definition \* [helm show crds](/helm/helm\_show\_crds.md) - show the chart's CRDs \* [helm show readme](/helm/helm\_show\_readme.md) - show the chart's README \* [helm show values](/helm/helm\_show\_values.md) - show the chart's values ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_show.md | main | helm | [
0.028501112014055252,
0.07230188697576523,
0.0017458973452448845,
-0.04103333503007889,
-0.015909988433122635,
-0.011860501952469349,
0.007300864905118942,
0.025011219084262848,
0.04708431288599968,
0.02682647667825222,
0.020798945799469948,
-0.10080227255821228,
0.03473497927188873,
-0.04... | 0.104462 |
manage a chart's dependencies ### Synopsis Manage the dependencies of a chart. Helm charts store their dependencies in 'charts/'. For chart developers, it is often easier to manage dependencies in 'Chart.yaml' which declares all dependencies. The dependency commands operate on that file, making it easy to synchronize between the desired dependencies and the actual dependencies stored in the 'charts/' directory. For example, this Chart.yaml declares two dependencies: # Chart.yaml dependencies: - name: nginx version: "1.2.3" repository: "https://example.com/charts" - name: memcached version: "3.2.1" repository: "https://another.example.com/charts" The 'name' should be the name of a chart, where that name must match the name in that chart's 'Chart.yaml' file. The 'version' field should contain a semantic version or version range. The 'repository' URL should point to a Chart Repository. Helm expects that by appending '/index.yaml' to the URL, it should be able to retrieve the chart repository's index. Note: 'repository' can be an alias. The alias must start with 'alias:' or '@'. Starting from 2.2.0, repository can be defined as the path to the directory of the dependency charts stored locally. The path should start with a prefix of "file://". For example, # Chart.yaml dependencies: - name: nginx version: "1.2.3" repository: "file://../dependency\_chart/nginx" If the dependency chart is retrieved locally, it is not required to have the repository added to helm by "helm add repo". Version matching is also supported for this case. ### Options ``` -h, --help help for dependency ``` ### 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 dependency build](/helm/helm\_dependency\_build.md) - rebuild the charts/ directory based on the Chart.lock file \* [helm dependency list](/helm/helm\_dependency\_list.md) - list the dependencies for the given chart \* [helm dependency update](/helm/helm\_dependency\_update.md) - update charts/ based on the contents of Chart.yaml ###### Auto generated by spf13/cobra on 14-Jan-2026 | https://github.com/helm/helm-www/blob/main//docs/helm/helm_dependency.md | main | helm | [
-0.040297526866197586,
0.020898660644888878,
0.06861862540245056,
-0.032375991344451904,
0.05345911532640457,
-0.028448577970266342,
-0.05055897682905197,
0.01659831963479519,
0.05396372824907303,
0.04904453083872795,
0.005600912496447563,
-0.0022294768132269382,
-0.014379788190126419,
0.0... | -0.009011 |
list the dependencies for the given chart ### Synopsis List all of the dependencies declared in a chart. This can take chart archives and chart directories as input. It will not alter the contents of a chart. This will produce an error if the chart cannot be loaded. ``` helm dependency list CHART [flags] ``` ### Options ``` -h, --help help for list --max-col-width uint maximum column width for output table (default 80) ``` ### 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_list.md | main | helm | [
0.026167159900069237,
0.057982832193374634,
0.027773503214120865,
-0.049401167780160904,
0.021125219762325287,
0.0378238745033741,
-0.04129381850361824,
0.0472966693341732,
0.0021732887253165245,
0.03921324759721756,
0.011753343045711517,
-0.0445583239197731,
-0.0017539411783218384,
-0.032... | 0.050822 |
logout from a registry ### Synopsis Remove credentials stored for a remote registry. ``` helm registry logout [host] [flags] ``` ### Options ``` -h, --help help for logout ``` ### 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_logout.md | main | helm | [
0.05091645196080208,
0.10190671682357788,
-0.02686634287238121,
-0.03723480552434921,
-0.019646544009447098,
0.005849810317158699,
0.014577850699424744,
-0.0003612363652791828,
0.08320816606283188,
0.0471903458237648,
-0.014204577542841434,
-0.022735895588994026,
0.050808101892471313,
-0.0... | 0.086059 |
install a Helm plugin ### Synopsis This command allows you to install a plugin from a url to a VCS repo or a local path. By default, plugin signatures are verified before installation when installing from tarballs (.tgz or .tar.gz). This requires a corresponding .prov file to be available alongside the tarball. For local development, plugins installed from local directories are automatically treated as "local dev" and do not require signatures. Use --verify=false to skip signature verification for remote plugins. ``` helm plugin install [options] [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 install --insecure-skip-tls-verify skip tls certificate checks for the plugin download --key-file string identify registry client using this SSL key file --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") --password string registry password --plain-http use insecure HTTP connections for the plugin download --username string registry username --verify verify the plugin signature before installing (default true) --version string specify a version constraint. If this is not specified, the latest version is installed ``` ### 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_install.md | main | helm | [
-0.035842251032590866,
0.06385955214500427,
-0.021727021783590317,
-0.08194287121295929,
0.0375499352812767,
-0.01107418816536665,
-0.021367350593209267,
0.03434779495000839,
-0.005440018605440855,
0.037136323750019073,
0.03367983549833298,
-0.0515560656785965,
-0.020024467259645462,
0.058... | -0.078137 |
list releases ### Synopsis This command lists all of the releases for a specified namespace (uses current namespace context if namespace not specified). By default, it lists all releases in any status. Individual status filters like '--deployed', '--failed', '--pending', '--uninstalled', '--superseded', and '--uninstalling' can be used to show only releases in specific states. Such flags can be combined: '--deployed --failed'. By default, items are sorted alphabetically. Use the '-d' flag to sort by release date. If the --filter flag is provided, it will be treated as a filter. Filters are regular expressions (Perl compatible) that are applied to the list of releases. Only items that match the filter will be returned. $ helm list --filter 'ara[a-z]+' NAME UPDATED CHART maudlin-arachnid 2020-06-18 14:17:46.125134977 +0000 UTC alpine-0.1.0 If no results are found, 'helm list' will exit 0, but with no output (or in the case of no '-q' flag, only headers). By default, up to 256 items may be returned. To limit this, use the '--max' flag. Setting '--max' to 0 will not return all results. Rather, it will return the server's default, which may be much higher than 256. Pairing the '--max' flag with the '--offset' flag allows you to page through results. ``` helm list [flags] ``` ### Options ``` -A, --all-namespaces list releases across all namespaces -d, --date sort by release date --deployed show deployed releases --failed show failed releases -f, --filter string a regular expression (Perl compatible). Any releases that match the expression will be included in the results -h, --help help for list -m, --max int maximum number of releases to fetch (default 256) --no-headers don't print headers when using the default output format --offset int next release index in the list, used to offset from start value -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) --pending show pending releases -r, --reverse reverse the sort order -l, --selector string Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Works only for secret(default) and configmap storage backends. -q, --short output short (quiet) listing format --superseded show superseded releases --time-format string format time using golang time formatter. Example: --time-format "2006-01-02 15:04:05Z0700" --uninstalled show uninstalled releases (if 'helm uninstall --keep-history' was used) --uninstalling show releases that are currently being uninstalled ``` ### 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") | https://github.com/helm/helm-www/blob/main//docs/helm/helm_list.md | main | helm | [
0.05496472120285034,
0.07891004532575607,
0.06050089746713638,
-0.02078757807612419,
0.10701241344213486,
0.032917242497205734,
0.012306653894484043,
-0.06265322118997574,
0.03128116950392723,
0.04939601197838783,
0.01593869738280773,
-0.0017679104348644614,
-0.0032104423735290766,
-0.0406... | 0.001984 |
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_list.md | main | helm | [
-0.058552421629428864,
0.04236750304698944,
-0.055658143013715744,
-0.012565922923386097,
-0.05787009745836258,
0.010426409542560577,
0.005769682582467794,
-0.02613118104636669,
0.047679610550403595,
0.01368657499551773,
0.025888700038194656,
-0.07840888202190399,
0.0017730164108797908,
0.... | 0.030601 |
roll back a release to a previous revision ### Synopsis This command rolls back a release to a previous revision. The first argument of the rollback command is the name of a release, and the second is a revision (version) number. If this argument is omitted or set to 0, it will roll back to the previous release. To see revision numbers, run 'helm history RELEASE'. ``` helm rollback [REVISION] [flags] ``` ### Options ``` --cleanup-on-fail allow deletion of new resources created in this rollback when rollback fails --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") --force-conflicts if set server-side apply will force changes against conflicts --force-replace force resource updates by replacement -h, --help help for rollback --history-max int limit the maximum number of revisions saved per release. Use 0 for no limit (default 10) --no-hooks prevent hooks from running during rollback --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") --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) --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_rollback.md | main | helm | [
-0.01887218840420246,
0.06081165373325348,
-0.0060266791842877865,
0.01844085194170475,
0.035790372639894485,
-0.025837626308202744,
-0.06836938858032227,
-0.05751841887831688,
0.02792929857969284,
0.04803358390927315,
0.052216533571481705,
0.06192417070269585,
0.004671878181397915,
-0.053... | 0.049707 |
download a chart from a repository and (optionally) unpack it in local directory ### Synopsis Retrieve a package from a package repository, and download it locally. This is useful for fetching packages to inspect, modify, or repackage. It can also be used to perform cryptographic verification of a chart without installing the chart. There are options for unpacking the chart after download. This will create a directory for the chart and uncompress into that directory. If the --verify flag is specified, the requested chart MUST have a provenance file, and MUST pass the verification process. Failure in any part of this will result in an error, and the chart will not be saved locally. ``` helm pull [chart URL | repo/chartname] [...] [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 -d, --destination string location to write the chart. If this and untardir are specified, untardir is appended to this (default ".") --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored. -h, --help help for pull --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 --prov fetch the provenance file, but don't perform verification --repo string chart repository url where to locate the requested chart --untar if set to true, will untar the chart after downloading it --untardir string if untar is specified, this flag specifies the name of the directory into which the chart is expanded (default ".") --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](/helm/helm.md) - The Helm package manager for | https://github.com/helm/helm-www/blob/main//docs/helm/helm_pull.md | main | helm | [
-0.02407948113977909,
0.06295638531446457,
-0.050029393285512924,
-0.03983379155397415,
0.08877339959144592,
-0.03678465634584427,
-0.07923867553472519,
0.030394745990633965,
0.03689200058579445,
0.04437083750963211,
0.08184705674648285,
-0.058616720139980316,
0.034742336720228195,
0.00246... | -0.042784 |
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_pull.md | main | helm | [
-0.02491167187690735,
0.05592449754476547,
-0.011265908367931843,
-0.030409712344408035,
-0.01615467295050621,
-0.0018690216820687056,
-0.030086619779467583,
-0.03834453225135803,
0.022962134331464767,
0.013589730486273766,
0.053202226758003235,
-0.03514784201979637,
0.013568149879574776,
... | -0.008725 |
download all hooks for a named release ### Synopsis This command downloads hooks for a given release. Hooks are formatted in YAML and separated by the YAML '---\n' separator. ``` helm get hooks RELEASE\_NAME [flags] ``` ### Options ``` -h, --help help for hooks --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_hooks.md | main | helm | [
0.019513575360178947,
0.06785256415605545,
0.02632801979780197,
-0.04200972989201546,
0.046210210770368576,
-0.016160443425178528,
0.000743464392144233,
-0.039338890463113785,
0.062145818024873734,
0.0811617448925972,
0.029190659523010254,
-0.056420423090457916,
-0.013974323868751526,
-0.0... | 0.12969 |
create a new chart with the given name ### Synopsis This command creates a chart directory along with the common files and directories used in a chart. For example, 'helm create foo' will create a directory structure that looks something like this: foo/ ├── .helmignore # Contains patterns to ignore when packaging Helm charts. ├── Chart.yaml # Information about your chart ├── values.yaml # The default values for your templates ├── charts/ # Charts that this chart depends on └── templates/ # The template files └── tests/ # The test files 'helm create' takes a path for an argument. If directories in the given path do not exist, Helm will attempt to create them as it goes. If the given destination exists and there are files in that directory, conflicting files will be overwritten, but other files will be left alone. ``` helm create NAME [flags] ``` ### Options ``` -h, --help help for create -p, --starter string the name or absolute path to Helm starter scaffold ``` ### 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_create.md | main | helm | [
-0.0004735736292786896,
-0.01998147927224636,
-0.004094639793038368,
-0.01145267579704523,
0.07112254947423935,
-0.019316991791129112,
-0.016363278031349182,
0.054863035678863525,
0.04556005448102951,
0.031604502350091934,
0.04902944341301918,
-0.032569047063589096,
0.03733386471867561,
0.... | 0.024244 |
show the chart's CRDs ### Synopsis This command inspects a chart (directory, file, or URL) and displays the contents of the CustomResourceDefinition files ``` helm show crds [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 crds --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_crds.md | main | helm | [
-0.04257861524820328,
0.05751872435212135,
-0.044745732098817825,
-0.06896702200174332,
0.012604736723005772,
-0.02587900683283806,
-0.010133540257811546,
0.012360305525362492,
0.006842165254056454,
0.004884438589215279,
0.02621932327747345,
-0.030632395297288895,
0.02828093245625496,
-0.0... | -0.059417 |
list installed Helm plugins ``` helm plugin list [flags] ``` ### Options ``` -h, --help help for list --type string Plugin type ``` ### 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_list.md | main | helm | [
0.014493050053715706,
0.06654523313045502,
0.004249534569680691,
-0.037980396300554276,
0.01908109150826931,
-0.000525017618201673,
-0.004229022189974785,
0.00468353321775794,
0.04797397181391716,
0.05040310323238373,
0.02065463922917843,
-0.07033198326826096,
0.020907385274767876,
-0.0267... | 0.09496 |
update information of available charts locally from chart repositories ### Synopsis Update gets the latest information about charts from the respective chart repositories. Information is cached locally, where it is used by commands like 'helm search'. You can optionally specify a list of repositories you want to update. $ helm repo update ... To update all the repositories, use 'helm repo update'. ``` helm repo update [REPO1 [REPO2 ...]] [flags] ``` ### Options ``` -h, --help help for update --timeout duration time to wait for the index file download to complete (default 2m0s) ``` ### 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_update.md | main | helm | [
0.03229483962059021,
0.016948319971561432,
-0.013995428569614887,
-0.03283534571528435,
0.07701784372329712,
-0.018145166337490082,
-0.022107813507318497,
0.00840951967984438,
0.02802986465394497,
0.09502483159303665,
0.06520741432905197,
-0.002105548745021224,
-0.0048389858566224575,
-0.0... | 0.05017 |
download the notes for a named release ### Synopsis This command shows notes provided by the chart of a named release. ``` helm get notes RELEASE\_NAME [flags] ``` ### Options ``` -h, --help help for notes --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_notes.md | main | helm | [
0.020579323172569275,
0.048750534653663635,
0.03278881311416626,
-0.04067927971482277,
0.014774407260119915,
-0.00822821818292141,
-0.029908744618296623,
-0.028688699007034302,
0.0868099182844162,
0.07081717997789383,
0.029722057282924652,
-0.03685106337070465,
-0.009862092323601246,
-0.07... | 0.126234 |
The Helm package manager for Kubernetes. ### Synopsis The Kubernetes package manager Common actions for Helm: - helm search: search for charts - helm pull: download a chart to your local directory to view - helm install: upload the chart to Kubernetes - helm list: list releases of charts Environment variables: | Name | Description | |------------------------------------|------------------------------------------------------------------------------------------------------------| | $HELM\_CACHE\_HOME | set an alternative location for storing cached files. | | $HELM\_CONFIG\_HOME | set an alternative location for storing Helm configuration. | | $HELM\_DATA\_HOME | set an alternative location for storing Helm data. | | $HELM\_DEBUG | indicate whether or not Helm is running in Debug mode | | $HELM\_DRIVER | set the backend storage driver. Values are: configmap, secret, memory, sql. | | $HELM\_DRIVER\_SQL\_CONNECTION\_STRING | set the connection string the SQL storage driver should use. | | $HELM\_MAX\_HISTORY | set the maximum number of helm release history. | | $HELM\_NAMESPACE | set the namespace used for the helm operations. | | $HELM\_NO\_PLUGINS | disable plugins. Set HELM\_NO\_PLUGINS=1 to disable plugins. | | $HELM\_PLUGINS | set the path to the plugins directory | | $HELM\_REGISTRY\_CONFIG | set the path to the registry config file. | | $HELM\_REPOSITORY\_CACHE | set the path to the repository cache directory | | $HELM\_REPOSITORY\_CONFIG | set the path to the repositories file. | | $KUBECONFIG | set an alternative Kubernetes configuration file (default "~/.kube/config") | | $HELM\_KUBEAPISERVER | set the Kubernetes API Server Endpoint for authentication | | $HELM\_KUBECAFILE | set the Kubernetes certificate authority file. | | $HELM\_KUBEASGROUPS | set the Groups to use for impersonation using a comma-separated list. | | $HELM\_KUBEASUSER | set the Username to impersonate for the operation. | | $HELM\_KUBECONTEXT | set the name of the kubeconfig context. | | $HELM\_KUBETOKEN | set the Bearer KubeToken used for authentication. | | $HELM\_KUBEINSECURE\_SKIP\_TLS\_VERIFY | indicate if the Kubernetes API server's certificate validation should be skipped (insecure) | | $HELM\_KUBETLS\_SERVER\_NAME | set the server name used to validate the Kubernetes API server certificate | | $HELM\_BURST\_LIMIT | set the default burst limit in the case the server contains many CRDs (default 100, -1 to disable) | | $HELM\_QPS | set the Queries Per Second in cases where a high number of calls exceed the option for higher burst values | | $HELM\_COLOR | set color output mode. Allowed values: never, always, auto (default: never) | | $NO\_COLOR | set to any non-empty value to disable all colored output (overrides $HELM\_COLOR) | Helm stores cache, configuration, and data based on the following configuration order: - If a HELM\_\*\_HOME environment variable is set, it will be used - Otherwise, on systems supporting the XDG base directory specification, the XDG variables will be used - When no other location is set a default location will be used based on the operating system By default, the default directories depend on the Operating System. The defaults are listed below: | Operating System | Cache Path | Configuration Path | Data Path | |------------------|---------------------------|--------------------------------|-------------------------| | Linux | $HOME/.cache/helm | $HOME/.config/helm | $HOME/.local/share/helm | | macOS | $HOME/Library/Caches/helm | $HOME/Library/Preferences/helm | $HOME/Library/helm | | Windows | %TEMP%\helm | %APPDATA%\helm | %APPDATA%\helm | ### Options ``` --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 -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 | https://github.com/helm/helm-www/blob/main//docs/helm/helm.md | main | helm | [
0.07087969779968262,
0.04681020230054855,
-0.000894648430403322,
-0.03248580917716026,
0.056800056248903275,
0.01637796312570572,
-0.0391862653195858,
0.027774788439273834,
0.061609506607055664,
0.0796971544623375,
0.02496754750609398,
-0.03704394772648811,
-0.03623472526669502,
-0.0528105... | 0.063191 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.