Skip to content

OBSDOCS-1550: Add assemblies for 'Configuring the core platform monito… #86014

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Dec 16, 2024
Merged

OBSDOCS-1550: Add assemblies for 'Configuring the core platform monito… #86014

merged 1 commit into from
Dec 16, 2024

Conversation

eromanova97
Copy link
Contributor

@eromanova97 eromanova97 commented Dec 10, 2024 •
edited
Loading

Version(s) for cherry-picking: none, merge only to monitoring-docs-restructure

Issue: OBSDOCS-1550

Link to docs preview:

QE review:

  • ACK

Additional information:
This PR moves content from configuring-the-monitoring-stack.adoc assembly file to the new assemblies. The content in the original assembly is still there . The reason is to not lose any content while moving the content around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to chekc in this PR is to see if the structure in the linked chapters looks good and renders without issues. Let me know if you have any additional questions, thank you!

Note: The following are the sections that need review (you can find it under Observability -> Monitoring) :
image

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Dec 10, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 10, 2024 •
edited by openshift-ci bot
Loading

@eromanova97: This pull request references OBSDOCS-1550 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none, merge only to monitoring-docs-restructure

Issue: OBSDOCS-1550

Link to docs preview:

QE review:

  • None needed for now, only structural chages

Additional information:
This PR moves content from configuring-the-monitoring-stack.adoc assembly file to the new assemblies. The content in the original assembly is still there . The reason is to not lose any content while moving the content around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to chekc in this PR is to see if the structure in the linked chapters looks good and renders without issues.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 10, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 10, 2024 •
edited by openshift-ci bot
Loading

@eromanova97: This pull request references OBSDOCS-1550 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none, merge only to monitoring-docs-restructure

Issue: OBSDOCS-1550

Link to docs preview:

QE review:

  • None needed for now, only structural chages

Additional information:
This PR moves content from configuring-the-monitoring-stack.adoc assembly file to the new assemblies. The content in the original assembly is still there . The reason is to not lose any content while moving the content around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to chekc in this PR is to see if the structure in the linked chapters looks good and renders without issues. Let me know if you have any additional questions, thank you!

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 10, 2024
eromanova97
eromanova97 commented Dec 10, 2024
View reviewed changes
modules/monitoring-configurable-monitoring-components.adoc
Comment on lines 2 to -12
//
// * observability/monitoring/configuring-the-monitoring-stack.adoc

[id="configurable-monitoring-components_{context}"]
= Configurable monitoring components
:_mod-docs-content-type: REFERENCE

This table shows the monitoring components you can configure and the keys used to specify the components in the
ifndef::openshift-dedicated,openshift-rosa[]
`cluster-monitoring-config` and
endif::openshift-dedicated,openshift-rosa[]
`user-workload-monitoring-config` `ConfigMap` objects.
Copy link
Contributor Author

@eromanova97 eromanova97 Dec 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot to divide the content in this module in the previous PR, so I am doing it here. the main thing to check here is the rendering of the two procedures (if there are any rendering issues, the content itself stays the same):

  1. For core platform monitoring (CPM): link1, link2
  2. For user workload monitoring (UWM): link

@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Dec 10, 2024 •
edited
Loading

🤖 Wed Dec 11 12:05:30 - Prow CI generated the docs preview:

https://86014--ocpdocs-pr.netlify.app/openshift-dedicated/latest/observability/monitoring/configuring-the-monitoring-stack.html
https://86014--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/configuring-core-platform-monitoring/before-you-begin.html
https://86014--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/configuring-core-platform-monitoring/configuring-alerts-and-notifications.html
https://86014--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/configuring-core-platform-monitoring/configuring-metrics.html
https://86014--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/configuring-core-platform-monitoring/configuring-performance-and-scalability.html
https://86014--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/configuring-core-platform-monitoring/storing-and-recording-data.html
https://86014--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/configuring-the-monitoring-stack.html
https://86014--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/enabling-monitoring-for-user-defined-projects.html
https://86014--ocpdocs-pr.netlify.app/openshift-rosa/latest/observability/monitoring/configuring-the-monitoring-stack.html

@eromanova97 eromanova97 force-pushed the OBSDOCS-1550 branch 2 times, most recently from 1fed4d5 to 9e66352 Compare December 10, 2024 11:16
@eromanova97
Copy link
Contributor Author

/test

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Dec 10, 2024

@eromanova97: The /test command needs one or more targets.
The following commands are available to trigger required jobs:

/test validate-asciidoc

/test validate-portal

Use /test all to run all jobs.

In response to this:

/test

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 10, 2024 •
edited by openshift-ci bot
Loading

@eromanova97: This pull request references OBSDOCS-1550 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none, merge only to monitoring-docs-restructure

Issue: OBSDOCS-1550

Link to docs preview:

QE review:

  • None needed for now, only structural chages

Additional information:
This PR moves content from configuring-the-monitoring-stack.adoc assembly file to the new assemblies. The content in the original assembly is still there . The reason is to not lose any content while moving the content around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to chekc in this PR is to see if the structure in the linked chapters looks good and renders without issues. Let me know if you have any additional questions, thank you!

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 10, 2024 •
edited by openshift-ci bot
Loading

