Skip to content

Allow static NodePort #138

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
merged 9 commits into from
Aug 3, 2021
+23 −2
Merged

Allow static NodePort #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7c8a8f8
Add nodeport to coder service
Emyrk Jul 28, 2021
deb2c0d
Make nodePort configurable
Emyrk Jul 29, 2021
9f7c37e
Make fmt
Emyrk Jul 29, 2021
8798ebe
Change wording
Emyrk Jul 29, 2021
785861c
Change values.yaml examples
Emyrk Jul 29, 2021
e11bd25
remove typo
Emyrk Aug 2, 2021
4d8eaa8
Convert to http/https fieldsg
Emyrk Aug 2, 2021
feca4f2
Get rid of '-e'
Emyrk Aug 2, 2021
6418583
Use null to keep existing default behavior
Emyrk Aug 3, 2021
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
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ fmt: README.md
README.md: README.md.gotmpl values.yaml
@echo "--- Generating documentation"
helm-docs --template-files=$<
@echo -e "<!-- DO NOT EDIT. THIS IS GENERATED FROM README.md.gotmpl -->\n\n$$(cat README.md)" > README.md
@echo "<!-- DO NOT EDIT. THIS IS GENERATED FROM README.md.gotmpl -->\n\n$$(cat README.md)" > README.md
.PHONY: README.md

