Skip to content
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

Merged
merged 11 commits into from
Jul 30, 2024

Conversation

Dog-Gone-Earl
Copy link
Contributor

What does this PR do?

  • Adds additional context for use specifying the namespaces

Motivation

Additional Notes

N/A

Minimum Agent Versions

Are there minimum versions of the Datadog Agent and/or Cluster Agent required?

  • Agent: N/A
  • Cluster Agent: >= v1.20.X
  • Datadog Operator v0.6+

Describe your test plan

  • Was validated in OH with TEE in minikube sandbox.
  • DatadogMonitor not found when Operator was in different namespace or vice-a-versa.

Checklist

  • [X ] PR has at least one valid label: bug, enhancement, refactoring, documentation, tooling, and/or dependencies
  • [ X] PR has a milestone or the qa/skip-qa label

What Does This PR Do?
- Adds additional context for use specifying the `namespaces`

Motivation:
https://datadog.zendesk.com/agent/tickets/1666229
@Dog-Gone-Earl Dog-Gone-Earl added documentation Improvements or additions to documentation qa/skip-qa labels Apr 29, 2024
@Dog-Gone-Earl Dog-Gone-Earl requested review from a team as code owners April 29, 2024 23:09
@codecov-commenter
Copy link

codecov-commenter commented Apr 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.64%. Comparing base (29510eb) to head (96f2b83).
Report is 22 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            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     
Flag Coverage Δ
unittests 59.64% <ø> (+0.09%) ⬆️

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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 29510eb...96f2b83. Read the comment docs.

Copy link
Contributor

@brett0000FF brett0000FF left a 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. 🙂

docs/datadog_monitor.md Outdated Show resolved Hide resolved
docs/datadog_monitor.md Outdated Show resolved Hide resolved
Dog-Gone-Earl and others added 3 commits May 1, 2024 13:29
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.
@Dog-Gone-Earl Dog-Gone-Earl changed the title Update datadog_monitor.md Add details regarding watched namespaces for the DatadogMonitor objects May 1, 2024
Update of syntax of code block section for proper markup of numbered list
docs/datadog_monitor.md Outdated Show resolved Hide resolved
docs/datadog_monitor.md Outdated Show resolved Hide resolved
Dog-Gone-Earl and others added 4 commits May 4, 2024 17:27
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.
@@ -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
Copy link
Contributor

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]

Copy link
Contributor Author

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.

Copy link
Contributor Author

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?

Copy link
Contributor

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

Dog-Gone-Earl and others added 2 commits May 24, 2024 10:34
Co-authored-by: Celene <celene@datadoghq.com>
Removal of [8] reference link.
@celenechang celenechang merged commit b30f915 into main Jul 30, 2024
19 checks passed
@celenechang celenechang deleted the Dog-Gone-Earl-patch-1 branch July 30, 2024 11:37
mftoure pushed a commit that referenced this pull request Oct 3, 2024
…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>
mftoure pushed a commit that referenced this pull request Oct 3, 2024
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation qa/skip-qa
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants