[DOC] adding prometheus-operator-cli design proposal #6435

nicolastakashi · 2024-03-25T16:38:08Z

Description

Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.
If it fixes a bug or resolves a feature request, be sure to link to that issue.

Document Proposal for prometheus-operator-cli
Related to: #6423

Type of change

What type of changes does your code introduce to the Prometheus operator? Put an x in the box that apply.

CHANGE (fix or feature that would cause existing functionality to not work as expected)
FEATURE (non-breaking change which adds functionality)
BUGFIX (non-breaking change which fixes an issue)
ENHANCEMENT (non-breaking change which improves existing functionality)
NONE (if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)

Verification

Please check the Prometheus-Operator testing guidelines for recommendations about automated tests.

Changelog entry

Please put a one-line changelog entry below. This will be copied to the changelog file during the release process.

N/A

nicolastakashi · 2024-03-25T16:40:35Z

Just for reference I have some draft CLI working on this repository:

Documentation/designs/prometheus-operator-cli.md

ArthurSens

I think we changed our approach for new proposals and we're putting everything under Documentation/proposals instead of Documentation/designs. We still have the agent design over there but I think we agreed on moving it some months ago 🤔 Could we also follow the design template? 🙈

But anyway, thanks for starting the proposal! The idea sounds awesome

Documentation/designs/prometheus-operator-cli.md

ArthurSens · 2024-03-28T18:38:46Z

Documentation/designs/prometheus-operator-cli.md

+### Why my Prometheus resource is not being created?
+
+People were struggling to troubleshoot why their Prometheus resources were not being created. They were not sure if the issue was with the Prometheus Operator or with the Prometheus resource itself.
+After long investigation, they found out that the Prometheus Operator were only watching the namespace where the Prometheus Operator was deployed, and the Prometheus resource was being created in a different namespace.


If I remember correctly, the problem was not about creating Prometheus resources but correctly configuring them. Creating just a single "Prometheus" resource is fairly simple, but also setting up the right permissions, attaching service accounts, troubleshooting target discovery was not straight forward

Documentation/designs/prometheus-operator-cli.md

ArthurSens · 2024-03-28T18:42:55Z

Documentation/designs/prometheus-operator-cli.md

+
+These are just some common issues that users reported, but there are many other issues that users face when managing Prometheus Operator resources, and we believe that a CLI tool can help users to manage Prometheus Operator resources more easily and efficiently.
+
+## Proposal


It's not entirely clear how the CLI (as a kubectl plugin) could help with CI validations 🤔

For CI we don't need the kubernetes cluster context, so I wonder if a kubectl plugin is the best choice here

Documentation/designs/prometheus-operator-cli.md

simonpasquier

I'm impatient to experiment with this tool :)

Documentation/designs/prometheus-operator-cli.md

ArthurSens · 2024-04-02T00:17:23Z

I know we don't have an "official proposal template", but all proposals we have today follow the same structure (documented by the thanos' folks[1])

The template is organized in a way to make sure both the problem and the solution are clear, that we know who are the interested parties, etc. A well-written proposal also attracts more people to contribute in case the current owners eventually fall short on capacity :)

Could we follow the proposal template?

Documentation/proposals/202403-prometheus-operator-cli.md

simonpasquier

Thanks! It's enough for me to get started with the new repository and experiment 👍

ArthurSens

Apologies if I'm being too picky 😅

I still think the proposal is confusing, but it's definitely progressing!

Documentation/proposals/202403-prometheus-operator-cli.md

ArthurSens · 2024-04-03T14:01:20Z

Documentation/proposals/202403-prometheus-operator-cli.md

+# Pitfalls of the current solution
+
+At the moment people are struggling to manage Prometheus Operator resources, they have to manually create, update, and delete Prometheus Operator resources using `kubectl` or other tools, and troubleshooting and debugging Prometheus Operator resources is challenging.


I think the issues you pointed out above can be explored and explained in this section instead of having subsections under Why.

