StyleBooks aus einem externen Repository importieren und synchronisieren
Betrachten Sie ein Szenario, in dem Sie CI/CD-Prozesse für Ihre Entwicklung verwenden. Oder ein Szenario, in dem Sie den gesamten Anwendungsquellcode und die Bereitstellungsartefakte in GitHub/GitLab verwalten.
In Ihrem GitHub/GitLab-Repository pflegen Sie möglicherweise mehrere StyleBooks für die Bereitstellung der NetScaler-Konfigurationen und die Verwaltung dieser StyleBooks. Sie müssen diese StyleBooks in die NetScaler Console hochladen. Mit dieser Funktion können Sie Ihre in GitHub/GitLab vorhandenen StyleBooks direkt in die NetScaler Console importieren. Sie müssen sie nicht manuell von GitHub/GitLab kopieren und dann in die NetScaler Console hochladen. Oder die Dateien in NetScaler Console und GitHub/GitLab manuell synchronisieren. Außerdem können Sie Konfigurationspakete (Config Packs) aus GitHub/GitLab importieren und synchronisieren.
Um StyleBooks und Konfigurationspakete zu importieren, definieren Sie ein Repository in der NetScaler Console, das ein GitHub/GitLab-Repository darstellt. Geben Sie die GitHub/GitLab-Repository-URL sowie Ihren Benutzernamen und das in GitHub/GitLab erstellte API- oder Personal Access (PA)-Token an. Das bedeutet, dass nur autorisierte Benutzer mit einem gültigen GitHub/GitLab-Konto StyleBooks importieren und synchronisieren können.
Sie können die folgenden Repository-Typen importieren und synchronisieren:
- Öffentlich zugängliche Repositories – Die Repositories, die öffentlich zugänglich sind und über das Internet aufgerufen werden können.
- On-Premise- oder private GitLab/GitHub-Repositories – Die Repositories, die privat gehostet werden und typischerweise nur innerhalb des Intranets eines Unternehmens zugänglich sind. Für diese Repositories müssen Sie während des Registrierungsprozesses einen NetScaler-Agenten auswählen. Der NetScaler-Agent fungiert als Proxy für den Zugriff auf die Repositories innerhalb des Intranets des Unternehmens.
Nachdem Sie das Repository erstellt haben, können Sie die NetScaler Console mit Ihrem GitHub/GitLab-Repository synchronisieren. Die NetScaler Console stellt eine Verbindung zu GitHub/GitLab her und importiert StyleBooks und Konfigurationspakete, die in diesem Repository gefunden werden. Die NetScaler Console validiert dann die StyleBooks und fügt sie der Liste der StyleBooks in der NetScaler Console hinzu. StyleBooks werden nicht zur NetScaler Console hinzugefügt, wenn die Validierung fehlschlägt. Sie können die Fehler in Ihren StyleBooks identifizieren und korrigieren. Committen Sie dann die aktualisierten Versionen in Ihr GitHub/GitLab-Repository. Später können Sie versuchen, sie erneut in die NetScaler Console zu importieren oder zu synchronisieren.
Wenn Sie beim Erstellen eines Repositorys den folgenden Fehler erhalten, weist dies darauf hin, dass die NetScaler Console das SSL-Zertifikat für das Repository aufgrund eines fehlenden oder nicht erkannten Zertifizierungsstellen (CA)-Zertifikats nicht überprüfen kann:
certificate verify failed: unable to get local issuer certificate
<!--NeedCopy-->
Um dieses Problem zu beheben, können Sie das erforderliche CA-Zertifikat manuell zum NetScaler Console-Agenten hinzufügen, der für den Zugriff auf das Repository verwendet wird. Das Hinzufügen des erforderlichen CA-Zertifikats stellt sicher, dass sichere Verbindungen zum externen Repository ordnungsgemäß validiert werden.
Melden Sie sich beim NetScaler Console-Agenten an, der für den Zugriff auf das Repository verwendet wird, und fügen Sie Ihr CA-Zertifikat zum vertrauenswürdigen Zertifikatsbündel /var/mps/ca_certs/cacert.pem hinzu.
Wichtig
StyleBooks-Dateien können von jedem Branch eines GitHub/GitLab-Repositorys importiert und synchronisiert werden.
Sie können auch StyleBooks importieren und synchronisieren, denen abhängige StyleBooks zugeordnet sind. Diese abhängigen StyleBooks können sich im GitHub/GitLab-Repository befinden oder bereits in der NetScaler Console vorhanden sein.
Die Synchronisierung von StyleBooks aus einem GitHub/GitLab-Repository muss manuell über die NetScaler Console GUI oder API initiiert werden. Das heißt, der Import und die Synchronisierung von StyleBooks erfolgen derzeit nicht automatisch basierend auf Ihrer GitHub/GitLab-Commit-Aktivität.
Die Konfigurationspaketdatei, die Sie importieren möchten, muss im JSON-Format vorliegen. Außerdem müssen die Inhalte der Konfigurationsdatei dem exportierten Konfigurationsformat entsprechen. In Ihrem GitHub/GitLab-Repository müssen die mit dem Konfigurationspaket verbundenen Dateien im Ordner
configpacksliegen.
Sie können StyleBook-Dateien aus jedem Ordner im GitHub/GitLab-Repository in die NetScaler Console importieren. Gehen Sie wie folgt vor, um Konfigurationspakete zu importieren:
-
Erstellen Sie einen Ordner mit dem Namen
configpacksim Stammverzeichnis. Stellen Sie sicher, dass sich alle mit Konfigurationen verbundenen Dateien in diesem Ordner befinden. -
Erstellen Sie im Ordner
configpackseine JSON-Datei, die die Nutzlast für das Konfigurationspaket enthält. Diese Nutzlast wird zur Synchronisierung von Konfigurationspaketen verwendet. Das Folgende ist eine Beispielnutzlast:{ "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 der NetScaler Console. Wenn Sieconfig_keynicht angeben, generiert die 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– Enthält alle notwendigen Parameter zum Erstellen oder Aktualisieren des Konfigurationspakets. -
stylebook– Dies ist eine obligatorische Eigenschaft in einer JSON-Datei. Sie enthält einen Namespace, eine Version und den StyleBook-Namen, mit dem Sie das Konfigurationspaket verknüpfen möchten.
-
-
Bewahren Sie im Ordner
configpacksalle Dateien auf, die mit dem Konfigurationspaket verbunden sind, wie z. B. Zertifikate, Signaturdateien und XML-Dateien.
Repository hinzufügen
-
Gehen Sie in der NetScaler Console zu Applications > Configuration > Repositories. Klicken Sie auf Add.
-
Geben Sie im Fenster Add Repository die folgenden Parameter ein:
-
Name – Geben Sie den Namen des Repositorys ein. Dieser Name kann derselbe sein wie der Repository-Name in GitHub/GitLab oder ein anderer.
-
Repository URL – Geben Sie die GitHub/GitLab-Repository-URL ein.
Sie können eine GitHub/GitLab Enterprise-URL angeben. Dies hilft Ihnen, StyleBooks und Konfigurationspakete von GitHub/GitLab Enterprise-Konten zu importieren oder zu synchronisieren.
-
Is it a private URL? – Wenn es sich um ein On-Premise- oder privates GitLab/GitHub-Repository handelt, aktivieren Sie dieses Kontrollkästchen und wählen Sie dann einen Agenten aus.
-
User Name – Geben Sie den Benutzernamen ein, den Sie für den Zugriff auf das GitHub/GitLab-Konto oder Enterprise-Konto verwenden.
-
API/PA Token – Dieses Token wird für den Zugriff auf Ihr GitHub/GitLab-Repository verwendet. Informationen zum Erstellen von API/PA-Tokens für Ihr GitHub/GitLab-Repository finden Sie in der GitHub/GitLab-Dokumentation unter creating personal access tokens.
-
-
Klicken Sie auf Create.
Das Repository wird in der NetScaler Console erstellt.
Repository-Optionen
Die folgenden zusätzlichen Optionen stehen für Ihre Repositories zur Verfügung:
-
Edit – Sie können die Repository-URL, den Benutzernamen und das API-Token bearbeiten.
-
Delete – Sie können das Repository zusammen mit allen in der NetScaler Console vorhandenen StyleBooks löschen, die zuvor aus diesem GitHub/GitLab-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 zuerst alle Konfigurationspakete dieser StyleBooks. Sie können das Repository später aus der NetScaler Console entfernen, um die StyleBooks aus diesem Repository zu bereinigen.
-
Reset – Sie können alle in der NetScaler Console synchronisierten StyleBooks aus diesem Repository entfernen, ohne den Repository-Eintrag tatsächlich zu löschen.
-
List files – Sie können eine Liste aller in der NetScaler Console vorhandenen StyleBooks sehen, die aus dem GitHub/GitLab-Repository stammen.
Schritte zum Importieren von StyleBooks und Konfigurationspaketen aus GitHub/GitLab
Nachdem Sie die Voraussetzungen erfüllt haben, führen Sie die folgenden Schritte aus, um StyleBooks und Konfigurationspakete aus einem GitHub/GitLab-Repository zu importieren:
- Optional: Fügen Sie ein Repository hinzu, falls Sie noch keines hinzugefügt haben.
- Wählen Sie das Repository auf der Seite Repositories aus.
- Klicken Sie auf Sync.