Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds section To CONTRIBUTING on running controller locally #230

Merged
merged 1 commit into from
Jan 31, 2022
Merged

Adds section To CONTRIBUTING on running controller locally #230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Contributing to Ketch
We welcome contributions to Ketch in the form of Pull Requests or submitting Issues. Looking for your first contribution? There
We welcome contributions to Ketch in the form of Pull Requests or submitting Issues. Looking for your first contribution? There
are excellent [starter issues](https://github.com/theketchio/ketch/labels/good%20first%20issue) to work on. If you encounter a problem with Ketch or want
to suggest an improvement please submit an Issue. If you find a bug please tell us about it by submitting an Issue or
Pull Request. Please make sure you are testing against the latest version of Ketch when you are submitting a bug. Provide
Expand Down Expand Up @@ -55,5 +55,35 @@ Use the cluster IP address when you create frameworks.
```bash
ketch framework add myframework --ingress-service-endpoint $(kubectl get svc traefik -o jsonpath='{.spec.clusterIP}')
```

### Running the Ketch Controller locally with Minikube
Start a Minikube cluster:

`minikube start -p ketch-cluster --driver=hyperkit`

Install CRDs:

`make install`

*Note: If you revise any CRDs or experience trouble, you can install them manually from the `config/crd` directory, e.g. `kubectl apply -f config/crd/bases/theketch.io_frameworks.yaml`*

Create Ketch's namespace:

`kubectl create ns ketch-system`

Run the controller locally. This permits you to see logs during development:

`go run ./cmd/manager/main.go --enable-leader-election=false --disable-webhooks`

Run a CLI command (in a seperate terminal window):

`go run ./cmd/ketch/. framework add test`

During development, you may need to utilize some `make` utils to update generated code/templates:

- `make generate` to update modified helm templates.
- `make uninstall` to uninstall CRDs prior to re-running `make install`.
- `make manifests` to generate CRDs & RBAC from from code annotations. Ketch uses [Kubebuilder](https://book.kubebuilder.io/reference/controller-gen.html).

## Submission Guidelines
Ketch follows a lightweight Pull Request process. When submitting a PR, answering a few [basic questions](https://github.com/theketchio/ketch/blob/main/.github/pull_request_template.md) around type of change and steps to test and you are well on your way to a PR approval.