Skip to content

Commit f3b2009

Browse files
kylecarbskylecarbs
authored
chore: reorder helm chart to improve ux (#8108)
It makes no sense that the primary option `env` was so far below infrequently used options.
1 parent 467b0a1 commit f3b2009

File tree

1 file changed

+42
-42
lines changed

1 file changed

+42
-42
lines changed

‎helm/values.yaml

+42-42
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,25 @@
11
# coder -- Primary configuration for `coder server`.
22
coder:
3-
# coder.replicaCount -- The number of Kubernetes deployment replicas. This
4-
# should only be increased if High Availability is enabled.
5-
#
6-
# This is an Enterprise feature. Contact sales@coder.com.
7-
replicaCount: 1
8-
9-
# coder.workspaceProxy -- Whether or not this deployment of Coder is a Coder
10-
# Workspace Proxy. Workspace Proxies reduce the latency between the user and
11-
# their workspace for web connections (workspace apps and web terminal) and
12-
# proxied connections from the CLI. Workspace Proxies are optional and only
13-
# recommended for geographically sparse teams.
14-
#
15-
# Make sure you set CODER_PRIMARY_ACCESS_URL and CODER_PROXY_SESSION_TOKEN in
16-
# the environment below. You can get a proxy token using the CLI:
17-
# coder wsproxy create \
18-
# --name "proxy-name" \
19-
# --display-name "Proxy Name" \
20-
# --icon "/emojis/xyz.png"
3+
# coder.env -- The environment variables to set for Coder. These can be used
4+
# to configure all aspects of `coder server`. Please see `coder server --help`
5+
# for information about what environment variables can be set.
6+
# Note: The following environment variables are set by default and cannot be
7+
# overridden:
8+
# - CODER_HTTP_ADDRESS: set to 0.0.0.0:8080 and cannot be changed.
9+
# - CODER_TLS_ADDRESS: set to 0.0.0.0:8443 if tls.secretName is not empty.
10+
# - CODER_TLS_ENABLE: set if tls.secretName is not empty.
11+
# - CODER_TLS_CERT_FILE: set if tls.secretName is not empty.
12+
# - CODER_TLS_KEY_FILE: set if tls.secretName is not empty.
13+
# - CODER_PROMETHEUS_ADDRESS: set to 0.0.0.0:6060 and cannot be changed.
14+
# Prometheus must still be enabled by setting CODER_PROMETHEUS_ENABLE.
15+
# - KUBE_POD_IP
16+
# - CODER_DERP_SERVER_RELAY_URL
2117
#
22-
# This is an Enterprise feature. Contact sales@coder.com
23-
# Docs: https://coder.com/docs/v2/latest/admin/workspace-proxies
24-
workspaceProxy: false
18+
# We will additionally set CODER_ACCESS_URL if unset to the cluster service
19+
# URL.
20+
env: []
21+
# - name: "CODER_ACCESS_URL"
22+
# value: "https://coder.example.com"
2523

2624
# coder.image -- The image to use for Coder.
2725
image:
@@ -106,27 +104,6 @@ coder:
106104
# root. It is recommended to leave this setting disabled in production.
107105
allowPrivilegeEscalation: false
108106

109-
# coder.env -- The environment variables to set for Coder. These can be used
110-
# to configure all aspects of `coder server`. Please see `coder server --help`
111-
# for information about what environment variables can be set.
112-
# Note: The following environment variables are set by default and cannot be
113-
# overridden:
114-
# - CODER_HTTP_ADDRESS: set to 0.0.0.0:8080 and cannot be changed.
115-
# - CODER_TLS_ADDRESS: set to 0.0.0.0:8443 if tls.secretName is not empty.
116-
# - CODER_TLS_ENABLE: set if tls.secretName is not empty.
117-
# - CODER_TLS_CERT_FILE: set if tls.secretName is not empty.
118-
# - CODER_TLS_KEY_FILE: set if tls.secretName is not empty.
119-
# - CODER_PROMETHEUS_ADDRESS: set to 0.0.0.0:6060 and cannot be changed.
120-
# Prometheus must still be enabled by setting CODER_PROMETHEUS_ENABLE.
121-
# - KUBE_POD_IP
122-
# - CODER_DERP_SERVER_RELAY_URL
123-
#
124-
# We will additionally set CODER_ACCESS_URL if unset to the cluster service
125-
# URL.
126-
env: []
127-
# - name: "CODER_ACCESS_URL"
128-
# value: "https://coder.example.com"
129-
130107
# coder.volumes -- A list of extra volumes to add to the Coder pod.
131108
volumes: []
132109
# - name: "my-volume"
@@ -146,6 +123,29 @@ coder:
146123
# "CODER_TLS_*" environment variables will be set for you.
147124
secretNames: []
148125

126+
# coder.replicaCount -- The number of Kubernetes deployment replicas. This
127+
# should only be increased if High Availability is enabled.
128+
#
129+
# This is an Enterprise feature. Contact sales@coder.com.
130+
replicaCount: 1
131+
132+
# coder.workspaceProxy -- Whether or not this deployment of Coder is a Coder
133+
# Workspace Proxy. Workspace Proxies reduce the latency between the user and
134+
# their workspace for web connections (workspace apps and web terminal) and
135+
# proxied connections from the CLI. Workspace Proxies are optional and only
136+
# recommended for geographically sparse teams.
137+
#
138+
# Make sure you set CODER_PRIMARY_ACCESS_URL and CODER_PROXY_SESSION_TOKEN in
139+
# the environment below. You can get a proxy token using the CLI:
140+
# coder wsproxy create \
141+
# --name "proxy-name" \
142+
# --display-name "Proxy Name" \
143+
# --icon "/emojis/xyz.png"
144+
#
145+
# This is an Enterprise feature. Contact sales@coder.com
146+
# Docs: https://coder.com/docs/v2/latest/admin/workspace-proxies
147+
workspaceProxy: false
148+
149149
# coder.lifecycle -- container lifecycle handlers for the Coder container, allowing
150150
# for lifecycle events such as postStart and preStop events
151151
# See: https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/

0 commit comments

Comments
 (0)