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: Managed service accounts disclaimer and config option #1142

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

gamab
Copy link
Contributor

@gamab gamab commented Sep 27, 2024

What this PR does / why we need it:

This PR documents the managed_service_accounts_enabled configuration option that is used in place of the externalServiceAccounts feature toggle starting with 11.3.0 (grafana/grafana#93384)

Following grafana/grafana#91844, I thought we could make it extra clear that we only support single organization setups.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Associated with: grafana/grafana#93883

@gamab gamab requested a review from a team as a code owner September 27, 2024 08:32
@gamab gamab requested review from mckn and removed request for a team September 27, 2024 08:32
Copy link

github-actions bot commented Sep 27, 2024

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs.

@gamab gamab added the no-changelog Don't include in changelog and version calculations label Sep 27, 2024
@gamab gamab marked this pull request as draft September 27, 2024 08:41
@gamab
Copy link
Contributor Author

gamab commented Sep 27, 2024

I'll GA the externalServiceAccounts feature then re-open this one for review without the feature toggle line.

@gamab gamab marked this pull request as ready for review October 4, 2024 07:05
Copy link

@linoman linoman left a comment

Choose a reason for hiding this comment

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

LGTM

docusaurus/docs/reference/metadata.md Show resolved Hide resolved
Copy link

@IevaVasiljeva IevaVasiljeva left a comment

Choose a reason for hiding this comment

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

Added two small comments, but feel free to merge as is :)

**Enabling the Feature:**

- Grafana versions **below 11.3.0**: Enable the `externalServiceAccounts` feature toggle.
- Grafana **11.3.0 and later**: Activate the `managed_service_accounts_enabled` configuration option in the [auth section](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#auth-section) of your Grafana configuration file.

Choose a reason for hiding this comment

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

Nit: I think the word "activate" is slightly confusing.

Suggested change
- Grafana **11.3.0 and later**: Activate the `managed_service_accounts_enabled` configuration option in the [auth section](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#auth-section) of your Grafana configuration file.
- Grafana **11.3.0 and later**: Set the `managed_service_accounts_enabled` configuration option to `true`. You can find this option in the [auth section](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#auth-section) of your Grafana configuration file.

docusaurus/docs/reference/metadata.md Show resolved Hide resolved
@gamab gamab marked this pull request as draft October 4, 2024 15:31
@Jguer Jguer unassigned gamab Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Don't include in changelog and version calculations
Projects
Status: 🔬 In review
Development

Successfully merging this pull request may close these issues.

5 participants