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

Fix spacelift-promex readme #73

Merged
merged 1 commit into from
Aug 23, 2024
Merged

Fix spacelift-promex readme #73

merged 1 commit into from
Aug 23, 2024

Conversation

eliecharra
Copy link
Member

The readme for installing the promex exporter is slightly incorrect. Config values are prefixed with spacelift.

image

@eliecharra eliecharra requested a review from Apollorion August 23, 2024 08:52
@eliecharra eliecharra requested a review from a team as a code owner August 23, 2024 08:52
@eliecharra
Copy link
Member Author

@Apollorion We should also suggest installing prom CRDs, since if you start from scratch, the cluster will not have them.

image

Can we add a dependency on this chart to install the CRDs without installing the whole prom stack?
https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack/charts/crds

@adamconnelly
Copy link
Collaborator

@Apollorion We should also suggest installing prom CRDs, since if you start from scratch, the cluster will not have them.

image

Can we add a dependency on this chart to install the CRDs without installing the whole prom stack? https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack/charts/crds

Personally I'm not sure that's a good idea. I think it might make more sense to make deploying the custom resources optional, and to explain in the README that there's a dependency on having a working Prometheus stack installed first. I'd be super wary of installing CRDs from some other project and ending up in a crazy dependency hell.

Copy link
Member

@Apollorion Apollorion left a comment

Choose a reason for hiding this comment

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

Ah, yeah, this is my fault. Thanks for the fix 👍

@Apollorion
Copy link
Member

Apollorion commented Aug 23, 2024

Also, I agree with @adamconnelly I do call out in the blog post I've written that kube prom stack is a requirement.

I can PR this repo too and make the callout in the readme as well later today.

@eliecharra eliecharra merged commit 80661ad into main Aug 23, 2024
1 check passed
@eliecharra eliecharra deleted the eliecharra-patch-1 branch August 23, 2024 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants