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

Reorder "guides" pages #1237

Merged
merged 4 commits into from
Feb 22, 2022
Merged

Reorder "guides" pages #1237

merged 4 commits into from
Feb 22, 2022

Conversation

jdbaldry
Copy link
Member

What this PR does

Reorders or removes all the pages remaining in the "guides" directory

Which issue(s) this PR fixes

Relates to #1110
Relates to #1114
Relates to #1108
Relates to #1111

@jdbaldry jdbaldry added the type/docs Improvements or additions to documentation label Feb 20, 2022
Placed in the architecture section as it is an optional component
similar to the Alertmanager or ruler.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
The "getting started" for the gossip ring is more of a demonstration
and does not inform users about the gossip ring.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry jdbaldry merged commit edd9beb into main Feb 22, 2022
@jdbaldry jdbaldry deleted the jdb/2022-02-reorder-guides branch February 22, 2022 11:38

Grafana Mimir supports applying overrides on a per-tenant basis.
A number of overrides configure limits that prevent a single tenant from using too many resources.
The overrides-exporter component exposes limits as Prometheus metrics so that operators can understand close tenants are to their limits.
Copy link
Collaborator

Choose a reason for hiding this comment

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

can understand close tenants are to their limits

I think you mean "can understand HOW close tenants are to their limits"

Run the overrides-exporter by providing the `-target`, and `-runtime-config.file` flags:

```
mimir -target=overrides-exporter -runtime-config.file=runtime.yaml -server.http-listen-port=8080
Copy link
Collaborator

Choose a reason for hiding this comment

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

-server.http-listen-port=8080

Can be omitted because it's the default

After the overrides-exporter starts, you can to use `curl` to inspect the tenant overrides:

```bash
curl -s http://localhost:8080/metrics | grep cortex_overrides
Copy link
Collaborator

Choose a reason for hiding this comment

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

The metric name has been renamed from cortex_overrides to cortex_limits_overrides

The output metrics look similar to the following:

```console
# HELP cortex_overrides Resource limit overrides applied to tenants
Copy link
Collaborator

Choose a reason for hiding this comment

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

We need to rename the metric here too.

@@ -1,134 +0,0 @@
---
title: "Getting started with gossiped ring"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are we going to drop this content entirely?


## Store-gateways: blocks replication

The Grafana Mimir [store-gateway](../blocks-storage/store-gateway.md) (used only when Grafana Mimir is running with the [blocks storage](../blocks-storage/_index.md)) supports blocks sharding, used to horizontally scale blocks in a large cluster without hitting any vertical scalability limit.
Copy link
Collaborator

Choose a reason for hiding this comment

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

used only when Grafana Mimir is running with the blocks storage

Can be removed

The Grafana Mimir services supporting **zone-aware replication** are:

- **[Distributors and Ingesters](#distributors-and-ingesters-time-series-replication)**
- **[Store-gateways](#store-gateways-blocks-replication)** ([blocks storage](../blocks-storage/_index.md) only)
Copy link
Collaborator

Choose a reason for hiding this comment

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

We need to add alertmanager too. Now zone aware replication is supported there too.

pracucci pushed a commit that referenced this pull request Feb 28, 2022
* Reorder the "(Optional) Overrides-exporter page

Placed in the architecture section as it is an optional component
similar to the Alertmanager or ruler.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Reorder "Running on Kubernetes" page

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Reorder "Configuring zone aware replication"

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove remaining guides pages

The "getting started" for the gossip ring is more of a demonstration
and does not inform users about the gossip ring.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants