FSXA / Entwickler-Dokumentation / Custom App Platform

Deployment eigener Anwendungen über die Custom App Platform

Inhaltsverzeichnis

Dieses Kapitel soll es Ihnen ermöglichen, Ihre eigene Anwendung im Rahmen der FirstSpirit Custom App Platform zu deployen.

Um das Deployment eigener Anwendungen anzustoßen, sind aktuell die folgenden Informationen nötig:

  • kundenspezifische Daten
  • deploymentspezifische Informationen
  • Umgebungsvariabeln

Wichtig Aktuell befindet sich die Entwicklung und Veröffentlichung eigener Anwendungen im Rahmen der Custom App Platform in der RampUp-Phase. Aus diesem Grunde müssen einige kundenspezifische Daten über den Umweg des e-Spirit Technical Support mitgeteilt werden. In absehbarer Zukunft wird Ihnen als Kunden direkt eine Webseite zur Verfügung gestellt, in der Sie selbst Ihre Apps und Services, ohne den Technical Support als Mittler, verwalten können.

Kundenspezifische Daten

Die grundlegenden Informationen, die für die Einrichtung eines Deployments benötigt werden, sind einige kundenspezifischen Daten. Das sind:

  • Kundenname
  • E-Mail-Kontaktadresse
  • Name der Anwendung

Der Kundenname ist im Kontext des jeweililigen Vorgangs natürlich bekannt. Eine wichtige Information, die uns vor der Einrichtung eines Deployments mitgeteilt werden muss, ist eine E-Mail-Adresse, an die Mails bezüglich der Deployments verschickt werden können.
Der Name des Repositories wird zunächst von uns vorgegeben und setzt sich aus der Art und dem Namen der Anwendung sowie dem Kundennamen zusammen.

Deploymentspezifische Informationen

Standard für ein Deployment über die Custom App Platform ist ein Setup mit drei Stages, einer DEV-, einer QA- und einer PROD-Stage. Die DEV-Stage basiert auf dem develop-Branch des zugehörigen Repositories, die QA-Stage auf dem qa-Branch und Prod-Stage auf dem master-Branch. Ein Push auf den jeweiligen Branch löst automatisch eine Aktualisierung der zugeordneten Stage aus.

Die wichtige Information, die in diesem Kontext benötigt wird, ist der Typ des jeweiligen Deployments. Zur Zeit gibt es hier drei Möglichkeiten.

Statischer Inhalt über NPM

Dient der Auslieferung von statischen Inhalten auf Basis eines npm-Projekts. Vorraussetzung ist, dass in der Generierung ein „dist“-Ordner vorhanden ist und die Generierung mit npm run build ausgeführt wird.

Node-Server

Anwendung, die in einer Node-Umgebung angesiedelt ist. Es ist wichtig, dass die Anwednung mit npm run start, gestartet wird.

FSXA-PWA

Eine Progressive Web App basierend auf der FSXA-PWA. Dies kann als Grundlage für die Entwicklung einer eigenen Anwendung dienen. In diesem Szenario gibt es, anders als bei den vorherigen, insgesamt sechs Stages,. Das sind jeweils eine Release- und eine Edit-Variante der DEV-, QA- und PROD-Stage. Die Zuordnung der Stages zu den Branches ist hier genau wie oben beschrieben, sprich beide DEV-Stages basieren auf dem develop-Branch des Repositories usw.

Umgebungsvariablen

Es gibt zwei Arten von Umgebungsvariablen für Deployments über die e-Spirit Custom App Platform. Beide werden als Key-Value Paare eingetragen und ausgewertet.

ParameterName : ParameterWert

Globale Umgebungsvariablen

Diese Umgebungsvariablen werden für alle Stages verwendet. Hiermit können Sie kunden- und anwendungsspezifische Parameter setzen, die das gesamte Deployment betreffen. Ein Beispiel hierfür wäre etwa ein Autorisierungstoken für eine Drittanwendung die für alle Stages relevant ist.

Umgebungsvariablen für die einzelnen Stages

Diese Umgebungsvariablen sind isoliert und beziehen sich immer auf eine bestimmte Stage. Damit können Sie individuelle Anpassungen machen, die nur jeweils die DEV-, QA-, oder PROD-Umgebung betreffen. Beispiele hierfür wären eine Unterscheidung zwischen Preview- und Live-Daten oder auch eine bestimmte stage-spezifische CaaS-Collection.

Technischer Überblick

Die oben dargestellte Grafik zeigt einen groben Überblick über die technische Architektur der Custom App Platform. Für jedes neue Deployment wird zuerst das Repository in Bitbucket erstellt, inklusive aller benötigten Branches. Das Kunden-Projekt in Bitbucket, in dem das Repository erstellt wird, existiert zu diesem Zeitpunkt bereits. Dieses wird initial für alle Cloud-Kunden nach der Vertragsunterzeichnung eingerichtet. Danach wird über einen internen Dienst, den BambooSpec-Service, für jede benötigte Stage des Deployments ein Bamboo-Plan angelegt und gestartet. Bei diesem Lauf werden durch die Pläne die jeweils zugehörigen Anwendungen und Namespaces, dies macht dann die „Stage“ aus, im Rancher-Kunden-Projekt angelegt. Wie das Projekt in Bitbucket, existiert auch das Rancher-Projekt zu diesem Zeitpunkt schon.
Damit ist das Deployment fertig eingerichtet. Jeder Push auf den develop-, qa- oder master-branch löst jetzt eine Aktualisierung der passenden Stage aus.

Zusammenfassung: Einrichten des Deployments

Zum Abschluß noch einmal zusammengefasst: wenn Sie als Cloud-Kunde über die Custom App Platform eine Anwendung entwickeln möchten, geben Sie die folgenden Daten über unseren Technical Support (help@e-spirit.com) an uns weiter:

  • Kontakt-E-Mail
  • Liste der Benutzer, die Zugriff auf das Repository benötigen
  • Art der Anwendung
  • Name der Anwendung
  • Globale und stage-spezifische Umgebungsvariablen

Sobald diese Daten bei uns eingegangen sind, werden die nötigen Schritte zur Einrichtung des Deployments eingeleitet. Wir schicken Ihnen danach baldmöglichst den Link zum Repository sowie die URLs für die Stages zu. Damit können Sie sofort mit der Entwicklung starten.

© 2005 - 2021 e-Spirit AG | Alle Rechte vorbehalten. | FirstSpirit 2021-04 | Datenschutz | Impressum | Kontakt