Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 0 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -228,13 +228,6 @@ lint:
lint-fix:
golangci-lint run --fix

### ------------------------------------ HELM ------------------------------------ ###

.PHONY: helm-chart
helm-chart: helm-templates
OPERATOR_VERSION=$(shell cat VERSION) envsubst < charts/$(PROJECT_FULL_NAME)/Chart.yaml.tpl > charts/$(PROJECT_FULL_NAME)/Chart.yaml
OPERATOR_VERSION=$(shell cat VERSION) envsubst < charts/$(PROJECT_FULL_NAME)/values.yaml.tpl > charts/$(PROJECT_FULL_NAME)/values.yaml

### ------------------------------------ E2E ------------------------------------ ###
.PHONY: e2e
e2e: docker-build
Expand Down
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,29 @@ This repository contains the controllers which reconcile Project and Workspace r

## Requirements and Setup

*Insert a short description what is required to get your project running...*
### Prerequisites
In order to run the operator locally, you need to have the following tools installed:
- [Go](https://golang.org/dl/)
- [Docker](https://docs.docker.com/get-docker/)
- [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
- [KIND](https://kind.sigs.k8s.io/)

### Running the Operator Locally
1. Execute `make dev-local` to create a local KIND cluster and deploy the operator via Helm.
2. Look at the [samples](./config/samples/) directory for examples on how to create Project and Workspace resources. Change the `spec` of the resources to you need.
3. Apply them at the local KIND cluster.

### Generating CRDs and Documentation
For generating the CRDs, DeepCopy methods and documentation, execute the following command:
```shell
make generate
```

### Cleaning up the KIND cluster
To clean up the KIND cluster with the deployed operator and its resources, execute the following command:
```shell
make dev-clean
```

## Support, Feedback, Contributing

Expand Down
Loading