Entwickler Tutorial (Legacy)
Authority

Authority

In diesem Kapitel wird die 5Minds Authority mit dem 5Minds Portal und der 5Minds Engine verbunden.

Voraussetzungen

  1. Docker Desktop (opens in a new tab).
  2. Docker Hub (opens in a new tab) Lesezugriff auf die Repositories von 5Minds (opens in a new tab).
  3. Der Eintrag 127.0.0.1 authority in der /etc/hosts (Linux/MacOs) bzw. C:\Windows\System32\drivers\etc\hosts (Windows). Dazu kann der Befehl benutzt werden:
echo '127.0.0.1 authority' | sudo tee -a /etc/hosts

Konfiguration

Eine Konvention der 5Minds Entwickler ist es, die Konfigurationen der Produkte im Root des Projektes in einem Ordner namens .processcube zu lagern, und die Konfiguration eines jeden Produkts in einen separaten Unterordner zu legen.

So ergibt sich die Struktur:

  • docker-compose.yml
  • Die einzelnen Konfigurationen können nun definiert werden.

    In der Konfiguration der Authority werden unter anderem das Portal und die Engine bzw. ihre Clients definiert.

    Gewünschte Authentication Providers können im Abschnitt extensions definiert werden. In diesem Beispiel wird "Azure AD" genutzt:

    .processcube/authority/config.json
    {
      "issuerUrl": "http://authority:11560",
      "applicationPort": 11560,
      "development": true,
      "studio": true,
      "portals": [
        {
          "clientId": "5minds_portal",
          "rootUrl": "http://localhost:8082"
        }
      ],
      "engines": [
        {
          "clientId": "5minds_engine",
          "clientSecret": "5minds_engine"
        }
      ],
      "database": {
        "dialect": "sqlite",
        "storage": "storage/database.sqlite",
        "logging": false
      },
      "extensions": {
        "path": "../extensions",
        "configs": {
          "azure_ad": {
            "providers": [
              {
                "id": "test_ad",
                "client_id": "7e839d45-c142-4a5d-b46d-4df195013da4",
                "tennant_id": "2403cfb3-2209-48fc-a198-db488a174f06",
                "redirect_uris_origins": ["http://authority:11560"]
              }
            ]
          }
        }
      }
    }

    Mehr Informationen zu den Konfigurationsmöglichkeiten der Authority gibt es hier (opens in a new tab).

    Mehr Erweiterungen und wie eine Erweiterung entwickelt werden kann, gibt es hier (opens in a new tab).

    Die Konfiguration des Portals und der Engine müssen die gleichen Clients definieren, wie in der Authority Konfiguration angegeben. Das heißt gleiche clientId und ggf. clientSecret und scope.

    .processcube/portal/config.json
    {
      "useAuthority": true,
      "authorityConfiguration": {
        "clientId": "5minds_portal"
      },
      "applicationBaseUrl": "http://localhost:8082",
      "engineUrl": "http://localhost:8000"
    }

    Mehr Informationen zu den Konfigurationsmöglichkeiten des Portals gibt es hier (opens in a new tab).

    Zusätzlich muss die Engine-Konfiguration einen Verweis auf die baseUrl der Authority enthalten.

    .processcube/engine/config.json
    {
      "iam": {
        "baseUrl": "http://authority:11560/",
        "allowAnonymousRootAccess": false,
        "clientId": "5minds_engine",
        "clientSecret": "5minds_engine"
      },
      "extraInfo": {
        "portalUrl": "http://localhost:8082/"
      },
      "httpServer": {
        "host": "0.0.0.0",
        "port": 8000
      },
      "logging": {
        "outputPath": "logs"
      },
      "database": {
        "username": null,
        "password": null,
        "database": null,
        "host": null,
        "port": null,
        "dialect": "sqlite",
        "storage": "atlasengine.sqlite",
        "supportBigNumbers": true,
        "resetPasswordRequestTimeToLive": 12,
        "logging": false
      },
      "application": {
        "name": "5Minds Engine"
      }
    }

    Mehr Informationen zu den Konfigurationsmöglichkeiten der Engine gibt es hier (opens in a new tab).

    Docker Compose

    Als nächstes wird eine docker-compose.yml Datei erstellt, welche die benötigten Docker Images der 5Minds Produkte lädt und konfiguriert.

    docker-compose.yml
    version: '3.5'
    services:
      authority:
        image: 5minds/authority:2.5.0-alpha.20
        environment:
          CONFIG_PATH: /etc/authority/config/config.json
        volumes:
          - ./.processcube/authority/config.json/:/etc/authority/config/config.json
        ports:
          - '11560:11560'
     
      portal:
        image: 5minds/portal:4.0.0-alpha.4
        environment:
          CONFIG_PATH: /etc/portal/config/config.json
        volumes:
          - ./.processcube/portal/config.json:/etc/portal/config/config.json:ro
        ports:
          - '8082:8082'
     
      engine:
        image: 5minds/engine:14.2.4
        environment:
          CONFIG_PATH: /etc/engine/config/config.json
        volumes:
          - ./.processcube/engine/config.json:/etc/engine/config/config.json:ro
        ports:
          - '8000:8000'

    Die aktuellen Versionen der Images sind auf Docker Hub zu finden: Authority (opens in a new tab), Portal (opens in a new tab), Engine (opens in a new tab)

    Wie in der Datei zu sehen, wird die 5Minds Authority 2.0 über den Port 11560 verfügbar sein, das 5Minds Portal über Port 8082 und die Engine über Port 8000. Außerdem wird jeweils der CONFIG_PATH gesetzt und die zuvor erstellten Konfigurationsdateien in die Container an den entsprechenden Pfaden gemountet.

    Starten

    Nach der Konfiguration kann das Projekt gestartet werden.

    docker compose up

    Die Container sollten alle starten. Mit folgendem Befehl kann der Status überprüft werden:

    docker ps
    CONTAINER ID   IMAGE                             COMMAND                  CREATED          STATUS                      PORTS                            NAMES
    3d52034457e4   5minds/portal:4.0.0-alpha.4       "portal"                 16 seconds ago   Up 15 seconds               0.0.0.0:8082->8082/tcp           authority-setup-portal-1
    c29208202e06   5minds/authority:2.5.0-alpha.20   "docker-entrypoint.s…"   16 seconds ago   Up 15 seconds               0.0.0.0:11560->11560/tcp         authority-setup-authority-1
    8f25f7e503fc   5minds/engine:14.2.4              "index.js"               16 seconds ago   Up 15 seconds               80/tcp, 0.0.0.0:8000->8000/tcp   authority-setup-engine-1

    Ruft man nun das Portal unter http://localhost:8082 auf, wird man zur Authority weitergeleitet, welche zum Azure AD Login führt.