GitOps-Konfigurationen verwalten

Erstellen Sie eine Konfiguration, um Apps aus Ihrem Repository unter GitHub oder GitLab in Ihren Clustern bereitzustellen.

Satellite „Config“ sichert die aktuelle Konfiguration alle 5 Minuten, unabhängig davon, ob der Vorgang erfolgreich war oder nicht. Wenn Änderungen an der Konfiguration im Cluster vorgenommen werden, beispielsweise mithilfe von kubectl edit, passt Satellite Config die Konfiguration so an, dass sie mit den Definitionen im Repository unter GitHub oder GitLab übereinstimmt.

Satellite-Konfigurationen erstellen

Verwenden Sie Satellite Config, um eine Konfiguration zu erstellen, über die Sie angeben, welche Kubernetes-Ressourcen Sie in einer Gruppe von Red Hat OpenShift on IBM Cloud-Clustern bereitstellen möchten, die an Ihrem Satellite-Standort oder in IBM Cloud ausgeführt werden.

Vorbereitende Schritte

Erstellen eines Geheimnisses für die Nutzung eines privaten Repositorys

Um eine Verbindung zu privaten Repositorys herzustellen, müssen Sie ein persönliches Git-Zugriffstoken erstellen und es auf Ihre Cluster anwenden.

  1. Erstellen Sie ein GitHub-oder GitLab-Token.

  2. Kodieren Sie das Token unter base64.

    printf "TOKEN_FROM_GITHUB_OR_GITLAB" | base64

  3. Melden Sie sich für jeden Cluster, den Sie verwenden wollen, beim Cluster an und erstellen Sie einen geheimen Schlüssel namens razee-git im Namensbereich razeedeploy, indem Sie die folgende YAML-Datei anwenden:

    apiVersion: v1
data:
  token: [BASE64_ENCODED_TOKEN_FROM_GITHUB_OR_GITLAB]
kind: Secret
metadata:
  name: razee-git
  namespace: razeedeploy
type: Opaque

    Zwischen den Repositorys „ GitHub “ und „ GitLab “ darf es nur ein Geheimnis geben.

Satellite-Konfigurationen über die Konsole erstellen

Informationen zum Bereitstellen einer Beispiel-App finden Sie unter Kubernetes-Ressourcen in Clustern mit Satellite Config bereitstellen.

Verwenden Sie zum Erstellen Ihrer angepassten Konfiguration die Benutzerschnittstelle von Satellite und führen Sie die folgenden Schritte aus.

  1. Melden Sie sich bei der Satellite Config UI mit Ihren IBM Cloud-Berechtigungsnachweisen an.

  2. Klicken Sie auf Konfiguration erstellen.

  3. Wählen Sie auf der Seite Vorlagen durchsuchen die Vorlage GitOps aus.

  4. Geben Sie auf der Seite Konfiguration Ihren Konfigurationsnamen und Provider an.

    Feld Beschreibung
    Konfigurationsname Geben Sie den Namen der „ Satellite “-Konfiguration ein.
    Anbieter Wählen Sie den Remote-Anbieter für die „ Satellite “-Konfigurationen aus, in dem die Definitionen der „ Kubernetes “-Ressourcen gespeichert sind, die in Ihren Clustern bereitgestellt werden sollen. Die Optionen sind GitHub und GitLab.
  1. Geben Sie auf der Seite „Abonnement“ Ihren Repository- URL, die Sichtbarkeit des Repositorys, die Details zum Referenz- Git, den Pfad zu Ihrer Datei oder Ihrem Verzeichnis sowie die Clustergruppe an, in der die Bereitstellung erfolgen soll.
    Feld Beschreibung
    Repository URL Geben Sie das Remote-Repository ein, das für dieses „ Satellite “-Abonnement verwendet werden soll.
    Repository-Sichtbarkeit Wählen Sie aus, ob dieses Repository öffentlich oder privat ist.
    Typ der „ Git “-Referenz Wählen Sie den Typ der „ Git “-Referenz aus, die für dieses „ Satellite “-Abonnement verwendet werden soll. Gültige Werte sind Branch, Tag, Commit und Release.
    Name des Branches/Tags/Commits/Releases Geben Sie die Referenz „ Git “ ein, die für dieses „ Satellite “-Abonnement verwendet werden soll.
    Pfad Geben Sie den Pfad zu den Dateien im Remote-Repository ein, die für dieses „ Satellite “-Abonnement verwendet werden sollen.
    Abonnementname Geben Sie einen Namen für Ihr „ Satellite “-Abonnement ein. Der Name branch/tag/commit/release wird standardmäßig automatisch als Subskriptionsname eingetragen.
    Clustergruppe Geben Sie den Namen der Clustergruppe ein, in der Sie Ihre „ Kubernetes “-Ressourcen bereitstellen möchten.
  1. Vergewissern Sie sich auf der Seite Zusammenfassung, dass die angezeigten Informationen korrekt sind, und klicken Sie anschließend auf Abschließen.

