terraform provider citrixadc herunterladen - terraform provider citrixadc Quellcode herunterladen

terraform provider citrixadc

Anderer Quellcode

v1.42.0

Herunterladen

Terraform `Citrix ADC` Anbieter

Citrix hat einen benutzerdefinierten Terraform-Anbieter zur Automatisierung von Citrix ADC-Bereitstellungen und -Konfigurationen entwickelt. Mit Terraform können Sie Ihre ADCs für verschiedene Anwendungsfälle wie Lastausgleich, SSL, Content Switching, GSLB, WAF usw. individuell konfigurieren.

Erfahren Sie hier mehr über Citrix ADC Automation

„Informationen zur Bereitstellung von Citrix ADC in der Public Cloud – AWS und Azure finden Sie unter Cloud-Skripte im Github-Repo Terraform-Cloud-Scripts.

✉️ Bei unmittelbaren Problemen oder Hilfe wenden Sie sich bitte an [email protected]!

Beispiele und Module

Siehe Beispiele
Siehe auch golden_templates

Dokumentation des Terraform-Anbieters

Warum Terraform für Citrix ADC?
Navigieren im Repository
Grundlegendes zur Anbieterkonfiguration
Ressourcenkonfiguration verstehen
Allgemeine Richtlinien zu ADC-Konfigurationen
Übernehmen von Änderungen am persistenten Speicher von Citrix ADC
Liste der von Terraform unterstützten ADC-Anwendungsfälle
Verwenden von remote-exec für einmalige Aufgaben

Einsteigerleitfaden zur Automatisierung von ADC mit Terraform

Praktisches Labor mit ADC-Automatisierung mit Terraform
Installieren Sie Terraform in Ihrem eigenen Setup
Grundlegendes zum ADC-Terraform-Provider-Repository)
Holen Sie sich Ihre erste Terraform-Konfiguration in ADC
So schreiben Sie eine Terraform-Ressourcendatei für ADC
Richten Sie den SSL-Offloading-Anwendungsfall in ADC ein
Übernehmen von Änderungen am persistenten Speicher von Citrix ADC
Verwalten von ADC-Konfigurationsabweichungen in Terraform
Importieren von ADC-Konfigurationen in die Terraform-Ressourcendatei

Erweiterte Anleitung zur Automatisierung von ADC mit Terraform

Stellen Sie ADC in AWS mithilfe von Terraform bereit
Nutzung von Terraform-Arbeitsbereichen zur Verwaltung mehrerer ADCs
Aktualisiert Dienste dynamisch mithilfe von Consul-Terraform-Sync
Blue-Green-Bereitstellung mit Citrix ADC und Azure Pipelines

Warum Terraform für Citrix ADC?

Terraform ist ein Open-Source-Infrastruktur-as-Code-Softwaretool, das einen konsistenten CLI-Workflow zur Verwaltung Hunderter Cloud-Dienste bietet. Terraform kodiert Cloud-APIs in deklarative Konfigurationsdateien. Terraform kann zum Bereitstellen und Konfigurieren von ADC verwendet werden. Die Konfiguration von Citrix ADC über Terraform bietet mehrere Vorteile.

Infrastruktur als Code-Ansatz für ADC – Sie können die ADC-Konfigurationen in SCM-Tools wie GitHub und Version speichern und wie andere Code-Repositorys verfolgen, die Sie haben.
Deklarativer Ansatz zur ADC-Automatisierung – Benutzer müssen lediglich den Zielzustand des ADC definieren. ADC-Terraform-Ressourcen führen die entsprechenden API-Aufrufe durch, um den Zielzustand zu erreichen.
ADC-Ressourcendateien in Terraform sind benutzerfreundlich und leicht verständlich.
Abstrahieren Sie die Komplexität, die mit der internen Architektur von Citrix ADC verbunden ist.
Erkennen Sie Konfigurationsabweichungen bei ADC mithilfe von Terraform ganz einfach.

Navigieren im Repository

