@helm-charts/bitnami-nginx v2.2.1-0.1.0
@helm-charts/bitnami-nginx
Chart for the nginx server
Field | Value |
---|---|
Repository Name | bitnami |
Chart Name | nginx |
Chart Version | 2.2.1 |
NPM Package Version | 0.1.0 |
## Global Docker image parameters
## Please, note that this will override the image parameters, including dependencies, configured to use the global value
## Current available global Docker image parameters: imageRegistry and imagePullSecrets
##
# global:
# imageRegistry: myRegistryName
# imagePullSecrets:
# - myRegistryKeySecretName
## Bitnami NGINX image version
## ref: https://hub.docker.com/r/bitnami/nginx/tags/
##
image:
registry: docker.io
repository: bitnami/nginx
tag: 1.14.2
## Specify a imagePullPolicy
## Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'
## ref: http://kubernetes.io/docs/user-guide/images/#pre-pulling-images
##
pullPolicy: IfNotPresent
## Optionally specify an array of imagePullSecrets.
## Secrets must be manually created in the namespace.
## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
##
# pullSecrets:
# - myRegistryKeySecretName
## Kubernetes configuration
## For minikube, set this to NodePort, elsewhere use LoadBalancer
##
service:
type: LoadBalancer
# HTTP Port
port: 80
##
## loadBalancerIP:
## nodePorts:
## http: <to set explicitly, choose port between 30000-32767>
nodePorts:
http: ''
## Enable client source IP preservation
## ref http://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip
##
externalTrafficPolicy: Cluster
# vhost: |-
# # example PHP-FPM vhost
# server {
# listen 0.0.0.0:8080;
# root /app;
# location / {
# index index.html index.php;
# }
# location ~ \.php$ {
# fastcgi_pass phpfpm-server:9000;
# fastcgi_index index.php;
# include fastcgi.conf;
# }
# }
## Pod annotations
## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
##
podAnnotations: {}
## Prometheus Exporter / Metrics
##
metrics:
enabled: false
image:
registry: docker.io
repository: nginx/nginx-prometheus-exporter
tag: 0.1.0
pullPolicy: IfNotPresent
## Optionally specify an array of imagePullSecrets.
## Secrets must be manually created in the namespace.
## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
##
# pullSecrets:
# - myRegistryKeySecretName
## Metrics exporter pod Annotation and Labels
podAnnotations:
prometheus.io/scrape: 'true'
prometheus.io/port: '9113'
## Metrics exporter resource requests and limits
## ref: http://kubernetes.io/docs/user-guide/compute-resources/
##
# resources: {}
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 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 install --name my-release bitnami/nginx
The command deploys 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 | {VERSION} |
image.pullPolicy | NGINX image pull policy | Always if imageTag is latest , else IfNotPresent |
image.pullSecrets | Specify docker-registry secret names as an array | [] (does not add image pull secrets to deployed pods) |
vhost | Custom NGINX virtual host | nil |
podAnnotations | Pod annotations | {} |
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 | nginx/nginx-prometheus-exporter |
metrics.image.tag | Promethus exporter image tag | 0.1.0 |
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 | {} |
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 | "" |
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
Providing a custom virtual host
You can use the vhost
value to provide a custom virtual host for NGINX to use.
To do this, create a values files with your virtual host:
custom-vhost.yaml
vhost: |-
server {
listen 0.0.0.0:8080;
location / {
return 200 "hello!";
}
}
Install the chart with this value:
$ helm install --name my-release -f custom-vhost.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"}]'
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago