Bereitstellen von Diensten

1. Navigieren: Wechsle zum Tab Managed Services.

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

3. Konfigurieren: Es erscheint ein Konfigurationsdialog. Lege die anfänglichen Parameter fest. Nicht erforderliche Parameter können auf ihren Standardwerten belassen und bei Bedarf später aktualisiert werden. Manche Parameter (wie der Benutzername in diesem PostgreSQL-Beispiel) haben spezielle Anforderungen. Bewege den Mauszeiger über das „Info“-Symbol, um mehr zu erfahren. Klicke auf „Define Secrets“, um fortzufahren.

4. Secrets: Die meisten Dienste erfordern Secrets. Erzeuge sie auf deinem Rechner und gib sie hier ein. Codesphere zeigt diese Secrets nach diesem Schritt nicht erneut an, daher solltest du sie sicher aufbewahren. Gehen sie verloren, müssen die Secrets zurückgesetzt werden, was zu einer Ausfallzeit des Dienstes 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 Dienst von Creating zu Synchronized wechselt. Nutze das Ereignisprotokoll, um weitere Details zum Bereitstellungsprozess zu erhalten. Sollte es während der Bereitstellung Probleme geben, liefert das Ereignisprotokoll Hinweise darauf, 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 Dienst erstellt wird.
• name (string, erforderlich): Ein eindeutiger Name für den Dienst.
• provider (object, erforderlich):
  • name: Der Name des Service-Providers (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 der geheimen Zugangsdaten des Dienstes.
• backups (object): Konfiguration automatisierter Backups. Für Provider, die dies unterstützen. Details siehe Managed Service Backups.
• recoverFrom (object): Automatisches Initialisieren der Instanz über ein Backup-Point-in-Time-Objekt oder ein bestimmtes Backup. Erfordert die backups-Konfiguration und Secrets. Siehe Managed Service Backups.

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

1. Finden: Suche den bereitgestellten Dienst, der aktualisiert werden soll.
2. Einstellungen öffnen: Klicke auf das Zahnrad-Symbol rechts in der Tabellenzeile, um die Detailansicht des Dienstes zu öffnen.
3. Ändern: Wechsle zum Tab Configuration und klicke auf „Edit Configuration“. Dadurch werden konfigurierbare Parameter bearbeitbar. Beachte, dass nicht jede Option, die beim Erstellungsvorgang verfügbar war, auch für Updates verfügbar ist. Muss ein nicht bearbeitbarer Parameter geändert werden, muss der Dienst gelöscht und mit der gewünschten Konfiguration neu erstellt werden.
4. Anwenden: Klicke auf Save, um die Änderungen zu übernehmen. Der Dienststatus wechselt 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 Ereignisprotokoll.

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, Pfadparameter): Die UUID des zu aktualisierenden Managed Service.
• config (object, optional): Konfigurationsaktualisierungen.
• plan (object, optional):
  • id: Die neue Plan-ID.
  • parameters: Aktualisierte Plan-Parameter (z. B. Speicherplatz).
• secrets (object, optional): Aktualisierte Secrets.
• backups (object, optional): Konfigurationen für automatisierte Backups.
• name (string, optional): Neuer Name für den Dienst.
• pause (boolean, optional): Auf true setzen, um den Dienst zu pausieren.
• version (string, optional): Der neue Versions-Tag (z. B. 1.2.0). Weitere Details siehe Abschnitt Upgrade auf eine neue Version.

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

Derzeit wird das Pausieren von Managed Services nur über die öffentliche API unterstützt. Anleitungen finden sich im API-Tab.

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

Dienst 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
  }'

Dienst 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 mit der Diensttabelle.
2. Löschen: Suche die Schaltfläche „Delete“ im Drei-Punkte-Menü.
3. Bestätigen: Zur Bestätigung der Aktion muss der Name des Dienstes 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, Pfadparameter): Die UUID des zu löschenden Managed Service.

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