@@ -8,8 +8,25 @@ ExecDAT is a tool to execute data analysis tasks on Kubernetes. It is designed t
8
8
9
9
## Getting Started
10
10
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
+ ```
13
30
14
31
### Running on the cluster
15
32
@@ -47,33 +64,13 @@ UnDeploy the controller to the cluster:
47
64
make undeploy
48
65
```
49
66
50
- ## Contributing
51
-
52
- // TODO(user): Add detailed information on how you would like others to contribute to this project
53
-
54
67
### How it works
55
68
56
69
This project aims to follow the Kubernetes [ Operator pattern] ( https://kubernetes.io/docs/concepts/extend-kubernetes/operator/ )
57
70
58
71
It uses [ Controllers] ( https://kubernetes.io/docs/concepts/architecture/controller/ )
59
72
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster
60
73
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
-
77
74
### Modifying the API definitions
78
75
79
76
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
0 commit comments