Services bereitstellen

1. Navigieren: Gehe zum Tab Managed Services.

2. Auswählen: Wähle den gewünschten Service-Anbieter aus dem Katalog. Services sind mit Kategorien gekennzeichnet (z. B. Database, Cache). In diesem Beispiel wählen wir PostgreSQL. Klicke auf „Start Setup“.

3. Konfigurieren: Ein Konfigurationsdialog wird angezeigt. Lege die initialen Parameter fest. Nicht erforderliche Parameter können bei ihren Standardwerten bleiben und später bei Bedarf angepasst werden. Manche Parameter (wie der Benutzername in diesem PostgreSQL-Beispiel) haben spezifische Anforderungen. Bewege den Mauszeiger über das Info-Symbol, um mehr zu erfahren. Klicke auf „Define Secrets“, um fortzufahren.

4. Secrets: Die meisten Services erfordern Secrets. Generiere sie auf deinem Rechner und trage sie hier ein. Codesphere zeigt diese Secrets nach diesem Schritt nicht erneut an, also stelle sicher, dass sie sicher gespeichert werden. Gehen sie verloren, müssen die Secrets zurückgesetzt werden, was zu einer Downtime des Service führt. Klicke auf „Create Service“, um fortzufahren.

5. Bereitstellen: Nach dem Klick auf „Deploy“ beginnt Codesphere mit der Bereitstellung der Ressourcen. Wechsle in der linken Seitenleiste zum Tab Managed Services, um den Fortschritt zu verfolgen. Statusanzeigen aktualisieren sich, während der Service von Creating zu Synchronized übergeht. Verwende das Event-Log, um weitere Details zum Bereitstellungsprozess zu erhalten. Bei Problemen während des Deployments liefert das Event-Log Einblicke, was schiefgelaufen ist und wie es behoben werden kann.

Ein Managed Service kann über den Endpunkt POST /managed-services erstellt werden.

curl -X POST "<your-codesphere-instance-url>/api/managed-services" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "teamId": 123,
    "name": "my-postgres-db",
    "provider": {
      "name": "postgresql",
      "version": "15"
    },
    "plan": {
      "id": 1,
      "parameters": {
        "storage": 10
      }
    },
    "config": {
      "max_connections": "100"
    },
    "secrets": {
      "password": "secure-password",
      "username": "admin"
    },
    "backups": {
      "enabled": true,
      "intervalH": 24,
      "deleteRetentionDays": 7,
      "config": {
        "endpointUrl": "https://s3.eu-central-1.amazonaws.com",
        "destinationPath": "s3://my-codesphere-backups/"
      },
      "secrets": {
        "accessKey": "YOUR_S3_ACCESS_KEY",
        "secretKey": "YOUR_S3_SECRET_KEY"
      }
    }
  }'

Parameter:

• teamId (integer, erforderlich): Die ID des Teams, in dem der Service erstellt wird.
• name (string, erforderlich): Ein eindeutiger Name für den Service.
• provider (object, erforderlich):
  • name: Der Name des Service-Anbieters (z. B. postgresql, redis).
  • version: Der Versions-Tag (z. B. 15).
• plan (object, erforderlich):
  • id: Die Plan-ID.
  • parameters: Plan-spezifische Parameter (z. B. Speichergröße in GB).
• secrets (object): Schlüssel-Wert-Paare mit geheimen Service-Zugangsdaten.
• backups (object): Konfiguration automatisierter Backups. Für Anbieter, die dies unterstützen. Details siehe Managed Service Backups.
• recoverFrom (object): Bootstrapped die Instanz automatisch anhand eines Point-in-Time-Objekts oder eines bestimmten Backups. Erfordert die backups-Konfiguration und die zugehörigen Secrets. Siehe Managed Service Backups.

Vollständige Details zum Schema finden sich in der API-Dokumentation.

