Skip to content

Commit

Permalink
DP-501: Update diagrams to include the entity verification component,…
Browse files Browse the repository at this point in the history 
… SQS, and S3

Rearrange components for readability.
  • Loading branch information
@jakzal
jakzal committed Oct 2, 2024
1 parent 704801e commit 1b8033b
Show file tree
Hide file tree
Showing 23 changed files with 1,283 additions and 641 deletions.
30 changes: 30 additions & 0 deletions docs/diagrams/libraries.dsl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
tenantClient = component "Tenant Client" {
technology "C# project"
description "Makes API calls to the Tenant API"
tags "Shared Component"
}
personClient = component "Person Client" {
technology "C# project"
description "Makes API calls to the Person API"
tags "Shared Component"
}
organisationClient = component "Organisation Client" {
technology "C# project"
description "Makes API calls to the Organisation API"
tags "Shared Component"
}
formsClient = component "Forms Client" {
technology "C# project"
description "Makes API calls to the Forms API"
tags "Shared Component"
}
dataSharingClient = component "Data Sharing Client" {
technology "C# project"
description "Makes API calls to the Data Sharing API"
tags "Shared Component"
}
entityVerificationClient = component "Entity Verification Client" {
technology "C# project"
description "Makes API calls to the Entity Verification API"
tags "Shared Component"
}
189 changes: 118 additions & 71 deletions docs/diagrams/workspace.dsl
View file
Original file line number Diff line number Diff line change
@@ -1,87 +1,124 @@
workspace "Central Digital Platform" {

!identifiers hierarchical

model {
supplier = person "Supplier"
buyer = person "Buyer"
eSender = softwareSystem "eSender" "Commercial Software that Buyers use to manage tender processes"
oneLogin = softwareSystem "Gov.uk One Login" "Let users sign in and prove their identities to use your service"
govNotify = softwareSystem "Gov.uk Notify" "Sends emails, text messages and letters"
companiesHouse = softwareSystem "Companies House" "Provides registered company details"
fts = softwareSystem "Find a Tender"
cfs = softwareSystem "Supplier Information and Contracts Finder"
ppg = softwareSystem "Public Procurement Gateway"
cdp = softwareSystem "Central Digital Platform" "Supports procurement" {
authority = container "Authority" "" "Asp.Net Core" WebApi {
openIdConfigurationEndpoint = component "OpenID Well-Known Configuration Endpoint" "Exposes OpenID configuration" "Asp.Net Core Web API"
openIdJwksConfigurationEndpoint = component "OpenID Well-Known JWKS Configuration Endpoint" "Exposes Json Web Key Set" "Asp.Net Core Web API"
tokenEndpoint = component "Token endpoint" "Exchanges a valid One Login token to a longer-lived token with additional claims." "Asp.Net Core Web API"
}
tenantApi = container "Tenant API" "" "Asp.Net Core" WebApi {
tenantEndpoint = component "Tenant Endpoint" "" "Asp.Net Core Web API"
registerTenantUseCase = component "Register Tenant Use Case"
getTenantUseCase = component "Get Tenant Use Case"
tenantPersistence = component "Persistence" "" "Project"
tenantEndpoint -> registerTenantUseCase "Executes"
tenantEndpoint -> getTenantUseCase "Executes"
registerTenantUseCase -> tenantPersistence "Calls"
getTenantUseCase -> tenantPersistence "Calls"
}
personApi = container "Person API" "" "Asp.Net Core" WebApi {
personEndpoint = component "Person Endpoint" "" "Asp.Net Core Web API"
}
organisationApi = container "Organisation API" "" "Asp.Net Core" WebApi {
organisationEndpoint = component "Organisation Endpoint" "" "Asp.Net Core Web API"
}
formsApi = container "Forms API" "" "Asp.Net Core" WebApi {
formsEndpoint = component "Forms Endpoint" "" "Asp.Net Core Web API"
}
dataSharingApi = container "Data Sharing API" "" "Asp.Net Core" WebApi {
dataSharingEndpoint = component "Data Sharing Endpoint" "" "Asp.Net Core Web API"

messageQueue = container "Message Queue" "" SQS "Message Queue" {
}
database = container "Organisation Information Database" "" PostgreSQL Database {
tenantPersistence -> database "reads/writes" "SQL"

group "Entity Verification" {
entityVerificationDatabase = container "Entity Verification Database" "" PostgreSQL Database {
}
entityVerification = container "Entity Verification" "" "Asp.Net Core" WebApi {
entityVerificationEndpoint = component "Entity Verification Endpoint" "Queries known identifers." "Asp.Net Core Web API"
entityVerificationUseCase = component "Use Case"
entityVerificationUseCase -> messageQueue "publishes to / listens to" "HTTPS"
-> entityVerificationDatabase "reads/writes" "SQL"
}
}
webApp = container "Web Application" "Account & data capture frontend" "Asp.Net Core MVC" WebApp {
mvcController = component "MVC Controller" "Enables web users to perform tasks." "Asp.Net Core MVC Controller"

tenantClient = component "Tenant Client" "Makes API calls to the Tenant API" "library"
personClient = component "Person Client" "Makes API calls to the Person API" "library"
organisationClient = component "Organisation Client" "Makes API calls to the Organisation API" "library"
formsClient = component "Forms Client" "Makes API calls to the Forms API" "library"
dataSharingClient = component "Data Sharing Client" "Makes API calls to the Data Sharing API" "library"

supplier -> mvcController "Uses" "HTTPS"

mvcController -> oneLogin "Authenticates with" "HTTPS"
mvcController -> tokenEndpoint "Authenticates and authorises with" "HTTPS"
mvcController -> tenantClient "Uses"
mvcController -> personClient "Uses"
mvcController -> organisationClient "Uses"
mvcController -> formsClient "Uses"
mvcController -> dataSharingClient "Uses"

group "Organisation Information" {
organisationInformationDatabase = container "Organisation Information Database" "" PostgreSQL Database {
}
fileStorage = container "File Storage" "" S3 "File Storage" {
}

authority = container "Authority" "" "Asp.Net Core" WebApi {
openIdConfigurationEndpoint = component "OpenID Well-Known Configuration Endpoint" "Exposes OpenID configuration" "Asp.Net Core Web API"
openIdJwksConfigurationEndpoint = component "OpenID Well-Known JWKS Configuration Endpoint" "Exposes Json Web Key Set" "Asp.Net Core Web API"
tokenEndpoint = component "Token endpoint" "Exchanges a valid One Login token to a longer-lived token with additional claims." "Asp.Net Core Web API"
-> organisationInformationDatabase "reads/writes" "SQL"
}
tenantApi = container "Tenant API" "" "Asp.Net Core" WebApi {
tenantEndpoint = component "Tenant Endpoint" "" "Asp.Net Core Web API"
registerTenantUseCase = component "Register Tenant Use Case"
getTenantUseCase = component "Get Tenant Use Case"
tenantPersistence = component "Persistence" "" "Project"
tenantEndpoint -> registerTenantUseCase "Executes"
tenantEndpoint -> getTenantUseCase "Executes"
registerTenantUseCase -> tenantPersistence "Calls"
getTenantUseCase -> tenantPersistence "Calls"
tenantPersistence -> organisationInformationDatabase "reads/writes" "SQL"
}
personApi = container "Person API" "" "Asp.Net Core" WebApi {
personEndpoint = component "Person Endpoint" "" "Asp.Net Core Web API"
-> organisationInformationDatabase "reads/writes" "SQL"
}
organisationApi = container "Organisation API" "" "Asp.Net Core" WebApi {
organisationEndpoint = component "Organisation Endpoint" "" "Asp.Net Core Web API"
useCase = component "Use Case"
useCase -> messageQueue "publishes to / listens to" "HTTPS"
useCase -> govNotify "sends notifications with" "HTTPS"
-> organisationInformationDatabase "reads/writes" "SQL"
}
formsApi = container "Forms API" "" "Asp.Net Core" WebApi {
formsEndpoint = component "Forms Endpoint" "" "Asp.Net Core Web API"
useCase = component "Use Case"
useCase -> fileStorage "writes to" "HTTPS"
-> organisationInformationDatabase "reads/writes" "SQL"
}
dataSharingApi = container "Data Sharing API" "" "Asp.Net Core" WebApi {
dataSharingEndpoint = component "Data Sharing Endpoint" "" "Asp.Net Core Web API"
useCase = component "Use Case"
useCase -> fileStorage "writes to / reads from" "HTTPS"
-> organisationInformationDatabase "reads/writes" "SQL"
}
webApp = container "Web Application" "Account & data capture frontend" "Asp.Net Core MVC" WebApp {
group "Libraries" {
!include "libraries.dsl"
}

mvcController = component "MVC Controller" "Enables web users to perform tasks." "Asp.Net Core MVC Controller"

supplier -> mvcController "Uses" "HTTPS"
buyer -> mvcController "Uses" "HTTPS"

mvcController -> oneLogin "Authenticates with" "HTTPS"
mvcController -> companiesHouse "Pulls company details from" "HTTPS"
mvcController -> authority.tokenEndpoint "Authenticates and authorises with" "HTTPS"
mvcController -> tenantClient "Uses"
mvcController -> personClient "Uses"
mvcController -> organisationClient "Uses"
mvcController -> formsClient "Uses"
mvcController -> dataSharingClient "Uses"
mvcController -> entityVerificationClient "Uses"
mvcController -> fileStorage "writes to" "HTTPS"

tenantClient -> tenantApi.tenantEndpoint "Calls" "HTTPS/json"
personClient -> personApi.personEndpoint "Calls" "HTTPS/json"
organisationClient -> organisationApi.organisationEndpoint "Calls" "HTTPS/json"
formsClient -> formsApi.formsEndpoint "Calls" "HTTPS/json"
dataSharingClient -> dataSharingApi.dataSharingEndpoint "Calls" "HTTPS/json"
entityVerificationClient -> entityVerification.entityVerificationEndpoint "Calls" "HTTPS/json"

-> cdp.authority.openIdConfigurationEndpoint "Retrieves OpenID configuration from"
-> cdp.authority.openIdJwksConfigurationEndpoint "Retrieves Json Web Key Set from"
}
}

personApi -> database "reads/writes" "SQL"
organisationApi -> database "reads/writes" "SQL"
formsApi -> database "reads/writes" "SQL"
dataSharingApi -> database "reads/writes" "SQL"

tenantClient -> tenantEndpoint "Calls" "HTTPS/json"
personClient -> personEndpoint "Calls" "HTTPS/json"
organisationClient -> organisationEndpoint "Calls" "HTTPS/json"
formsClient -> formsEndpoint "Calls" "HTTPS/json"
dataSharingClient -> dataSharingEndpoint "Calls" "HTTPS/json"
eSender -> dataSharingEndpoint "Looks up supplier information" "HTTPS/json"
eSender -> dataSharingApi.dataSharingEndpoint "Looks up supplier information" "HTTPS/json"
}

buyer -> eSender "Uses"

fts -> oneLogin "Authenticates with"
fts -> tokenEndpoint "Authorizes with"
fts -> openIdConfigurationEndpoint "Retrieves OpenID configuration from"
fts -> openIdJwksConfigurationEndpoint "Retrieves Json Web Key Set from"
webApp -> openIdConfigurationEndpoint "Retrieves OpenID configuration from"
webApp -> openIdJwksConfigurationEndpoint "Retrieves Json Web Key Set from"
cfs -> authority "Authorizes with"
ppg -> authority "Authorizes with"
fts -> cdp.authority.tokenEndpoint "Authenticates with"
fts -> cdp.authority.openIdConfigurationEndpoint "Retrieves OpenID configuration from"
fts -> cdp.authority.openIdJwksConfigurationEndpoint "Retrieves Json Web Key Set from"
fts -> cdp.organisationApi.organisationEndpoint "Calls" "HTTPS/json"
cfs -> cdp.authority "Authenticates with"
ppg -> cdp.authority "Authenticates with"
}

views {
Expand All @@ -93,39 +130,49 @@ workspace "Central Digital Platform" {
include *
description "The container diagram for the Central Digital Platform."
}
component authority "CDP-3-Authority-Components" {
component cdp.authority "CDP-3-Authority-Components" {
include *
description "The component diagram for the Authority service."
}
component webApp "CDP-3-WebApp-Components" {
component cdp.webApp "CDP-3-WebApp-Components" {
include *
description "The component diagram for the Web Application."
}
component tenantApi "CDP-4-TenantApi-Components" {
component cdp.tenantApi "CDP-4-TenantApi-Components" {
include *
description "The component diagram for the Tenant API."
}
component personApi "CDP-5-PersonApi-Components" {
component cdp.personApi "CDP-5-PersonApi-Components" {
include *
description "The component diagram for the Person API."
}
component organisationApi "CDP-6-OrganisationApi-Components" {
component cdp.organisationApi "CDP-6-OrganisationApi-Components" {
include *
description "The component diagram for the Organisation API."
}
component formsApi "CDP-7-FormsApi-Components" {
component cdp.formsApi "CDP-7-FormsApi-Components" {
include *
description "The component diagram for the Forms API."
}
component dataSharingApi "CDP-8-DataSharingApi-Components" {
component cdp.dataSharingApi "CDP-8-DataSharingApi-Components" {
include *
description "The component diagram for the Data Sharing API."
}
component cdp.entityVerification "CDP-9-EntityVerification-Components" {
include *
description "The component diagram for the Entity Verification."
}
theme default
styles {
element Database {
shape Cylinder
}
element "Message Queue" {
shape Pipe
}
element "File Storage" {
shape Folder
}
element WebApp {
shape WebBrowser
}
Expand Down
Loading

0 comments on commit 1b8033b

Please sign in to comment.