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 NetScaler-Konfigurationen und die Verwaltung dieser StyleBooks. Sie müssen diese StyleBooks auf NetScaler Console hochladen. Mit dieser Funktion können Sie Ihre in GitHub vorhandenen StyleBooks direkt in die NetScaler Console importieren. Sie müssen sie nicht manuell von GitHub kopieren und dann in NetScaler Console hochladen. Oder synchronisieren Sie die Dateien manuell in NetScaler Console und GitHub. Sie können auch Konfigurationspakete von GitHub importieren und synchronisieren.

Um StyleBooks und Config Packs zu importieren, definieren Sie in NetScaler Console 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 NetScaler Console mit Ihrem GitHub-Repository synchronisieren. NetScaler Console stellt eine Verbindung zu GitHub her und importiert StyleBooks und Konfigurationspakete, die in diesem Repository gefunden wurden. NetScaler Console validiert dann die StyleBooks und fügt sie der Liste der StyleBooks in der NetScaler Console hinzu. StyleBooks werden der NetScaler Console 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 NetScaler Console 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 der NetScaler Console vorhanden sein.

  • Die Synchronisation von StyleBooks aus einem GitHub-Repository muss manuell über die NetScaler Console-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 NetScaler Console 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 Nutzlast für das Konfigurationspaket enthält. Diese Nutzlast 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 NetScaler Console. Wenn Sie config_key nicht angeben, generiert NetScaler Console die ID beim Erstellen des Konfigurationspakets automatisch.

      Wenn die angegebene ID in der NetScaler Console-GUI gefunden wird, aktualisiert die Synchronisierungsaktion das Konfigurationspaket in der NetScaler Console-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 der NetScaler Console zu Anwendungen > Konfiguration > Repositorys . 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 von 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.

    GitHub-Repository hinzufügen

  3. Klicken Sie auf Erstellen.

    Das Repository wird in NetScaler Console 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 der NetScaler Console vorhandenen StyleBooks löschen, die zuvor aus diesem GitHub-Repository importiert wurden.

    Hinweis:

    Sie können ein Repository nicht aus der NetScaler Console löschen, wenn es StyleBooks enthält, denen Konfigurationspakete zugeordnet sind. Löschen Sie zunächst alle Konfigurationspakete dieser StyleBooks. Sie können das Repository später aus der NetScaler Console entfernen, um die StyleBooks aus diesem Repository zu bereinigen.

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

  • Dateienauflisten — Sie können eine Liste aller in der NetScaler Console vorhandenen StyleBooks sehen, die aus dem GitHub-Repository stammen.

Schritte zum Importieren von StyleBooks und Konfigurationspaketen von GitHub

Nachdem Sie die Voraussetzungen erfüllt haben, folgen Sie den Schritten, um StyleBooks und Config Packs 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