Skip to content

docs: add steps to configure supportLinks in Helm chart #11612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 15, 2024
+40 −0
Merged

docs: add steps to configure supportLinks in Helm chart #11612

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c586445
docs: add steps to configure supportLinks in Helm chart
ericpaulsen Jan 14, 2024
9e091a0
make: fmt
ericpaulsen Jan 14, 2024
40e8e75
fix: typo
ericpaulsen Jan 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions docs/admin/appearance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <coder-namespace> --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 <coder-namespace> -f <values-file.yaml>
```

## Up next

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