citrixadc Ordner – Enthält die gesamte ADC-Ressourcenbibliothek, die wir über Terraform unterstützen. Diese Ressourcenbibliotheken rufen intern NITRO APIS auf, um den Ziel-ADC zu konfigurieren.
Ordner examples – Enthält die Beispiele für Benutzer zur Verwendung verschiedener ADC-Ressourcen. Der Ordner „simple_lb“ enthält beispielsweise die Datei „resources.tf“, die veranschaulicht, wie die Ressource „citrixadc_lbvserver“ zum Erstellen eines Lastausgleichs-VServers auf dem Ziel-ADC verwendet werden kann. Ebenso enthalten verschiedene Ordner Beispiele zum Definieren verschiedener Ressourcen. Von den Benutzern wird erwartet, dass sie diese Beispiele überprüfen und ihre gewünschten ADC-Konfigurationen definieren.
docs Ordner – https://github.com/citrix/terraform-provider-citrixadc/tree/master/docs/resources – enthält die Dokumentation aller von Terraform unterstützten Ressourcenkonfigurationen. Lesen Sie hier, um die verschiedenen Argumente und Werte zu verstehen, die eine bestimmte Ressource annimmt.

Grundlegendes zur Anbieterkonfiguration

provider.tf enthält die Informationen zum Ziel-ADC, auf den Sie die Konfiguration anwenden möchten.

 provider "citrixadc" {
    username = " ${ var . ns_user } "  # You can optionally use `NS_LOGIN` environment variables.
    password = " ${ var . ns_password } "  # You can optionally use `NS_PASSWORD` environment variables.
    endpoint = " http://10.71.136.250/ "  # You can optionally use `NS_URL` environment variables.
}

Wir können eine https URL verwenden und das nicht vertrauenswürdige Autoritätszertifikat auf dem Citrix ADC akzeptieren, indem wir insecure_skip_verify = true angeben

Um https zu verwenden, ohne insecure_skip_verify = true festlegen zu müssen, befolgen Sie diese Anleitung zum Ersetzen des Standard-TLS-Zertifikats durch eines einer vertrauenswürdigen Zertifizierungsstelle.

Die Verwendung von https wird bevorzugt. Die Verwendung von http führt dazu, dass alle Provider-Konfigurationsvariablen sowie Ressourcenvariablen im Klartext übertragen werden. Jeder, der den HTTP-Datenstrom beobachtet, kann sensible Werte wie das Provider-Passwort analysieren.

Vermeiden Sie die Speicherung von Anbieteranmeldeinformationen im lokalen Bundesstaat, indem Sie ein Backend verwenden, das Verschlüsselung unterstützt. Auch für die Speicherung sensibler Daten empfiehlt sich der Vault-Anbieter hasicorp.

Sie können auch Umgebungsvariablen verwenden, wie in den Kommentaren oben angegeben.

Die folgenden Argumente werden unterstützt.

username – Dies ist der Benutzername für den Zugriff auf Citrix ADC. Der Standardwert ist nsroot , es sei denn, die Umgebungsvariable NS_LOGIN wurde festgelegt
password – Dies ist das Passwort für den Zugriff auf Citrix ADC. Standardmäßig ist nsroot , es sei denn, die Umgebungsvariable NS_PASSWORD wurde festgelegt
endpoint – (Erforderlich) Nitro API-Endpunkt in der Form http://<NS_IP>/ oder http://<NS_IP>:<PORT>/ . Kann in der Umgebungsvariablen NS_URL angegeben werden

insecure_skip_verify – (Optional, true/false) Ob das nicht vertrauenswürdige Zertifikat auf dem Citrix ADC akzeptiert werden soll, wenn der Citrix ADC-Endpunkt https ist

proxied_ns – (Optional, NSIP) Die Ziel-Citrix ADC NSIP für MAS-Proxy-Aufrufe. Wenn diese Option definiert ist, müssen sich username , password und endpoint auf den MAS-Proxy beziehen.

Der Benutzername, das Passwort und der Endpunkt können in den Umgebungsvariablen NS_LOGIN , NS_PASSWORD und NS_URL angegeben werden.

Ressourcenkonfiguration

