Skip to content

Commit c586445

Browse files
committed
docs: add steps to configure supportLinks in Helm chart
1 parent 8b10d21 commit c586445

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/admin/appearance.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,45 @@ 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 deployment,
73+
follow the steps below.
74+
75+
#### 1. Create Kubernetes Secret From File
76+
77+
Run the below commmand to create the YAML file as a Kubernetes secret in your cluster:
78+
79+
```console
80+
kubectl create secret generic coder-support-links -n <coder-namespace> --from-file=config.yaml
81+
```
82+
83+
#### 2. Mount Secret as Volume in Helm Chart
84+
85+
Next, update your Helm chart values as follows:
86+
87+
```yaml
88+
coder:
89+
env:
90+
- name: CODER_CONFIG_PATH
91+
value: /etc/coder/config.yaml
92+
volumes:
93+
- name: coder-config
94+
secret:
95+
secretName: coder-support-links
96+
volumeMounts:
97+
- name: coder-config
98+
mountPath: /etc/coder/
99+
```
100+
101+
#### 3. Upgrade Coder
102+
103+
Lastly, upgrade Coder using the following command:
104+
105+
```console
106+
helm upgrade coder coder-v2/coder -n <coder-namespace> -f <values-file.yaml>
107+
```
108+
70109
## Up next
71110

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

0 commit comments

Comments
 (0)