Satellite-Konfigurationen über die CLI erstellen

Verwenden Sie das CLI-Plugin für die Befehle „ Satellite “, um eine Konfiguration zu erstellen.

Gehen Sie wie folgt vor, um die Konfiguration zu erstellen:

  1. Richten Sie Ihre Cluster für die Verwendung mit Satellite Config ein. Diese Einrichtung umfasst die Erstellung einer Clustergruppe und die Gewährung des Zugriffs auf „ Satellite-Konfiguration“ für Ihre Cluster.

  2. Erstellen Sie eine „ Satellite “-Konfiguration.

    ibmcloud sat config create --name CONFIG_NAME [--provider <provider>] [-q]
    Erläuterungen zu den Komponenten dieses Befehls
    Komponente Beschreibung
    --name <config_name> Geben Sie den Namen der Satellite-Konfiguration ein.
    --provider <provider> Geben Sie den fernen Anbieter für die Konfigurationen von Satellite ein, in denen die Definitionen von Kubernetes-Ressourcen gespeichert werden, die in Ihren Clustern bereitgestellt werden sollen. Gültige Werte sind github und gitlab.
    -q Keine Tagesnachricht oder Aktualisierungserinnerung anzeigen.

    Beispielausgabe

    Creating configuration...
OK
Configuration <config_name> was successfully created with ID 116fffde-0835-467c-8987-67dd42e4e393.

  3. Erstellen Sie eine Subskription für Ihre Clustergruppe für die Konfiguration Satellite.

    ibmcloud sat subscription create --name <subscription_name> --group <cluster_group_name> --config <config_name_or_ID> --repository <repository_value> --gitref-type <type_value> --gitref <gitref_value> --path <path_value> [-q]
    Erläuterungen zu den Komponenten dieses Befehls
    Komponente Beschreibung
    --name <subscription_name> Geben Sie einen Namen für Ihr Satellite-Abonnement ein.
    --group <cluster_group_name> Geben Sie den Namen der Clustergruppe ein, in der Ihre Kubernetes-Ressourcen bereitgestellt werden sollen.
    --config <config_name_or_ID> Geben Sie den Namen oder die ID der Satellite-Konfiguration ein, die Sie zuvor erstellt haben.
    --repository <repository_value> Geben Sie das ferne Repository für dieses Satellite-Abonnement ein.
    --gitref-type <type_value> Geben Sie den Typ der Git-Referenz ein, die für dieses Satellite-Abonnement verwendet wird. Gültige Werte sind branch, commit, tag und release.
    --gitref <gitref_value> Geben Sie die Git-Referenz ein, die für dieses Satellite-Abonnement verwendet wird.
    --path <path_value> Geben Sie den Pfad zu den Dateien im fernen Repository ein, die für dieses Satellite-Abonnement verwendet werden sollen.
    -q Keine Tagesnachricht oder Aktualisierungserinnerung anzeigen.

    Beispielausgabe

    Creating subscription...
OK
Subscription <subscription_name> was successfully created with ID f6114bd5-f71e-4335-b034-ca45fa3cab81.

  4. Führen Sie Schritt 5 aus dem Abschnitt Satellite-Konfigurationen über die Konsole erstellen aus, um den Rollout-Status Ihrer Kubernetes-Ressourcen zu überprüfen.

Satellite-Konfiguration aktualisieren