Resources.tf enthält den gewünschten Status der Ressourcen, die Sie auf dem Ziel-ADC haben möchten. Zum Beispiel zum Erstellen eines Lastausgleichs-Vservers in ADC enthält die folgende Datei „resource.tf“ die gewünschten Konfigurationen des lbvservers

citrixadc_lbvserver

 resource "citrixadc_lbvserver" "foo" {
  name = " sample_lb "
  ipv46 = " 10.71.136.150 "
  port = 443
  servicetype = " SSL "
  lbmethod = " ROUNDROBIN "
  persistencetype = " COOKIEINSERT "
  sslcertkey = " ${ citrixadc_sslcertkey . foo . certkey } "
  sslprofile = " ns_default_ssl_profile_secure_frontend "
}

Informationen zu den Argumenten, möglichen Werten und anderen für eine bestimmte Ressource verfügbaren Argumenten finden Sie in der NITRO-API-Dokumentation https://developer-docs.citrix.com/projects/netscaler-nitro-api/en/12.0/configuration/ Load-balancing/lbvserver/lbvserver/ und die Terraform-Dokumentation wie z https://github.com/citrix/terraform-provider-citrixadc/blob/master/docs/resources/lbvserver.md .

Der state ist nicht mit dem Remote-Objekt synchronisiert. Wenn der Status des LB-Vservers nicht mit der Terraform-Konfiguration übereinstimmt, müssen Sie die Ressource manuell tainten und die Konfiguration erneut anwenden.

Allgemeine Richtlinien zur Konfiguration von ADC

Die Unterordner im Beispielordner enthalten Beispiele für verschiedene ADC-Konfigurationen über Terraform. Sehen Sie sich das Beispiel „simple_lb“ an, um die Struktur und Verwendung unten zu verstehen.

Struktur

resources.tf beschreibt die tatsächlich zu erstellenden NetScaler-Konfigurationsobjekte. Die Attribute dieser Ressourcen sind entweder fest codiert oder werden anhand von Eingabevariablen in terraform.tfvars nachgeschlagen
variables.tf beschreibt die Eingabevariablen für die Terraform-Konfiguration. Diese können Voreinstellungen haben
Mit provider.tf werden der Benutzername, das Passwort und der Endpunkt des NetScaler angegeben. Alternativ können Sie die Umgebungsvariablen NS_URL, NS_LOGIN und NS_PASSWORD festlegen.
terraform.tfvars verfügt über die in variables.tf angegebenen Variableneingänge

Benutzen

Ändern Sie die Datei terraform.tfvars und provider.tf entsprechend Ihrer eigenen NetScaler-Bereitstellung.
Verwenden Sie terraform plan und terraform apply um den NetScaler zu konfigurieren.

Aktualisieren Ihrer Konfiguration

Ändern Sie die Back-End-Dienste und verwenden Sie terraform plan und terraform apply um die Änderungen zu überprüfen

Übernehmen von Änderungen am persistenten Speicher von Citrix ADC

Der Anbieter übernimmt die Konfigurationsänderungen nicht in den persistenten Speicher von Citrix ADC. Führen Sie dazu das Shell-Skript ns_commit.sh aus:

 export NS_URL=http:// < host > : < port > /
export NS_LOGIN=nsroot
export NS_PASSWORD=nsroot
./ns_commit.sh

Um sicherzustellen, dass die Konfiguration bei jedem Lauf gespeichert wird, können wir so etwas wie terraform apply && ns_commit.sh verwenden

ADC-Anwendungsfall, unterstützt durch Terraform

Eine Liste der in ADC unterstützten Anwendungsfälle finden Sie hier: https://registry.terraform.io/providers/citrix/citrixadc/latest/docs.

Verwenden von `remote-exec` für einmalige Aufgaben

Terraform ist nützlich, um den gewünschten Zustand für eine Reihe von Ressourcen aufrechtzuerhalten. Es ist weniger nützlich für Aufgaben wie die Netzwerkkonfiguration, die sich nicht ändern. Die Netzwerkkonfiguration ähnelt der Verwendung eines Provisioners in Terraform. Das Verzeichnis examples/remote-exec zeigt Beispiele dafür, wie Terraform ssh verwenden kann, um diese einmaligen Aufgaben zu erledigen.

