From 977490b0a0fcf94454fcdf7c79ee2e3952e14e19 Mon Sep 17 00:00:00 2001
From: Cian Johnston <cian@coder.com>
Date: Tue, 2 Jan 2024 11:10:48 +0000
Subject: [PATCH] chore(README.md): add note regarding structure of
 CODER_IMAGE_PULL_SECRET

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index a64c560..8fb02eb 100644
--- a/README.md
+++ b/README.md
@@ -63,3 +63,25 @@ env {
   }
 }
 ```
+
+> **Note:**
+>
+> If you use external tooling to generate the secret, ensure that it is generated with the same fields as `kubectl create secret docker-registry`. You can check this with the following command:
+>
+> ```console
+> kubectl create secret docker-registry example --docker-server=registry.domain.tld --docker-username=username --docker-password=password --dry-run=client --output=json | jq -r '.data[".dockerconfigjson"]' | base64 -d | jq
+> ```
+>
+> Sample output:
+>
+> ```json
+> {
+>   "auths": {
+>     "registry.domain.tld": {
+>       "username": "username",
+>       "password": "password",
+>       "auth": "dXNlcm5hbWU6cGFzc3dvcmQ=" // base64(username:password)
+>     }
+>   }
+> }
+> ```