Skip to content

Commit 2d45bc6

Browse files
author
Simon Emms
committed
[installer]: add explanation for configuring AWS container registry
1 parent f41c652 commit 2d45bc6

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

components/installer/README.md

+23
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,29 @@ The `container-registry-token` secret must contain a `.dockerconfigjson`
252252
key - this can be created by using the `kubectl create secret docker-registry`
253253
[command](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#create-a-secret-by-providing-credentials-on-the-command-line).
254254

255+
### Using Amazon Elastic Container Registry (ECR)
256+
257+
Gitpod is compatible with any registry that implements the [Docker Registry HTTP API V2](https://docs.docker.com/registry/spec/api/)
258+
specification. Amazon ECR does not implement this spec fully. The spec expects
259+
that, if an image is pushed to a repository that doesn't exist, it creates the
260+
repository before uploading the image. Amazon ECR does not do this - if the
261+
repository doesn't exist, it will error on push.
262+
263+
To configure Gitpod to use Amazon, you will need to use the in-cluster
264+
registry and configure it to use S3 storage as the backend storage.
265+
266+
```yaml
267+
containerRegistry:
268+
inCluster: true
269+
s3storage:
270+
bucket: <name of bucket>
271+
certificate:
272+
kind: secret
273+
name: s3-storage-token
274+
```
275+
276+
Please follow the configuration instructions for the [S3 object storage secret](#s3).
277+
255278
## Database
256279

257280
Gitpod requires an instance of MySQL 5.7 for data storage.

0 commit comments

Comments
 (0)