Skip to content

Commit c1905cb

Browse files
committed
documentation update
1 parent ee9fdc8 commit c1905cb

File tree

3 files changed

+1520
-1
lines changed

3 files changed

+1520
-1
lines changed

dogfood/CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,42 @@ If your changes don't seem to propagate, you can:
2525
- `make uninstall` and `make install`
2626
or move to the top level directory and run
2727
- `colima delete` and `make colima-start` and redo [dogfood instructions](README.md)
28+
29+
## Testing Datadog Metrics
30+
31+
To apply the datadog agent to your local colima environment, run the following:
32+
33+
```
34+
kubectl apply -f "https://raw.githubusercontent.com/DataDog/datadog-agent/master/Dockerfiles/manifests/rbac/clusterrole.yaml"
35+
36+
kubectl apply -f "https://raw.githubusercontent.com/DataDog/datadog-agent/master/Dockerfiles/manifests/rbac/serviceaccount.yaml"
37+
38+
kubectl apply -f "https://raw.githubusercontent.com/DataDog/datadog-agent/master/Dockerfiles/manifests/rbac/clusterrolebinding.yaml"
39+
```
40+
41+
Then take a look at the file `datadog-agent-all-features.yaml` (Feel free to remove the SECURITY feature as it is
42+
unnecessary for testing). You will notice that an api key AND a random string encoded in base64 is required. Get yourself
43+
an API key from your Datadog site, think of a random string, then do the following:
44+
45+
```
46+
echo -n '<Your API key>' | base64
47+
# Copy the encoding and paste it where needed in the datadog.yaml
48+
echo -n 'Random string' | base64
49+
# Copy the encoding and paste it where needed in the datadog.yaml
50+
```
51+
52+
By default the Datadog site is set to the US site datadoghq.com. If you're using other sites, you may want to edit the
53+
`DD_SITE` environment variable accordingly.
54+
55+
Deploy the Daemonset:
56+
```
57+
kubectl apply -f datadog-agent-all-features.yaml
58+
```
59+
60+
Verify it is running correctly using `kubectl get daemonset` in the appropriate namespace (`default` is the default)
61+
62+
Once you've verified the daemonset is up and running, you'll need to get Kubernetes State Metrics with the following steps:
63+
1. Download the kube-state manifests folder [here](https://github.com/kubernetes/kube-state-metrics/tree/master/examples/standard).
64+
2. `kubectl apply -f <NAME_OF_THE_KUBE_STATE_MANIFESTS_FOLDER>`
65+
66+
Then you should be set to see metrics for the client and server containers.

dogfood/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Installing protoc
1+
# Installing protoc
22

33
Run `brew install protobuf` or `make install-protobuf`
44

@@ -104,6 +104,13 @@ x
104104
You can `kubectl apply -f examples/<disruption.yaml>` for any `example/` disruption files.
105105
For gRPC disruption, you can follow these [detailed steps](../docs/grpc_disruption/demo_instructions.md).
106106
107+
### Sending Metrics to Datadog
108+
109+
For the purposes of testing disruptions/workflows, you should make sure that the datadog agent is properly installed
110+
on the cluster that the client and server are running on. 3 of the major disruptive resources properly send metrics
111+
to Datadog (CPU, Network, Disk). The client contains computation related to these disruptions and can be tested using
112+
the disruptions mentioned.
113+
107114
### Clean up
108115
109116
- Run `make uninstall` to `kubectl delete` both charts as well as remove the namespace.

0 commit comments

Comments
 (0)