-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
closes #78
- Loading branch information
Showing
2 changed files
with
33 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,35 @@ | ||
# Local Environment Setup | ||
# Contributing | ||
|
||
We have included some makefile targets to ease the local development process. You will need the following tools installed to get started. | ||
We have included some makefile targets to ease the local development process. You will need the following tools | ||
installed to get started. | ||
|
||
- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/) | ||
- [Kubectl](https://kubernetes.io/docs/tasks/tools/) | ||
- [Crossplane CLI](https://crossplane.io/docs/v1.4/getting-started/install-configure.html#install-crossplane-cli) (Not required, but suggested) | ||
## How-Tos | ||
|
||
You can then run `make` which will build the project and setup the build submodule. Once this is finished you can then run `make dev` which will boot up a kind cluster, install Crossplane, any CRDs for the project, and then start the provider. | ||
### Getting Started | ||
|
||
You can run `make dev-clean` to then cleanup the cluster, or `make dev-restart` which will run the `dev-clean` and then the `dev` targets. | ||
1. Install [Kind][0]. | ||
2. Install [Kubectl][1]. | ||
3. Install [Crossplane CLI][2] (Not required, but suggested). | ||
4. Install `make`. | ||
5. Install `go` version `1.18`. | ||
6. Run `make submodules` to initialize the submodules. | ||
7. Run `make dev` to start the cluster and install the provider. | ||
|
||
### Cleanup the Cluster | ||
|
||
1. Run `make dev-clean` to then clean up the cluster. | ||
2. Run `make dev-restart` to then start the cluster again. Or run `make dev-restart` which will run the `make dev-clean` | ||
and then the `make dev` targets. | ||
|
||
## Explanations | ||
|
||
### Makefile | ||
|
||
- `make dev` will boot up a `kind` cluster, install `Crossplane`, any `CRDs` for the project, and then start the | ||
provider. | ||
|
||
[0]: https://kind.sigs.k8s.io/docs/user/quick-start/ | ||
|
||
[1]: https://kubernetes.io/docs/tasks/tools/ | ||
|
||
[2]: https://docs.crossplane.io/v1.10/getting-started/install-configure#install-crossplane-cli |