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.

Sign up for GitHub

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

Jump to bottom

Docs: Review about-tenant-ids.md. #1251

Merged
merged 1 commit into from
Feb 21, 2022
Merged

Docs: Review about-tenant-ids.md. #1251

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/sources/about-tenant-ids.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ weight: 10

# About tenant IDs

The tenant ID is the unique identifier of a tenant within a Grafana Mimir cluster.
Within a Grafana Mimir cluster, the tenant ID is the unique identifier of a tenant.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I opted to provide context before details.

For information about how Grafana Mimir components use tenant IDs, refer to [About authentication and authorization]({{<relref "./about-authentication-and-authorization.md" >}}).

## Restrictions

Tenant IDs must be less-than or equal-to 150 bytes/characters in length and must comprise only supported characters:
Tenant IDs must be less-than or equal-to 150 bytes or characters in length and must comprise only supported characters:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pracucci I believe / means or here. Is that so?

Copy link
Collaborator

Choose a reason for hiding this comment

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

"or" is correct here.


- Alphanumeric characters
- `0-9`
Expand All @@ -21,12 +21,12 @@ Tenant IDs must be less-than or equal-to 150 bytes/characters in length and must
- Exclamation point (`!`)
- Hyphen (`-`)
- Underscore (`_`)
- Single Period (`.`)
- Single period (`.`)
- Asterisk (`*`)
- Single quote (`'`)
- Open parenthesis (`(`)
- Close parenthesis (`)`)

> **Note:** For security reasons, `.` and `..` aren't valid tenant IDs.
> **Note:** For security reasons, `.` and `..` are not valid tenant IDs.

All other characters, including slashes and whitespace, aren't supported.
All other characters, including slashes and whitespace, are not supported.