Einsteigerleitfaden zur ADC-Automatisierung mit Terraform

Praktisches Labor zur ADC-Automatisierung mit Terraform

Probieren Sie unser Hands-on-Lab aus, um zu erfahren, wie es ist, Terraform für ADC zu verwenden.

Installieren Sie Terraform in Ihrem eigenen Setup

Der erste Schritt zur Verwendung von Terraform für ADC ist die Installation der Terraform CLI. Informationen zur Installation von Terraform CLI für Ihre eigene Umgebung finden Sie in der Hashicorp-Dokumentation.

Grundlegendes zum ADC-Terraform-Provider-Repository

Weitere Informationen finden Sie im Abschnitt „Navigieren in unserem Repository“.

Holen Sie sich Ihre erste Terraform-Konfiguration in ADC

Folgen Sie dem Artikel „Erste Schritte mit Terraform auf NetScaler“, um Ihre erste Konfiguration zu erhalten

So schreiben Sie eine Terraform-Ressourcendatei für ADC

Informationen zum Schreiben der Terraform-Ressourcen für Citrix ADC finden Sie unter den folgenden Links zur NITRO-API-Dokumentation oder zur Terraform-Registrierungsdokumentation.

Richten Sie den SSL-Offloading-Anwendungsfall in ADC ein

Hier ist die Terraform-Vorlage, der Sie folgen, um SSL-Offloading zu konfigurieren.

Übernehmen von Änderungen am persistenten Speicher von Citrix ADC

Weitere Informationen finden Sie im Abschnitt „Änderungen festschreiben“.

Verwalten von ADC-Konfigurationsabweichungen in Terraform

Sie möchten den aktuellen Status von ADC-Entitäten in Terraform sehen

Verwenden Sie Terraform Refresh , um Ihre lokale Terraform-Statusdatei so zu aktualisieren, dass sie mit dem vorhandenen ADC-Status übereinstimmt
Verwenden Sie Terraform Show, um den aktuellen Status Ihrer gesamten Konfiguration anzuzeigen
Verwenden Sie die Terraform-Statusliste, um die Ressourcen anzuzeigen, die über Terraform verfolgt/verwaltet werden
Um eine bestimmte Entität zu überprüfen, verwenden Sie terraform state show <entity_name> , z. B. terraform state show citrixadc_servicegroup.tf_servicegroup

Wenn Sie die ADC-Konfiguration mit den Konfigurationen überschreiben möchten, die Sie in der Terraform-Ressourcendatei haben, dann

Sie können Terraform Plan ausführen, um die Abweichungen/Unterschiede zwischen den beiden Staaten anzuzeigen
Führen Sie terraform apply aus, um die gewünschten Konfigurationen (in Ihrer Terraform-Ressourcendatei) an Ihren ADC zu übertragen.

Aktualisieren Sie Ihre Terraform-Statusdatei, um den aktuellen/wahren Status von ADC widerzuspiegeln

Verwenden Sie Terraform Refresh , um Ihre lokale Terraform-Statusdatei so zu aktualisieren, dass sie mit dem vorhandenen ADC-Status übereinstimmt

Importieren von ADC-Konfigurationen in die Terraform-Ressourcendatei

Erfahren Sie hier, wie Sie vorhandene NetScaler-Konfigurationen in Terraform-Ressourcen importieren

Erweiterte Anleitung zur Automatisierung von ADC mit Terraform

Stellen Sie ADC in AWS mithilfe von Terraform bereit

Weitere Informationen finden Sie in unseren Terraform-Cloud-Skripten für AWS und im Demovideo

Nutzung von Terraform-Arbeitsbereichen zur Verwaltung mehrerer ADCs

Noch offen

Aktualisiert Dienste dynamisch mithilfe von Consul-Terraform-Sync

Unsere Consul-Terraform-Sync-Integration ermöglicht Benutzern das automatische Erstellen, Aktualisieren und Löschen von Servicegruppen in Citrix ADC, die mit dem Consul Terraform Sync-Framework synchronisiert werden.