Nubus for Kubernetes - Architecture Manual

Contents:

• 1. Introduction
  • 1.1. Audience
  • 1.2. Knowledge needed for understanding
  • 1.3. Feedback
• 2. Overviews
  • 2.1. Capabilities
    • 2.1.1. End user perspective
    • 2.1.2. Provider and operation perspective
    • 2.1.3. Development and governance perspective
  • 2.2. Functional components
    • 2.2.1. End user facing
    • 2.2.2. Authentication and Authorization
    • 2.2.3. Integration
    • 2.2.4. Connectors
  • 2.3. Capability mapping
    • 2.3.1. End user perspective
    • 2.3.2. Provider and operation perspective
    • 2.3.3. Development and governance perspective
  • 2.4. Interfaces and protocols
    • 2.4.1. External perspective
    • 2.4.2. Authorization Service
    • 2.4.3. Directory Manager
    • 2.4.4. End User Self Service
    • 2.4.5. Identity Provider
    • 2.4.6. Identity Store and Directory Service
    • 2.4.7. Intercom Service
    • 2.4.8. Management UI
    • 2.4.9. Portal Service
    • 2.4.10. Provisioning Service
  • 2.5. Deployment view
    • 2.5.1. Registries for Helm Charts and images
    • 2.5.2. Authorization Service
    • 2.5.3. Directory Manager
    • 2.5.4. End User Self Service
    • 2.5.5. Identity Provider
    • 2.5.6. Identity Store and Directory Service
    • 2.5.7. Management UI
    • 2.5.8. Portal Service
    • 2.5.9. Provisioning Service
    • 2.5.10. Ingress configuration
    • 2.5.11. SQL database: PostgreSQL
  • 2.6. Transport security with TLS
  • 2.7. Scalability
    • 2.7.1. Identity Provider
    • 2.7.2. Identity Store and Directory Service
    • 2.7.3. Directory Manager
    • 2.7.4. Management UI
    • 2.7.5. Portal Service
  • 2.8. S3-compatible object storage
  • 2.9. Message queues
• 3. Components
  • 3.1. Authorization Service
    • 3.1.1. Policy-based authorization
    • 3.1.2. Management of authorization rules
    • 3.1.3. Registration of Authorization Service in Identity Provider
    • 3.1.4. Storage
    • 3.1.5. Dependencies
  • 3.2. Directory Manager
    • 3.2.1. Internal functions
    • 3.2.2. Authentication and authorization for CRUD operations
    • 3.2.3. Populate data on initial startup of Nubus
  • 3.3. End User Self Service
    • 3.3.1. Self Service Consumer
    • 3.3.2. User account profile
    • 3.3.3. User self registration
    • 3.3.4. User password reset
  • 3.4. Identity Provider
    • 3.4.1. Single sign-on / single sign-out
    • 3.4.2. Identity Store
    • 3.4.3. Keycloak Extensions
  • 3.5. Identity Store and Directory Service
    • 3.5.1. Information types in identity store
    • 3.5.2. Provide user account and user group information
    • 3.5.3. Notify about changes to directory objects
    • 3.5.4. Write data to the identity store
    • 3.5.5. Store configuration data
  • 3.6. Intercom Service
  • 3.7. Management UI
    • 3.7.1. UMC Gateway
    • 3.7.2. UMC Server
  • 3.8. Portal Service
    • 3.8.1. Portal Server
    • 3.8.2. Portal Frontend
    • 3.8.3. Portal Consumer
    • 3.8.4. Portal Announcement
    • 3.8.5. Notifications API
    • 3.8.6. Central Navigation API
  • 3.9. Provisioning Service
    • 3.9.1. UDM Listener
    • 3.9.2. UDM Transformer
    • 3.9.3. Dispatcher
    • 3.9.4. Consumer Messages HTTP REST API
    • 3.9.5. Consumer Registration HTTP REST API
    • 3.9.6. Prefill Service
    • 3.9.7. Nubus initial startup
  • 3.10. Connectors
    • 3.10.1. IAM Connector
    • 3.10.2. Nubus Directory Importer
  • 3.11. Dependencies
    • 3.11.1. Functional component level
    • 3.11.2. Application component level
• 4. Data objects
  • 4.1. Directory objects
  • 4.2. UDM objects
    • 4.2.1. UDM objects fields and types
    • 4.2.2. Consumers of UDM objects
    • 4.2.3. Functions for the UDM object
  • 4.3. Event objects
    • 4.3.1. Structure
    • 4.3.2. Consumers of Event objects
    • 4.3.3. Queues holding Event objects
• 5. Data flow
  • 5.1. Directory objects flow
    • 5.1.1. Consumers of directory objects
    • 5.1.2. Data flow - Read directory objects
    • 5.1.3. Data flow - Write directory objects
  • 5.2. UDM objects flow
    • 5.2.1. UDM objects processing flow
    • 5.2.2. Write operation
  • 5.3. Event objects flow
    • 5.3.1. Event objects processing
    • 5.3.2. Event objects consumers
  • 5.4. Complete flow
    • 5.4.1. Functional components level
    • 5.4.2. Behavior level
• 6. Appendix
  • 6.1. Glossary
  • 6.2. Indices
  • 6.3. Bibliography

• Document changelog
  • Year 2024