chore: update readme for GKE clusters using GCR

KatieArmstr · KatieArmstr · commit d3fbae46d4e6 · 2021-05-05T10:03:25.000+01:00
gcloud installed on the image to allow users with clusters running on GKE to access GCR without without managing static credentials
diff --git a/README.md b/README.md
@@ -43,13 +43,24 @@ The Snyk Integration ID is used in the `--from-literal=integrationId=` parameter
 
 Create a file named `dockercfg.json`. Store your `dockercfg` in there; it should look like this:
 
-```json
+```hjson
 {
+  // If your cluster does not run on GKE or it runs on GKE and pulls images from other private registries, add the following:
   "auths": {
     "gcr.io": {
       "auth": "BASE64-ENCODED-AUTH-DETAILS"
     }
     // Add other registries as necessary
+  },
+  
+  // If your cluster runs on GKE and you are using GCR, add the following:
+  "credHelpers": {
+    "us.gcr.io": "gcloud",
+    "asia.gcr.io": "gcloud",
+    "marketplace.gcr.io": "gcloud",
+    "gcr.io": "gcloud",
+    "eu.gcr.io": "gcloud",
+    "staging-k8s.gcr.io": "gcloud"
   }
 }
 ```

Original file line number	Diff line number	Diff line change
@@ -43,13 +43,24 @@ The Snyk Integration ID is used in the `--from-literal=integrationId=` parameter
`43`	`43`
`44`	`44`	Create a file named `dockercfg.json`. Store your `dockercfg` in there; it should look like this:
`45`	`45`
`46`		-```json
	`46`	+```hjson
`47`	`47`	`{`
	`48`	`+ // If your cluster does not run on GKE or it runs on GKE and pulls images from other private registries, add the following:`
`48`	`49`	`"auths": {`
`49`	`50`	`"gcr.io": {`
`50`	`51`	`"auth": "BASE64-ENCODED-AUTH-DETAILS"`
`51`	`52`	`}`
`52`	`53`	`// Add other registries as necessary`
	`54`	`+ },`
	`55`	`+`
	`56`	`+ // If your cluster runs on GKE and you are using GCR, add the following:`
	`57`	`+ "credHelpers": {`
	`58`	`+ "us.gcr.io": "gcloud",`
	`59`	`+ "asia.gcr.io": "gcloud",`
	`60`	`+ "marketplace.gcr.io": "gcloud",`
	`61`	`+ "gcr.io": "gcloud",`
	`62`	`+ "eu.gcr.io": "gcloud",`
	`63`	`+ "staging-k8s.gcr.io": "gcloud"`
`53`	`64`	`}`
`54`	`65`	`}`
`55`	`66`	```