Deploy To Platform

SOA Example

This is a synthetic example that reproduces a use-case related to a SOA architecture.

In .platform/applications.yaml, we have

• a single React app as a front end accessible at the apex
• one API gateway that can proxy the other micro-services
• a Python service acting as "Assets Service"
  • includes a worker instances in Python; this does nothing currently (their start command is simply sleep), but it shows more topological options
• a NodeJS service acting as "Settings Service"
• a Java service acting as "Data/Connector Service"
• a Keycloak (Java service) instance acting as "User Management" service
• a Vault instance (depending on your usage pattern, Platform.sh also offer Vault as a managed service when used as a KMS)

In .platform/services.yaml, we have:

• a PostgreSQL instance (as an example it is configured with two different schemas - and three "endpoints" or roles - admin, reporter and importer),
• a MariaDB instance (for Keycloak).
• a network storage instance accessible by the Python and Golang apps and workers
• a Redis instance
• an Elasticsearch instance

And in .platform/routes.yaml:

We expose public routes for the Frontend, the API gateway as well as for Vault and Keycloak:

• https://{default}/
• https://api.{default}/
• https://keycloack.{default}
• https://vault.{default}/

Notes

The configuration of the internal routing of the gateway is in api-gateway/krakend.json. But, again, this is just a toy. In real life there is a possibility Platform.sh built-in Router Service could have enough functionality to replace it.

Relationships between apps and services have been added just so it could be demonstrated that inter-service routing is opt-in.

This example uses a single configuration file applications.yaml to set up the various apps, but there are other options that could be considered, such using a single .platform.app.yaml per application (in the root of each application's directory).