Datadog #1384
Datadog #1384
Conversation
dmitry-spectro
requested review from
karl-cardenas-coding,
ritawatson and
rahulhazra97
and removed request for
a team
✅ 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}
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|100 col 19| [Vale.Spelling] Did you really mean 'Keycloak'?
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|100 col 241| [Google.Exclamation] Don't use exclamation points in text.
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|101 col 43| [Vale.Terms] Use 'admin' instead of 'Admin'.
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|108 col 23| [Vale.Spelling] Did you really mean 'Keycloak'?
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|156 col 113| [Vale.Spelling] Did you really mean 'Keycloak'?
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|157 col 34| [Vale.Spelling] Did you really mean 'Keycloak'?
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|167 col 66| [spectrocloud.ableism] Avoid using ableism terms. Use 'display' instead of 'see'.
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|188 col 50| [Vale.Spelling] Did you really mean 'Keycloak'?
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|196 col 27| [Vale.Spelling] Did you really mean 'Keycloak'?
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|196 col 93| [Google.Exclamation] Don't use exclamation points in text.
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|205 col 70| [Vale.Spelling] Did you really mean 'Keycloak'?
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|219 col 44| [Vale.Terms] Use 'admin' instead of 'Admin'.
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|234 col 18| [Vale.Spelling] Did you really mean 'Keycloak'?
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|248 col 100| [Vale.Spelling] Did you really mean 'Keycloak'?
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|255 col 67| [Vale.Spelling] Did you really mean 'Keycloak'?
content/docs/08-user-management/04-saml-sso/05-palette-sso-with-keycloak.md|263 col 77| [Google.Exclamation] Don't use exclamation points in text.
|
|
||
| * Docs to Markdown version 1.0β34 | ||
| * Tue Jun 27 2023 01:55:24 GMT-0700 (PDT) | ||
| * Source doc: Palette Datadog Integration |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
|
|
||
| <p style="color: red; font-weight: bold">>>>>> gd2md-html alert: ERRORs: 0; WARNINGs: 0; ALERTS: 8.</p> | ||
| <ul style="color: red; font-weight: bold"><li>See top comment block for details on ERRORs and WARNINGs. <li>In the converted Markdown or HTML, search for inline alerts that start with >>>>> gd2md-html alert: for specific instances that need correction.</ul> |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud.ableism] Avoid using ableism terms. Use 'display' instead of 'See'.
|
|
||
| 1. Access to Palette | ||
| 2. Kubernetes Cluster | ||
| 3. Datadog account with API key |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
| ## Installation | ||
|
|
||
|
|
||
| ### Datadog preparation |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
|
|
||
|
|
||
| 1. If you don’t already have access to Datadog, open [https://app.datadoghq.eu/signup](https://app.datadoghq.eu/signup) choose your region (EU1 in my case), give your name, email address and company name, and press “Sign up” |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| 1. Provision a k8s cluster from Palette and download its kubeconfig | ||
| 2. Let’s install keycloak on our Kubernetes cluster with CLI: | ||
| 3. After a couple of minutes, verify which address Keycloak got: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
| 4. Let’s create an Ingress from an official doc, replacing KEYCLOAK_HOST with your hostname for LoadBalance: | ||
|
|
||
| This creates an ingress and we can now see keycloak available at services in Palette: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud.ableism] Avoid using ableism terms. Use 'display' instead of 'see'.
|
|
||
| 4. Let’s create an Ingress from an official doc, replacing KEYCLOAK_HOST with your hostname for LoadBalance: | ||
|
|
||
| This creates an ingress and we can now see keycloak available at services in Palette: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'keycloak'?
| <p id="gdcalert1" ><span style="color: red; font-weight: bold">>>>>> gd2md-html alert: inline image link here (to images/image1.png). Store image on your image server and adjust path/filename/extension if necessary. </span><br>(<a href="#">Back to top</a>)(<a href="#gdcalert2">Next alert</a>)<br><span style="color: red; font-weight: bold">>>>>> </span></p> | ||
|
|
||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
|
|
||
|
|
||
| 5. I’ll also create a CNAME _keycloak.dmitry.sa.spectrodemos.com_ pointing to _a5f3a06f0063143fea26b6a086cb2c89-1900572074.eu-west-3.elb.amazonaws.com_ so that it’d be more convenient to type and to get access to our Keycloak |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
| * Docs to Markdown version 1.0β34 | ||
| * Tue Jun 27 2023 01:32:57 GMT-0700 (PDT) | ||
| * Source doc: Palette Keycloak Integration |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
|
|
||
| 5. I’ll also create a CNAME _keycloak.dmitry.sa.spectrodemos.com_ pointing to _a5f3a06f0063143fea26b6a086cb2c89-1900572074.eu-west-3.elb.amazonaws.com_ so that it’d be more convenient to type and to get access to our Keycloak | ||
| 6. Let’s login to Keycloak with default _admin:admin_ credentials at _[http://keycloak.dmitry.sa.spectrodemos.com:8080/admin](http://keycloak.dmitry.sa.spectrodemos.com:8080/admin)_, First thing is to change the admin password to something sensible! |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
|
|
||
| 5. I’ll also create a CNAME _keycloak.dmitry.sa.spectrodemos.com_ pointing to _a5f3a06f0063143fea26b6a086cb2c89-1900572074.eu-west-3.elb.amazonaws.com_ so that it’d be more convenient to type and to get access to our Keycloak | ||
| 6. Let’s login to Keycloak with default _admin:admin_ credentials at _[http://keycloak.dmitry.sa.spectrodemos.com:8080/admin](http://keycloak.dmitry.sa.spectrodemos.com:8080/admin)_, First thing is to change the admin password to something sensible! |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Exclamation] Don't use exclamation points in text.
|
|
||
| 5. I’ll also create a CNAME _keycloak.dmitry.sa.spectrodemos.com_ pointing to _a5f3a06f0063143fea26b6a086cb2c89-1900572074.eu-west-3.elb.amazonaws.com_ so that it’d be more convenient to type and to get access to our Keycloak | ||
| 6. Let’s login to Keycloak with default _admin:admin_ credentials at _[http://keycloak.dmitry.sa.spectrodemos.com:8080/admin](http://keycloak.dmitry.sa.spectrodemos.com:8080/admin)_, First thing is to change the admin password to something sensible! | ||
| 7. Let’s login to Palette, choose “Tenant Admin” at the top, click on “Tenant Settings” on the left hand side, then click on “SSO” in the center and “OIDC” on the right hand side. We’ll need to copy “Callback URL” and “Logout URL” |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'admin' instead of 'Admin'.
|
|
||
|  | ||
|
|
||
| 8. Let’s now login to Keycloak and create a client for Palette: I click on “Create client” |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|  | ||
|
|
||
|
|
||
| 23. I add a team “admins” and add “Project Admin” role to my project “Default” |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'admin' instead of 'Admin'.
|
|
||
|  | ||
|
|
||
| 26. I go back to Keycloak, click on “Users” on the left hand side and create a user, making sure “Username”, “Email”, “First Name” and “Last Name” are all filled in. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
|  | ||
|
|
||
| 28. If I now open another incognito window, go to Palette and log in with my newly created user in Keycloak, I should be automatically logged in Palette as admin! |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
|  | ||
|
|
||
| 29. Voilà, our example is done,we’re logged in with the user from Keycloak without touching anything in Palette |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|  | ||
|
|
||
|
|
||
| Please contact us if you have any further questions on how to set up proper RBAC! |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Exclamation] Don't use exclamation points in text.
|
@dmitry-spectro We took a peek at this guide. Dmitry, the voice and style does not follow our docs style. Can you update the content to follow our styleguide and voice please? Here is a link to a good how-to example. |
Hey @karl-cardenas-coding Karl, happy to review and to improve, but can you be a little bit more specific in what you want me to change please? |
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
content/docs/10-audit-logs/06-integrating-with-datadog.md|20 col 98| [Vale.Spelling] Did you really mean 'Datadog'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|26 col 29| [Vale.Spelling] Did you really mean 'datadog'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|26 col 42| [Vale.Terms] Use 'Repo' instead of 'repo'.
content/docs/10-audit-logs/06-integrating-with-datadog.md|26 col 183| [Vale.Spelling] Did you really mean 'Datadog'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|30 col 67| [Vale.Spelling] Did you really mean 'Datadog'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|30 col 171| [Vale.Spelling] Did you really mean 'datadog'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|30 col 308| [Vale.Spelling] Did you really mean 'datadog'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|34 col 65| [Vale.Spelling] Did you really mean 'changesi'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|34 col 103| [Vale.Spelling] Did you really mean 'Datadog'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|38 col 8| [Vale.Spelling] Did you really mean 'api'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|38 col 29| [Vale.Spelling] Did you really mean 'your_api_key_here'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|74 col 12| [Vale.Spelling] Did you really mean 'mountPath'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|78 col 118| [Vale.Spelling] Did you really mean 'datadog'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|82 col 25| [Vale.Spelling] Did you really mean 'Datadog'?
content/docs/10-audit-logs/06-integrating-with-datadog.md|111 col 6| [Vale.Spelling] Did you really mean 'Datadog'?
| @@ -0,0 +1,118 @@ | |||
|
|
|||
| # Palette Datadog Integration | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| 1. Access to Palette | ||
| 2. Kubernetes Cluster | ||
| 3. Datadog account with API key |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| ## Installation | ||
|
|
||
| This documents permits to integrate Palette and Datadog: export logs from Kubernetes clusters managed by Palette to Datadog instance |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| ## Installation | ||
|
|
||
| This documents permits to integrate Palette and Datadog: export logs from Kubernetes clusters managed by Palette to Datadog instance |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| This documents permits to integrate Palette and Datadog: export logs from Kubernetes clusters managed by Palette to Datadog instance | ||
|
|
||
| ### Datadog preparation |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| ## Installation | ||
|
|
||
| This documents permits to integrate Palette and Datadog: export logs from Kubernetes clusters managed by Palette to Datadog instance |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| ## Installation | ||
|
|
||
| This documents permits to integrate Palette and Datadog: export logs from Kubernetes clusters managed by Palette to Datadog instance |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| ### Datadog preparation | ||
|
|
||
| 1. If you don’t already have access to Datadog, open [https://app.datadoghq.eu/signup](https://app.datadoghq.eu/signup) choose appropriate region (for example, EU1), give your name, email address and company name, and press “Sign up” |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Datadog'?
|
|
||
| 1. If you don’t already have access to Datadog, open [https://app.datadoghq.eu/signup](https://app.datadoghq.eu/signup) choose appropriate region (for example, EU1), give your name, email address and company name, and press “Sign up” | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
| 1. If you don’t already have access to Datadog, open [https://app.datadoghq.eu/signup](https://app.datadoghq.eu/signup) choose appropriate region (for example, EU1), give your name, email address and company name, and press “Sign up” | ||
|
|
||
|  |
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.
507 images did not require optimisation. |
|
Closed as #1961 carries over the work. |
Describe the Change
This PR adds Datatog integration for sending logs
Review Changes
💻 Add Preview URL
🎫 Jira Ticket