Skip to content

Commit 654b106

Browse files
Adding developer documentation in README.md (#9)
Signed-off-by: Archisman-Mridha <[email protected]> Co-authored-by: Archisman-Mridha <[email protected]> Reviewed-on: https://gitea.obmondo.com/EnableIT/kubeaid-bootstrap-script/pulls/9
1 parent e896608 commit 654b106

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# KubeAid Bootstrap Script
22

3+
## Developer Guide
4+
5+
> Make sure, you've Docker installed in your system.
6+
7+
Run `make build-image-dev` to build the KubeAid Bootstrap Script container image (development version).
8+
9+
Then run `make run-container-dev` to run the container.
10+
11+
In a separate terminal window, use `make exec-container-dev` to execute into the container.
12+
13+
Once you're inside the container, use `make generate-sample-config-aws-dev` to generate a sample config file at [./outputs/kubeaid-bootstrap-script.config.yaml](./outputs/kubeaid-bootstrap-script.config.yaml), targetting the AWS cloud provider. Adjust the config file according to your needs.
14+
15+
Then run `make bootstrap-cluster-dev` to bootstrap the cluster!
16+
317
## REFERENCES
418

519
- [Server-Side Apply](https://kubernetes.io/docs/reference/using-api/server-side-apply/#comparison-with-client-side-apply)

0 commit comments

Comments
 (0)