Back to Nginx Ui

Nginx UI Helm Chart

charts/nginx-ui/README.md

2.5.101.8 KB
Original Source

Nginx UI Helm Chart

This chart deploys one Nginx UI instance together with the Nginx bundled in the official container image. It is intentionally single-replica because the Nginx configuration and Nginx UI database are stored on writable persistent volumes.

The chart is not a Kubernetes Ingress controller and does not watch or modify Kubernetes Ingress resources. The optional ingress value only exposes the Nginx UI web interface through an existing Ingress controller.

Install

shell
helm repo add nginx-ui https://cloud.nginxui.com/helm
helm repo update
helm install nginx-ui nginx-ui/nginx-ui --namespace nginx-ui --create-namespace

Read the one-time installation secret after the pod starts:

shell
kubectl exec -n nginx-ui deploy/nginx-ui -- cat /etc/nginx-ui/.install_secret

Persistent data

The chart creates retained PVCs for /etc/nginx and /etc/nginx-ui by default. The /var/www PVC is optional. Set existingClaim for any volume to reuse a pre-created claim. Retained PVCs are not deleted by helm uninstall; remove them manually only after backing up the data.

Important values

ValueDefaultDescription
image.repositoryuozi/nginx-uiOfficial container repository
image.tagchart appVersionContainer tag
service.typeClusterIPKubernetes Service type
ingress.enabledfalseExpose the UI through an existing Ingress controller
persistence.nginx.size1GiNginx configuration volume size
persistence.nginxUI.size1GiNginx UI data volume size
persistence.www.enabledfalsePersist /var/www

The values schema enforces replicaCount: 1. Horizontal scaling is not supported because multiple instances must not concurrently mutate the same Nginx configuration or embedded database.