Troubleshooting Alertmanager, Prometheus and Thanos ruler pod creation is very manual and requires domain knowledge about what RBAC permissions are needed.

Target discovery also requires domain knowledge, understanding label selectors, RBAC permissions, etc.

And we could add links to existing support issues here in Github, StackOverflow, or Slack to show that we have data to back this up.

And what do you think about not adding a subsection for the problems mentioned? I feel like it's an overkill to add very big title just to say 1 paragraph 🤔

@ArthurSens could you review?

Documentation/proposals/202403-prometheus-operator-cli.md

ArthurSens · 2024-04-03T14:33:03Z

Documentation/proposals/202403-prometheus-operator-cli.md

+
+### Linting and Validation
+
+Allow users to validate Prometheus Operator resources before creating them, the CLI should check if the resource manifest is valid.


What do you mean by valid? Kubernetes already does validation when applying objects 🤔

The first use case I can see is the validation of the expressions used on rules

You can do that on apply as well, no?

It's not something that the Kube API can do on its own. You need an admission webhook service: https://prometheus-operator.dev/docs/user-guides/webhook/#prometheusrule

Documentation/proposals/202403-prometheus-operator-cli.md

ArthurSens · 2024-04-03T14:39:54Z

Thanks! It's enough for me to get started with the new repository and experiment 👍

I agree with this part!!! Let's create the repository and play a little bit, but I think we can improve the proposal before merging it

xiu

Quick review, nothing blocking. Exciting proposal 🎉

Documentation/proposals/202403-prometheus-operator-cli.md

xiu · 2024-04-03T17:53:21Z

Documentation/proposals/202403-prometheus-operator-cli.md

+
+For example, the CLI should allow the creation of a Prometheus object and the related Kubernetes objects such as service account, RBAC, service, pod disruption budget, and other related objects.
+
+### Linting and Validation


Is one of the goals to replace po-lint?

That's a fair point!
I think we could review it.
wdyt @simonpasquier @ArthurSens @slashpai ?

Funnily enough, #6474 just popped up 😄

To the best of my knowledge, po-lint is mostly unmaintained and we don't ship it in the releases page or containre images.

I think there was a idea to use kubeconform instead of po-lint

Documentation/proposals/202403-prometheus-operator-cli.md

haanhvu · 2024-04-04T04:54:09Z

Just a question: In Contribfest, did participants report similar issues to GMP? Whether yes or no, do you know how they solve this problem? Do they solve it with a similar approach like this?

Signed-off-by: Nicolas Takashi <nicolas.tcs@hotmail.com>

Co-authored-by: Simon Pasquier <spasquie@redhat.com>

Co-authored-by: Arthur Silva Sens <arthursens2005@gmail.com>

ArthurSens

Some small nits, but good enough to get started :)

Documentation/proposals/202403-prometheus-operator-cli.md

Co-authored-by: Arthur Silva Sens <arthursens2005@gmail.com>

nicolastakashi · 2024-04-17T08:53:59Z

@simonpasquier @slashpai @xiu @ArthurSens could you review it, I think I addressed the comments already.

ArthurSens

Let's get it started :)

nicolastakashi requested a review from a team as a code owner March 25, 2024 16:38

pull-request-size bot added the size/M label Mar 25, 2024

nicolastakashi force-pushed the doc/prometheus-operator-cli branch from 739a09c to 249c40b Compare March 25, 2024 16:43

mviswanathsai reviewed Mar 28, 2024

View reviewed changes

Documentation/designs/prometheus-operator-cli.md Outdated Show resolved Hide resolved

ArthurSens reviewed Mar 28, 2024

View reviewed changes

simonpasquier reviewed Mar 29, 2024

View reviewed changes

nicolastakashi force-pushed the doc/prometheus-operator-cli branch 2 times, most recently from b5416ca to 902797a Compare April 1, 2024 07:24

nicolastakashi requested review from simonpasquier and ArthurSens April 1, 2024 07:31

