Skip to content

[UIAM API key] Adds docs for Elastic Cloud API keys and rules#6722

Draft
nastasha-solomon wants to merge 7 commits into
mainfrom
issue-702
Draft

[UIAM API key] Adds docs for Elastic Cloud API keys and rules#6722
nastasha-solomon wants to merge 7 commits into
mainfrom
issue-702

Conversation

@nastasha-solomon
Copy link
Copy Markdown
Member

@nastasha-solomon nastasha-solomon commented May 26, 2026

Summary

Addresses #702 by adding a new reference page for Elastic Cloud API keys and rules, and propagating a Serverless-scoped note across all relevant rule creation and management pages.

Also created a new reusable snippet at solutions/_snippets/elastic-cloud-api-key-rules.md. The snipped it a Serverless-scoped note that explains new and edited rules automatically use Elastic Cloud API keys, and links to the new reference page. It's been included in the following pages:

Stack alerting docs

Observability alerting docs

Secrurity alerting docs

Review request

  • Rules and API keys in Serverless: New page that explains how Elastic Cloud API keys affect rule behavior, ownership, and scope in Serverless projects. Covers the differences from Elasticsearch API keys, what does not update automatically after migration (new roles, role changes, orphaned rules), a post-migration checklist organized into three collapsed dropdowns (right after migration, within 90 days, ongoing), and a table summarizing how rule behavior improves after migration.
  • Observability alerting overview | Authentication: Adds a new "Authentication" section explaining that rules use an API key for all background tasks.
  • Alerting setup | Elasticsearch API keys: Updates the section intro to show the different key types used by deployments.
  • Detection rule concepts | API key: Updates the API key glossary definition and Rule authorization glossary term to distinguish both key types, with links to each.
  • Detections privileges: Updates the authorization model bullet and the important callout to name both API key types and clarify which applies in each deployment.
  • Manage detection rules: Updates the API key reference in the important callout to {{es}} API key with a link to the Elasticsearch API keys page.

@nastasha-solomon nastasha-solomon self-assigned this May 26, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 26, 2026

🔍 Preview links for changed docs

More links …

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 26, 2026

Vale Linting Results

Summary: 2 warnings, 5 suggestions found

⚠️ Warnings (2)
File Line Rule Message
solutions/observability/incident-management/create-latency-threshold-rule.md 17 Elastic.DontUse Don't use 'and/or'.
solutions/observability/incident-management/create-latency-threshold-rule.md 17 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
💡 Suggestions (5)
File Line Rule Message
explore-analyze/alerting/alerts/alerting-setup.md 100 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI.
solutions/observability/incident-management/create-an-inventory-rule.md 49 Elastic.Semicolons Use semicolons judiciously.
solutions/security/detect-and-alert/detection-rule-concepts.md 95 Elastic.WordChoice Consider using 'run, start' instead of 'Execute', unless the term is in the UI.
solutions/security/detect-and-alert/detection-rule-concepts.md 97 Elastic.WordChoice Consider using 'run, start' instead of 'Execute', unless the term is in the UI.
solutions/security/detect-and-alert/detection-rule-concepts.md 123 Elastic.WordChoice Consider using 'run, start' instead of 'execute', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

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.

1 participant