Skip to content

Conversation

@KorayErkan
Copy link
Collaborator

@KorayErkan KorayErkan commented Sep 26, 2025

Summary by CodeRabbit

  • Documentation

    • Added guides for Multitenancy, Role-Based Access Control, and Single Sign-On (Azure AD/Entra ID).
    • Updated navigation to surface new topics.
    • Removed legacy v1.3.0 sections (about, administration, configuration, devices, processors, CLI, appendix) to streamline and reduce outdated content.
  • Chores

    • Upgraded site dependencies (Docusaurus 3.9.0) and migrated broken-link handling to the new markdown hooks API with unchanged behavior.

@coderabbitai
Copy link

coderabbitai bot commented Sep 26, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The PR adds new documentation pages for Multitenancy, RBAC, and Single Sign-On (SSO), updates Docusaurus configuration to the markdown.hooks API, adjusts the sidebar to include new entries, bumps Docusaurus dependencies to 3.9.0, and removes a large set of versioned 1.3.0 documentation files across multiple sections.

Changes

Cohort / File(s) Summary
New docs: Multitenancy & SSO & RBAC
docs/multitenancy.mdx, docs/single-sign-on.mdx, docs/organization/role-based-access-control.mdx
Add documentation pages covering tenant model and management, SSO (Azure AD/Entra ID) setup, and RBAC roles/permissions and custom roles.
Site config update
docusaurus.config.ts
Migrate deprecated top-level onBrokenMarkdownLinks to markdown.hooks.onBrokenMarkdownLinks: "warn".
Dependencies/version
package.json
Bump Docusaurus-related packages 3.8.1 → 3.9.0; change package version 1.4.0 → 1.3.0.
Sidebar entries
sidebars.ts
Add links for RBAC under Organization and top-level “single-sign-on”, “multitenancy” to userDocs.
Remove v1.3.0: About & Architecture
versioned_docs/version-1.3.0/about/*, versioned_docs/version-1.3.0/architecture/*
Delete product, features, licensing, benchmarks, comparisons, and architecture pages.
Remove v1.3.0: Administration
versioned_docs/version-1.3.0/administration/...
Delete Home, Content Hub, Fleet Management (devices/directors/targets), Organization (users/roles/audit), Routes, and My Pipelines docs.
Remove v1.3.0: Configuration overview
versioned_docs/version-1.3.0/configuration/overview.mdx, .../configuration/devices/*
Delete configuration overview and all device configuration docs (Azure, syslog, netflow, kafka, etc.).
Remove v1.3.0: Pipelines & processors
versioned_docs/version-1.3.0/configuration/pipelines/*, .../processors/*
Delete pipelines overview and numerous processor docs (parsers, transforms, enrichments, control-flow).
Remove v1.3.0: Appendix
versioned_docs/version-1.3.0/appendix/*
Delete file formats, log formats, protocols, BNF, Windows Event IDs reference.
Remove v1.3.0: CLI
versioned_docs/version-1.3.0/cli/*
Delete Agent and Director CLI docs.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Admin
  participant DS as DataStream UI
  participant AAD as Azure AD/Entra ID

  rect rgba(220,235,255,0.5)
  note right of Admin: Configure SSO
  Admin->>DS: Enable SSO (Azure AD)
  DS->>AAD: Register app / read config (tenant ID, client ID, scopes)
  DS-->>Admin: Show redirect URI, client settings
  end

  rect rgba(220,255,220,0.5)
  note right of User: Sign-in via SSO
  actor User
  User->>DS: Access login page
  DS-->>User: Redirect to Azure AD
  User->>AAD: Authenticate
  AAD-->>DS: Authorization code / tokens
  DS-->>User: Session established
  end
Loading
sequenceDiagram
  autonumber
  actor OrgOwner as Org Owner
  participant DS as DataStream Control Plane
  participant T as Tenant Env
  actor TenantUser as Tenant User

  rect rgba(255,245,200,0.6)
  OrgOwner->>DS: Create tenant (name, limits, parent)
  DS->>T: Provision isolated resources/config
  DS-->>OrgOwner: Tenant status: Enabled
  end

  rect rgba(235,255,235,0.6)
  TenantUser->>DS: Login (scoped to tenant)
  DS->>T: Route requests to tenant-scoped resources
  T-->>DS: Data / metrics / audit (tenant-isolated)
  DS-->>TenantUser: Tenant-specific UI/data
  end
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • Docs-updates #209 — Also modifies sidebars.ts, potentially overlapping with new entries added here.
  • Update Structure #240 — Restructures documentation including sidebars and organization-related docs, overlapping with RBAC/Users topics.

Poem

A rabbit taps keys in a moonlit nook,
New tenants spin up, neat as a book.
SSO doors swing—single key, you’re through!
Roles stand guard, knowing who’s who.
Old scrolls archived, paths made clear—
Hippity-hop, docs fresh this year! 🐇✨

✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DT-385-sso-and-multi-tenancy-documentation

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 62483eb and ce0ea18.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (135)
  • docs/multitenancy.mdx (1 hunks)
  • docs/organization/role-based-access-control.mdx (1 hunks)
  • docs/single-sign-on.mdx (1 hunks)
  • docusaurus.config.ts (1 hunks)
  • package.json (3 hunks)
  • sidebars.ts (1 hunks)
  • versioned_docs/version-1.3.0/about/applications.mdx (0 hunks)
  • versioned_docs/version-1.3.0/about/benchmarks.mdx (0 hunks)
  • versioned_docs/version-1.3.0/about/comparisons/cribl.mdx (0 hunks)
  • versioned_docs/version-1.3.0/about/comparisons/logstash.mdx (0 hunks)
  • versioned_docs/version-1.3.0/about/comparisons/overview.mdx (0 hunks)
  • versioned_docs/version-1.3.0/about/comparisons/tenzir.mdx (0 hunks)
  • versioned_docs/version-1.3.0/about/comparisons/vector.mdx (0 hunks)
  • versioned_docs/version-1.3.0/about/key-features.mdx (0 hunks)
  • versioned_docs/version-1.3.0/about/licensing.mdx (0 hunks)
  • versioned_docs/version-1.3.0/about/product.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/content-hub/managing-templates.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/content-hub/overview.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/creating-accounts.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/fleet-management/devices/creating-pull-devices.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/fleet-management/devices/creating-push-devices.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/fleet-management/devices/managing-devices.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/fleet-management/devices/overview.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/fleet-management/directors/creating-directors.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/fleet-management/directors/managing-directors.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/fleet-management/directors/overview.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/fleet-management/targets/creating-targets.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/fleet-management/targets/managing-targets.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/fleet-management/targets/overview.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/home.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/managing-accounts.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/my-pipelines/creating-pipelines.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/my-pipelines/managing-pipelines.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/my-pipelines/overview.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/organization/audit.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/organization/roles.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/organization/users/creating-users.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/organization/users/managing-users.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/organization/users/overview.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/routes/managing-advanced-routes.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/routes/managing-quick-routes.mdx (0 hunks)
  • versioned_docs/version-1.3.0/administration/routes/overview.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/configuration-bnf.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/file-formats/avro.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/file-formats/parquet.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/file-formats/pem.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/log-formats/asim.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/log-formats/cef.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/log-formats/cim.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/log-formats/ecs.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/log-formats/estreamer.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/log-formats/ipfix.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/log-formats/leef.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/log-formats/netflow.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/log-formats/sflow.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/protocols/kafka.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/protocols/nats.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/protocols/rabbitmq.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/protocols/redis.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/protocols/smtp.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/protocols/syslog.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/protocols/tftp.mdx (0 hunks)
  • versioned_docs/version-1.3.0/appendix/windows-event-ids.mdx (0 hunks)
  • versioned_docs/version-1.3.0/architecture/clustering.mdx (0 hunks)
  • versioned_docs/version-1.3.0/architecture/file-system.mdx (0 hunks)
  • versioned_docs/version-1.3.0/architecture/overview.mdx (0 hunks)
  • versioned_docs/version-1.3.0/architecture/persistency.mdx (0 hunks)
  • versioned_docs/version-1.3.0/architecture/zero-trust.mdx (0 hunks)
  • versioned_docs/version-1.3.0/cli/agent.mdx (0 hunks)
  • versioned_docs/version-1.3.0/cli/director.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/_app-protocols.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/azure-blob-storage.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/azure-monitor.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/estreamer.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/event-hubs.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/http.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/ipfix.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/kafka.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/linux.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/microsoft-sentinel.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/nats.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/netflow.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/overview.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/rabbitmq.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/redis.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/sflow.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/smtp.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/snmp-trap.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/syslog.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/tcp.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/tftp.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/udp.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/devices/windows.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/overview.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/conditional-running.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/handling-failures.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/handling-success.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/normalization.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/overview.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/aad-errcode.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/abs.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/acl-decode.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/add.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/alienvault.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/anthropic.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/append.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/attachment.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/azure-openai.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/bag-pack.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/binary-decode.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/bytes.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/camel-case.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/capitalize.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/case.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/cef.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/ceil.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/checksum.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/circle.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/clean.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/cloudflare-intel.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/coalesce.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/color-decode.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/comment.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/community-id.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/compact.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/concat.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/confidence.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/contains.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/continue.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/convert.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/cpid.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/csv.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/data-size.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/date-index.mdx (0 hunks)
  • versioned_docs/version-1.3.0/configuration/pipelines/processors/date.mdx (0 hunks)

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

@KorayErkan KorayErkan merged commit 9298121 into dev Sep 26, 2025
1 of 2 checks passed
@KorayErkan KorayErkan deleted the DT-385-sso-and-multi-tenancy-documentation branch September 26, 2025 13:01
@github-actions
Copy link

Docs Feature Deployment https://7d7184b4.virtualmetric-docs.pages.dev

@coderabbitai coderabbitai bot mentioned this pull request Oct 16, 2025
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.

2 participants