Zum Aktualisieren Ihrer Konfiguration können Sie Aktualisierungen auf Subskriptionsebene vornehmen. Welche Aktionen Sie ausführen müssen, hängt davon ab, welche Art von Aktualisierungen Sie vornehmen möchten.

  • Um eine neue Version Ihrer Anwendung in derselben Clustergruppe bereitzustellen, aktualisieren Sie die Dateien im GitHub-oder GitLab-Repository, das in Ihrer Konfiguration definiert ist, und schreiben Sie die Änderungen fest.
  • Wenn Sie Eigenschaften Ihres Quellenrepositorys ändern möchten, können Sie die Subskription bearbeiten und die Felder mit neuen Details aktualisieren.
  • Um mehrere Repositorys derselben Konfiguration zuzuordnen, ein neues Quellenrepository hinzuzufügen oder neue Git-Referenzdetails für dasselbe Quellenrepository hinzuzufügen, können Sie neue Subskriptionen erstellen. Klicken Sie auf Abonnement erstellen und füllen Sie die Details für Ihr neues Abonnement aus. Wenn Sie eine neue Subskription erstellen möchten, für die nur wenige Details geändert wurden, können Sie die Option Duplizieren verwenden, um alle Felder automatisch mit den Eigenschaften der vorhandenen Subskription auszufüllen und die Felder zu ändern, die Sie ändern möchten.
  • Verwenden Sie zum Löschen einer Subskription die Option Entfernen.

Aktualisierung Ihres Abonnements über die Konsole

Verwenden Sie die „ Satellite “-Konsole, um Ihre Konfiguration zu aktualisieren.

  1. Melden Sie sich bei der Satellite Config UI mit Ihren IBM Cloud-Berechtigungsnachweisen an.

  2. Wählen Sie die Konfiguration aus, die Sie aktualisieren möchten.

  3. Klicken Sie auf das Überlaufmenü in der Zeile der zu aktualisierenden Subskription und wählen Sie Bearbeiten aus.

  4. Nehmen Sie auf der Seite Subskription bearbeiten die Änderungen vor und klicken auf Speichern.

Konfiguration von Satellite über die Befehlszeilenschnittstelle aktualisieren

Verwenden Sie das CLI-Plugin für die Befehle „ Satellite “, um Ihre Konfiguration zu aktualisieren. Wenn Sie Ihre Konfiguration aktualisieren möchten, um eine neue Datei zu verwenden, können Sie Ihr Abonnement so aktualisieren, dass es auf die neue Datei verweist.

  1. Aktualisieren Sie die Subskription für Ihre Clustergruppe, sodass sie die neue Konfiguration Satellite im fernen Repository verwendet. Sie müssen nur die Parameter angeben, die Sie ändern möchten.

    ibmcloud sat subscription update --subscription <subscription_name> [--name <new_subscription_name>] [--group <cluster_group_name>] [--repository <repository_value>] [--gitref-type <type_value>] [--gitref <gitref_value>] [--path <path_value>] [-f] [-q]
    Erläuterungen zu den Komponenten dieses Befehls
    Komponente Beschreibung
    --subscription <subscription_value> Geben Sie den Namen oder die ID des Abonnements ein, das aktualisiert werden soll.
    --name <new_subscription_name> Geben Sie den neuen Namen des Abonnements ein.
    --group <cluster_group_name> Geben Sie den Namen der Clustergruppe ein, in der Ihre Kubernetes-Ressourcen bereitgestellt werden sollen.
    --repository <repository_value> Geben Sie das ferne Repository für dieses Satellite-Abonnement ein.
    --gitref-type <type_value> Geben Sie den Typ der Git-Referenz ein, die für dieses Satellite-Abonnement verwendet wird. Gültige Werte sind branch, commit, tag und release.
    --gitref <gitref_value> Geben Sie die Git-Referenz ein, die für dieses Satellite-Abonnement verwendet wird.
    --path <path_value> Geben Sie den Pfad zu den Dateien im fernen Repository ein, die für dieses Satellite-Abonnement verwendet werden sollen.
    -f Erzwingt die Ausführung des Befehls ohne Eingabeaufforderungen.
    -q Keine Tagesnachricht oder Aktualisierungserinnerung anzeigen.

    Beispielausgabe

    Are you sure you want to update the subscription <subscription_name>? [y/N]y
OK
Subscription f6114bd5-f71e-4335-b034-ca45fa3cab81 was successfully updated.

  2. Führen Sie Schritt 5 aus dem Abschnitt Satellite-Konfigurationen über die Konsole erstellen aus, um den Rollout-Status Ihrer Kubernetes-Ressourcen zu überprüfen.