charts/bitnami/nginx

NGINX

NGINX (pronounced "engine-x") is an open source reverse proxy server for HTTP, HTTPS, SMTP, POP3, and IMAP protocols, as well as a load balancer, HTTP cache, and a web server (origin server).

TL;DR;

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install bitnami/nginx

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 NGINX Open Source deployment on a Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This Helm chart has been tested on top of Bitnami Kubernetes Production Runtime (BKPR). Deploy BKPR to get automated TLS certificates, logging and monitoring for your applications.

Installing the Chart

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

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install --name my-release bitnami/nginx

These commands deploy NGINX Open Source on the Kubernetes cluster in the default configuration.

Tip

: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following tables lists the configurable parameters of the NGINX Open Source chart and their default values.

Parameter	Description	Default
global.imageRegistry	Global Docker image registry	nil
global.imagePullSecrets	Global Docker registry secret names as an array	[] (does not add image pull secrets to deployed pods)
image.registry	NGINX image registry	docker.io
image.repository	NGINX Image name	bitnami/nginx
image.tag	NGINX Image tag	{TAG_NAME}
image.pullPolicy	NGINX image pull policy	IfNotPresent
image.pullSecrets	Specify docker-registry secret names as an array	[] (does not add image pull secrets to deployed pods)
nameOverride	String to partially override nginx.fullname template with a string (will prepend the release name)	nil
fullnameOverride	String to fully override nginx.fullname template with a string	nil
serverBlock	Custom NGINX server block	nil
podAnnotations	Pod annotations	{}
nodeAffinity	Node Affinity rules for pod assignment. The value is evaluated as a template	{}
podAffinity	Affinity rules for pod assignment. The value is evaluated as a template	{}
podAntiAffinity	Anti-Affinity rules for pod assignment. Allowed values: soft and hard	soft
nodeSelector	Node labels for pod assignment. The value is evaluated as a template	{}
tolerations	Tolerations for pod assignment. The value is evaluated as a template	{}
metrics.enabled	Start a side-car prometheus exporter	false
metrics.image.registry	Promethus exporter image registry	docker.io
metrics.image.repository	Promethus exporter image name	bitnami/nginx-exporter
metrics.image.tag	Promethus exporter image tag	{TAG_NAME}
metrics.image.pullPolicy	Image pull policy	IfNotPresent
metrics.image.pullSecrets	Specify docker-registry secret names as an array	[] (does not add image pull secrets to deployed pods)
metrics.podAnnotations	Additional annotations for Metrics exporter pod	{prometheus.io/scrape: "true", prometheus.io/port: "9113"}
metrics.resources	Exporter resource requests/limit	{}
replicaCount	Number of replicas to deploy	1
service.type	Kubernetes Service type	LoadBalancer
service.port	Service HTTP port	80
service.nodePorts.http	Kubernetes http node port	""
service.externalTrafficPolicy	Enable client source IP preservation	Cluster
service.loadBalancerIP	LoadBalancer service IP address	""
service.annotations	Service annotations	{}
ingress.enabled	Enable ingress controller resource	false
ingress.certManager	Add annotations for cert-manager	false
ingress.annotations	Ingress annotations	[]
ingress.hosts[0].name	Hostname to your NGINX installation	nginx.local
ingress.hosts[0].path	Path within the url structure	/
ingress.tls[0].hosts[0]	TLS hosts	nginx.local
ingress.tls[0].secretName	TLS Secret (certificates)	nginx.local-tls
ingress.secrets[0].name	TLS Secret Name	nil
ingress.secrets[0].certificate	TLS Secret Certificate	nil
ingress.secrets[0].key	TLS Secret Key	nil
livenessProbe	Deployment Liveness Probe	See values.yaml
readinessProbe	Deployment Readiness Probe	See values.yaml
resources	Resource requests/limit	{}

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name my-release \
  --set imagePullPolicy=Always \
    bitnami/nginx

The above command sets the imagePullPolicy to Always.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install --name my-release -f values.yaml bitnami/nginx

Tip

: You can use the default values.yaml

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.

Providing a custom server block

You can use the serverBlock value to provide a custom server block for NGINX to use. To do this, create a values files with your server block:

custom-server-block.yaml

serverBlock: |-
  server {
    listen 0.0.0.0:8080;
    location / {
      return 200 "hello!";
    }
  }

Install the chart with this value:

$ helm install --name my-release -f custom-server-block.yaml bitnami/nginx

Upgrading

To 1.0.0

Backwards compatibility is not guaranteed unless you modify the labels used on the chart's deployments. Use the workaround below to upgrade from versions previous to 1.0.0. The following example assumes that the release name is nginx:

$ kubectl patch deployment nginx --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'