|
| 1 | +# Defining ImagePullSecrets for Coder workspaces |
| 2 | + |
| 3 | +<div> |
| 4 | + <a href="https://github.com/ericpaulsen" style="text-decoration: none; color: inherit;"> |
| 5 | + <span style="vertical-align:middle;">Your Name</span> |
| 6 | + <img src="https://github.com/ericpaulsen.png" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/> |
| 7 | + </a> |
| 8 | +</div> |
| 9 | +January 12, 2024 |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +Coder workspaces are commonly run as Kubernetes pods. When run inside of an enterprise, |
| 14 | +the pod image is typically pulled from a private image registry. This guide walks |
| 15 | +through creating an ImagePullSecret to use for authenticating to your registry. |
| 16 | + |
| 17 | +## 1. Create Docker Config JSON File |
| 18 | + |
| 19 | +Create a Docker configuration JSON file containing your registry credentials. |
| 20 | +Replace `<your-registry>`, `<your-username>`, and `<your-password>` with your |
| 21 | +actual Docker registry URL, username, and password. |
| 22 | + |
| 23 | +```json |
| 24 | +{ |
| 25 | + "auths": { |
| 26 | + "<your-registry>": { |
| 27 | + "username": "<your-username>", |
| 28 | + "password": "<your-password>" |
| 29 | + } |
| 30 | + } |
| 31 | +} |
| 32 | +``` |
| 33 | + |
| 34 | +## 2. Create Kubernetes Secret |
| 35 | + |
| 36 | +Run the below `kubectl` command in the K8s cluster where you intend to run your Coder |
| 37 | +workspaces: |
| 38 | + |
| 39 | +```console |
| 40 | +kubectl create secret generic regcred \ |
| 41 | + --from-file=.dockerconfigjson=<path-to-docker-config.json> \ |
| 42 | + --type=kubernetes.io/dockerconfigjson \ |
| 43 | + --namespace=<workspaces-namespace> |
| 44 | +``` |
| 45 | + |
| 46 | +Inspect the secret to confirm its contents: |
| 47 | + |
| 48 | +```console |
| 49 | +kubectl get secret -n <workspaces-namespace> regcred --output="jsonpath={.data.\.dockerconfigjson}" | base64 --decode |
| 50 | +``` |
| 51 | + |
| 52 | +The output should look similar to this: |
| 53 | + |
| 54 | +```json |
| 55 | +{"auths":{"your.private.registry.com":{"username":"ericpaulsen","password":"xxxx","auth":"c3R...zE2"}}} |
| 56 | +``` |
| 57 | + |
| 58 | +## 3. Define ImagePullSecret in Terraform template |
| 59 | + |
| 60 | +```hcl |
| 61 | +resource "kubernetes_pod" "dev" { |
| 62 | + metadata { |
| 63 | + # this must be the same namespace where workspaces will be deployed |
| 64 | + namespace = "workspaces-namespace" |
| 65 | + } |
| 66 | +
|
| 67 | + spec { |
| 68 | + image_pull_secrets { |
| 69 | + name = "regcred" |
| 70 | + } |
| 71 | + container { |
| 72 | + name = "dev" |
| 73 | + image = "your-image:latest" |
| 74 | + } |
| 75 | + } |
| 76 | +} |
| 77 | +``` |
| 78 | + |
0 commit comments