Skip to content

Enhancement [CAT-FR-AU-01] Admin UI — Architecture Documentation#29

Open
peleskek wants to merge 4 commits intoeclipse-xfsc:mainfrom
federated-catalogue-enhancements-2026:merge-to-upstream/CAT-FR-AU-01-Admin-UI
Open

Enhancement [CAT-FR-AU-01] Admin UI — Architecture Documentation#29
peleskek wants to merge 4 commits intoeclipse-xfsc:mainfrom
federated-catalogue-enhancements-2026:merge-to-upstream/CAT-FR-AU-01-Admin-UI

Conversation

@peleskek
Copy link
Copy Markdown
Contributor

📦 [CAT-FR-AU-01] Admin UI — Architecture Documentation

🚀 Summary

Requirement: CAT-FR-AU-01 — Admin Dashboard & Runtime Configuration

This change is part of the Enhancement of XFSC Federated Catalogue. Details can be found here (permalink):

https://github.com/eclipse-xfsc/docs/blob/f3c6e6b6fbcc87732a1dfe83f060fa58a9a97873/federated-catalogue/src/docs/CAT%20Enhancement/CAT_Enhancement_Specifications%20v1.0.pdf

Documents the Admin API implementation in the arc42 architecture — building block view, deployment view, and concepts.

✅ What's Changed

Modified files:

  • 05_building_block_view.adoc

    • Add [[_admin_api]] section: four delegate service descriptions with endpoint inventory and effects table; one enforcement component description (CredentialVerificationStrategy) with notes on @Cacheable hot-path caching and the unimplemented graph backend switch
    • Fix Mermaid erDiagram audit table diagrams: PK_FKFK (Mermaid v10 does not support compound key type specifiers)
  • 07_deployment_view.adoc

    • Add "Admin UI — Keycloak Setup" subsection covering: ADMIN_ALL role requirement, KC_REALM_ENV-based realm directory structure, iFrame embedding security header changes for user management, Admin Console URL derivation and override
  • 08_concepts.adoc

    • Add "Admin Configuration Persistence" subsection: describes trust_frameworks and admin_config tables; documents all active admin_config keys

🔍 Related Issues

Related to PR #96 (federated-catalogue — CAT-FR-AU-01 Admin UI implementation)
Implements documentation for CAT-FR-AU-01 (Admin Dashboard & Runtime Configuration)

📋 Checklist

  • I've updated documentation if necessary
  • My changes follow the project's coding style

noVaSon and others added 4 commits April 14, 2026 14:16
…ove-tagus-support

Reflect the removed Tagus support
Extended docs for schemas and asset with new audit logs columns
Building block view:
 - Add Admin API section: endpoint delegate services (fc-service-server),
runtime enforcement components (AssetTypeRestrictionService,                                                                CredentialVerificationStrategy) with config effects table, and
    implementation gap note for the graph backend switch
  - Add GET /admin/asset-types/type-hints to AssetTypeAdminService entry
  - Note SchemaModuleConfigService @Cacheable caching on hot path in
    CredentialVerificationStrategy entry
  - Add credential_types (text[]) column to ASSETS table and notes
  - Fix Mermaid erDiagram PK_FK → FK in audit tables

  Deployment view:
  - Add Admin UI Keycloak setup: ADMIN_ALL role requirement, realm environment
    directory structure (KC_REALM_ENV), iFrame security header changes for
    user management page, Admin Console URL derivation
  - Add admin.dashboard.* property aliases for Admin Console URL config

  Concepts:
  - Add Admin Configuration Persistence section with trust_frameworks and
    admin_config key reference table

[CAT-FR-AU-01] remove asset type restriction from architecture docs

- Removed credential_types column from assets table schema
- Removed AssetTypeAdminService and AssetTypeRestrictionService from admin tables
- Removed asset.type.restriction.* keys from admin_config reference table
@sonarqubecloud
Copy link
Copy Markdown

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.

3 participants