Skip to content

Commit c799f0f

Browse files
authored
docs: add steps to configure supportLinks in Helm chart (#11612)
1 parent e1493b2 commit c799f0f

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/admin/appearance.md

+40
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,46 @@ supportLinks:
6767
6868
The link icons are optional, and limited to: `bug`, `chat`, and `docs`.
6969

70+
### Kubernetes configuration
71+
72+
To pass in the `supportLinks` YAML file above into your Coder Kubernetes
73+
deployment, follow the steps below.
74+
75+
#### 1. Create Kubernetes Secret From File
76+
77+
Run the below command to create the YAML file as a Kubernetes secret in your
78+
cluster:
79+
80+
```console
81+
kubectl create secret generic coder-support-links -n <coder-namespace> --from-file=config.yaml
82+
```
83+
84+
#### 2. Mount Secret as Volume in Helm Chart
85+
86+
Next, update your Helm chart values as follows:
87+
88+
```yaml
89+
coder:
90+
env:
91+
- name: CODER_CONFIG_PATH
92+
value: /etc/coder/config.yaml
93+
volumes:
94+
- name: coder-config
95+
secret:
96+
secretName: coder-support-links
97+
volumeMounts:
98+
- name: coder-config
99+
mountPath: /etc/coder/
100+
```
101+
102+
#### 3. Upgrade Coder
103+
104+
Lastly, upgrade Coder using the following command:
105+
106+
```console
107+
helm upgrade coder coder-v2/coder -n <coder-namespace> -f <values-file.yaml>
108+
```
109+
70110
## Up next
71111

72112
- [Enterprise](../enterprise.md)

0 commit comments

Comments
 (0)