Code-Einführung

Das Code-Deployment-Tool wird zur Bereitstellung des Quellcodes von Anwendungen auf IBM® Code Engine verwendet, was den Bereitstellungsprozess vereinfacht und den manuellen Aufwand reduziert.

Das Code-Deployment-Tool bietet einen rationalisierten und automatisierten Deployment-Prozess. Es unterstützt zwei Arten von Bereitstellungen, IBM -managed und user-managed, und bietet Funktionen wie das Abrufen des Status des Bereitstellungsprozesses, das Abrufen von Protokollen der bereitgestellten Anwendung und das Löschen der angegebenen Anwendung.

Unterstützte Dienste und Bereitstellungsarten

IBM -verwaltete Bereitstellung
Stellt den Anwendungscode in einer von IBM verwalteten Code Engine Umgebung bereit, die eine temporäre und selbstreinigende Einrichtung bietet. Zu den wichtigsten Merkmalen gehören die folgenden:
Vorübergehende Ressourcen
Die Anwendung und die zugehörigen Ressourcen werden nach einem bestimmten Zeitraum automatisch aufgeräumt, wobei die Entwickler-Persona im Mittelpunkt steht.
Testen
Die Entwickler-Persona-Benutzer erhalten den Endpunkt der Anwendung URL und den Namen der Anwendung zum bequemen Testen.
API Connect SaaS exklusiv
Diese Funktion wurde für API Connect SaaS, entwickelt, um die Bereitstellungs- und Testprozesse zu optimieren.
Benutzer-verwaltete Bereitstellung
Einfache Bereitstellung von Anwendungscode, der die Agentenschnittstelle verwendet, für einen benutzerdefinierten Dienst IBM Code Engine, der Flexibilität und Kontrolle bietet. Zu den wichtigsten Merkmalen gehören die folgenden:
Benutzergesteuerte Ressourcen
Sie behalten die volle Kontrolle über den Lebenszyklus und die Konfiguration der bereitgestellten Ressourcen.
Bereitstellungsdetails
Das Tool stellt den Endpunkt der Anwendung URL und den Anwendungsnamen nach erfolgreicher Bereitstellung bereit.

Funktionen

Bereitstellung von Anwendungscode
Bereitstellen eines .zip Datei, die Anwendungscode für eine IBM oder vom Benutzer verwaltete Code Engine Umgebung enthält.
  • Die Bereitstellung von Anwendungscode ist ein asynchroner Vorgang.
  • Fragen Sie den Einsatzstatus separat ab, um die Ergebnisse zu erhalten.
Hinweis:
  • Nur .zip Dateien werden für die Bereitstellung unterstützt. Andere Formate werden nicht akzeptiert.
  • Die Dateigröße muss weniger als 1 MB betragen.
  • Informationen zu grundlegenden Validierungsprüfungen vor der Bereitstellung finden Sie unter Prüfungen vor der Bereitstellung für IBM -verwaltete Code Engine.
  • Das Tool bestimmt die Ressourcenzuweisung für die eingesetzte Anwendung wie folgt:
    • 0.125 CPU
    • 0.5 GB Speicher
Bereitstellungsstatus prüfen
Abrufen des Status einer Bereitstellung auf der Grundlage des vom Benutzer angegebenen Dateinamens .zip .
  • Nach Abschluss der Bereitstellung zeigt das Tool den Bereitstellungsstatus sowie den Anwendungsnamen und den Endpunkt URL an.
  • Weitere Informationen zu den Verteilungsstatus finden Sie unter Verteilungsstatus.
Abrufen von Protokollen der Anwendung
Rufen Sie die Protokolle der Anwendung ab, die in Code Engine bereitgestellt wird.
  • Die abgerufenen Protokolle werden in eine .log Datei gepackt und zum Herunterladen und Debuggen bereitgestellt.
Anwendung löschen
Löschen Sie die Anwendung und ihre zugehörigen Ressourcen.

Prüfungen vor dem Einsatz für IBM -verwaltet Code Engine

