Skip to content

Commit 433b53c

Browse files
committed
feature: update readme
1 parent b4b1d1a commit 433b53c

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

README.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,25 @@ ExecDAT is a tool to execute data analysis tasks on Kubernetes. It is designed t
88

99
## Getting Started
1010

11-
You’ll need a Kubernetes cluster to run against. See k3d for a quick way to get a local cluster up and running.
12-
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
11+
### Prerequisites
12+
13+
* operator-sdk
14+
* container engine (docker, podman, ...)
15+
* kubernetes cluster (minikube, k3d, ...)
16+
17+
### Test out the operator
18+
19+
```shell
20+
make install
21+
make run
22+
```
23+
24+
### Run using OLM
25+
26+
```shell
27+
operator-sdk olm install
28+
operator-sdk run bundle-upgrade ghcr.io/austriandatalab/execdat-operator-bundle:v0.2.0
29+
```
1330

1431
### Running on the cluster
1532

@@ -47,33 +64,13 @@ UnDeploy the controller to the cluster:
4764
make undeploy
4865
```
4966

50-
## Contributing
51-
52-
// TODO(user): Add detailed information on how you would like others to contribute to this project
53-
5467
### How it works
5568

5669
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
5770

5871
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/)
5972
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster
6073

61-
### Test It Out
62-
63-
1. Install the CRDs into the cluster:
64-
65-
```sh
66-
make install
67-
```
68-
69-
2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
70-
71-
```sh
72-
make run
73-
```
74-
75-
**NOTE:** You can also run this in one step by running: `make install run`
76-
7774
### Modifying the API definitions
7875

7976
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

0 commit comments

Comments
 (0)