Skip to content

docs: set kubernetes.io/ingress.class to null if ingressClassName is set #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicksnyder merged 3 commits into from
Aug 22, 2022
Merged

docs: set kubernetes.io/ingress.class to null if ingressClassName is set #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e09c1b
document that you need to set kubernetes.io/ingress.class to null if …
nicksnyder Aug 22, 2022
2fe4315
update generated docs
nicksnyder Aug 22, 2022
1041ed4
full path
nicksnyder Aug 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion charts/sourcegraph/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,10 @@ In addition to the documented values, all services also support the following va
| frontend.image.defaultTag | string | `"3.42.2@sha256:abe3ed2071e9e8020209bf0f4cf5cb4432fb25e60f776fedb9be0423747e259e"` | Docker image tag for the `frontend` image |
| frontend.image.name | string | `"frontend"` | Docker image name for the `frontend` image |
| 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/) |
| 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. |
| frontend.ingress.enabled | bool | `true` | Enable ingress for the Sourcegraph server |
| frontend.ingress.host | string | `""` | External hostname for the Sourcegraph server ingress (SSL) |
| frontend.ingress.ingressClassName | string | `nil` | IngressClassName for the Ingress (Available in Kubernetes 1.18+) |
| 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` |
| frontend.ingress.tlsSecret | string | `""` | Secret containing SSL cert |
| frontend.name | string | `"sourcegraph-frontend"` | Name used by resources. Does not affect service names or PVCs. |
| 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) |
Expand Down
3 changes: 3 additions & 0 deletions charts/sourcegraph/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,11 +305,14 @@ frontend:
enabled: true
# -- Annotations for the Sourcegraph server ingress. For example, securing ingress with TLS provided by [cert-manager](https://cert-manager.io/docs/usage/ingress/)
annotations:
# -- [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.
kubernetes.io/ingress.class: nginx
nginx.ingress.kubernetes.io/proxy-body-size: 150m
# -- External hostname for the Sourcegraph server ingress (SSL)
host: ""
# -- 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`
ingressClassName: null
# -- Secret containing SSL cert
tlsSecret: ""
Expand Down