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
# Multi TLS certificate termination This example uses 2 different certificates to terminate SSL for 2 hostnames. 1. Create tls secrets for foo.bar.com and bar.baz.com as indicated in the yaml 2. Create [multi-tls.yaml](multi-tls.yaml) This should generate a segment like: ```console $ kubectl exec -it ingress-nginx-cont...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/multi-tls/README.md
main
ingress-nginx
[ -0.03295516595244408, 0.0744187980890274, 0.015578866936266422, -0.05889641121029854, -0.09917810559272766, -0.08166827261447906, -0.0053678592666983604, -0.061620768159627914, 0.10684247314929962, 0.005674590356647968, -0.049189187586307526, -0.10798922926187515, 0.027674958109855652, 0.0...
0.019453
# Canary Ingress Nginx Has the ability to handle canary routing by setting specific annotations, the following is an example of how to configure a canary deployment with weighted canary routing. ## Create your main deployment and service This is the main deployment of your application with the service that will be used...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/canary/README.md
main
ingress-nginx
[ 0.038302354514598846, 0.04928012937307358, 0.009014439769089222, -0.007655706722289324, -0.041143327951431274, -0.058741096407175064, -0.052503567188978195, -0.007652896922081709, -0.030990883708000183, 0.02934913896024227, -0.07507194578647614, -0.048882775008678436, -0.06154947727918625, ...
0.0925
working as expected: ```bash Hostname: production-5c5f65d859-phqzc Hostname: canary-6697778457-zkfjf Hostname: canary-6697778457-zkfjf Hostname: production-5c5f65d859-phqzc Hostname: canary-6697778457-zkfjf Hostname: production-5c5f65d859-phqzc Hostname: production-5c5f65d859-phqzc Hostname: production-5c5f65d859-phqzc...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/canary/README.md
main
ingress-nginx
[ 0.06841284036636353, 0.04275389760732651, -0.015103340148925781, -0.041289545595645905, 0.02162119187414646, -0.05840083211660385, 0.013313588686287403, -0.09585285186767578, 0.031039126217365265, 0.051301125437021255, 0.014850842766463757, -0.0803741067647934, 0.005450412165373564, 0.0286...
-0.059837
# Configuration Snippets ## Ingress The Ingress in [this example](ingress.yaml) adds a custom header to Nginx configuration that only applies to that specific Ingress. If you want to add headers that apply globally to all Ingresses, please have a look at [an example of specifying custom headers](../custom-headers/READM...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/customization/configuration-snippets/README.md
main
ingress-nginx
[ -0.007010378874838352, 0.1010606661438942, 0.06452378630638123, -0.035377755761146545, 0.045766692608594894, 0.012077556923031807, 0.047404803335666656, -0.02021331526339054, 0.09128882735967636, 0.0512552447617054, -0.08558651804924011, -0.12112587690353394, 0.004703613463789225, -0.02131...
0.136514
# Accommodation for JWT JWT (short for Json Web Token) is an authentication method widely used. Basically an authentication server generates a JWT and you then use this token in every request you make to a backend service. The JWT can be quite big and is present in every http headers. This means you may have to adapt t...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/customization/jwt/README.md
main
ingress-nginx
[ -0.06220947578549385, 0.06923944503068924, 0.07194510102272034, -0.0420130118727684, -0.03298484906554222, -0.05129428207874298, -0.015646683052182198, 0.06887263059616089, -0.015950798988342285, 0.06792493909597397, -0.10630369931459427, -0.027402888983488083, 0.03059164248406887, -0.0399...
0.100848
# Custom Configuration Using a [ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/) is possible to customize the NGINX configuration For example, if we want to change the timeouts we need to create a ConfigMap: ``` $ cat configmap.yaml apiVersion: v1 data: proxy-connect-timeout...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/customization/custom-configuration/README.md
main
ingress-nginx
[ -0.008595342747867107, 0.0510106235742569, 0.058936357498168945, 0.014922285452485085, -0.06226317584514618, 0.006471717264503241, -0.02097053825855255, -0.021248599514365196, 0.040253423154354095, 0.07657577097415924, -0.05383891612291336, 0.00457875756546855, -0.009504842571914196, -0.03...
0.101227
# Custom DH parameters for perfect forward secrecy This example aims to demonstrate the deployment of an Ingress-Nginx Controller and use a ConfigMap to configure a custom Diffie-Hellman parameters file to help with "Perfect Forward Secrecy". ## Custom configuration ```console $ cat configmap.yaml apiVersion: v1 data: ...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/customization/ssl-dh-param/README.md
main
ingress-nginx
[ -0.046749867498874664, 0.07002180814743042, 0.006570814643055201, 0.00945805013179779, -0.025595150887966156, -0.03159303963184357, 0.01584804430603981, -0.0021771653555333614, 0.04296332970261574, 0.04964124411344528, 0.01947190798819065, -0.08374875038862228, 0.005358920432627201, -0.029...
0.039418
# Sysctl tuning This example aims to demonstrate the use of an Init Container to adjust sysctl default values using `kubectl patch`. ```console kubectl patch deployment -n ingress-nginx ingress-nginx-controller \ --patch="$(curl https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/docs/examples/customization...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/customization/sysctl/README.md
main
ingress-nginx
[ -0.04253901168704033, 0.04392767697572708, 0.02843153290450573, -0.002597078448161483, -0.01959233172237873, -0.07508967816829681, 0.009935244917869568, 0.003754651639610529, 0.004413919989019632, 0.07865244895219803, -0.04216049611568451, -0.006871986202895641, 0.0028105685487389565, -0.0...
0.115319
# External authentication, authentication service response headers propagation This example demonstrates propagation of selected authentication service response headers to a backend service. Sample configuration includes: \* Sample authentication service producing several response headers \* Authentication logic is bas...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/customization/external-auth-headers/README.md
main
ingress-nginx
[ -0.015269309282302856, 0.024062320590019226, -0.06012176349759102, -0.0834774374961853, -0.025403980165719986, -0.018824024125933647, 0.049503572285175323, -0.0057788509875535965, 0.07823704928159714, 0.057865407317876816, 0.04742756858468056, -0.13514509797096252, 0.0470866821706295, -0.0...
0.086774
# Custom Errors This example demonstrates how to use a custom backend to render custom error pages. If you are using the Helm Chart, look at [example values](https://github.com/kubernetes/ingress-nginx/blob/main/docs/examples/customization/custom-errors/custom-default-backend.helm.values.yaml) and don't forget to add t...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/customization/custom-errors/README.md
main
ingress-nginx
[ 0.001349492697045207, 0.06252731382846832, 0.09500375390052795, -0.0069017838686704636, 0.0007480038329958916, 0.03248898312449455, -0.0413513109087944, 0.06367985159158707, 0.006084890570491552, 0.10366977006196976, -0.047590434551239014, -0.053914040327072144, 0.06608577072620392, -0.046...
0.051699
to `return 503;`, to make the NGINX Ingress Controller always return the 503 HTTP error page for all the requests
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/customization/custom-errors/README.md
main
ingress-nginx
[ -0.06243224814534187, 0.08205489814281464, 0.01038726419210434, -0.022637953981757164, 0.010416997596621513, -0.05184110626578331, -0.025356724858283997, -0.04523774981498718, 0.044410400092601776, 0.1440918892621994, -0.004407584201544523, -0.05671565607190132, 0.0007675262750126421, -0.0...
0.024258
# Custom Headers ## Caveats Changes to the custom header config maps do not force a reload of the ingress-nginx-controllers. ### Workaround To work around this limitation, perform a rolling restart of the deployment. ## Example This example demonstrates configuration of the Ingress-Nginx Controller via a ConfigMap to p...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/customization/custom-headers/README.md
main
ingress-nginx
[ -0.03284170851111412, 0.08415326476097107, 0.08780966699123383, -0.022526197135448456, -0.023281551897525787, 0.013589256443083286, 0.003285192884504795, 0.009642161428928375, 0.020096775144338608, 0.08654523640871048, -0.030794216319918633, -0.08083748817443848, 0.01634511724114418, -0.02...
0.068098
# OpenPolicyAgent and pathType enforcing Ingress API allows users to specify different [pathType](https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types) on Ingress object. While pathType `Exact` and `Prefix` should allow only a small set of characters, pathType `ImplementationSpecific` allows any ...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/openpolicyagent/README.md
main
ingress-nginx
[ -0.058847181499004364, 0.007016838062554598, 0.018694816157221794, -0.0034985137172043324, -0.02309517189860344, -0.010701007209718227, 0.06150020658969879, -0.024750251322984695, 0.06360504776239395, 0.05016756057739258, 0.009077183902263641, -0.018114207312464714, 0.0033636335283517838, ...
0.184785
# Static IPs This example demonstrates how to assign a static-ip to an Ingress on 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. You will also need to make sure your Ing...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/static-ip/README.md
main
ingress-nginx
[ -0.0767587423324585, 0.02366495132446289, 0.03361274302005768, 0.008379065431654453, -0.012375387363135815, -0.002602779073640704, 0.06081218272447586, -0.07716385275125504, -0.0020283167250454426, 0.08054820448160172, 0.0033509728964418173, -0.08016175776720047, 0.08022776246070862, -0.04...
0.079995
# gRPC This example demonstrates how to route traffic to a gRPC service through the Ingress-NGINX controller. ## Prerequisites 1. You have a kubernetes cluster running. 2. You have a domain name such as `example.com` that is configured to route traffic to the Ingress-NGINX controller. 3. You have the ingress-nginx-cont...
https://github.com/kubernetes/ingress-nginx/blob/main//docs/examples/grpc/README.md
main
ingress-nginx
[ -0.020629875361919403, 0.010525941848754883, -0.026163917034864426, -0.03293367102742195, -0.08882956206798553, -0.010623749345541, 0.05311312526464462, -0.012574727647006512, 0.0658067986369133, 0.05608795955777168, -0.05723066255450249, -0.10600673407316208, -0.004785172175616026, 0.0711...
0.084393
# 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...
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...
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 (Sig...
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 fi...
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 aff...
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 [cons...
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/k...
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 apiVe...
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](#impleme...
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...
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 ...
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-da...
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...
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](Y...
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 templat...
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]...
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://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/ingr...
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 ...
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-t...
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 \* T...
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 | Titl...
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 fun...
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 U...
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 |...
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-...
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 ...
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 | | #1344...
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-...
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. ### Instal...
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 ...
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. - Te...
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 th...
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 ...
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` - Th...
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 ...
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...
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 n...
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 p...
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 ...
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...
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...
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 omi...
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://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 pro...
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 vali...
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...
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 .Val...
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 crea...
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...
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. He...
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...
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 hav...
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.Bas...
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 im...
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 ...
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: ``` my...
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: myvalu...
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...
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...
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 ...
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 fi...
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 s...
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:...
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/template...
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...
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 templ...
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 exam...
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 ...
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 ...
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...
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. F...
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.firs...
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 ...
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: W...
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...
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 outpu...
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 plu...
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 powe...
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 "...
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 inherite...
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 (...
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 b...
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