@eromanova97: This pull request references OBSDOCS-1550 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none, merge only to monitoring-docs-restructure

Issue: OBSDOCS-1550

Link to docs preview:

QE review:

  • None needed for now, only structural chages

Additional information:
This PR moves content from configuring-the-monitoring-stack.adoc assembly file to the new assemblies. The content in the original assembly is still there . The reason is to not lose any content while moving the content around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to chekc in this PR is to see if the structure in the linked chapters looks good and renders without issues. Let me know if you have any additional questions, thank you!

Note: The following is the section that needs review (you can find it under Observability -> Monitoring) :
image

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 10, 2024 •
edited by openshift-ci bot
Loading

@eromanova97: This pull request references OBSDOCS-1550 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none, merge only to monitoring-docs-restructure

Issue: OBSDOCS-1550

Link to docs preview:

QE review:

  • None needed for now, only structural chages

Additional information:
This PR moves content from configuring-the-monitoring-stack.adoc assembly file to the new assemblies. The content in the original assembly is still there . The reason is to not lose any content while moving the content around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to chekc in this PR is to see if the structure in the linked chapters looks good and renders without issues. Let me know if you have any additional questions, thank you!

Note: The following are the sections that need review (you can find it under Observability -> Monitoring) :
image

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Dec 11, 2024

@eromanova97: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@eromanova97
Copy link
Contributor Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Dec 11, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 12, 2024 •
edited by openshift-ci bot
Loading

@eromanova97: This pull request references OBSDOCS-1550 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none, merge only to monitoring-docs-restructure

Issue: OBSDOCS-1550

Link to docs preview:

QE review:

  • [] ACK

Additional information:
This PR moves content from configuring-the-monitoring-stack.adoc assembly file to the new assemblies. The content in the original assembly is still there . The reason is to not lose any content while moving the content around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to chekc in this PR is to see if the structure in the linked chapters looks good and renders without issues. Let me know if you have any additional questions, thank you!

Note: The following are the sections that need review (you can find it under Observability -> Monitoring) :
image

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@eromanova97 eromanova97 changed the title [WIP] OBSDOCS-1550: Add assemblies for 'Configuring the core platform monito… OBSDOCS-1550: Add assemblies for 'Configuring the core platform monito… Dec 12, 2024
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 12, 2024
@juzhao
Copy link

juzhao commented Dec 13, 2024

note: there are TBD under Additional resources, example: https://86014--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/configuring-core-platform-monitoring/before-you-begin#granting-users-permissions-for-core-platform-monitoring_before-you-begin

@juzhao
Copy link

juzhao commented Dec 13, 2024

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Dec 13, 2024
@bhardesty
Copy link
Contributor

/remove-label peer-review-needed
/label peer-review-in-progress

@openshift-ci openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Dec 13, 2024
bhardesty
bhardesty reviewed Dec 13, 2024
View reviewed changes
Copy link
Contributor

@bhardesty bhardesty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I reviewed the structure of the changes, and the content is much easier to follow than before. I did not notice any rendering issues.

One thing to keep in mind with this work: a lot of the Monitoring content is reused in the ROSA and OSD docs (at least the user workload bits). So the applicable changes that you previously made to the OCP topic map will need to be made to the ROSA and OSD topic maps.

@bhardesty
Copy link
Contributor

/remove-label peer-review-in-progress
/label peer-review-done

@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Dec 13, 2024
@eromanova97
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Dec 16, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 16, 2024 •
edited by openshift-ci bot
Loading

@eromanova97: This pull request references OBSDOCS-1550 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none, merge only to monitoring-docs-restructure

Issue: OBSDOCS-1550

Link to docs preview:

QE review:

  • ACK

Additional information:
This PR moves content from configuring-the-monitoring-stack.adoc assembly file to the new assemblies. The content in the original assembly is still there . The reason is to not lose any content while moving the content around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to chekc in this PR is to see if the structure in the linked chapters looks good and renders without issues. Let me know if you have any additional questions, thank you!

Note: The following are the sections that need review (you can find it under Observability -> Monitoring) :
image

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@stevsmit stevsmit added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Dec 16, 2024
@stevsmit stevsmit added this to the Continuous Release milestone Dec 16, 2024
stevsmit
stevsmit reviewed Dec 16, 2024
View reviewed changes
Copy link
Member

@stevsmit stevsmit 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 few nits. The content reorg looks good. I'm good with merging this since the content will not go live directly.

@stevsmit stevsmit merged commit 0f93cce into openshift:monitoring-docs-restructure Dec 16, 2024
2 checks passed
@eromanova97 eromanova97 deleted the OBSDOCS-1550 branch December 16, 2024 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stevsmit stevsmit stevsmit left review comments

+1 more reviewer

@bhardesty bhardesty bhardesty left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@juzhao juzhao

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. merge-review-in-progress Signifies that the merge review team is reviewing this PR peer-review-done Signifies that the peer review team has reviewed this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

Continuous Release

Development

Successfully merging this pull request may close these issues.

6 participants

@eromanova97 @openshift-ci-robot @ocpdocs-previewbot @juzhao @bhardesty @stevsmit