clean:
Expand Down
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ View [our docs](https://coder.com/docs/setup/installation) for detailed installa
| certs | object | Certificate that will be mounted inside Coder services. | `{"secret":{"key":"","name":""}}` |
| certs.secret.key | string | Key pointing to a certificate in the secret. | `""` |
| certs.secret.name | string | Name of the secret. | `""` |
| coderd | object | Primary service responsible for all things Coder! | `{"builtinProviderServiceAccount":{"annotations":{},"labels":{}},"devurlsHost":"","image":"","oidc":{"enableRefresh":false,"redirectOptions":{}},"podSecurityContext":{"runAsNonRoot":true,"runAsUser":1000,"seccompProfile":{"type":"RuntimeDefault"}},"replicas":1,"resources":{"limits":{"cpu":"250m","memory":"512Mi"},"requests":{"cpu":"250m","memory":"512Mi"}},"satellite":{"accessURL":"","enable":false,"primaryURL":""},"securityContext":{"allowPrivilegeEscalation":false,"readOnlyRootFilesystem":true,"seccompProfile":{"type":"RuntimeDefault"}},"serviceAnnotations":{},"serviceSpec":{"externalTrafficPolicy":"Local","loadBalancerIP":"","loadBalancerSourceRanges":[],"type":"LoadBalancer"},"superAdmin":{"passwordSecret":{"key":"password","name":""}},"tls":{"devurlsHostSecretName":"","hostSecretName":""},"trustProxyIP":false}` |
| coderd | object | Primary service responsible for all things Coder! | `{"builtinProviderServiceAccount":{"annotations":{},"labels":{}},"devurlsHost":"","image":"","oidc":{"enableRefresh":false,"redirectOptions":{}},"podSecurityContext":{"runAsNonRoot":true,"runAsUser":1000,"seccompProfile":{"type":"RuntimeDefault"}},"replicas":1,"resources":{"limits":{"cpu":"250m","memory":"512Mi"},"requests":{"cpu":"250m","memory":"512Mi"}},"satellite":{"accessURL":"","enable":false,"primaryURL":""},"securityContext":{"allowPrivilegeEscalation":false,"readOnlyRootFilesystem":true,"seccompProfile":{"type":"RuntimeDefault"}},"serviceAnnotations":{},"serviceNodePorts":{"http":30080,"https":30443},"serviceSpec":{"externalTrafficPolicy":"Local","loadBalancerIP":"","loadBalancerSourceRanges":[],"type":"LoadBalancer"},"superAdmin":{"passwordSecret":{"key":"password","name":""}},"tls":{"devurlsHostSecretName":"","hostSecretName":""},"trustProxyIP":false}` |
| coderd.builtinProviderServiceAccount | object | Customize the built-in Kubernetes provider service account. | `{"annotations":{},"labels":{}}` |
| coderd.builtinProviderServiceAccount.annotations | object | A KV mapping of annotations. See: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ | `{}` |
| coderd.builtinProviderServiceAccount.labels | object | Add labels to the service account used for the built-in provider. | `{}` |
Expand All @@ -46,6 +46,9 @@ View [our docs](https://coder.com/docs/setup/installation) for detailed installa
| coderd.securityContext.readOnlyRootFilesystem | bool | Mounts the container's root filesystem as read-only. It is recommended to leave this setting enabled in production. This will override the same setting in the pod | `true` |
| coderd.securityContext.seccompProfile | object | Sets the seccomp profile for the migration and runtime containers. | `{"type":"RuntimeDefault"}` |
| coderd.serviceAnnotations | object | Extra annotations to apply to the coderd service. | `{}` |
| coderd.serviceNodePorts | object | Allows manually setting static node ports for the coderd service. This is only helpful if static ports are required, and usually should be left alone. By default these are dynamically chosen. | `{"http":30080,"https":30443}` |
| coderd.serviceNodePorts.http | int | Sets a static 'coderd' service non-TLS nodePort. This should usually be omitted. | `30080` |
| coderd.serviceNodePorts.https | int | Sets a static 'coderd' service TLS nodePort This should usually be omitted. | `30443` |
| coderd.serviceSpec | object | Specification to inject for the coderd service. See: https://kubernetes.io/docs/concepts/services-networking/service/ | `{"externalTrafficPolicy":"Local","loadBalancerIP":"","loadBalancerSourceRanges":[],"type":"LoadBalancer"}` |
| coderd.serviceSpec.externalTrafficPolicy | string | Set the traffic policy for the service. See: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip | `"Local"` |
| coderd.serviceSpec.loadBalancerIP | string | Set the external IP address of the Ingress service. | `""` |
Expand Down
6 changes: 6 additions & 0 deletions templates/coderd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,10 +254,16 @@ spec:
port: 80
targetPort: 8080
protocol: TCP
{{ if .Values.coderd.serviceNodePorts.http }}
nodePort: {{ .Values.coderd.serviceNodePorts.http }}
{{ end }}
- name: tcp-{{ include "coder.serviceName" . }}-https
port: 443
targetPort: 8443
protocol: TCP
{{ if .Values.coderd.serviceNodePorts.https }}
nodePort: {{ .Values.coderd.serviceNodePorts.https }}
{{ end }}
{{- else }}
---
apiVersion: v1
Expand Down
12 changes: 12 additions & 0 deletions values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@ coderd:
# will be restricted to the specified client IPs. This field will be ignored if
# the cloud provider does not support this feature.
loadBalancerSourceRanges: []

# coderd.serviceNodePorts -- Allows manually setting static node ports for the coderd service.
# This is only helpful if static ports are required, and usually should be left alone.
# By default these are dynamically chosen.
serviceNodePorts:
Copy link

@jawnsy jawnsy Aug 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By adding these to the values file, these will be the default values applicable to all installs - is that what we want? What's the default behavior (e.g. if nodePort isn't specified)?

Copy link
Member Author

@Emyrk Emyrk Aug 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The values.yaml is the default?
The original default is that the nodePorts are selected dynamically. I thought values.yaml was an example config for generating the docs.

Copy link

@jawnsy jawnsy Aug 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the values file is the defaults that will be used if you don't specify any that override them, it's included in the Helm chart package (so if you do: helm install . coder then it'll use the values.yaml file unmodified). otherwise, if you specify --set, then it'll merge the default values file with the args you pass

Copy link
Member Author

@Emyrk Emyrk Aug 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL. So we can't document a field without explicitly setting a default?
I wonder if I can set it to null?

I prefer the default to be unset.

Copy link
Member Author

@Emyrk Emyrk Aug 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could also make the value "0" effectively be "unset"

Copy link

@jawnsy jawnsy Aug 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I think null should work

Copy link

@jawnsy jawnsy Aug 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can test by running make lint/kubernetes, this will generate a bunch of YAML files somewhere that you can examine

Copy link
Member Author

@Emyrk Emyrk Aug 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

null works

# coderd.serviceNodePorts.http -- Sets a static 'coderd' service non-TLS nodePort.
# This should usually be omitted.
http: null
# coderd.serviceNodePorts.https -- Sets a static 'coderd' service TLS nodePort
# This should usually be omitted.
https: null

# coderd.serviceAnnotations -- Extra annotations to apply to the coderd service.
serviceAnnotations: {}

Expand Down