[DOCS] adding analyze operator cmd docs #33
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nicolastakashi
force-pushed
the
docs/adding-analyze-operator-command
branch
from
d87e235
to
145ff36
Compare
ArthurSens
reviewed
Sep 10, 2024
|
|
||
| ### Operator Existence | ||
|
|
||
| The Prometheus Operator deployment must exist in the Kubernetes cluster. |
There was a problem hiding this comment.
Could you explain how that is done? The sentence here sounds pretty vague
There was a problem hiding this comment.
Sure!
Wdyt about the new version?
Signed-off-by: Nicolas Takashi <nicolas.tcs@hotmail.com>
nicolastakashi
force-pushed
the
docs/adding-analyze-operator-command
branch
from
145ff36
to
0fbe9cd
Compare
simonpasquier
approved these changes
Sep 10, 2024
nicolastakashi
added a commit
that referenced
this pull request
Sep 13, 2024
…perator-command [DOCS] adding analyze operator cmd docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes significant updates to the
Documentation/commands/analyze/index.mdfile to enhance the documentation around theanalyzecommand, particularly in the context of the Prometheus Operator. The most important changes include the addition of sections detailing the analyze command's functionality, the rules it evaluates, and specific requirements for the Prometheus Operator deployment.Enhancements to Documentation:
analyzecommand can target the Prometheus Operator deployment within a Kubernetes cluster, including specifying the namespace and name of the Prometheus Operator. ([Documentation/commands/analyze/index.mdR44-R61](https://github.com/prometheus-operator/poctl/pull/33/files#diff-975e48a917fb0aacf8b99f389b853b76ce598e680cf7cf369e4717b8313431deR44-R61))analyzecommand, which are defined in theanalyzerpackage and implemented in theinternal/analyzer/operator.gofile. ([Documentation/commands/analyze/index.mdR44-R61](https://github.com/prometheus-operator/poctl/pull/33/files#diff-975e48a917fb0aacf8b99f389b853b76ce598e680cf7cf369e4717b8313431deR44-R61))[Documentation/commands/analyze/index.mdR44-R61](https://github.com/prometheus-operator/poctl/pull/33/files#diff-975e48a917fb0aacf8b99f389b853b76ce598e680cf7cf369e4717b8313431deR44-R61))[Documentation/commands/analyze/index.mdR44-R61](https://github.com/prometheus-operator/poctl/pull/33/files#diff-975e48a917fb0aacf8b99f389b853b76ce598e680cf7cf369e4717b8313431deR44-R61))