Discover here the Access Control Management application domain project, that have mission to build and deliver testable CYBNITY domain software components and systems versions.
The CYBNITY Access Control domain technical documentation includes many types of support deliverables produced during the software development life cycle.
You can find informations relative to software maintenance like:
- Design diagrams regarding software developed concepts and source codes
- Support to software build process and packaging
- Systems configuration and deployment procedures
- Show the functionalities of the system(s) as perceived by the external actors
- Exposes the requirements of the systems
Formalizes software functional and/or technical analysis according to the functional and technical requirements.
Feature specifications API versions (e.g interface versions) are delivered according to requirements and specification identified by MVF project line's prototyping results.
The managed source files are stored in the functional-view sub-folder like:
- Static aspects (structural diagrams): use cases
- Dynamic aspects (behavioral diagrams): interactions, statecharts, activities
- Model sub-packages:
- Each context of the software (e.g Domain context) is described in a separate sub-package
- Sub-capture how the functionality is designed inside the domain contexts
- Logical view of systems and sub-systems
Formalizes the specification of the software and sub-components produced during the solution analysis and technical design activities.
Feature implementations versions are designed and delivered as implementation software which extends the Foundation Core project.
The managed source files are stored in the design-view sub-folder like:
- Static aspects (structural diagrams): classes, objects
- Dynamic aspects (behavioral diagrams): interactions, statecharts, activities, sequences
- Show the concurrency of the system(s)
- Encompasses the threads and processes that form the system's concurrency and synchronization mechanisms
Describes execution models and synchronization rules, identified during the technical design phase and implementation rules definition.
The managed source files are stored in the process-view sub-folder like:
- Static aspects: equals to design view's diagrams, with focus on the active classes that represent theses threads and processes
- Model sub-packages:
- Performance
- Scalability
- Show the organization of the core components and files (e.g source code, setting files)
- Packaging models and dependencies distribution
- Addresses the configuration management of the system's releases
Formalizes the maintenance documentation aligned with source codes developed, including specificities regarding technologies (e.g language requirements) and frameworks (e.g implementation templates, protocols) used for implementation of the software.
The managed source files are stored in the implementation-view sub-folder like:
- Static aspects (structural diagrams): components, packages
- Dynamic aspects (behavioral diagrams): interactions, statecharts, activities
- Model sub-packages:
- Implementation principles & models
- Configuration-management
- System-assembly
Implementation components projects are structured and built according to standards:
- Maven: Java components using a standard Maven project structure
- NPM: JavaScript components
- Docker: system containers and images templates are managed by each project (e.g via auto-generated Dockerfile by Maven process)
- Helm: parameters and Kubernetes resources configuration using a standard Helm structure
The implementation projects are supported by an Official TechStack version defining the authorized technologies used by this software project.
The source codes managed in theses sub-projects are providing capabilities to final user via web interfaces (e.g visual interfaces and/or backend API services) which can enhance the Foundation Core project's capabilities layer:
The source codes managed in theses sub-projects (Maven projects) are supporting the features (as micro-service components constituing the business capabilities provided by the application domain) provided by the bounded context:
- Adapter libraries
- Adapter API libraries
- Adapter implementation components
- Adapter translator libraries
- UI translator library
- Keycloak translator library
- Domain model library
- Domain service libraries
- Service API library
- Service implementation module
- System modules
- Gateway application module
- RTS computation unit
%%{
init: {
'theme': 'base',
'themeVariables': {
'background': '#ffffff',
'fontFamily': 'arial',
'fontSize': '13px',
'primaryColor': '#fff',
'primaryTextColor': '#0e2a43',
'primaryBorderColor': '#0e2a43',
'secondaryColor': '#fff',
'secondaryTextColor': '#fff',
'secondaryBorderColor': '#fff',
'tertiaryColor': '#fff',
'tertiaryTextColor': '#fff',
'tertiaryBorderColor': '#fff',
'edgeLabelBackground':'#fff',
'lineColor': '#0e2a43',
'titleColor': '#fff',
'textColor': '#fff',
'lineColor': '#0e2a43',
'nodeTextColor': '#fff',
'nodeBorder': '#0e2a43',
'noteTextColor': '#fff',
'noteBorderColor': '#fff'
},
'flowchart': { 'curve': 'monotoneX', 'htmlLabels': 'true', 'wrappingWidth': '400' }
}
}%%
flowchart LR
access_control_rts_computation_unit("_<<System>>_<br>groupId: org.cybnity.application.access-control.**system** <br>artifactId: **process-module**")
access_control_domain_gateway_server("_<<System>>_<br>groupId: org.cybnity.application.access-control.**system** <br>artifactId: **domain-gateway-server**")
access_backend_server("_<<UI system>>_<br>groupId: org.cybnity.application.access-control.**ui.system** <br>artifactId: **backend-server**")
access_frontend_server("_<<UI system>>_<br>groupId: org.cybnity.application.access-control.**ui.system** <br>artifactId: **frontend-server**")
access_control_adapter_keycloak_impl("_<<Adapter>>_<br>groupId: org.cybnity.application.access-control.**adapters** <br>artifactId: **keycloak-impl**")
access_control_adapter_admin_api("_<<Adapter API>>_<br>groupId: org.cybnity.application.access-control.**adapters** <br>artifactId: **admin-api**")
access_control_adapter_keycloak_admin_impl("_<<Adapter>>_<br>groupId: org.cybnity.application.access-control.**adapters** <br>artifactId: **keycloak-admin-impl**")
access_control_adapter_api("_<<Adapter API>>_<br>groupId: org.cybnity.application.access-control.**adapters** <br>artifactId: **api**")
access_control_domain_model("_<<Domain model>>_<br>groupId: org.cybnity.application.**access-control** <br>artifactId: **domain**")
access_control_service_api("_<<Service API>>_<br>groupId: org.cybnity.application.**access-control** <br>artifactId: **service-api**")
access_control_ui_translator("_<<Translator>>_<br>groupId: org.cybnity.application.access-control.**translator** <br>artifactId: **ui**")
access_control_ui_api("_<<UI API>>_<br>groupId: org.cybnity.application.access-control.**ui** <br>artifactId: **api**")
access_control_service_impl("_<<Service>>_<br>groupId: org.cybnity.application.**access-control** <br>artifactId: **service-impl**")
access_control_keycloak_translator("_<<Translator>>_<br>groupId: org.cybnity.application.access-control.**translator** <br>artifactId: **keycloak**")
fwk_support("_<<Framework>>_<br>groupId: org.cybnity.**framework** <br>artifactId: **support**")
fwk_domain("_<<Framework>>_<br>groupId: org.cybnity.**framework** <br>artifactId: **domain**")
vertx_common("_<<Framework>>_<br>groupId: org.cybnity.**framework** <br>artifactId: **vertx-common**")
redis_store("_<<Feature>>_<br>groupId: org.cybnity.features.technical.**persistence** <br>artifactId: **redis-store**")
janusgraph_repository("_<<Feature>>_<br>groupId: org.cybnity.features.technical.**persistence** <br>artifactId: **janusgraph-repository**")
redis_impl("_<<Adapter>>_<br>groupId: org.cybnity.infrastructure.integration.**uis.adapters** <br>artifactId: **redis-impl**")
access_backend_server -.-> access_control_ui_api & access_control_ui_translator
access_control_service_impl -.-> access_control_adapter_admin_api
access_control_service_impl -.-> access_control_service_api & access_control_adapter_api & access_control_ui_api & access_control_domain_model
access_control_adapter_keycloak_admin_impl -.-> access_control_adapter_admin_api
access_control_adapter_keycloak_admin_impl -.-> access_control_adapter_keycloak_impl
access_control_adapter_keycloak_impl -.-> access_control_adapter_api
access_control_service_api -.-> access_control_ui_translator
access_control_domain_gateway_server -.-> access_control_ui_translator
access_control_rts_computation_unit -.-> access_control_adapter_keycloak_admin_impl & access_control_service_impl
access_control_adapter_api -.-> access_control_ui_translator
access_control_adapter_keycloak_impl -.-> access_control_keycloak_translator
classDef module fill:#0e2a43, color:#fff
classDef lib fill:#fff, stroke:##0e2a43, color:##0e2a43
classDef external fill:#fff, stroke:#e5302a, color:#e5302a, stroke-dasharray: 5 5
class access_control_ui_api,access_control_ui_translator,access_control_keycloak_translator,access_control_service_api,access_control_service_impl,access_control_domain_model,access_control_adapter_admin_api,access_control_adapter_api,access_control_adapter_keycloak_admin_impl,access_control_adapter_keycloak_impl lib;
class access_backend_server,access_frontend_server,access_control_rts_computation_unit,access_control_domain_gateway_server module;
class fwk_domain,redis_store,janusgraph_repository,redis_impl,vertx_common,fwk_support external;
The source code managed in the Adapter translator libraries area are about the infrastructure components supporting the integration capabilities:
- Keycloak Admin Rest API adapter to Keycloak server
- Keycloak SSO API adapter to Keycloak SSO server
- Show the deployment of the systems in terms of physical architecture;
- Encompasses the node that form the system's hardware topology (e.g type of infrastructure components, network, virtual environments) on which the system executes (e.g resources requirements, runtime platform);
- Addresses the distribution (e.g flow opening), delivery (e.g procedures to respect), and installation (e.g resource prerequisites) of the parts that make up the physical system.
Describes the environment(s), infrastructure and operating conditions required to install, activate and operate the systems safely.
The managed source files are stored in the deployment-view sub-folder like:
- Static aspects (structural diagrams): components, deployment
- Model sub-packages:
- Installation
- Systems deployment
- Delivery
- System-distribution
- System-topology
- Installation
Several systems are built as executable modules, containerized (Docker images) and that are ready for deployment via provisioning management solution (e.g Helm charts):
Several servers are developed as executable domain components, which are containerized and ready for deployment via provisioning management solution:
- Domain Gateway Server
- For example, to start auto-generated docker image (by Maven) into a Kubernetes context, execute command line
kubectl run cybnity-ac-domain-gateway --image=cybnity/access-control-domain-gateway --image-pull-policy=Never
- For example, to start auto-generated docker image (by Maven) into a Kubernetes context, execute command line
- Real-Time Stream Computation Unit
- For example, to start docker image as Pod in Kubernetes context, execute command line
kubectl run cybnity-ac-domain-rts-process --image=cybnity/access-control-process-module --image-pull-policy=Never
- For example, to start docker image as Pod in Kubernetes context, execute command line
Perimeter: some infrastructure third-party software (e.g Keycloak, Postgresql, Redis, JanusGraph, Cassandra) are available on the market as template of provisioning helping to quickly customize the runtime (provisioning of pre-configured Docker image) into a Kubernetes platform. Some infrastructure systems are reused by CYBNITY as infrastructure systems with customization of the prepared templates of their images helmization.
Project type: Helm implementation structures.
Description: several generic infrastructure projects required by the CYBNITY implementation architecture are managed into the CYBNITY helm charts repository supporting the provisioning of servers over Helm chart implementation.
The infrastructure servers reused by the Access Control domain are:
- SSO service: Keycloak server
- UIS service: Redis server
- Knowledge repository service: JanusGraph server with Cassandra