Skip to content

Commit

Permalink
Adding developer documentation in README.md (#9)
Browse files Browse the repository at this point in the history
Signed-off-by: Archisman-Mridha <archismanmridha12345@gmail.com>
Co-authored-by: Archisman-Mridha <archismanmridha12345@gmail.com>
Reviewed-on: https://gitea.obmondo.com/EnableIT/kubeaid-bootstrap-script/pulls/9
  • Loading branch information
Archisman Mridha and Archisman-Mridha committed Oct 16, 2024
1 parent e896608 commit 654b106
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# KubeAid Bootstrap Script

## Developer Guide

> Make sure, you've Docker installed in your system.
Run `make build-image-dev` to build the KubeAid Bootstrap Script container image (development version).

Then run `make run-container-dev` to run the container.

In a separate terminal window, use `make exec-container-dev` to execute into the container.

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.

Then run `make bootstrap-cluster-dev` to bootstrap the cluster!

## REFERENCES

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

0 comments on commit 654b106

Please sign in to comment.