Skip to content

Commit

Permalink
updates docs
Browse files Browse the repository at this point in the history
  • Loading branch information
prasadtalasila committed Jun 18, 2024
1 parent bfb6fcc commit d337c07
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 30 deletions.
30 changes: 6 additions & 24 deletions docs/developer/system/current-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,36 +11,18 @@ A C4 representation of the same diagram is also [available](current-status-devel

## :lock: User Security

There is authorization mechanisms in place for the react website
There is a two-level authorization mechanisms in place for the react website
and the Traefik gateway.

The react website component uses Gitlab for user authorization using
OAuth protocol.

### Gateway Authorization

The Traefik gateway has HTTP basic authorization enabled by default. This
authorization on top of HTTPS connection can provide a good protection
against unauthorized use.

!!! warning
Please note that HTTP basic authorization over insecure non-TLS
is insecure.

There is also a possibility of using self-signed mTLS certificates.
The current security functionality is based on signed
Transport Layer Security (TLS)
certificates issued to users. The TLS certificate based mutual TLS (mTLS)
authorization protocol provides better security than the usual
username and password combination. The mTLS authorization takes place between
the users browser and the platform gateway. The gateway federates all
the backend services. The service discovery, load balancing, and health checks
are carried by the gateway based on a dynamic reconfiguration mechanism.

!!! note
The mTLS is not enabled in the default install.
Please use the scripts in `ssl/` directory to generate
the required certificates for users and Traefik gateway.
The Traefik gateway has OAuth2 web server authorization provided by
[Traefik-forward-auth](https://github.com/thomseddon/traefik-forward-auth)
microservice. This authorization protects all the microservices
and workspaces running in the backend.

## :technologist: User Workspaces

Expand Down Expand Up @@ -85,7 +67,7 @@ The development priorities for the DTaaS software development team are:

* [DT Runner](https://github.com/INTO-CPS-Association/DTaaS/tree/feature/distributed-demo/servers/execution/runner)
(API Interface to DT)
* Multi-user and microservice security
* DevOps from React frontend website
* Increased automation of installation procedures
* Upgrade software stack of user workspaces
* DT Configuration DSL ín the form of YAML schema
Expand Down
16 changes: 10 additions & 6 deletions docs/user/website/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ authorization. Click on **Authorize** button.
After successful authorization, you will be redirected to the **Library**
page of the DTaaS website.

There are two icons on the top-right of the webpage. The hyperlink on
**question mark icon** redirects to help page while the hyperlink on
**github icon** redirects to github code repository.

## Overview of menu items

The menu is hidden by default. Only the icons of menu items are visible.
Expand Down Expand Up @@ -92,7 +96,7 @@ You can see the file manager and five tabs above the library manager. Each tab
provides help text to guide users in the use of different directories
in their workspace.

??? Functions tip
??? tip "Functions"
The functions responsible for pre- and post-processing of: data inputs,
data outputs, control outputs. The data science libraries and functions
can be used to create useful function assets for the platform.
Expand All @@ -101,7 +105,7 @@ in their workspace.
model calibration an achievable goal. Another use of functions is to process
the sensor and actuator data of both Physical Twins and Digital Twins.

??? Data tip
??? tip "Data"
The data sources and sinks available to a digital twins. Typical examples
of data sources are sensor measurements from Physical Twins, and
test data provided by manufacturers for calibration of models.
Expand All @@ -112,7 +116,7 @@ in their workspace.
These control outputs usually go to Physical Twins, but they can also
go to another Digital Twin.

??? Models tip
??? tip "Models"
The model assets are used to describe different aspects of Physical Twins
and their environment, at different levels of abstraction. Therefore,
it is possible to have multiple models for the same Physical Twin.
Expand All @@ -124,7 +128,7 @@ in their workspace.
can also have a functional model(s) describing the part manufacturing
capabilities of the robot.

??? Tools tip
??? tip "Tools"
The software tool assets are software used to create, evaluate and
analyze models. These tools are executed on top of a computing
platforms, i.e., an operating system, or virtual machines like
Expand All @@ -139,15 +143,15 @@ in their workspace.
combination of models and tools put together to create a ready to
use Digital Twins.

??? Digital Twins tip
??? tip "Digital Twins"
These are ready to use digital twins created by one or more users.
These digital twins can be reconfigured later for specific use cases.

In addition to the five directories, there is also **common** directory
in which five sub-directories exist. These sub-directories are:
data, functions, models, tools and digital twins.

??? Common Assets tip
??? tip "Common Assets"
The common directory again has four sub-directories:
- data
- functions
Expand Down

0 comments on commit d337c07

Please sign in to comment.