Skip to content

docs(auto-create-groups): polish IFC-2521 user docs + dev knowledge + changelog#9340

Merged
polmichel merged 7 commits into
developfrom
pmi-20260522-polish-autocreation-feature
May 27, 2026
Merged

docs(auto-create-groups): polish IFC-2521 user docs + dev knowledge + changelog#9340
polmichel merged 7 commits into
developfrom
pmi-20260522-polish-autocreation-feature

Conversation

@polmichel
Copy link
Copy Markdown
Contributor

@polmichel polmichel commented May 22, 2026

Why

The IFC-2521 auto-create-groups epic shipped without the user-facing and dev-knowledge docs caught up. Operators have no public reference for auto_create_groups_filter / auto_create_groups_max_per_login behavior, the origin provenance attribute, or the three new audit events; the dev event-types table still lists only the membership events; no changelog fragment exists.

Closes https://opsmill.atlassian.net/browse/IFC-2593 (docs polish phase).

What changed

  • New section in docs/docs/deploy-manage/user-management/sso/advanced-sso.mdx and documentation update.
  • Added dev/knowledge/backend/events.md.
  • Changelog fragment +ifc-2521-auto-create-account-groups.added.md.
  • Removed dev/specs/infp-556-auto-create-groups/tasks.md (per-task tracker becomes stale post-shipping; durable spec artifacts kept).

How to test

Build the docs site locally and visit the SSO "Advanced SSO" page to confirm the new section renders.

Checklist

  • Changelog entry added (uv run towncrier create ...)
  • External docs updated (if user-facing or ops-facing change)
  • Internal .md docs updated (internal knowledge and AI code tools knowledge)
  • I have reviewed AI generated content

Summary by cubic

Polishes user and developer docs for SSO auto-create account groups (IFC-2521). Adds the Advanced SSO guide section, documents the auth pipeline, syncs event names across docs/specs, surfaces the auth/ package in architecture docs, and adds a trimmed changelog entry.

  • Documentation
    • Advanced SSO: “Auto-create groups from identity provider claims” — opt-in via security.auto_create_groups_filter, named-capture extraction, precedence over the default group, per-login cap via security.auto_create_groups_max_per_login, origin provenance (read-only, display: extra), and emitted events; updated the group-mapping note.
    • New dev/knowledge/backend/authentication.md: password/SSO/LDAP flows, SSO group-resolution pipeline, AutoCreateEventEmitter (Live/Disabled), and config keys; linked from backend/AGENTS.md and the architecture layer table (new Auth layer).
    • Events/specs: events table lists GroupAutoCreatedEvent, GroupAutoCreateRejectedEvent, GroupAutoCreateCappedEvent; propagated the rename from the old ...RejectedClaimEvent/...CapBreachEvent across contracts, data-model, plan, research, quickstart; removed obsolete dev/specs/infp-556-auto-create-groups/tasks.md.
    • Changelog: added a concise user-facing fragment for the feature.

Written for commit 06e6a27. Summary will update on new commits. Review in cubic

@github-actions github-actions Bot added type/documentation Improvements or additions to documentation type/spec A specification for an upcoming change to the project labels May 22, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 4 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Shadow auto-approve: would auto-approve. This PR is purely documentation: it adds a new section to the SSO guide, updates developer event docs, adds a changelog fragment, and removes a stale task tracker—no source code, config, or business logic changes are made.

Re-trigger cubic

@github-actions github-actions Bot added the group/backend Issue related to the backend (API Server, Git Agent) label May 22, 2026
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented May 22, 2026

Merging this PR will not alter performance

✅ 12 untouched benchmarks


Comparing pmi-20260522-polish-autocreation-feature (06e6a27) with develop (09d7a5e)

Open in CodSpeed

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

0 issues found across 6 files (changes from recent commits).

Shadow auto-approve: would auto-approve. This PR adds documentation, event serialization methods, GraphQL types, and tests for the already-merged auto-create group events, with no changes to core business logic, security, or data paths, making the risk very low.

Re-trigger cubic

