Skip to content

Commit fca73dc

Browse files
committed
docs(docker-registry-ui): add doc for user-interface ingress
1 parent e0b4f9d commit fca73dc

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

charts/docker-registry-ui/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,13 @@ helm upgrade --install docker-registry-ui joxit/docker-registry-ui
6464
| `ui.service.nodePort` | `null` | If using a `NodePort` service type, you must specify the desired `nodePort` for each exposed port. |
6565
| `ui.service.annotations` | `null` | Annotations to apply to the user interface service. |
6666
| `ui.service.additionalSpec` | `null` | Optional YAML string that will be appended to the Service spec. |
67+
| `ui.ingress.enable` | `false` | Enable the ingress for the user interface. |
68+
| `ui.ingress.host` | `null` | Fully qualified domain name of a network host. |
69+
| `ui.ingress.path` | `/` | Path is matched against the path of an incoming request. |
70+
| `ui.ingress.pathType` | `Prefix` | Determines the interpretation of the Path matching, must be Prefix to serve assets. |
71+
| `ui.ingress.ingressClassName` | `nginx` | The name of an IngressClass cluster resource. |
72+
| `ui.ingress.tls` | `null` | Optional YAML tls configuration. |
73+
| `ui.ingress.annotations` | `null` | Annotations to apply to the user interface ingress. |
6774

6875
### Registry Server
6976

charts/docker-registry-ui/values.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,21 +77,21 @@ ui:
7777
additionalSpec: null
7878

7979
ingress:
80-
# Enable the ingress
80+
# Enable the ingress for the user interface.
8181
enabled: false
8282
# Fully qualified domain name of a network host.
8383
host: null
84-
# Path is matched against the path of an incoming request
84+
# Path is matched against the path of an incoming request.
8585
path: /
86-
# Determines the interpretation of the Path matching, must be Prefix to serve assets
86+
# Determines the interpretation of the Path matching, must be Prefix to serve assets.
8787
pathType: Prefix
8888
# The name of an IngressClass cluster resource.
8989
ingressClassName: nginx
9090
# TLS configuration
9191
tls: null
9292
# Annotations to apply to the user interface ingress.
9393
annotations: null
94-
# If you want a custom path, you can try this example
94+
# If you want a custom path, you can try this example:
9595
# path: /ui(/|$)(.*)
9696
# annotations:
9797
# nginx.ingress.kubernetes.io/rewrite-target: /$2

0 commit comments

Comments
 (0)