DOC-806: adding revised Datadog integration doc #1961
Conversation
dmitry-spectro
requested review from
karl-cardenas-coding,
addetz and
ritawatson
✅ Deploy Preview for docs-spectrocloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| --- | ||
|
|
||
|
|
||
| # Palette Datadog Integration |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| # Palette Datadog Integration | ||
|
|
||
| Datadog is a monitoring and analytics tool. You can set up Palette to export audit logs from your Kubernetes clusters managed by Palette to Datadog. This guide will walk you through the steps to accomplish this through installing Datadog Helm chart and configuring it. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| # Palette Datadog Integration | ||
|
|
||
| Datadog is a monitoring and analytics tool. You can set up Palette to export audit logs from your Kubernetes clusters managed by Palette to Datadog. This guide will walk you through the steps to accomplish this through installing Datadog Helm chart and configuring it. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| # Palette Datadog Integration | ||
|
|
||
| Datadog is a monitoring and analytics tool. You can set up Palette to export audit logs from your Kubernetes clusters managed by Palette to Datadog. This guide will walk you through the steps to accomplish this through installing Datadog Helm chart and configuring it. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| 2. Kubernetes Cluster with admin rights under Palette control | ||
|
|
||
| 3. Datadog account with API key |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
| |**Line**| **Modification**| | ||
| |---|---| | ||
| |2 | choose namespace for Datadog install, for example: namespace: "datadog"| | ||
| |36 | add your Datadog API key saved earlier | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
| |---|---| | ||
| |2 | choose namespace for Datadog install, for example: namespace: "datadog"| | ||
| |36 | add your Datadog API key saved earlier | | ||
| |117 | choose your regional Datadog website, for example datadoghq.eu, please refer to [Datadog Documentation](https://docs.datadoghq.com/) for the full list |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
| ::: | ||
|
|
||
| :::caution | ||
| Make sure to save the profile after making these changes! |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Exclamation] Don't use exclamation points in text.
|
|
||
|  | ||
|
|
||
| 6. After some time, the Datadog agent should start reporting, click **Finish** to get to the Datadog Panel and verify that audit logs are indeed being transferred to it. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| ## Validate | ||
|
|
||
| Open Datadog console by clicking **Logs** on the left hand side and make sure you're seeing Kubernetes audit logs flowing in |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 8.3%, saving 238.45 KB.
560 images did not require optimisation. |
|
|
||
| Datadog is a monitoring and analytics tool. You can set up Palette to export audit logs from your Kubernetes clusters managed by Palette to Datadog. This guide will walk you through the steps to accomplish this through installing Datadog Helm chart and configuring it. | ||
|
|
||
| ## Prerequisites: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.colon] Use colons only to introduce lists, unless in code blocks or inline code.
|
|
||
| Datadog will provide you with an API key, record it for the future | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| ::: | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| Then click on **Add new pack**, choose Pack Type **Helm Chart** and Registry **Datadog** Then pick the **Datadog** chart and its latest version. | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| 4. This will open a Helm chart modification window, so that Datadog installation collects all the necessary data, you need to modify a number of parameters and to add two YAML stanzas to the Helm chart | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| 6. After some time, the Datadog agent should start reporting, click **Finish** to get to the Datadog Panel and verify that audit logs are indeed being transferred to it. | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
|  | ||
|
|
||
| 7. Enable configmap for the cluster to collect data: create a `datadog-configmap.yaml` file with the following content: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.colon] Use colons only to introduce lists, unless in code blocks or inline code.
| and apply it with the kubeconfig file for the Kubernetes cluster from which you want to obtain audit logs: | ||
|
|
||
| ```bash | ||
| kubectl -n datadog apply -f datadog-configmap.yaml |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.longform] Avoid using the short form of commands. Replace the short form flag in 'apply -f' with the corresponding long form flag.
| ``` | ||
|
|
||
| :::tip | ||
| Make sure path for apiserver corresponds to what is in `kube-apiserver-arg` argument of the Kubernetes cluster, you can look it up in Kubernetes profile in Palette. In case of k3s it is `/var/log/apiserver` |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'K3s' instead of 'k3s'.
|
|
||
| Open Datadog console by clicking **Logs** on the left hand side and make sure you're seeing Kubernetes audit logs flowing in | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| 1. Ensure you have access to Datadog console, navigate to [https://app.datadoghq.eu/signup](https://app.datadoghq.eu/signup) to obtain a free trial. Pick appropriate region (for example, EU1), provide your name, email address and company name, and click **Sign up** | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| Datadog will provide you with an API key, record it for the future | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| ::: | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| Then click on **Add new pack**, choose Pack Type **Helm Chart** and Registry **Datadog** Then pick the **Datadog** chart and its latest version. | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| 4. This will open a Helm chart modification window, so that Datadog installation collects all the necessary data, you need to modify a number of parameters and to add two YAML stanzas to the Helm chart | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
| |**Line**| **Modification**| | ||
| |---|---| | ||
| |2 | choose namespace for Datadog install, for example: namespace: "datadog"| | ||
| |38 | add your Datadog API key saved earlier | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
| |---|---| | ||
| |2 | choose namespace for Datadog install, for example: namespace: "datadog"| | ||
| |38 | add your Datadog API key saved earlier | | ||
| |119 | choose your regional Datadog website, for example datadoghq.eu, please refer to [Datadog Documentation](https://docs.datadoghq.com/) for the full list |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| 5. Now apply new created profile to the cluster: go to **Profiles** of the cluster, click on blue **+** sign, choose `datadog` profile and click on **Confirm** | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| 6. After some time, the Datadog agent should start reporting, click **Finish** to get to the Datadog Panel and verify that audit logs are indeed being transferred to it. | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| Open Datadog console by clicking **Logs** on the left hand side and make sure you're seeing Kubernetes audit logs flowing in | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| # Palette Datadog Integration | ||
|
|
||
| Datadog is a monitoring and analytics tool. You can set up Palette to export audit logs from your Kubernetes clusters |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
| # Palette Datadog Integration | ||
|
|
||
| Datadog is a monitoring and analytics tool. You can set up Palette to export audit logs from your Kubernetes clusters | ||
| managed by Palette to Datadog. This guide will walk you through the steps to accomplish this through installing Datadog |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
| # Palette Datadog Integration | ||
|
|
||
| Datadog is a monitoring and analytics tool. You can set up Palette to export audit logs from your Kubernetes clusters | ||
| managed by Palette to Datadog. This guide will walk you through the steps to accomplish this through installing Datadog |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| ### Datadog configuration | ||
|
|
||
| 1. Ensure you have access to Datadog console, navigate to |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
| [https://app.datadoghq.eu/signup](https://app.datadoghq.eu/signup) to obtain a free trial. Pick appropriate region | ||
| (for example, EU1), provide your name, email address and company name, and click **Sign up** | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
| | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | 2 | choose namespace for Datadog install, for example: namespace: "datadog" | | ||
| | 38 | add your Datadog API key saved earlier | | ||
| | 119 | choose your regional Datadog website, for example datadoghq.eu, please refer to [Datadog Documentation](https://docs.datadoghq.com/) for the full list | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
| ``` | ||
|
|
||
| :::tip Make sure `mountPath` and `path` for apiserver correspond to what is set up in `kube-apiserver-arg` argument of | ||
| your Kubernetes cluster, you can look it up in Kubernetes profile in Palette. In case of k3s it is `/var/log/apiserver` |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'K3s' instead of 'k3s'.
| your Kubernetes cluster, you can look it up in Kubernetes profile in Palette. In case of k3s it is `/var/log/apiserver` | ||
| ::: | ||
|
|
||
| :::caution Make sure to save the profile after making these changes! ::: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Exclamation] Don't use exclamation points in text.
| service: audit | ||
| ``` | ||
|
|
||
| and apply it with the kubeconfig file for the Kubernetes cluster from which you want to obtain audit logs: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.colon] Use colons only to introduce lists, unless in code blocks or inline code.
| ``` | ||
|
|
||
| :::tip Make sure path for apiserver corresponds to what is in `kube-apiserver-arg` argument of the Kubernetes cluster, | ||
| you can look it up in Kubernetes profile in Palette. In case of k3s it is `/var/log/apiserver` ::: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'K3s' instead of 'k3s'.
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 60.7%, saving 1.49 MB.
719 images did not require optimisation. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 1.6%, saving 9.45 KB.
721 images did not require optimisation. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 1.3%, saving 1.31 KB.
726 images did not require optimisation. |
Describe the Change
This PR pushes revised Datadog documentation
Review Changes
💻 Add Preview URL
🎫 Jira Ticket