Documentation: Private image registries

[csweichel]

trafficstars

Describe your feature

We're adding support for private Docker image registries. The support is very rough and needs documentation. The PR (linked below) demonstrates how to use that feature.

How to test

see PR

[pawlean]

Yay! So exciting.

[csweichel]

added in https://github.com/gitpod-io/gitpod/pull/8550

[princerachit]

I am opening this issue as I don't see associated PR for the docs. Search on gitpod website is also not returning anything useful. Is this actually documented?

[atduarte]

@csweichel I would like to pick this up. Could you share some details or pointer on how this works?

[kylos101]

@atduarte some pointers:

Setup must be done in a Project's Variables.

1. Define GITPOD_IMAGE_AUTH as the name [1]
2. The value is <domain>:<base64 encoded value> [2]
   1. The string you base64 encode should be like username:password_or_apikey
   2. If using Docker Hub, the domain is docker.io
   3. Beware [3]
3. Limitation: if using a custom image, define it in the .gitpod.yml (not the Dockerfile), related.

[kylos101]

@atduarte ☝ should be enough to pick this up, test it, and update the documentation. I'mma move to breakdown. Would you still like to pick this up?

[atduarte]

@kylos101 yes, thank you! I missed the previous comment last week. It's perfect 🙌

[Siddhant-K-code]

Please, do take care of https://github.com/gitpod-io/gitpod/pull/8550#issuecomment-1278780916