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: Sandbox play with Mimir #9247

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: Sandbox play with Mimir #9247

wants to merge 4 commits into from

Conversation

Jayclifford345
Copy link

What this PR does

This PR adds the Interactive sandbox metadata to the Play with Mimir tutorial. This tutorial can be tested here: https://killercoda.com/grafana-dev-testing/course/mimir/play-with-mimir

Here are the docs for the annotations I added: https://github.com/grafana/killercoda/blob/staging/docs/transformer.md

This is part of a larger effort to make our docs more interactive. Happy to jump on a call to discuss further as needed.

Checklist

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

@CLAassistant
Copy link

CLAassistant commented Sep 10, 2024

CLA assistant check
All committers have signed the CLA.

@Jayclifford345
Copy link
Author

@jdbaldry hello my good sir! Does Mimir have a different docs checker than the other repos? Just wanted to check whether it should still be the case to include images directly within the repo

@jdbaldry
Copy link
Member

@jdbaldry hello my good sir! Does Mimir have a different docs checker than the other repos? Just wanted to check whether it should still be the case to include images directly within the repo

Good spot, yeah, they have different rules in Mimir.

I should really work with @tacole02 to migrate them to using the media storage.

@Jayclifford345
Copy link
Author

aaah dang good to know. I will re-add the image back in and remove my banner to save repo space

@jdbaldry
Copy link
Member

Think the other linting error is just formatting with prettier (or running the command from the CI output)

https://github.com/grafana/mimir/actions/runs/10791026737/job/29927546365?pr=9247

@tacole02
Copy link
Contributor

Let's do it, @jdbaldry 😄

Copy link
Contributor

@tacole02 tacole02 left a comment

Choose a reason for hiding this comment

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

LGTM 😄

{{< admonition type="tip" >}}
Alternatively, you can try out this example in our interactive learning environment: [Play with Mimir](https://killercoda.com/grafana-labs/course/mimir/play-with-mimir).

It's a fully configured environment with all the dependencies already installed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
It's a fully configured environment with all the dependencies already installed.
It's a fully configured environment with all dependencies already installed.

1. Configure the alert rule:
1. Type `MimirNotRunning` in the **Rule name** field.
1. Choose **Mimir** in the **Select data source** field.
1. Type `count(up == 0)` in the **Metrics browser** query field. This will currently show `no data` since all instances are running.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. Type `count(up == 0)` in the **Metrics browser** query field. This will currently show `no data` since all instances are running.
1. Type `count(up == 0)` in the **Metrics browser** query field. This currently shows `no data` since all instances are running.

1. Type `count(up == 0)` in the **Metrics browser** query field. This will currently show `no data` since all instances are running.
1. Scroll down to **Set evaluation behavior**:
1. Select `New folder` and type `example-folder` in the **Folder name** field.
1. Select `New evaluation group` and type `example-group` in the **Group name** field. Set evaluation interval to `30s`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. Select `New evaluation group` and type `example-group` in the **Group name** field. Set evaluation interval to `30s`.
1. Select `New evaluation group` and type `example-group` in the **Group name** field. Set the evaluation interval to `30s`.

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