@polmichel polmichel force-pushed the pmi-20260522-polish-autocreation-feature branch from 746b51c to 6bafaa9 Compare May 22, 2026 13:59
@github-actions github-actions Bot removed the group/backend Issue related to the backend (API Server, Git Agent) label May 22, 2026
@polmichel polmichel force-pushed the pmi-20260522-polish-autocreation-feature branch 4 times, most recently from b161343 to 01c20ad Compare May 22, 2026 14:36
@polmichel polmichel force-pushed the pmi-20260517-event-autocreation-groups branch from ea93e62 to a943b7e Compare May 22, 2026 14:38
@polmichel polmichel force-pushed the pmi-20260522-polish-autocreation-feature branch from 01c20ad to bf10b25 Compare May 22, 2026 14:40
@github-actions github-actions Bot added the group/frontend Issue related to the frontend (React) label May 22, 2026
@polmichel polmichel force-pushed the pmi-20260522-polish-autocreation-feature branch from bf10b25 to 6257c96 Compare May 22, 2026 14:42
@github-actions github-actions Bot removed the group/frontend Issue related to the frontend (React) label May 22, 2026
@polmichel polmichel force-pushed the pmi-20260522-polish-autocreation-feature branch from 6257c96 to 351e60e Compare May 25, 2026 12:13
@polmichel polmichel marked this pull request as ready for review May 25, 2026 12:13
@polmichel polmichel requested review from a team as code owners May 25, 2026 12:13
@github-actions github-actions Bot added the group/backend Issue related to the backend (API Server, Git Agent) label May 25, 2026
Base automatically changed from pmi-20260517-event-autocreation-groups to develop May 26, 2026 07:20
polmichel and others added 6 commits May 26, 2026 10:00
Add a new "Auto-create groups from identity provider claims" section to the
advanced-sso guide covering: opt-in via the regex filter, the named-capture
vs full-claim name extraction, precedence over the default-group fallback,
the per-login cap and its dropped-claim behavior, the `origin` provenance
attribute on auto-created groups, and the three audit events emitted on the
event bus.

Also update the in-page warning at the top of "Group mapping" — it was
stating that Infrahub never auto-creates groups, which is no longer true.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Add `GroupAutoCreatedEvent`, `GroupAutoCreateRejectedClaimEvent`, and
`GroupAutoCreateCapBreachEvent` alongside the existing membership events
so the table reflects what's actually defined in `group_action.py`.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The per-task tracking file becomes stale once the feature ships and is no
longer load-bearing. The durable design artifacts (spec, plan, data-model,
research, quickstart, contracts/, checklists/) stay in place.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Drop env var name, event class names, origin attribute detail, and
cap-setting key — those belong in docs, not the changelog.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The upstream branch renamed GroupAutoCreateRejectedClaimEvent →
GroupAutoCreateRejectedEvent and GroupAutoCreateCapBreachEvent →
GroupAutoCreateCappedEvent, with the matching event_name strings
flattened from dotted to flat form. Sync the user-facing SSO guide,
the events knowledge table, and the spec artifacts to match the code.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…package

The auth package owns a non-trivial pipeline (password / SSO / LDAP →
claim filter → auto-create → default-group fallback → membership) with
no high-level write-up. Add dev/knowledge/backend/authentication.md to
cover the entry points, the SSO group resolution pipeline, the
AutoCreateEventEmitter Live/Disabled split, and the config keys.

Surface the auth/ package in backend/AGENTS.md and the architecture
layer table so future readers find it from the standard entry points,
and cross-link from events.md.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@polmichel polmichel force-pushed the pmi-20260522-polish-autocreation-feature branch from 351e60e to 06e6a27 Compare May 26, 2026 08:01
@polmichel polmichel merged commit cc355ed into develop May 27, 2026
50 checks passed
@polmichel polmichel deleted the pmi-20260522-polish-autocreation-feature branch May 27, 2026 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

group/backend Issue related to the backend (API Server, Git Agent) type/documentation Improvements or additions to documentation type/spec A specification for an upcoming change to the project

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants