Mit Services verbinden

Beta

Dieses Feature befindet sich derzeit in der Beta-Phase.

Deploio-Applikationen können sich mit On-Demand Services wie Datenbanken und Key-Value-Stores verbinden, indem sie Service-Referenzen in der Applikation definieren. Nine injiziert die Verbindungsdaten automatisch als Umgebungsvariablen in die Applikation zur Laufzeit.

Dabei erstellt und verwaltet Nine automatisch eine verschlüsselte ServiceConnection im Projekt des Ziel-Services. Eine manuelle Netzwerkkonfiguration ist nicht erforderlich.

Unterstützte Services

Folgende Service-Typen können von einer Deploio-Applikation referenziert werden:

• Key-Value-Store
• MySQL
• PostgreSQL
• OpenSearch

Service-Referenz hinzufügen

Jede Service-Referenz erfordert ein Ziel (den gewünschten Service).

Cockpit

1. Öffne die Applikation und wechsle zum Tab Verbundene Services.
2. Klicke auf Service verbinden.
3. Wähle einen existierenden Service aus einem beliebigen Projekt oder erstelle einen neuen. Neue Services werden nach dem Erstellen automatisch verbunden.

Der Service-Name wird als Referenzname verwendet. Um eine Referenz zu entfernen, klicke auf Trennen.

nctl

Verwende beim Erstellen einer neuen Applikation --service im Format name=kind/target-name:

nctl create application my-app \
  --git-url=https://github.com/example/app.git \
  --service cache=keyvaluestore/my-kvs

Um einen Service zu einer bestehenden Applikation hinzuzufügen:

nctl update application my-app \
  --service cache=keyvaluestore/my-kvs

Um eine Service-Referenz zu entfernen:

nctl update application my-app \
  --delete-service cache

Injizierte Umgebungsvariablen

Wenn Service-Referenzen konfiguriert sind, injiziert Nine die Verbindungsdaten als Umgebungsvariablen in jede Instanz der Applikation. Die Variablennamen folgen dem Format NINE_<IDENTIFIER>_<NAME>_<KEY>:

• <IDENTIFIER> ist ein Kürzel für den Service-Typ, zum Beispiel KVS, PG oder MYSQL. Die Tabellen unten zeigen den jeweiligen Identifier für ihren Service-Typ.
• <NAME> ist der Referenzname (der name in --service <name>=... oder der Service-Name in Cockpit), in Grossbuchstaben und mit nicht-alphanumerischen Zeichen ersetzt durch _. cache wird zum Beispiel zu CACHE.
• <KEY> bezeichnet das Verbindungsdetail, zum Beispiel FQDN, PORT oder PASSWORD.

Die Variablennamen verwenden den von dir gewählten Referenznamen, nicht den Namen der Ziel-Serviceressource. --service cache=keyvaluestore/my-kvs erzeugt zum Beispiel Variablen wie NINE_KVS_CACHE_FQDN — mit cache, nicht mit my-kvs.

Ein neues Release ist erforderlich

Das Hinzufügen oder Ändern einer Service-Referenz aktualisiert eine laufende Instanz nicht automatisch. Nine injiziert die Variablen nur, wenn ein neues Release erstellt wird. Wenn deine Änderung nicht ohnehin ein neues Release erzeugt, löse eines mit Nochmals releasen in Cockpit oder mit nctl aus:

nctl update app my-app --retry-release

Dadurch wird die Applikation erneut deployt: Deploio erstellt neue Instanzen mit der aktualisierten Umgebung und ersetzt die derzeit aktiven Instanzen. Rechne mit einem Deployment-Zyklus und plane die Änderung entsprechend.

Die verfügbaren Variablen hängen vom Service-Typ ab:

Key-Value-Store

