Skip to content

Add docs for identity provider in drasi-server#223

Open
ruokun-niu wants to merge 6 commits into
drasi-project:mainfrom
ruokun-niu:drasi-server-identity-provider
Open

Add docs for identity provider in drasi-server#223
ruokun-niu wants to merge 6 commits into
drasi-project:mainfrom
ruokun-niu:drasi-server-identity-provider

Conversation

@ruokun-niu
Copy link
Copy Markdown
Contributor

Description

This pull request adds a comprehensive new documentation page that explains how to configure and use identity providers in Drasi Server. The page covers the structure of the identityProviders configuration, details for each supported provider type (password, Azure, AWS), and validation rules. This documentation will help users securely manage authentication for sources and reactions without hardcoding credentials.

The most important changes include:

New documentation for identity providers:

  • Added a new guide at docs/content/drasi-server/how-to-guides/configuration/configure-identity-providers/_index.md that explains how to declare reusable identity providers, reference them from sources and reactions, and configure provider-specific authentication methods.

Provider-specific configuration instructions:

  • Detailed instructions and YAML examples for the built-in password provider, Azure provider (with all supported authentication methods), and AWS provider (including ambient credentials, role assumption, and IRSA on EKS).
  • Tables listing required and optional fields for each provider type, with explanations of each field’s purpose.

Usage and validation guidance:

Type of change

  • This pull request fixes a bug in Drasi and has an approved issue (issue link required).
  • This pull request adds or changes features of Drasi and has an approved issue (issue link required).
  • This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Drasi (issue link optional).

Fixes: #issue_number

ruokun-niu and others added 3 commits April 28, 2026 10:49
Signed-off-by: ruokun-niu <ruokunniu@gmail.com>
Signed-off-by: ruokun-niu <ruokunniu@gmail.com>
Copilot AI review requested due to automatic review settings May 29, 2026 23:01
@ruokun-niu ruokun-niu requested a review from a team as a code owner May 29, 2026 23:01
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new Drasi Server configuration guide describing how to declare reusable identityProviders and reference them from sources/reactions, including provider-specific YAML examples and field reference tables.

Changes:

  • Added a new documentation page for identity provider configuration and usage.
  • Documented built-in password provider and plugin-based azure / aws providers (auth methods, fields, examples).
  • Added a “Validation rules” section describing configuration constraints and common failure cases.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Signed-off-by: ruokun-niu <ruokunniu@gmail.com>
Signed-off-by: ruokun-niu <ruokunniu@gmail.com>
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