Skip to content

Commit baca4eb

Browse files
Add make target for easy-deploy
1 parent 91b76da commit baca4eb

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

Makefile

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,13 @@ ifneq ($(TAG:release-v%=%),$(TAG))
182182
endif
183183
endif
184184

185+
# easy-deploy can be used for building and pushing a custom image of MCAD and deploying it on your K8s cluster for development.
186+
# Example: "make easy-deploy TAG=<image tag> USERNAME=<quay.io username>"
187+
easy-deploy: images-podman
188+
podman tag localhost/mcad-controller:${TAG} quay.io/${USERNAME}/mcad-controller:${TAG}
189+
podman push quay.io/${USERNAME}/mcad-controller:${TAG}
190+
cd deployment && helm install mcad-controller mcad-controller --namespace kube-system --wait --set image.repository=quay.io/${USERNAME}/mcad-controller --set image.tag=${TAG}
191+
185192
run-test:
186193
$(info Running unit tests...)
187194
go test -v -coverprofile cover.out -race -parallel 8 ./pkg/...

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ Follow the [build instructions here](./doc/build/build.md) to build the Multi-Cl
1414

1515
Refer to [deployment instructions here](./doc/deploy/deployment.md) on how to deploy the `multi-cluster-app-dispatcher` as a controller in Kubernetes.
1616

17+
Alternatively, for a quick deployment, you can use the `easy-deploy` make target to build, push, and deploy your custom image of MCAD on your Kubernetes cluster:
18+
```
19+
make easy-deploy TAG=<image tag> USERNAME=<quay.io username>
20+
```
21+
Note: Ensure you are logged into your quay.io account on your local machine, and your kubeconfig is pointing to the cluster you want to deploy MCAD on.
1722

1823
## Release Process
1924

doc/deploy/deployment.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,15 @@ For example:
142142
```
143143
helm install <release-name> mcad-controller --namespace kube-system --wait --set image.repository=tonghoon --set image.tag=both --set configMap.name=mcad-deployer --set configMap.dispatcherMode='"true"' --set configMap.agentConfigs=agent101config:uncordon --set volumes.hostPath=/etc/kubernetes
144144
```
145+
146+
##### Example 4
147+
Use the `easy-deploy` make target to build, push, and deploy your custom image of MCAD on your Kubernetes cluster:
148+
149+
```
150+
make easy-deploy TAG=<image tag> USERNAME=<quay.io username>
151+
```
152+
Note: This assumes you are logged into your quay.io account on your local machine, and your kubeconfig is pointing to the cluster you want to deploy MCAD on.
153+
145154
### Chart configuration
146155

147156
The following table lists the configurable parameters of the helm chart and their default values.

0 commit comments

Comments
 (0)