StyleBook-Konfiguration

Importieren und Synchronisieren von StyleBooks aus GitHub-Repository

Stellen Sie sich ein Szenario vor, in dem Sie CI/CD-Prozesse für Ihre Entwicklung verwenden. Oder ein Szenario, in dem Sie den gesamten Quellcode und die Bereitstellungsartefakte der Anwendung in GitHub verwalten.

Im GitHub-Repository verwalten Sie möglicherweise mehrere StyleBooks für die Bereitstellung der Citrix ADC-Konfigurationen und die Verwaltung dieser StyleBooks. Sie müssen diese StyleBooks auf Citrix ADM hochladen. Mit dieser Funktion können Sie Ihre in GitHub vorhandenen StyleBooks direkt in Citrix ADM importieren. Sie müssen sie nicht manuell von GitHub kopieren und dann in Citrix ADM hochladen. Oder synchronisieren Sie die Dateien manuell in Citrix ADM und GitHub. Außerdem können Sie Konfigurationspakete von GitHub importieren und synchronisieren.

Um StyleBooks und Konfigurationspakete zu importieren, definieren Sie in Citrix ADM ein Repository, das ein GitHub-Repository darstellt. Geben Sie die GitHub-Repository-URL sowie Ihren in GitHub erstellten Benutzernamen und API-Token an. Das bedeutet, dass nur autorisierte Benutzer, die ein gültiges Konto in GitHub haben, StyleBooks importieren und synchronisieren können.

Nachdem Sie das Repository erstellt haben, können Sie Citrix ADM mit Ihrem GitHub-Repository synchronisieren. Citrix ADM stellt eine Verbindung zu GitHub her und importiert StyleBooks und Configuration Packs, die in diesem Repository gefunden wurden. Citrix ADM validiert dann die StyleBooks und fügt sie der Liste der StyleBooks in Citrix ADM hinzu. StyleBooks werden Citrix ADM nicht hinzugefügt, wenn die Validierung fehlschlägt. Sie können die Fehler in Ihren StyleBooks identifizieren und korrigieren. Übertragen Sie dann die aktualisierten Versionen in Ihr GitHub-Repository. Später können Sie versuchen, sie zu importieren oder erneut mit Citrix ADM zu synchronisieren.

Wichtig

  • StyleBooks-Dateien können aus jedem Zweig eines GitHub-Repositorys importiert und synchronisiert werden.

  • Sie können StyleBooks importieren und synchronisieren, denen auch abhängige StyleBooks zugeordnet sind. Diese abhängigen StyleBooks können sich im Github-Repository befinden oder bereits in Citrix ADM vorhanden sein.

  • Die Synchronisation von StyleBooks aus einem GitHub-Repository muss manuell über die Citrix ADM GUI oder API initiiert werden. Das heißt, das Importieren und Synchronisieren von StyleBooks erfolgt derzeit nicht automatisch basierend auf Ihrer GitHub-Commit-Aktivität.

  • Die Konfigurationspaketdatei, die Sie importieren möchten, muss im JSON-Format vorliegen. Außerdem muss der Inhalt der Konfigurationsdatei dem exportierten Konfigurationsformat entsprechen. Unter Ihrem GitHub-Repository müssen die mit dem Konfigurationspaket verknüpften Dateien im Ordner configpacks sein.

