Skip to content

Commit 3c9d36f

Browse files
authored
Update custom registry instructions to include details on keeping image digests intact (#278)
Signed-off-by: Dom Del Nano <ddelnano@pixielabs.ai>
1 parent 7f0020f commit 3c9d36f

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

content/en/05-reference/01-admin/03-deploy-options.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,9 @@ helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-k
203203

204204
By default, Pixie uses images hosted on `gcr.io`. Pixie allows you to specify a custom image registry for clusters which may not have access to `gcr.io` or for users who simply want to host their own images.
205205

206+
### Prerequisites
207+
* Install the [crane](https://github.com/google/go-containerregistry/blob/a748190e18d49e759b7e28309f576dba82280d47/cmd/crane/README.md#install-from-releases) cli utility. This will be used to copy Pixie's source images to your registry while keeping the the image digest intact. Note that `docker tag` and other tools that change the image digest will fail to install during the final deploy step.
208+
206209
### Collect the Vizier images
207210

208211
1. Download the Vizier artifacts:
@@ -228,7 +231,13 @@ cat images/vizier_etcd_image_list.txt
228231

229232
3. Collect and publish the images listed in **Step 2** to your custom registry.
230233

231-
> Note that Pixie expects hosted images to adhere to the following format: `${custom_registry}/${defaultImagePath | sed 's/\//-/g'}`. In other words, Pixie will expect your images to be hosted on your registry, where the image name in your registry is Pixie's full image path with any `/` replaced with `-`. For example: `gcr.io/pixie-oss/pixie-dev/vizier/metadata_server_image:latest` should pushed to `$registry/gcr.io-pixie-oss-pixie-dev-vizier-metadata_server_image:latest`.
234+
> Note that Pixie expects hosted images to adhere to the following format: `${custom_registry}/${defaultImagePath | sed 's/\//-/g'}`. In other words, Pixie will expect your images to be hosted on your registry, where the image name in your registry is Pixie's full image path with any `/` replaced with `-`. For example: `gcr.io/pixie-oss/pixie-dev/vizier/metadata_server_image:latest` should pushed to `$registry/gcr.io-pixie-oss-pixie-dev-vizier-metadata_server_image:latest` and contain the same image digest.
235+
236+
> This can be accomplished with the crane cli tool and an example of it's copy command is shown below:
237+
238+
```
239+
crane cp gcr.io/pixie-oss/pixie-dev/vizier-metadata_server_image:latest $registry/gcr.io-pixie-oss-pixie-dev-vizier-metadata_server_image:latest
240+
```
232241

233242
### Collect the OLM images
234243

0 commit comments

Comments
 (0)