Component list & process flow if not deploying via Ansible

[mrticks]

Hi Folks,

We would like to deploy X-ROad in PoC but do not have Ansible for the easy path. Is there one page diagram will all the components required with data flows that we could use to build out the components?

Something like this one below, but including central server, OSCP, logging and logging etc.? https://github.com/nordic-institute/X-Road/blob/027d59d57db06846a3c5bac8a7ad65ae59bcf882/doc/Architecture/img/arc-ss_security_server_process_diagram.png

[petkivim]

Hi @mrticks,

All the X-Road components, their roles and responsibilities are explained here:

https://github.com/nordic-institute/X-Road/blob/develop/doc/Architecture/arc-g_x-road_arhitecture.md

More detailed sequence diagram describing the message flow between two Security Servers can be found here:

https://github.com/nordic-institute/X-Road/blob/develop/doc/UseCases/uc-mess_x-road_member_communication_use_case_model.md#annex-a-sequence-diagram-for-messaging

I hope these documents provide the information you're looking for.

Best regards, Petteri

[mrticks]

Hi @mrticks,

All the X-Road components, their roles and responsibilities are explained here:

https://github.com/nordic-institute/X-Road/blob/develop/doc/Architecture/arc-g_x-road_arhitecture.md

More detailed sequence diagram describing the message flow between two Security Servers can be found here:

https://github.com/nordic-institute/X-Road/blob/develop/doc/UseCases/uc-mess_x-road_member_communication_use_case_model.md#annex-a-sequence-diagram-for-messaging

I hope these documents provide the information you're looking for.

Best regards, Petteri

Hi Petteri,

Thanks for your response. The architecture documents and sequence flows are really good. Is there a one pager with all the applications listed depicting data flows. Its been done for the security server here, https://github.com/nordic-institute/X-Road/blob/027d59d57db06846a3c5bac8a7ad65ae59bcf882/doc/Architecture/img/arc-ss_security_server_process_diagram.png

But I was hoping to find outif you would have a bigger one also depicting applications sitting in central server etc.?

We'd like to build this but I'm hoping to get a complete list of applications/components with flows?

Am I explaining what we're looking for on paper properly?

Regards, Gavin

[petkivim]

Hi @mrticks,

Unfortunately, the process diagram that you're referring to is available for the Security Server only. Doing a similar diagram for the Central Server is in our backlog, but we're not working on it currently and it's not a high priority at the moment.

The diagram describes the data flows between the Security Server internal modules. When you install the Security Server using package manager (sudo apt-get install xroad-securityserver), the installation process takes care of installing and configuring all the different modules - you do not need to configure the modules and/or data flows between them manually.

If you want to set up an X-Road instance, you don't need to know the details regarding data flows between internal modules of different X-Road components. It is enough to understand the roles, responsibilities and dependencies between the high level components, and take them into account when designing the infrastructure and network where the instance is deployed.

Best regards, Petteri

[mrticks]

Thanks Petteri.

We'll give it a go and do a trial with a host external system for data sharing.

Many thanks for the prompt response.

[mrticks]

Hi @mrticks,

Unfortunately, the process diagram that you're referring to is available for the Security Server only. Doing a similar diagram for the Central Server is in our backlog, but we're not working on it currently and it's not a high priority at the moment.

The diagram describes the data flows between the Security Server internal modules. When you install the Security Server using package manager (sudo apt-get install xroad-securityserver), the installation process takes care of installing and configuring all the different modules - you do not need to configure the modules and/or data flows between them manually.

If you want to set up an X-Road instance, you don't need to know the details regarding data flows between internal modules of different X-Road components. It is enough to understand the roles, responsibilities and dependencies between the high level components, and take them into account when designing the infrastructure and network where the instance is deployed.

Best regards, Petteri

Hi Petteri,

I can expand the diagram out myself and share with the group pending approval?

I see a reference to draw.io format, but I can't access it. Do you have a link to a draw.io diagram I could import and edit?

This is the link I'm referring to, https://github.com/nordic-institute/X-Road/blob/develop/doc/Architecture/img/arc-sec_x-road_security_architecture_diagram.drawio

Regards, /m

[petkivim]

Hi @mrticks,

I can expand the diagram out myself and share with the group pending approval?

Yes, you can submit a pull request. Before the pull request can be approved we must have received a signed Contributor License Agreement from you. Please see more detailed instructions here.

This is the file you can import and edit. Just save it on your workstation first and then open using Draw.io.

https://github.com/nordic-institute/X-Road/blob/develop/doc/Architecture/img/arc-sec_x-road_security_architecture_diagram.drawio

Best regards, Petteri

[petkivim]

I’m closing this issue now, but in case you require any assistance in the future, please open a new issue.