IBM -die Managed Code Engine führt die Prüfungen durch, die vor der Bereitstellung der Anwendung und der zugehörigen Ressourcen durchgeführt werden.
Von IBM verwaltet
Für IBM -verwaltete Umgebungen müssen alle folgenden Bedingungen erfüllt sein, bevor eine Bereitstellung eingeleitet wird.
Tabelle 1. Anforderungen
Prüfen Anforderungen
Projektgrenze
  • Wenn das Projekt für die Anbieterorganisation auf IBM vorhanden ist Code Engine, verwendet das Codeverteilungs-Tool das vorhandene Projekt.
  • Wenn das Projekt für die Anbieterorganisation nicht vorhanden ist, erstellt das Codeverteilungs-Tool ein neues Projekt unter IBM Code Engine, wenn die Anzahl der verfügbaren Projekte weniger als 20 beträgt.
Projektstatus Das Projekt darf sich nicht in der Erstellungsphase befinden.
Bestehende Anwendung Das System verhindert, dass ein anderer Benutzer eine Anwendung mit demselben Quellcode bereitstellt .zip
Mehrere Anwendungen Pro Projekt ist nur ein Antrag zulässig.
Geheimer Registry-Schlüssel Ein Registrierungsgeheimnis mit demselben Namen darf nicht existieren.

Benennungskonventionen für die Bereitstellung von Ressourcen

Um Konsistenz und Nachvollziehbarkeit zu gewährleisten, folgt das Code Deployment Tool bei der Erstellung von Ressourcen standardisierten Benennungsmustern.
IBM Code Engine
Verwenden Sie die folgenden Namenskonventionen, wenn Sie Bereitstellungsressourcen in den Diensten IBM Code Engine erstellen:

Die folgende Tabelle zeigt, wie Ressourcen für eine Anwendung mit dem Codedateinamen app-code erstellt werden, die vom Benutzer 123 unter der Anbieterorganisation abc bereitgestellt wird.

Tabelle 2. Namenskonventionen
Ressourcentyp Format Namenskonvention
Projekt aa-<provider_organization>-project
Hinweis: Projekte in IBM Code Engine sind auf die Anbieterorganisation in API Connect beschränkt.
aa-abc-project
Geheimer Registry-Schlüssel <project_name>-registry-secret aa-abc-project-registry-secret
Image-Build <project_name>-<application_code_file_name>-<user_id>-<resource_name> aa-abc-project-app-code-123-image-build
Image Builds laufen <project_name>-<application_code_file_name>-<user_id>-<resource_name> aa-abc-project-app-code-123-image-build-run
ConfigMap <project_name>-<application_code_file_name>-<user_id>-<resource_name> aa-abc-project-app-code-123-cm
Secret <project_name>-<application_code_file_name>-<user_id>-<resource_name> aa-abc-project-app-code-123-secret
Anwendung <project_name>-<application_code_file_name>-<user_id>-<resource_name> aa-abc-project-app-code-123-app

Bereitstellungsstatus

Wenn Sie den Verteilungsstatusvorgang starten, werden vom Codeverteilungswerkzeug verschiedene Status zurückgegeben, um den Fortschritt oder das Ergebnis der Verteilung zu ermitteln.
IBM Code Engine einsatzstatus
Die folgenden Status repräsentieren die Stadien des Einsatzes innerhalb von IBM Code Engine :
Tabelle 3. Status
Phase Beschreibung Status
Projekterstellung Projekt und geheime Einrichtung PENDING, IN_PROGRESS, COMPLETED, FAILED
Imagebildung Bilderstellung und Push PENDING, IN_PROGRESS, COMPLETED, FAILED
Anwendungsimplementierung Erstellung von Anwendungen, Configmaps und Geheimnissen PENDING, IN_PROGRESS, COMPLETED, FAILED
Hinweis:
  • Alle drei Phasen werden angezeigt, um zu verdeutlichen, welche Phasen abgeschlossen sind, welche in Bearbeitung sind und welche noch ausstehen.
  • Wenn ein Teil des Prozesses fehlschlägt, zeigt die fehlgeschlagene Stufe den Status FAILED und einen Grund für den Fehler an.
  • Wenn alle Phasen den Status ABGESCHLOSSEN anzeigen, gibt das Tool die Anwendung URL und den Anwendungsnamen an.
  • Stellen Sie sicher, dass das Quelldokument OpenAPI, aus dem die bereitgestellte Anwendung generiert wurde, jetzt aktualisiert wird, um die IBM Code Engine Anwendung URL als Wert der servers[0].url zu verwenden. Dies ist unerlässlich, wenn als nächster Schritt ein API-Entwurf erstellt und mithilfe des Tools „ API Connect “ auf API Connect veröffentlicht werden soll.