Skip to content

Commit 54594eb

Browse files
authored
Modify README/usage to address the current situation (#177)
Currently, our image repository (ghcr.io) is private. So users should build and load images themselves. This PR modifies The usage part in README to add that information. Fixes: #175
2 parents 9b478c5 + 938c686 commit 54594eb

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

Makefile

+4-2
Original file line numberDiff line numberDiff line change
@@ -331,11 +331,13 @@ build.cluster: $(KTF) # builds a KIND cluster which can be used for testing and
331331
.PHONY: load.image
332332
load.image: build.image
333333
kind load docker-image $(BLIXT_CONTROLPLANE_IMAGE):$(TAG) --name $(KIND_CLUSTER) && \
334-
kubectl -n blixt-system rollout restart deployment blixt-controlplane
334+
kubectl -n blixt-system get deployment blixt-controlplane >/dev/null 2>&1 && \
335+
kubectl -n blixt-system rollout restart deployment blixt-controlplane || true
335336

336337
.PHONY: load.all.images
337338
load.all.images: build.all.images
338339
kind load docker-image $(BLIXT_CONTROLPLANE_IMAGE):$(TAG) --name $(KIND_CLUSTER) && \
339340
kind load docker-image $(BLIXT_DATAPLANE_IMAGE):$(TAG) --name $(KIND_CLUSTER) && \
340341
kind load docker-image $(BLIXT_UDP_SERVER_IMAGE):$(TAG) --name $(KIND_CLUSTER) && \
341-
kubectl -n blixt-system rollout restart deployment blixt-controlplane
342+
kubectl -n blixt-system get deployment blixt-controlplane >/dev/null 2>&1 && \
343+
kubectl -n blixt-system rollout restart deployment blixt-controlplane || true

README.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,28 @@ to have _you_ join us in iterating on it and helping us build it together!
8181
> (KIND)][kind] clusters. You can generate a new development cluster for
8282
> testing with `make build.cluster`.
8383
84-
Deploy [Gateway API][gwapi] [CRDs][crds]:
84+
> **Note**: Currently our container images are under migration from a private repository.
85+
> At this moment, you should build and load images yourself.
86+
87+
1. Deploy [Gateway API][gwapi] [CRDs][crds]:
8588

8689
```console
8790
kubectl apply -k https://github.com/kubernetes-sigs/gateway-api/config/crd/experimental?ref=v0.8.1
8891
```
8992

90-
Deploy:
93+
2. Build Blixt images:
94+
95+
```console
96+
make build.all.images TAG=latest
97+
```
98+
99+
3. Load images into your Kind cluster:
100+
101+
```console
102+
make load.all.images TAG=latest
103+
```
104+
105+
4. Deploy Blixt:
91106

92107
```console
93108
kubectl apply -k config/default

0 commit comments

Comments
 (0)