Skip to content

Commit 1032d9e

Browse files
committed
docs(readme): fixup docs for building dev registry
1 parent 563a90d commit 1032d9e

1 file changed

Lines changed: 30 additions & 8 deletions

File tree

README.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,58 @@ This Docker image is based on the official docker distribution image.
66

77
Please add any [issues](https://github.com/deis/registry/issues) you find with this software to the [Distribution Project](https://github.com/docker/distribution).
88

9-
109
## Deploying
1110

12-
To build a dev release of this image, you will also need your own registry, but DockerHub or Quay will do fine here. To build, run:
11+
If you want to use the latest registry image built by they Deis team you can simply start a registry via `make deploy`.
12+
13+
If however, you want to build and use a custom image see the instructions below.
14+
15+
## Build and Deploy
16+
17+
To build a dev release of this image, you will also need a registry to hold the custom images. This can be your own registry, Dockerhub, or Quay.
18+
1319

20+
First, configure your environment to point to the registry location.
21+
22+
```console
23+
$ export DEIS_REGISTRY=myregistry.com:5000 # or quay.io, if using Dockerhub, leave this unset
24+
$ export IMAGE_PREFIX=youruser/ # if using Quay or Dockerhub
1425
```
15-
$ export DEIS_REGISTRY=myregistry.com:5000
26+
27+
To build and push the image run:
28+
29+
```console
1630
$ make docker-build docker-push
1731
```
1832

19-
This will compile the Docker image and push it to your registry.
33+
Before deploying your custom image you must update the container image specification in the pod manifest. This file is found at `contrib/kubernetes/manifests/registry-rc.yaml`:
34+
35+
```yaml
36+
- name: registry
37+
image: quay.io/youruser/registry:git-f5c7dc3
38+
env:
39+
- name: REGISTRY_STORAGE_DELETE_ENABLED
40+
value: "true"
41+
```
2042
21-
After that, run
43+
Once updated, deploy the registry to your kubernetes cluster with:
2244
2345
```
2446
$ make deploy
2547
```
2648

27-
Which will deploy the component to kubernetes. After a while, you should see one pod up with one running:
49+
After a while, you should see one pod up with one running:
2850

2951
```
3052
NAME READY STATUS RESTARTS AGE
3153
registry-6wy8o 1/1 Running 0 32s
3254
```
3355

34-
You can then query this pod as you would with any other Kubernetes pod:
56+
You can then interact with this pod as you would with any other Kubernetes pod:
3557

3658
```
3759
$ kubectl logs -f registry-6wy8o
38-
$ kubectl exec -it registry-6wy8o psql
60+
$ kubectl exec -it registry-6wy8o sh
3961
```
4062

4163
## License

0 commit comments

Comments
 (0)