simonpasquier reviewed Apr 2, 2024

View reviewed changes

Documentation/proposals/202403-prometheus-operator-cli.md Outdated Show resolved Hide resolved

nicolastakashi force-pushed the doc/prometheus-operator-cli branch from 902797a to fbb1350 Compare April 2, 2024 14:08

nicolastakashi requested a review from simonpasquier April 2, 2024 21:05

nicolastakashi enabled auto-merge April 2, 2024 21:51

nicolastakashi disabled auto-merge April 2, 2024 21:51

simonpasquier reviewed Apr 3, 2024

View reviewed changes

Documentation/proposals/202403-prometheus-operator-cli.md Outdated Show resolved Hide resolved

simonpasquier reviewed Apr 3, 2024

View reviewed changes

simonpasquier previously approved these changes Apr 3, 2024

View reviewed changes

ArthurSens reviewed Apr 3, 2024

View reviewed changes

nicolastakashi force-pushed the doc/prometheus-operator-cli branch from 7b7921a to 6e09ada Compare April 3, 2024 15:44

pull-request-size bot added size/L and removed size/M labels Apr 3, 2024

xiu reviewed Apr 3, 2024

View reviewed changes

nicolastakashi force-pushed the doc/prometheus-operator-cli branch from 7ecd618 to c661b68 Compare April 3, 2024 22:03

pull-request-size bot added size/M and removed size/L labels Apr 3, 2024

nicolastakashi force-pushed the doc/prometheus-operator-cli branch from 8e963fa to 8851894 Compare April 12, 2024 07:28

nicolastakashi and others added 17 commits April 12, 2024 08:28

[DOC] adding prometheus-operator-cli design proposal

7c2a670

Signed-off-by: Nicolas Takashi <nicolas.tcs@hotmail.com>

Update Documentation/designs/prometheus-operator-cli.md

5aeeb39

Co-authored-by: Simon Pasquier <spasquie@redhat.com>

Update Documentation/designs/prometheus-operator-cli.md

24c05ff

Co-authored-by: Simon Pasquier <spasquie@redhat.com>

Update Documentation/designs/prometheus-operator-cli.md

e00d2b6

Co-authored-by: Simon Pasquier <spasquie@redhat.com>

Update Documentation/designs/prometheus-operator-cli.md

95c70db

Co-authored-by: Simon Pasquier <spasquie@redhat.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

73ab248

Co-authored-by: Simon Pasquier <spasquie@redhat.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

e817792

Co-authored-by: Simon Pasquier <spasquie@redhat.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

cb870ca

Co-authored-by: Simon Pasquier <spasquie@redhat.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

c57d3fb

Co-authored-by: Simon Pasquier <spasquie@redhat.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

075a633

Co-authored-by: Simon Pasquier <spasquie@redhat.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

7f93619

Co-authored-by: Arthur Silva Sens <arthursens2005@gmail.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

9b7d3b9

Co-authored-by: Arthur Silva Sens <arthursens2005@gmail.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

70974d9

Co-authored-by: Arthur Silva Sens <arthursens2005@gmail.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

34c52e4

Co-authored-by: Arthur Silva Sens <arthursens2005@gmail.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

93a4d66

Co-authored-by: Arthur Silva Sens <arthursens2005@gmail.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

1926a27

Co-authored-by: Arthur Silva Sens <arthursens2005@gmail.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

4b93524

Co-authored-by: Arthur Silva Sens <arthursens2005@gmail.com>

nicolastakashi force-pushed the doc/prometheus-operator-cli branch from 8851894 to 4b93524 Compare April 12, 2024 07:28

nicolastakashi requested review from simonpasquier and ArthurSens April 12, 2024 07:29

ArthurSens previously approved these changes Apr 12, 2024

View reviewed changes

Documentation/proposals/202403-prometheus-operator-cli.md Outdated Show resolved Hide resolved

