You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-26Lines changed: 19 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -151,32 +151,25 @@ After deployment, create your DataSink configuration as described in the [DataSi
151
151
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
152
152
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
153
153
154
-
### Running on the cluster
155
-
1. Install Instances of Custom Resources:
156
-
157
-
```sh
158
-
make dev-local-all
159
-
```
160
-
161
-
2. Run the controller:
162
-
163
-
```sh
164
-
make dev-run
165
-
```
166
-
Or run it from your IDE.
167
-
168
-
### Delete Kind Cluster
169
-
Delete Kind cluster
170
-
```sh
171
-
make dev-clean
172
-
```
173
-
174
-
### Modifying the API definitions
175
-
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
176
-
177
-
```sh
178
-
make manifests generate
179
-
```
154
+
### Quickstart
155
+
156
+
1. Clone the repository and install prerequisites (Go, Docker, kind, kubectl).
157
+
2. Configure your data sink by copying the configuration in [`examples/datasink/basic-datasink.yaml`](examples/datasink/basic-datasink.yaml) and modifying it to suit your environment.
158
+
- For example, if using Dynatrace, create a Kubernetes Secret with your API token and update the DataSink resource accordingly.
159
+
- The file should be placed and named like this: `examples/datasink/dynatrace-prod-setup.yaml`. (automatically excluded in [.gitignore](.gitignore))
160
+
3. Run `make dev-local-all` to set up a local development environment.
161
+
4. Run `make run` to start the Metrics Operator locally.
162
+
5. Check your data sink for incoming metrics.
163
+
164
+
### Common Development Tasks
165
+
This project uses a Makefile to streamline development tasks. Common targets include:
166
+
167
+
-`make dev-local-all` – Set up a local kind cluster with all CRDs, Crossplane, and sample resources.
168
+
-`make run` – Run the operator locally for development.
169
+
-`make dev-clean` – Delete the local kind cluster.
170
+
-`make test` – Run all Go tests.
171
+
-`make lint` – Run golangci-lint on the codebase.
172
+
-`make manifests generate` – Regenerate CRDs and deepcopy code after API changes.
0 commit comments