1. Auffinden: Suche den bereitgestellten Service, der aktualisiert werden soll.
2. Einstellungen öffnen: Klicke auf das Zahnrad-Symbol rechts in der Tabellenzeile, um die Detailansicht des Service zu öffnen.
3. Bearbeiten: Navigiere zum Tab Configuration und klicke auf „Edit Configuration“. Dadurch werden die konfigurierbaren Parameter bearbeitbar. Beachte, dass nicht jede Option, die im Erstellungs-Workflow verfügbar war, auch für die Aktualisierung verfügbar ist. Muss ein nicht editierbarer Parameter geändert werden, muss der Service gelöscht und mit der gewünschten Konfiguration neu erstellt werden.
4. Anwenden: Klicke auf Save, um die Änderungen anzuwenden. Der Status des Service ändert sich während der Anwendung der Änderungen von Synchronized zu Updating. Nach Abschluss kehrt er zu Synchronized zurück. Weitere Details zum Aktualisierungsprozess finden sich im Event-Log.

Ein Managed Service kann über den Endpunkt PATCH /managed-services/{id} aktualisiert werden.

curl -X PATCH "<your-codesphere-instance-url>/api/managed-services/YOUR_SERVICE_ID" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "config": {
      "max_connections": "200"
    },
    "plan": {
      "id": 2,
      "parameters": {
        "storage": 20
      }
    },
    "secrets": {
      "password": "new-secure-password"
    },
    "backups": {
      "enabled": true,
      "intervalH": 12,
      "deleteRetentionDays": 30,
      "config": {
        "endpointUrl": "https://s3.eu-central-1.amazonaws.com",
        "destinationPath": "s3://my-codesphere-backups/"
      },
      "secrets": {
        "accessKey": "YOUR_S3_ACCESS_KEY",
        "secretKey": "YOUR_S3_SECRET_KEY"
      }
    },
    "version": "1.2.0"
  }'

Parameter:

• id (string, Pfad-Parameter): Die UUID des zu aktualisierenden Managed Service.
• config (object, optional): Konfigurationsänderungen.
• plan (object, optional):
  • id: Die neue Plan-ID.
  • parameters: Aktualisierte Plan-Parameter (z. B. Speicher).
• secrets (object, optional): Aktualisierte Secrets.
• backups (object, optional): Konfiguration automatisierter Backups.
• name (string, optional): Neuer Name für den Service.
• pause (boolean, optional): Auf true setzen, um den Service zu pausieren.
• version (string, optional): Der neue Versions-Tag (z. B. 1.2.0). Weitere Details im Abschnitt Upgrade auf eine neue Version.

Vollständige Details zum Schema finden sich in der API-Dokumentation.

Derzeit wird das Pausieren von Managed Services nur über die öffentliche API unterstützt. Nutze den API-Tab für Anweisungen.

Ein Managed Service kann pausiert werden, indem die Eigenschaft pause über den Endpunkt PATCH /managed-services/{id} auf true gesetzt wird.

Service pausieren:

curl -X PATCH "<your-codesphere-instance-url>/api/managed-services/YOUR_SERVICE_ID" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "pause": true
  }'

Service fortsetzen:

curl -X PATCH "<your-codesphere-instance-url>/api/managed-services/YOUR_SERVICE_ID" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "pause": false
  }'

1. Navigieren: Gehe zur Seite der Service-Tabelle.
2. Löschen: Finde die Schaltfläche „Delete“ im 3-Punkte-Menü.
3. Bestätigen: Zur Bestätigung der Aktion muss der Name des Service eingegeben werden.

Ein Managed Service kann über den Endpunkt DELETE /managed-services/{id} gelöscht werden.

curl -X DELETE "<your-codesphere-api-endpoint>/managed-services/YOUR_SERVICE_ID" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Parameter:

• id (string, Pfad-Parameter): Die UUID des zu löschenden Managed Service.

Vollständige Details zum Schema finden sich in der API-Dokumentation.