NGINX Open Source is a web server that can be also used as a reverse proxy, load balancer, and HTTP cache. Recommended for high-demanding sites due to its ability to provide faster content.

Overview of NGINX Open Source

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.

helm install my-release oci://registry-1.docker.io/bitnamicharts/nginx

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.

Looking to use NGINX Open Source in production? Try VMware Application Catalog, the enterprise edition of Bitnami Application Catalog.

• Kubernetes 1.19+
• Helm 3.2.0+

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

helm install my-release oci://registry-1.docker.io/bitnamicharts/nginx

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

Tip: List all releases using helm list

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.

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

helm install my-release \
  --set imagePullPolicy=Always \
    oci://registry-1.docker.io/bitnamicharts/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 my-release -f values.yaml oci://registry-1.docker.io/bitnamicharts/nginx

Tip: You can use the default values.yaml

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.

To modify the application version used in this chart, specify a different version of the image using the image.tag parameter and/or a different repository using the image.repository parameter. Refer to the chart documentation for more information on these parameters and how to use them with images from a private registry.

The NGINX chart allows you to deploy a custom web application using one of the following methods:

• Cloning from a git repository: Set cloneStaticSiteFromGit.enabled to true and set the repository and branch using the cloneStaticSiteFromGit.repository and cloneStaticSiteFromGit.branch parameters. A sidecar will also pull the latest changes in an interval set by cloneStaticSitesFromGit.interval.
• Providing a ConfigMap: Set the staticSiteConfigmap value to mount a ConfigMap in the NGINX html folder.
• Using an existing PVC: Set the staticSitePVC value to mount an PersistentVolumeClaim with the static site content.

You can deploy a example web application using git deploying the chart with the following parameters:

cloneStaticSiteFromGit.enabled=true
cloneStaticSiteFromGit.repository=https://github.com/mdn/beginner-html-site-styled.git
cloneStaticSiteFromGit.branch=master

This helm chart supports using custom custom server block for NGINX to use.

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 and install the chart using it:

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

Warning: The above example is not compatible with enabling Prometheus metrics since it affects the /status endpoint.

In addition, you can also set an external ConfigMap with the configuration file. This is done by setting the existingServerBlockConfigmap parameter. Note that this will override the previous option.

In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars property.

extraEnvVars:
  - name: LOG_LEVEL
    value: error

Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM or the extraEnvVarsSecret values.

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.

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.

This chart provides support for ingress resources. If you have an ingress controller installed on your cluster, such as nginx-ingress-controller or contour you can utilize the ingress controller to serve your application.

To enable ingress integration, please set ingress.enabled to true.

Most likely you will only want to have one hostname that maps to this NGINX installation. If that's your case, the property ingress.hostname will set it. However, it is possible to have more than one host. To facilitate this, the ingress.extraHosts object can be specified as an array. You can also use ingress.extraTLS to add the TLS configuration for extra hosts.

For each host indicated at ingress.extraHosts, please indicate a name, path, and any annotations that you may want the ingress controller to know about.

For annotations, please see this document. Not all annotations are supported by all ingress controllers, but this document does a good job of indicating which annotation is supported by many popular ingress controllers.

Find more information about how to deal with common errors related to Bitnami's Helm charts in this troubleshooting guide.

This major release renames several values in this chart and adds missing features, in order to be aligned with the rest of the assets in the Bitnami charts repository.

Affected values:

• service.port was renamed as service.ports.http.
• service.httpsPort was deprecated. We recommend using service.ports.https.
• serviceAccount.autoMount was renamed as serviceAccount.automountServiceAccountToken
• metrics.serviceMonitor.additionalLabels was renamed as metrics.serviceMonitor.labels

This major release no longer uses the bitnami/nginx-ldap-auth-daemon container as a dependency since its upstream project is not actively maintained.

2022-04-12 edit:

Bitnami's reference implementation.

On 9 April 2022, security vulnerabilities in the NGINX LDAP reference implementation were publicly shared. Although the deprecation of this container from the Bitnami catalog was not related to this security issue, here you can find more information from the Bitnami security team.

On November 13, 2020, Helm v2 support was formally finished, this major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL.

• Previous versions of this Helm Chart use apiVersion: v1 (installable by both Helm 2 and 3), this Helm Chart was updated to apiVersion: v2 (installable by Helm 3 only). Here you can find more information about the apiVersion field.
• Move dependency information from the requirements.yaml to the Chart.yaml
• After running helm dependency update, a Chart.lock file is generated containing the same structure used in the previous requirements.lock
• The different fields present in the Chart.yaml file has been ordered alphabetically in a homogeneous way for all the Bitnami Helm Charts

• If you want to upgrade to this version from a previous one installed with Helm v3, you shouldn't face any issues
• If you want to upgrade to this version using Helm v2, this scenario is not supported as this version doesn't support Helm v2 anymore
• If you installed the previous version with Helm v2 and wants to upgrade to this version with Helm v3, please refer to the official Helm documentation about migrating from Helm v2 to v3

• https://docs.bitnami.com/tutorials/resolve-helm2-helm3-post-migration-issues/
• https://helm.sh/docs/topics/v2_v3_migration/
• https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/

• This version also introduces bitnami/common, a library chart as a dependency. More documentation about this new utility could be found here. Please, make sure that you have updated the chart dependencies before executing any upgrade.
• Ingress configuration was also adapted to follow the Helm charts best practices.

Note: There is no backwards compatibility due to the above mentioned changes. It's necessary to install a new release of the chart, and migrate your existing application to the new NGINX instances.

Added support for the use of LDAP.

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 5.0.0. The following example assumes that the release name is nginx:

kubectl delete deployment nginx --cascade=false
helm upgrade nginx oci://registry-1.docker.io/bitnamicharts/nginx

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"}]'

Bitnami Kubernetes documentation is available at https://docs.bitnami.com/. You can find there the following resources:

• Documentation for NGINX Helm chart
• Get Started with Kubernetes guides
• Bitnami Helm charts documentation
• Kubernetes FAQs
• Kubernetes Developer guides

Copyright © 2023 VMware, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.