-
Notifications
You must be signed in to change notification settings - Fork 104
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add details regarding watched namespaces for the DatadogMonitor objects #1158
Conversation
What Does This PR Do? - Adds additional context for use specifying the `namespaces` Motivation: https://datadog.zendesk.com/agent/tickets/1666229
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1158 +/- ##
==========================================
+ Coverage 59.54% 59.64% +0.09%
==========================================
Files 174 175 +1
Lines 21510 22310 +800
==========================================
+ Hits 12809 13306 +497
- Misses 7930 8199 +269
- Partials 771 805 +34
Flags with carried forward coverage won't be shown. Click here to find out more. see 19 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple small suggestions from Docs. 🙂
Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com>
Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com>
Updated of code block configuration for syntax corrections.
Update of syntax of code block section for proper markup of numbered list
Removed highlighting the word namespace for conformity. Co-authored-by: Celene <celene@datadoghq.com>
Adding *Note* on increased memory usage with adding namesapces referenced: #967
Updates of format for conformity. Co-authored-by: Celene <celene@datadoghq.com>
Re-formatted to reduce repetition of `Note` identifiers.
docs/datadog_monitor.md
Outdated
@@ -130,3 +142,4 @@ kubectl logs <my-datadog-operator-pod-name> | |||
[5]: https://app.datadoghq.com/account/settings#api | |||
[6]: https://github.com/DataDog/helm-charts/blob/master/charts/datadog-operator/values.yaml | |||
[7]: https://app.datadoghq.com/monitors/manage?q=tag%3A"generated%3Akubernetes" | |||
[8]: https://github.com/DataDog/helm-charts/blob/main/charts/datadog-operator/values.yaml#L147-L156 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since line numbers will change on main
, and we want the doc to be timeless, perhaps we can remove this reference and just re-use [6]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @celenechang , thank you for this! I agree as it is a fluid document, it should not be referenced. And a little redundant from [6]
already referencing main page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @celenechang. Apologies for the delay. Just wanted to see if this PR was good to go or already released by another PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi! I'm sorry too. This looks good to me. Just an FYI, there are more refined configuration options coming with the next Operator version, but we can update the doc again after it's released
Co-authored-by: Celene <celene@datadoghq.com>
Removal of [8] reference link.
…ts (#1158) * Update datadog_monitor.md What Does This PR Do? - Adds additional context for use specifying the `namespaces` Motivation: https://datadog.zendesk.com/agent/tickets/1666229 * Update docs/datadog_monitor.md Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com> * Update docs/datadog_monitor.md Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com> * Update datadog_monitor.md Updated of code block configuration for syntax corrections. * Update datadog_monitor.md Update of syntax of code block section for proper markup of numbered list * Update docs/datadog_monitor.md Removed highlighting the word namespace for conformity. Co-authored-by: Celene <celene@datadoghq.com> * Update datadog_monitor.md Adding *Note* on increased memory usage with adding namesapces referenced: #967 * Update docs/datadog_monitor.md Updates of format for conformity. Co-authored-by: Celene <celene@datadoghq.com> * Update datadog_monitor.md Re-formatted to reduce repetition of `Note` identifiers. * Update docs/datadog_monitor.md Co-authored-by: Celene <celene@datadoghq.com> * Update datadog_monitor.md Removal of [8] reference link. --------- Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com> Co-authored-by: Celene <celene@datadoghq.com>
…ts (#1158) * Update datadog_monitor.md What Does This PR Do? - Adds additional context for use specifying the `namespaces` Motivation: https://datadog.zendesk.com/agent/tickets/1666229 * Update docs/datadog_monitor.md Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com> * Update docs/datadog_monitor.md Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com> * Update datadog_monitor.md Updated of code block configuration for syntax corrections. * Update datadog_monitor.md Update of syntax of code block section for proper markup of numbered list * Update docs/datadog_monitor.md Removed highlighting the word namespace for conformity. Co-authored-by: Celene <celene@datadoghq.com> * Update datadog_monitor.md Adding *Note* on increased memory usage with adding namesapces referenced: #967 * Update docs/datadog_monitor.md Updates of format for conformity. Co-authored-by: Celene <celene@datadoghq.com> * Update datadog_monitor.md Re-formatted to reduce repetition of `Note` identifiers. * Update docs/datadog_monitor.md Co-authored-by: Celene <celene@datadoghq.com> * Update datadog_monitor.md Removal of [8] reference link. --------- Co-authored-by: Brett Blue <84536271+brett0000FF@users.noreply.github.com> Co-authored-by: Celene <celene@datadoghq.com>
What does this PR do?
namespaces
Motivation
Additional Notes
N/A
Minimum Agent Versions
Are there minimum versions of the Datadog Agent and/or Cluster Agent required?
Describe your test plan
minikube
sandbox.DatadogMonitor
not found when Operator was in differentnamespace
or vice-a-versa.Checklist
bug
,enhancement
,refactoring
,documentation
,tooling
, and/ordependencies
qa/skip-qa
label