Skip to content

docs: azure_blob: document OAuth authentication support#2535

Open
zshuang0316 wants to merge 2 commits into
fluent:masterfrom
zshuang0316:azure-blob-oauth-auth
Open

docs: azure_blob: document OAuth authentication support#2535
zshuang0316 wants to merge 2 commits into
fluent:masterfrom
zshuang0316:azure-blob-oauth-auth

Conversation

@zshuang0316
Copy link
Copy Markdown

@zshuang0316 zshuang0316 commented Apr 3, 2026

Add new auth_type values (managed_identity, service_principal, workload_identity) and their required configuration parameters (tenant_id, client_id, client_secret, workload_identity_token_file). Add OAuth authentication section with examples for each method.

Summary by CodeRabbit

  • Documentation
    • Expanded Azure Blob authentication to include managed identity, service principal, and workload identity alongside existing key and SAS methods.
    • Documented Azure AD credential parameters (client ID, client secret, tenant ID, workload identity token file path) and when each is required.
    • Added an OAuth authentication section with example configuration snippets and guidance for all supported auth flows.

Review Change Stack

@zshuang0316 zshuang0316 requested review from a team and eschabell as code owners April 3, 2026 12:45
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 3, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8ff406af-aa22-4790-a832-c7a10ddfbde4

📥 Commits

Reviewing files that changed from the base of the PR and between a3b339b and 36b91f3.

📒 Files selected for processing (1)
  • pipeline/outputs/azure_blob.md
✅ Files skipped from review due to trivial changes (1)
  • pipeline/outputs/azure_blob.md

📝 Walkthrough

Walkthrough

Documentation for the Azure Blob output plugin adds OAuth-based auth modes (managed_identity, service_principal, workload_identity), new Azure AD config options (client_id, client_secret, tenant_id, workload_identity_token_file), and example Fluent Bit configs for those flows; key/sas docs unchanged.

Changes

Azure Blob Authentication Documentation

Layer / File(s) Summary
OAuth auth types and config fields
pipeline/outputs/azure_blob.md
Expanded auth_type to include managed_identity, service_principal, workload_identity; added Azure AD config keys (client_id, client_secret, tenant_id, workload_identity_token_file); added OAuth Authentication section with example fluent-bit.yaml and fluent-bit.conf. Existing key/sas docs retained.

Sequence Diagram(s)

sequenceDiagram
    participant FluentBit as Fluent Bit (client)
    participant AzureAD as Azure AD (token endpoint)
    participant Blob as Azure Blob Storage
    FluentBit->>AzureAD: Request token (service_principal / managed_identity / workload_identity)
    AzureAD-->>FluentBit: Return OAuth access_token
    FluentBit->>Blob: PUT/POST blob with Authorization: Bearer <token>
    Blob-->>FluentBit: 201/200 OK
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

5.0

Suggested reviewers

  • patrick-stephens
  • eschabell

Poem

🐰 I hopped through docs with cheer,

Tokens, clients now appear.
Managed, Principal, Workload too,
Fluent Bit speaks AD anew.
🥕📄

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely summarizes the main change: documenting OAuth authentication support for Azure Blob output plugin.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Collaborator

@eschabell eschabell left a comment

Choose a reason for hiding this comment

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

@zshuang0316 see comments inline on the files changed that need attention before review will pass.

Comment thread pipeline/outputs/azure_blob.md Outdated
Comment thread pipeline/outputs/azure_blob.md Outdated
Comment thread pipeline/outputs/azure_blob.md Outdated
Comment thread pipeline/outputs/azure_blob.md Outdated
Comment thread pipeline/outputs/azure_blob.md Outdated

If a chunk arrives with the tag `kube.var.log.containers.app-default`, this configuration creates blobs under `kube/app-default/2025/12/16/05/042/abcd1234/...`.

## OAuth authentication
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@zshuang0316 use backticks around OAuth to get past vale issues here.

Comment thread pipeline/outputs/azure_blob.md Outdated

## OAuth authentication

In addition to shared key and SAS token authentication, the Azure Blob plugin supports Azure AD-based authentication using the following methods.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@zshuang0316 use backticks around SAS, Azure Blob, and Zaure AD to get past vale issues here.

Comment thread pipeline/outputs/azure_blob.md Outdated

### Workload identity

Use [Azure Workload Identity](https://azure.github.io/azure-workload-identity/docs/) to exchange a Kubernetes-projected service account token for an Azure AD access token. This is the recommended approach for workloads running in AKS.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@zshuang0316 use backticks around Azure AD and AKS to get past vale issues here.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@zshuang0316 looks like you missed this vale issue?

Add new auth_type values (managed_identity, service_principal,
workload_identity) and their required configuration parameters
(tenant_id, client_id, client_secret, workload_identity_token_file).
Add OAuth authentication section with examples for each method.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: zshuang0316 <zshuang0316@163.com>
@zshuang0316 zshuang0316 force-pushed the azure-blob-oauth-auth branch from 05784fb to a3b339b Compare April 7, 2026 15:58
@zshuang0316
Copy link
Copy Markdown
Author

@zshuang0316 see comments inline on the files changed that need attention before review will pass.

Thanks, updated.

@eschabell eschabell self-requested a review May 26, 2026 06:00
Copy link
Copy Markdown
Collaborator

@eschabell eschabell left a comment

Choose a reason for hiding this comment

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

@zshuang0316 just one vale issue was missed in your last round of fixes, tackle this one and we're good to go. Thanks for the docs PR work!

Comment thread pipeline/outputs/azure_blob.md Outdated

### Workload identity

Use [Azure Workload Identity](https://azure.github.io/azure-workload-identity/docs/) to exchange a Kubernetes-projected service account token for an Azure AD access token. This is the recommended approach for workloads running in AKS.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@zshuang0316 looks like you missed this vale issue?

@eschabell eschabell added waiting-for-user Waiting for user/contributors feedback or requested changes lint-vale-issues and removed lint-vale-issues labels May 26, 2026
Signed-off-by: zshuang0316 <zshuang0316@163.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@eschabell eschabell removed waiting-for-user Waiting for user/contributors feedback or requested changes waiting-on-review Waiting on a review from mainteners labels May 28, 2026
Copy link
Copy Markdown
Collaborator

@eschabell eschabell left a comment

Choose a reason for hiding this comment

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

@zshuang0316 fixed issues for you, now waiting on code PR merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants