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

docs: Getting Started Improvements #6046

Conversation

CharlieTLe
Copy link
Member

  • Enable auth for multi-tenancy.
  • Load the Cortex dashboards from the cortex-jsonnet repo for the getting-started tutorial. This should allow newcomers to get a better feel for what Cortex is doing.
  • Configure recording rules, alerting rules, and alertmanager with cortextool.
  • Add Grafana datasources to showcase multi-tenancy.

What this PR does:

Which issue(s) this PR fixes:
Fixes #

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

- Enable auth for multi-tenancy.
- Load the Cortex dashboards from the cortex-jsonnet repo for the getting-started tutorial. This should allow newcomers to get a better feel for what Cortex is doing.
- Configure recording rules, alerting rules, and alertmanager with cortextool.
- Add Grafana datasources to showcase multi-tenancy.

Signed-off-by: Charlie Le <charlie_le@apple.com>
@CharlieTLe CharlieTLe force-pushed the improve-getting-started-documentation-2 branch from c19ac04 to 601bf42 Compare June 30, 2024 21:37
Copy link
Member

@friedrichg friedrichg left a comment

Choose a reason for hiding this comment

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

Thanks for doing this.
I am ok repeating cortex-jsonnet dashboards, alerts and rules here in a more readable format.
The only thing I would like to see is a way to do update it here easily.

A makefile target is one option. As simple as:

docs/getting-started/prometheus-config.yaml Outdated Show resolved Hide resolved
Signed-off-by: Charlie Le <charlie_le@apple.com>
@CharlieTLe
Copy link
Member Author

Thanks for doing this. I am ok repeating cortex-jsonnet dashboards, alerts and rules here in a more readable format. The only thing I would like to see is a way to do update it here easily.

A makefile target is one option. As simple as:

When generating the dashboards, singleBinary is set to be true on https://github.com/cortexproject/cortex-jsonnet/blob/5038e0cc8739790b061123ac318debf4c4a8b2f1/cortex-mixin/config.libsonnet#L13.

It looks like the dashboards from cortex-mixin.zip has singleBinary was set to be false.

Should we clone the cortex-jsonnet repo to generate the output files?

Signed-off-by: Charlie Le <charlie_le@apple.com>
Signed-off-by: Charlie Le <charlie_le@apple.com>
Copy link
Member

@friedrichg friedrichg left a comment

Choose a reason for hiding this comment

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

Thanks for implementing the feedback 🙇 . I have only one small nit. For that I created this PR CharlieTLe#5

@@ -0,0 +1,64 @@
{
Copy link
Member

Choose a reason for hiding this comment

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

Nit: I think I prefer we modify mixin.libsonnet.

friedrichg and others added 2 commits July 9, 2024 14:42
Signed-off-by: Friedrich Gonzalez <friedrichg@gmail.com>
Use mixin.libsonnet instead of config.libsonnet
@friedrichg friedrichg merged commit c9f914e into cortexproject:master Jul 10, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants