terraform-provider-citrix

Terraform Citrix Provider

Citrix has developed a custom Terraform provider for automating Citrix product deployments and configurations. Using Terraform with Citrix provider, you can manage your Citrix products via Infrastructure as Code, giving you higher efficiency and consistency on infrastructure management, as well as better reusability on infrastructure configuration.

Table of Content

• Terraform Citrix Provider
  • Table of Content
  • Citrix Terraform Provider Documentation
    • Navigating the repository
    • Provider Configuration
    • Resource Configuration
  • Using Citrix Terraform provider for Citrix DaaS
    • Install Terraform
    • Configure your Citrix Terraform Provider
    • Start writing Terraform for managing your Citrix DaaS site
    • Create a Zone in Citrix DaaS as the first step
  • Frequently Asked Questions
    • resource.name vs resource.id

Citrix Terraform Provider Documentation

Navigating the repository

1. internal folder - Contains the following sub directories:
   • provider folder - Contains the Citrix provider implementation for Terraform
   • daas folder - Contains all the Citrix DaaS resources libraries that we support through Terraform.
   • test folder - Contains the Go tests for both provider and all resources that we have.
   • util folder - Contains general utility functions that can be reused.
2. examples folder - Contains the examples for users to use various Citrix resources e.g zone folder contains the resources.tf that illustrates how citrix_daas_zone resource can be used to create a DaaS Zone on target Citrix DaaS site. There are also examples for Citrix provider configuration for both Citrix Cloud customer and Citrix On-Premises customers. Users can use the examples as a starting point to configure their own Citrix Terraform script.
3. docs folder - resources - contains the documentation for all resource configurations supported through Terraform. Refer this to understand the properties, accepted values, and how various properties work together for each type of resource.

Provider Configuration

provider.tf contains the information on target DaaS site where you want to apply configuration.

Depending on whether its managing a Citrix Cloud site, or a Citrix On-Premises site, Citrix provider should be configured differently.

Example for On-Premises site:

provider "citrix" {
    hostname      = "10.71.136.250"  # Optionally set with `CITRIX_HOSTNAME` environment variable.
    client_id     = "${var.domain_admin_id}"  # Optionally set with `CITRIX_CLIENT_ID` environment variable.
    client_secret = "${var.domain_admin_secret}"  # Optionally set with `CITRIX_CLIENT_SECRET` environment variable.
}

Example for Cloud site:

provider "citrix" {
    region        = "US"  # Optionally set with `CITRIX_REGION` environment variable.
    environment   = "Production"  # Optionally set with `CITRIX_ENVIRONMENT` environment variable.
    customer_id   = "${var.customer_id}"  # Optionally set with `CITRIX_CUSTOMER_ID` environment variable.
    client_id     = "${var.api_key_clientId}"  # Optionally set with `CITRIX_CLIENT_ID` environment variable.
    client_secret = "${var.api_key_clientSecret}"  # Optionally set with `CITRIX_CLIENT_SECRET` environment variable.
}

You can also set hostname for cloud site to force override the Citrix DaaS service URL for a cloud customer.

You can use environment variables as stated in the comments above. When running Go tests, always use environment variables so that no credentials or other sensitive information are checked-in to the code.

Below is a table to show the difference between On-Premises and Cloud provider configuration:

Resource Configuration

Resources.tf can be used to configure the desired state of the resources that you want to create and manage in your Citrix Services. The example below shows how you can configure a Citrix DaaS Zone in Citrix DaaS service in resource.tf.

citrix_daas_zone

resource "citrix_daas_zone" "example-zone" {
    name                = "example-zone"
    description         = "zone example"
    metadata            = [
        {
            name    = "key1"
            value   = "value1"
        }
    ]
}

Please refer the Citrix Terraform Provider documentation such as docs/resources/daas_zone.md to find out the configurable properties of each type of resources, understand what they do, and what option values are supported.

Using Citrix Terraform provider for Citrix DaaS

Install Terraform

Refer the Hashicorp documentation for installing Terraform CLI for your own environment.

Configure your Citrix Terraform Provider

Refer section Understanding Provider Configuration or Provider documentation to configure Citrix Terraform Provider for the Citrix DaaS site you want to manage with Terraform.

Start writing Terraform for managing your Citrix DaaS site

To find all the Citrix DaaS resources manageable via Terraform, understand all the configurable properties for each resource and how they work together, refer documentations for DaaS resources that has daas_ as resource name prefix in Citrix Terraform resource documentation. To better understand how the resource is managed via Citrix DaaS Rest API, you can refer the Citrix DaaS Rest API documentation.

Create a Zone in Citrix DaaS as the first step

Refer the DaaS Zone documentation to configure a zone via terraform.

Frequently Asked Questions