bitnamicharts/nginx-ingress-controller

Verified Publisher

By VMware

•Updated 10 months ago

Bitnami Helm chart for NGINX Ingress Controller

Helm

Image

Networking

Security

Web servers

5M+

Overview Tags

bitnamicharts/nginx-ingress-controller repository overview

⁠Bitnami Secure Images Helm chart for NGINX Ingress Controller

NGINX Ingress Controller is an Ingress controller that manages external access to HTTP services in a Kubernetes cluster using NGINX.

Overview of NGINX Ingress Controller⁠

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

⁠This Helm chart is deprecated

This product is unmaintained by the upstream; see https://github.com/kubernetes/ingress-NGINX?tab=readme-ov-file#retiring⁠

⁠ TL;DR

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/nginx-ingress-controller

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository.

⁠ Introduction

Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.

This chart bootstraps a ingress-nginx⁠ deployment on a Kubernetes⁠ cluster using the Helm⁠ package manager.

⁠ Before you begin

Kubernetes 1.23+
Helm 3.8.0+

⁠ Installing the Chart

To install the chart with the release name my-release:

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/nginx-ingress-controller

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts.

These commands deploy nginx-ingress-controller on the Kubernetes cluster in the default configuration.

Tip: List all releases using helm list

⁠ Configuration and installation details

This section describes credentials, configuration, and other installation options.

⁠ Resource requests and limits

Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.

To make this process easier, the chart contains the resourcesPreset values, which automatically sets the resources section according to different presets. Check these presets in the bitnami/common chart⁠. However, in production workloads using resourcesPreset is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation⁠.

⁠ Prometheus metrics

This chart can be integrated with Prometheus by setting metrics.enabled to true. This will expose nginx-ingress-controller native Prometheus endpoint and a metrics service that can be configured using the metrics.service section. It will be have the necessary annotations to be automatically scraped by Prometheus.

⁠Prometheus requirements

It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart⁠ or the Bitnami Kube Prometheus helm chart⁠ to easily have a working Prometheus in your cluster.

⁠Integration with Prometheus Operator

The chart can deploy ServiceMonitor objects for integration with Prometheus Operator installations. To do so, set the value metrics.serviceMonitor.enabled=true. Ensure that the Prometheus Operator CustomResourceDefinitions are installed in the cluster or it will fail with the following error:

no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"

Install the Bitnami Kube Prometheus helm chart⁠ for having the necessary CRDs and the Prometheus Operator.

⁠ Rolling VS Immutable tags⁠

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

⁠ FIPS parameters

The FIPS parameters only have effect if you are using images from the Bitnami Secure Images catalog⁠.

For more information on this new support, please refer to the FIPS Compliance section⁠.

⁠ Backup and restore

To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero⁠, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide⁠.

⁠ Sidecars and Init Containers

If you have a need for additional containers to run within the same pod as the NGINX Ingress Controller (e.g. an additional metrics or logging exporter), you can do so via the sidecars config parameter. Simply define your container according to the Kubernetes container spec.

sidecars:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
       containerPort: 1234

Similarly, you can add extra init containers using the initContainers parameter.

initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

⁠ Deploying extra resources

There are cases where you may want to deploy extra objects, such a ConfigMap containing your app's configuration or some extra deployment with a micro service used by your app. For covering this case, the chart allows adding the full specification of other objects using the extraDeploy parameter.

⁠ Setting Pod's affinity

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod's affinity in the kubernetes documentation⁠.

As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common⁠ chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

⁠ Parameters

The following subsections list global, common, and component-specific parameters.

⁠ Global parameters

Name	Description	Value
`global.imageRegistry`	Global Docker image registry	`""`
`global.imagePullSecrets`	Global Docker registry secret names as an array	`[]`
`global.defaultFips`	Default value for the FIPS configuration (allowed values: '', restricted, relaxed, off). Can be overridden by the 'fips' object	`restricted`
`global.security.allowInsecureImages`	Allows skipping image verification	`false`
`global.compatibility.openshift.adaptSecurityContext`	Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation)	`auto`

⁠ Common parameters

Name	Description	Value
`kubeVersion`	Force target Kubernetes version (using Helm capabilities if not set)	`""`
`nameOverride`	String to partially override common.names.fullname	`""`
`fullnameOverride`	String to fully override common.names.fullname	`""`
`namespaceOverride`	String to fully override common.names.namespace	`""`
`commonLabels`	Add labels to all the deployed resources	`{}`
`commonAnnotations`	Add annotations to all the deployed resources	`{}`
`extraDeploy`	Array of extra objects to deploy with the release	`[]`
`clusterDomain`	Kubernetes cluster domain name	`cluster.local`

⁠ Nginx Ingress Controller parameters

Name	Description	Value
`image.registry`	Nginx Ingress Controller image registry	`REGISTRY_NAME`
`image.repository`	Nginx Ingress Controller image repository	`REPOSITORY_NAME/nginx-ingress-controller`
`image.digest`	Nginx Ingress Controller image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag	`""`
`image.pullPolicy`	Nginx Ingress Controller image pull policy	`IfNotPresent`
`image.pullSecrets`	Specify docker-registry secret names as an array	`[]`
`containerPorts.http`	Nginx Ingress Controller HTTP port	`8080`
`containerPorts.https`	Nginx Ingress Controller HTTPS port	`8443`
`containerPorts.defaultServer`	Nginx Ingress Controller default server port	`8181`
`containerPorts.metrics`	Nginx Ingress Controller metrics port	`10254`
`containerPorts.profiler`	Nginx Ingress Controller profiler port	`10245`
`containerPorts.status`	Nginx Ingress Controller status port	`10246`
`containerPorts.stream`	Nginx Ingress Controller stream port	`10247`
`automountServiceAccountToken`	Mount Service Account token in pod	`true`
`hostAliases`	Deployment pod host aliases	`[]`
`config`	Custom configuration options for NGINX	`{}`
`proxySetHeaders`	Custom headers before sending traffic to backends	`{}`
`addHeaders`	Custom headers before sending response traffic to the client	`{}`
`defaultBackendService`	Default 404 backend service; required only if `defaultBackend.enabled = false`	`""`
`electionID`	Election ID to use for status update	`ingress-controller-leader`
`allowSnippetAnnotations`	Allow users to set snippet annotations	`false`
`reportNodeInternalIp`	If using `hostNetwork=true`, setting `reportNodeInternalIp=true`, will pass the flag `report-node-internal-ip-address` to Nginx Ingress Controller	`false`
`watchIngressWithoutClass`	Process Ingress objects without ingressClass annotation/ingressClassName field	`false`