Skip to content

Commit 411f4b6

Browse files
authored
docs: set kubernetes.io/ingress.class to null if ingressClassName is set (#165)
1 parent 28664ce commit 411f4b6

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

charts/sourcegraph/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,10 @@ In addition to the documented values, all services also support the following va
8686
| frontend.image.defaultTag | string | `"3.42.2@sha256:abe3ed2071e9e8020209bf0f4cf5cb4432fb25e60f776fedb9be0423747e259e"` | Docker image tag for the `frontend` image |
8787
| frontend.image.name | string | `"frontend"` | Docker image name for the `frontend` image |
8888
| frontend.ingress.annotations | object | `{"kubernetes.io/ingress.class":"nginx","nginx.ingress.kubernetes.io/proxy-body-size":"150m"}` | Annotations for the Sourcegraph server ingress. For example, securing ingress with TLS provided by [cert-manager](https://cert-manager.io/docs/usage/ingress/) |
89+
| frontend.ingress.annotations."kubernetes.io/ingress.class" | string | `"nginx"` | [Deprecated annotation](https://kubernetes.io/docs/concepts/services-networking/ingress/#deprecated-annotation) for specifing the IngressClass in Kubernetes 1.17 and earlier. If you are using Kubernetes 1.18+, use `ingressClassName` instead and set an override value of `null` for this annotation. |
8990
| frontend.ingress.enabled | bool | `true` | Enable ingress for the Sourcegraph server |
9091
| frontend.ingress.host | string | `""` | External hostname for the Sourcegraph server ingress (SSL) |
91-
| frontend.ingress.ingressClassName | string | `nil` | IngressClassName for the Ingress (Available in Kubernetes 1.18+) |
92+
| frontend.ingress.ingressClassName | string | `nil` | IngressClassName for the Ingress (Available in Kubernetes 1.18+) If you set this field, set the annotation `frontend.ingress.annotations."kubernetes.io/ingress.class"` to `null` |
9293
| frontend.ingress.tlsSecret | string | `""` | Secret containing SSL cert |
9394
| frontend.name | string | `"sourcegraph-frontend"` | Name used by resources. Does not affect service names or PVCs. |
9495
| frontend.podSecurityContext | object | `{}` | Security context for the `frontend` pod, learn more from the [Kubernetes documentation](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) |

charts/sourcegraph/values.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,11 +305,14 @@ frontend:
305305
enabled: true
306306
# -- Annotations for the Sourcegraph server ingress. For example, securing ingress with TLS provided by [cert-manager](https://cert-manager.io/docs/usage/ingress/)
307307
annotations:
308+
# -- [Deprecated annotation](https://kubernetes.io/docs/concepts/services-networking/ingress/#deprecated-annotation) for specifing the IngressClass in Kubernetes 1.17 and earlier.
309+
# If you are using Kubernetes 1.18+, use `ingressClassName` instead and set an override value of `null` for this annotation.
308310
kubernetes.io/ingress.class: nginx
309311
nginx.ingress.kubernetes.io/proxy-body-size: 150m
310312
# -- External hostname for the Sourcegraph server ingress (SSL)
311313
host: ""
312314
# -- IngressClassName for the Ingress (Available in Kubernetes 1.18+)
315+
# If you set this field, set the annotation `frontend.ingress.annotations."kubernetes.io/ingress.class"` to `null`
313316
ingressClassName: null
314317
# -- Secret containing SSL cert
315318
tlsSecret: ""

0 commit comments

Comments
 (0)