Skip to content

Commit

Permalink
add legend to studio diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
TomasEkeli committed Jun 26, 2023
1 parent c5e1319 commit d562f2a
Showing 1 changed file with 28 additions and 15 deletions.
43 changes: 28 additions & 15 deletions Source/content/en/docs/platform/studio/_index.md
Expand Up @@ -6,9 +6,9 @@ weight: 60
type: "space"
---

Aigonix Studio is your management-tool to interact with services and products you run in the Dolittle Platform. It is a web-based application that is available at [dolittle.studio](https://dolittle.studio).
Aigonix Studio is your management-tool to interact with services and products you run in the Aigonix Platform. It is a web-based application that is available at [dolittle.studio](https://dolittle.studio).

In Studio you can create and manage Applications, Environments, Microservices and other products and services.
In Studio you can create and manage [Applications]({{<ref application>}}), [Environments]({{<ref environment>}} ), [Microservices]({{<ref microservice>}}) and other products and services.

## Getting started

Expand All @@ -18,15 +18,28 @@ Once you have access to Studio, you can log in using your credentials at [dolitt

## Components

When you run your Microservices in the Aigonix platform we will set up Applications with Environments wherein Microservices run. You will define each Application with its Environments, and add Microservices to them. You define which Docker image to use for each Microservice, and whether or not you want to use the Dolittle Runtime. If you use the Runtime one will be available from your Head and through it you will have access to Tenanted resources like the Event Store and Read Cache.
When you run your Microservices in the Aigonix Platform you will have access to a number of components that will help you manage your services.

You will define each Application with its Environments, and add Microservices to them. You define which Docker image to use for each Microservice, and whether or not you want to use the Dolittle Runtime. You can use a publically available image, or store your container image in the provided container-registry.

If you use the Dolittle Runtime one will be made available to your Head and through it you will have access to Tenanted resources like the Event Store and Read Cache. If you do not use the Dolittle Runtime the service will run the assigned Docker-image without permanent storage (stateless).

You can make your services available to the internet if you so wish. If you do not they will only be available within the platform.

```mermaid
flowchart TB
subgraph Legend
direction LR
S[Docker Container]
R>Dolittle Runtime]
D[(Database)]
F[\Studio function/]
end
subgraph Customer
subgraph app1[Application with 3 Environments]
subgraph app1dev[Development Environment]
subgraph app1devms1[Microservice with Runtime]
app1devms1head[Head] --SDK--> app1devms1runtime[Runtime]
app1devms1head[Head] --SDK--> app1devms1runtime>Runtime]
app1devms1runtime --uses--> app1devms1eventstore[(Event Store)]
app1devms1runtime --makes available--> app1devms1readmodel[(Read Cache)]
Expand All @@ -40,7 +53,7 @@ flowchart TB
end
subgraph app1test[Test Environment]
subgraph app1testms1[Microservice with Runtime]
app1testms1head[Head] --uses--> app1testms1runtime[Runtime]
app1testms1head[Head] --uses--> app1testms1runtime>Runtime]
app1testms1runtime --uses--> app1testms1eventstore[(Event Store)]
app1testms1runtime --makes available--> app1testms1readmodel[(Read Cache)]
Expand All @@ -53,7 +66,7 @@ flowchart TB
end
subgraph app1prod[Production Environment]
subgraph app1prodms1[Microservice with Runtime]
app1prodms1head[Head] --uses--> app1prodms1runtime[Runtime]
app1prodms1head[Head] --uses--> app1prodms1runtime>Runtime]
app1prodms1runtime --uses--> app1prodms1eventstore[(Event Store)]
app1prodms1runtime --makes available--> app1prodms1readmodel[(Read Cache)]
Expand All @@ -65,24 +78,24 @@ flowchart TB
app1prodms1eventstore --in--> app1prodDB[(Prod Database)]
app1prodms1readmodel --in--> app1prodDB
end
ACR1[Container Registry]
Docs1[Documentation]
ACR1[\Container Registry/]
Docs1[\Documentation/]
Logs1[Log viewer] -.gathers logs.-> app1devms1head
Logs1[\Log viewer/] -.gathers logs.-> app1devms1head
Logs1 -.gathers logs.-> app1devms2head
Logs1 -.gathers logs.-> app1testms1head
Logs1 -.gathers logs.-> app1testms2head
Logs1 -.gathers logs.-> app1prodms1head
Logs1 -.gathers logs.-> app1prodms2head
app1devDB -.regular backups.-> Backups1[Backups]
app1devDB -.regular backups.-> Backups1[\Backups/]
app1testDB -.regular backups.-> Backups1
app1prodDB -.regular backups.-> Backups1
end
subgraph app2[Application with 1 Environment]
subgraph app2prod[Production Environment]
subgraph app2prodms1[Microservice with Runtime]
app2prodms1head[Head] --uses--> app2prodms1runtime[Runtime]
app2prodms1head[Head] --uses--> app2prodms1runtime>Runtime]
app2prodms1runtime --uses--> app2prodms1eventstore[(Event Store)]
app2prodms1runtime --makes available--> app2prodms1readmodel[(Read Cache)]
Expand All @@ -94,12 +107,12 @@ flowchart TB
app2prodms1readmodel --in--> app2prodDB
end
ACR2[Container Registry]
Docs2[Documentation]
Logs2[Log viewer] -.gathers logs.-> app2prodms1head
ACR2[\Container Registry/]
Docs2[\Documentation/]
Logs2[\Log viewer/] -.gathers logs.-> app2prodms1head
Logs2 -.gathers logs.-> app2prodms2head
app2prodDB -.regular backups.-> Backups2[Backups]
app2prodDB -.regular backups.-> Backups2[\Backups/]
end
end
```

0 comments on commit d562f2a

Please sign in to comment.