Skip to content

Commit 589d056

Browse files
docs: add requirements and setup section
1 parent 2fe335f commit 589d056

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,27 @@
66

77
A cluster provider for OpenMCP that uses [kind](https://kind.sigs.k8s.io/) to provision clusters. Ideal for local development and E2E tests.
88

9+
## Requirements and Setup
10+
11+
In combination with the [openMCP Operator](https://github.com/openmcp-project/openmcp-operator), this operator can be deployed via a simple k8s resource:
12+
```yaml
13+
apiVersion: openmcp.cloud/v1alpha1
14+
kind: ClusterProvider
15+
metadata:
16+
name: kind
17+
spec:
18+
image: "ghcr.io/openmcp-project/images/cluster-provider-kind:<latest-version>"
19+
```
20+
21+
To run it locally, run
22+
```shell
23+
go run ./cmd/cluster-provider-kind/main.go init
24+
```
25+
to deploy the CRDs that are required for the operator and then
26+
```shell
27+
go run ./cmd/cluster-provider-kind/main.go run
28+
```
29+
930
## How it works
1031

1132
In order to create new kind clusters from within a kind cluster, the Docker socket (usually `/var/run/docker.sock`) needs to be available to the `cluster-provider-kind` pod. As a prerequisite, the Docker socket of the host machine must be mounted into the nodes of the platform kind cluster. In this case, there is only a single node (`platform-control-plane`). The socket can then be mounted by the cluster-provider-kind pod using a `hostPath` volume.

0 commit comments

Comments
 (0)