From c799f0ff4300ec99ae373e75320c4a74239d356c Mon Sep 17 00:00:00 2001 From: Eric Paulsen Date: Mon, 15 Jan 2024 05:29:59 -0500 Subject: [PATCH] docs: add steps to configure supportLinks in Helm chart (#11612) --- docs/admin/appearance.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/docs/admin/appearance.md b/docs/admin/appearance.md index 168aa930cc..b1bd1aa7b4 100644 --- a/docs/admin/appearance.md +++ b/docs/admin/appearance.md @@ -67,6 +67,46 @@ supportLinks: The link icons are optional, and limited to: `bug`, `chat`, and `docs`. +### Kubernetes configuration + +To pass in the `supportLinks` YAML file above into your Coder Kubernetes +deployment, follow the steps below. + +#### 1. Create Kubernetes Secret From File + +Run the below command to create the YAML file as a Kubernetes secret in your +cluster: + +```console +kubectl create secret generic coder-support-links -n --from-file=config.yaml +``` + +#### 2. Mount Secret as Volume in Helm Chart + +Next, update your Helm chart values as follows: + +```yaml +coder: + env: + - name: CODER_CONFIG_PATH + value: /etc/coder/config.yaml + volumes: + - name: coder-config + secret: + secretName: coder-support-links + volumeMounts: + - name: coder-config + mountPath: /etc/coder/ +``` + +#### 3. Upgrade Coder + +Lastly, upgrade Coder using the following command: + +```console +helm upgrade coder coder-v2/coder -n -f +``` + ## Up next - [Enterprise](../enterprise.md)