Variable	Beschreibung
NINE_KVS_<NAME>_FQDN	Hostname. Verwendet privates Networking-DNS, wenn privates Networking konfiguriert ist; andernfalls den öffentlichen Hostname.
NINE_KVS_<NAME>_PORT	Port (immer 6379).
NINE_KVS_<NAME>_USER	Benutzername.
NINE_KVS_<NAME>_PASSWORD	Passwort.
NINE_KVS_<NAME>_CA_CERT	CA-Zertifikat. Wird nur injiziert, wenn ein CA-Zertifikat vorhanden ist.
NINE_KVS_<NAME>_DSN	Redis-Verbindungs-URI mit TLS (rediss://user:pass@host:port).

PostgreSQL — Business

Variable	Beschreibung
NINE_PG_<NAME>_FQDN	Hostname. Verwendet privates Networking-DNS, wenn privates Networking konfiguriert ist; andernfalls den öffentlichen Hostname.
NINE_PG_<NAME>_PORT	Port (immer 5432).
NINE_PG_<NAME>_USER	Benutzername.
NINE_PG_<NAME>_PASSWORD	Passwort.
NINE_PG_<NAME>_CA_CERT	CA-Zertifikat. Wird nur injiziert, wenn ein CA-Zertifikat vorhanden ist.
NINE_PG_<NAME>_DSN	PostgreSQL-Verbindungs-URI (postgresql://user:pass@host:port?sslmode=require).

PostgreSQL — Economy

Variable	Beschreibung
NINE_PGDB_<NAME>_FQDN	Hostname. Verwendet privates Networking-DNS, wenn privates Networking konfiguriert ist; andernfalls den öffentlichen Hostname.
NINE_PGDB_<NAME>_PORT	Port (immer 5432).
NINE_PGDB_<NAME>_USER	Datenbankname (entspricht dem bei der Erstellung vergebenen Namen).
NINE_PGDB_<NAME>_PASSWORD	Passwort.
NINE_PGDB_<NAME>_CA_CERT	CA-Zertifikat. Wird nur injiziert, wenn ein CA-Zertifikat vorhanden ist.
NINE_PGDB_<NAME>_DSN	PostgreSQL-Verbindungs-URI (postgresql://user:pass@host:port/dbname?sslmode=require).

MySQL — Business

Variable	Beschreibung
NINE_MYSQL_<NAME>_FQDN	Hostname. Verwendet privates Networking-DNS, wenn privates Networking konfiguriert ist; andernfalls den öffentlichen Hostname.
NINE_MYSQL_<NAME>_PORT	Port (immer 3306).
NINE_MYSQL_<NAME>_USER	Benutzername.
NINE_MYSQL_<NAME>_PASSWORD	Passwort.
NINE_MYSQL_<NAME>_CA_CERT	CA-Zertifikat. Wird nur injiziert, wenn ein CA-Zertifikat vorhanden ist.
NINE_MYSQL_<NAME>_DSN	MySQL-Verbindungs-URI (mysql://user:pass@host:port?ssl-mode=REQUIRED).

MySQL — Economy

Variable	Beschreibung
NINE_MYSQLDB_<NAME>_FQDN	Hostname. Verwendet privates Networking-DNS, wenn privates Networking konfiguriert ist; andernfalls den öffentlichen Hostname.
NINE_MYSQLDB_<NAME>_PORT	Port (immer 3306).
NINE_MYSQLDB_<NAME>_USER	Benutzername (entspricht dem bei der Erstellung vergebenen Datenbanknamen).
NINE_MYSQLDB_<NAME>_PASSWORD	Passwort.
NINE_MYSQLDB_<NAME>_CA_CERT	CA-Zertifikat. Wird nur injiziert, wenn ein CA-Zertifikat vorhanden ist.
NINE_MYSQLDB_<NAME>_DSN	MySQL-Verbindungs-URI (mysql://user:pass@host:port/dbname?ssl-mode=REQUIRED).

OpenSearch

Variable	Beschreibung
NINE_OS_<NAME>_FQDN	Hostname. Verwendet privates Networking-DNS, wenn privates Networking konfiguriert ist; andernfalls den öffentlichen Hostname.
NINE_OS_<NAME>_PORT	Port (immer 9200).
NINE_OS_<NAME>_USER	Benutzername.
NINE_OS_<NAME>_PASSWORD	Passwort.
NINE_OS_<NAME>_CA_CERT	CA-Zertifikat. Wird nur injiziert, wenn ein CA-Zertifikat vorhanden ist.
NINE_OS_<NAME>_DSN	HTTPS-URL mit eingebetteten Zugangsdaten (https://user:pass@host:port).

Injizierte Variablen überprüfen

Cockpit

Öffne den Tab Variablen der Applikation. Injizierte Variablen werden mit der Ebene Service aufgeführt.

Falls sie fehlen, prüfe, ob nach dem Hinzufügen der Service-Referenz ein neues Release erstellt wurde.

nctl

Überprüfe die injizierten Variablen auf zwei Arten:

• In der Release-Ressource (nicht der Applikations-Ressource). Releases haben generierte Namen, liste sie also zuerst auf und untersuche dann das neueste. Das Feld serviceEnvVars listet die Namen der injizierten Variablen auf (die Werte liegen in einem referenzierten Secret und werden hier nicht angezeigt):

  nctl get releases -p my-project
  nctl get releases <release-name> -p my-project -o yaml

• In einer laufenden Instanz, indem du deren Umgebung auflistest. Das zeigt sowohl die Namen als auch die Werte:

  nctl exec app my-app -p my-project -- env

Wenn die Variablen fehlen, prüfe, ob nach dem Hinzufügen der Service-Referenz ein neues Release erstellt wurde.