Documentation/proposals/202403-prometheus-operator-cli.md Outdated Show resolved Hide resolved

Documentation/proposals/202403-prometheus-operator-cli.md Outdated Show resolved Hide resolved

nicolastakashi dismissed ArthurSens’s stale review via f377574 April 12, 2024 22:12

nicolastakashi and others added 3 commits April 12, 2024 23:12

Update Documentation/proposals/202403-prometheus-operator-cli.md

f377574

Co-authored-by: Arthur Silva Sens <arthursens2005@gmail.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

aea48a8

Co-authored-by: Arthur Silva Sens <arthursens2005@gmail.com>

Update Documentation/proposals/202403-prometheus-operator-cli.md

040c417

Co-authored-by: Arthur Silva Sens <arthursens2005@gmail.com>

nicolastakashi requested a review from ArthurSens April 12, 2024 22:12

ArthurSens approved these changes Apr 25, 2024

View reviewed changes

haanhvu mentioned this pull request May 25, 2024

Proposal for Documentation Restructuring prometheus-operator/website#77

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOC] adding prometheus-operator-cli design proposal #6435

[DOC] adding prometheus-operator-cli design proposal #6435

nicolastakashi commented Mar 25, 2024 •

edited

nicolastakashi commented Mar 25, 2024 •

edited

ArthurSens left a comment •

edited

ArthurSens Mar 28, 2024

ArthurSens Mar 28, 2024

simonpasquier left a comment

ArthurSens commented Apr 2, 2024

simonpasquier left a comment

ArthurSens left a comment

ArthurSens Apr 3, 2024

ArthurSens Apr 3, 2024

nicolastakashi Apr 4, 2024

ArthurSens Apr 3, 2024

nicolastakashi Apr 3, 2024

bwplotka Apr 4, 2024

simonpasquier Apr 5, 2024

ArthurSens commented Apr 3, 2024

xiu left a comment

xiu Apr 3, 2024

nicolastakashi Apr 4, 2024

xiu Apr 4, 2024

simonpasquier Apr 5, 2024

slashpai Apr 8, 2024

haanhvu commented Apr 4, 2024

ArthurSens left a comment

nicolastakashi commented Apr 17, 2024

ArthurSens left a comment


		These are just some common issues that users reported, but there are many other issues that users face when managing Prometheus Operator resources, and we believe that a CLI tool can help users to manage Prometheus Operator resources more easily and efficiently.

		## Proposal

		# Pitfalls of the current solution

		At the moment people are struggling to manage Prometheus Operator resources, they have to manually create, update, and delete Prometheus Operator resources using `kubectl` or other tools, and troubleshooting and debugging Prometheus Operator resources is challenging.


		### Linting and Validation

		Allow users to validate Prometheus Operator resources before creating them, the CLI should check if the resource manifest is valid.


		For example, the CLI should allow the creation of a Prometheus object and the related Kubernetes objects such as service account, RBAC, service, pod disruption budget, and other related objects.

		### Linting and Validation

[DOC] adding prometheus-operator-cli design proposal #6435

Are you sure you want to change the base?

[DOC] adding prometheus-operator-cli design proposal #6435

Conversation

nicolastakashi commented Mar 25, 2024 • edited

Description

Type of change

Verification

Changelog entry

nicolastakashi commented Mar 25, 2024 • edited

ArthurSens left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

simonpasquier left a comment

Choose a reason for hiding this comment

ArthurSens commented Apr 2, 2024

simonpasquier left a comment

Choose a reason for hiding this comment

ArthurSens left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ArthurSens commented Apr 3, 2024

xiu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

haanhvu commented Apr 4, 2024

ArthurSens left a comment

Choose a reason for hiding this comment

nicolastakashi commented Apr 17, 2024

ArthurSens left a comment

Choose a reason for hiding this comment

nicolastakashi commented Mar 25, 2024 •

edited

nicolastakashi commented Mar 25, 2024 •

edited

ArthurSens left a comment •

edited