Files
coder/docs/tutorials/image-pull-secret.md
T
Nick Vigilante c58ac71ca3 docs(docs/tutorials): reformat to one sentence per line (#30703)
Reformats the tutorials under `docs/tutorials` to one sentence per line,
as the [docs style
guide](https://github.com/coder/coder/blob/main/docs/.style/style-guide/formatting.md#one-sentence-per-line)
requires. Hard-wrapped paragraphs are unwrapped and lines holding
several sentences are split, so a later edit to one sentence shows up as
a one-line diff.

Apart from the exception below, only whitespace inside paragraphs and
list items changes, and the rendered pages are the same. Comparing the
changed files against `main` word for word, ignoring whitespace and
blockquote `>` markers, finds differences only on the reworded lines.
`git diff --word-diff` is easier to read than the line diff.

9 lines that already contained an em or en dash were reworded by hand,
because `lint/emdash` treats every reflowed line as newly added. Each
uses a parenthetical, a separate sentence, or a colon after a lead-in.
Dashes on lines the reflow did not touch are left alone. The two reverse
proxy tutorials also write `*.coder.example.com` in backticks instead of
escaping the asterisk, which the formatter would otherwise drop.

Applied with an in-progress formatter, limited to pages listed in
`docs/manifest.json` and excluding generated reference docs. This is one
of a batch of PRs that split the docs by area (19 files changed, 656
insertions(+), 1265 deletions(-)).

---
🤖 Built with AI assistance.
2026-10-15 11:24:40 -04:00

2.4 KiB

title
title
Define ImagePullSecrets for Coder workspaces
January 12, 2024

Coder workspaces are commonly run as Kubernetes pods. When run inside of an enterprise, the pod image is typically pulled from a private image registry. This guide walks through creating an ImagePullSecret to use for authenticating to your registry, and defining it in your workspace template.

1. Create Docker Config JSON File

Create a Docker configuration JSON file containing your registry credentials. Replace <your-registry>, <your-username>, and <your-password> with your actual Docker registry URL, username, and password.

{
    "auths": {
        "<your-registry>": {
            "username": "<your-username>",
            "password": "<your-password>"
        }
    }
}

2. Create Kubernetes Secret

Run the below kubectl command in the K8s cluster where you intend to run your Coder workspaces:

kubectl create secret generic regcred \
  --from-file=.dockerconfigjson=<path-to-docker-config.json> \
  --type=kubernetes.io/dockerconfigjson \
  --namespace=<workspaces-namespace>

Inspect the secret to confirm its contents:

kubectl get secret -n <workspaces-namespace> regcred --output="jsonpath={.data.\.dockerconfigjson}" | base64 --decode

The output should look similar to this:

{
    "auths": {
        "your.private.registry.com": {
            "username": "ericpaulsen",
            "password": "xxxx",
            "auth": "c3R...zE2"
        }
    }
}

3. Define ImagePullSecret in Terraform template

With the ImagePullSecret now created, we can add the secret into the workspace template. In the example below, we define the secret via the image_pull_secrets argument. Note that this argument is nested at the same level as the container argument:

resource "kubernetes_pod" "dev" {
  metadata {
    # this must be the same namespace where workspaces will be deployed
    namespace = "workspaces-namespace"
  }

  spec {
    image_pull_secrets {
      name = "regcred"
    }
    container {
      name  = "dev"
      image = "your-image:latest"
    }
  }
}

4. Push New Template Version

Update your template by running the following commands:

coder login <access-url>
coder templates push <template-name>