From c586445145f03be90cb92397aee2511ed646200c Mon Sep 17 00:00:00 2001 From: Eric Date: Sun, 14 Jan 2024 23:14:43 +0000 Subject: [PATCH 1/3] docs: add steps to configure supportLinks in Helm chart --- docs/admin/appearance.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/docs/admin/appearance.md b/docs/admin/appearance.md index 168aa930cc842..18b4d2ae3a4c9 100644 --- a/docs/admin/appearance.md +++ b/docs/admin/appearance.md @@ -67,6 +67,45 @@ 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 commmand 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) From 9e091a02f53809d6b162dfecb6b8c35dc1242a2a Mon Sep 17 00:00:00 2001 From: Eric Date: Sun, 14 Jan 2024 23:15:19 +0000 Subject: [PATCH 2/3] make: fmt --- docs/admin/appearance.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/admin/appearance.md b/docs/admin/appearance.md index 18b4d2ae3a4c9..759e503a4e970 100644 --- a/docs/admin/appearance.md +++ b/docs/admin/appearance.md @@ -69,12 +69,13 @@ 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. +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 commmand to create the YAML file as a Kubernetes secret in your cluster: +Run the below commmand 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 @@ -87,15 +88,15 @@ Next, update your Helm chart values as follows: ```yaml coder: env: - - name: CODER_CONFIG_PATH - value: /etc/coder/config.yaml + - name: CODER_CONFIG_PATH + value: /etc/coder/config.yaml volumes: - - name: coder-config - secret: - secretName: coder-support-links + - name: coder-config + secret: + secretName: coder-support-links volumeMounts: - - name: coder-config - mountPath: /etc/coder/ + - name: coder-config + mountPath: /etc/coder/ ``` #### 3. Upgrade Coder From 40e8e750877576e8822d6d1bc1d3370454578c7f Mon Sep 17 00:00:00 2001 From: Eric Date: Sun, 14 Jan 2024 23:25:35 +0000 Subject: [PATCH 3/3] fix: typo --- docs/admin/appearance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin/appearance.md b/docs/admin/appearance.md index 759e503a4e970..b1bd1aa7b4aa8 100644 --- a/docs/admin/appearance.md +++ b/docs/admin/appearance.md @@ -74,7 +74,7 @@ deployment, follow the steps below. #### 1. Create Kubernetes Secret From File -Run the below commmand to create the YAML file as a Kubernetes secret in your +Run the below command to create the YAML file as a Kubernetes secret in your cluster: ```console