Sie können StyleBook-Dateien aus jedem Ordner im GitHub-Repository in Citrix ADM importieren. Gehen Sie wie folgt vor, um Konfigurationspakete zu importieren:

  1. Erstellen Sie einen Ordner mit Namen configpacks unter dem Stammverzeichnis. Stellen Sie sicher, dass sich alle mit Konfigurationen verknüpften Dateien in diesem Ordner befinden.

  2. Erstellen Sie im Ordner configpacks eine JSON-Datei, die die Payload für das Konfigurationspaket enthält. Diese Payload wird verwendet, um Konfigurationspakete zu synchronisieren. Das Folgende ist ein Beispiel für eine Nutzlast:

    {
        "config_key": "unique-key-for-configpack",
    
        "parameters": {
            "param-name1": "param-value1",
            "param-name": "param-value2",
            "param-namen": "param-valuen"
        },
        "stylebook": {
            "namespace": "some namespace",
            "name": "somename",
            "version": "spme-version"
        }
    }
    <!--NeedCopy-->
    
    • config_key - Eine eindeutige ID oder ein Name zur Identifizierung eines Konfigurationspakets in Citrix ADM. Wenn Sie config_key nicht angeben, generiert Citrix ADM die ID beim Erstellen des Konfigurationspakets automatisch.

      Wenn die angegebene ID in der Citrix ADM GUI gefunden wird, aktualisiert die Synchronisierungsaktion das Konfigurationspaket in der Citrix ADM GUI. Andernfalls wird ein Konfigurationspaket mit der angegebenen ID erstellt.

    • parameters - Es enthält alle notwendigen Parameter, um das Konfigurationspaket zu erstellen oder zu aktualisieren.

    • stylebook - Es ist eine obligatorische Eigenschaft in einer JSON-Datei. Es enthält einen Namespace, eine Version und einen StyleBook-Namen, dem Sie das Konfigurationspaket zuordnen möchten.

  3. Bewahren Sie im Ordner configpacks alle Dateien auf, die dem Konfigurationspaket zugeordnet sind, wie Zertifikate, Signaturdateien und XML-Dateien.

Ein Repository hinzufügen

  1. Gehen Sie in Citrix ADM zu Anwendungen > Konfiguration > Repositories. Klicken Sie auf Hinzufügen.

  2. Geben Sie im Fenster Repository hinzufügen die folgenden Parameter ein:

    • Name - Geben Sie den Namen des Repositorys ein. Dieser Name kann mit dem Repository-Namen in GitHub oder einem anderen Namen identisch sein.

    • Repository-URL - Geben Sie die URL des GitHub-Reposit

      Sie können eine GitHub-Unternehmens-URL angeben. Es hilft Ihnen, StyleBooks und Konfigurationspakete aus GitHub-Unternehmenskonten zu importieren oder zu synchronisieren.

    • Benutzername - Geben Sie den Benutzernamen ein, den Sie für den Zugriff auf das GitHub-Konto oder das Unternehmenskonto verwenden.

    • API-Token - Dieses Token wird verwendet, um auf Ihr GitHub-Repository zuzugreifen. Informationen zum Erstellen von API-Token für Ihr GitHub-Repository finden Sie in der GitHub-Dokumentation zum Erstellen persönlicher Zugriffstoken.

    Fügen Sie ein GitHub-Repository hinzu

  3. Klicken Sie auf Erstellen.

    Das Repository wird in Citrix ADM erstellt.

Repositorys

Im Folgenden sind die zusätzlichen Optionen für Ihre Repositorys aufgeführt:

  • Bearbeiten — Sie können die Repository-URL, den Benutzernamen und das API-Token bearbeiten.

  • Löschen - Sie können das Repository zusammen mit allen in Citrix ADM vorhandenen StyleBooks löschen, die zuvor aus diesem GitHub-Repository importiert wurden.

    Hinweis:

    Sie können ein Repository nicht aus Citrix ADM löschen, wenn es über StyleBooks verfügt, denen Konfigurationspakete zugeordnet sind. Löschen Sie zunächst alle Konfigurationspakete dieser StyleBooks. Sie können das Repository später aus Citrix ADM entfernen, um die StyleBooks aus diesem Repository zu bereinigen.

  • Zurücksetzen - Sie können alle StyleBooks in Citrix ADM entfernen, die aus diesem Repository synchronisiert wurden, ohne den Repository-Eintrag tatsächlich zu löschen.

  • Listendateien - Sie können eine Liste aller StyleBooks sehen, die in Citrix ADM vorhanden sind und aus dem GitHub-Repository stammen.

Liste der GitHub-Repositorys

Schritte zum Importieren von StyleBooks und Konfigurationspaketen von GitHub

Nachdem Sie die Voraussetzungen erfüllt haben, führen Sie die Schritte aus, um StyleBooks und Konfigurationspakete aus einem GitHub-Repository zu importieren:

  1. Fügen Sie optional ein Repository hinzu, wenn Sie es noch nicht hinzugefügt haben.
  2. Wählen Sie das Repository auf der Seite Repositories aus.
  3. Klicke auf Synchronisieren.
Importieren und Synchronisieren von StyleBooks aus GitHub-Repository