Skip to content

Commit

Permalink
release v1.0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
zhuolun-citrix committed Oct 15, 2024
1 parent b0bfc0e commit 0d5325d
Show file tree
Hide file tree
Showing 96 changed files with 1,888 additions and 594 deletions.
1 change: 1 addition & 0 deletions .github/workflows/gotest-cloud.yml
Original file line number Diff line number Diff line change
Expand Up @@ -147,4 +147,5 @@ jobs:

# Sweep
- name: Sweep
if: always()
run: go test -v ./internal/test -run "^TestAzureMcs$" -timeout 1h -sweep-run "citrix_zone,citrix_zone,citrix_admin_folder,citrix_admin_role,citrix_admin_scope" -sweep="azure"
1 change: 1 addition & 0 deletions .github/workflows/gotest-onprem.yml
Original file line number Diff line number Diff line change
Expand Up @@ -141,4 +141,5 @@ jobs:

# Sweep
- name: Sweep
if: always()
run: go test -v ./internal/test -run "^TestAzureMcs$" -timeout 1h -sweep-run "citrix_zone,citrix_zone,citrix_admin_folder,citrix_admin_role,citrix_admin_scope" -sweep="azure"
31 changes: 31 additions & 0 deletions docs/data-sources/cloud_resource_location.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "citrix_cloud_resource_location Data Source - citrix"
subcategory: "Citrix Cloud"
description: |-
Read data of an existing resource location.
---

# citrix_cloud_resource_location (Data Source)

Read data of an existing resource location.

## Example Usage

```terraform
# Get Resource Location resource by name
data "citrix_cloud_resource_location" "example-resource-location" {
name = "example-resource-location"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) Name of the resource location.

### Read-Only

- `id` (String) ID of the resource location.
43 changes: 42 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,43 @@ description: |-

Manage and deploy Citrix resources easily using the Citrix Terraform provider. The provider currently supports both Citrix Virtual Apps & Desktops(CVAD) and Citrix Desktop as a Service (DaaS) solutions. You can automate creation of site setup including host connections, machine catalogs and delivery groups etc for both CVAD and Citrix DaaS. You can deploy resources in Citrix supported hypervisors and public clouds. Currently, we support deployments in Nutanix, VMware vSphere, XenServer, Microsoft Azure, AWS EC2 and Google Cloud Compute. Additionally, you can also use Manual provisioning or RemotePC to add workloads. The provider is developed and maintained by Citrix.

Documentation regarding the [Data Sources](https://developer.hashicorp.com/terraform/language/data-sources) and [Resources](https://developer.hashicorp.com/terraform/language/resources) supported by the Citrix Provider can be found in the navigation to the left.

Check out the [release notes](https://github.com/citrix/terraform-provider-citrix/releases) to find out more about the provider's latest features and version information.

## Getting Started

New to Terraform? Click [here](https://developer.hashicorp.com/terraform) to learn more.

### Importing existing Citrix resources into Terraform

Experience the immediate benefits of Terraform by importing your Citrix resources (CVAD or DaaS) using our [Onboarding Script](https://github.com/citrix/terraform-provider-citrix/blob/main/scripts/onboarding-helper/terraform-onboarding.ps1). This allows you to quickly adopt infrastructure as code and streamline your infrastructure management. A comprehensive [ReadMe](https://github.com/citrix/terraform-provider-citrix/blob/main/scripts/onboarding-helper/README.md) is available to guide you through the process.

### Creating Citrix resources via Terraform

Please refer to [Citrix Tech Zone](https://community.citrix.com/tech-zone/automation/) to find detailed guides on how to deploy and manage resources using the Citrix provider:
- [Installing and configuring the Citrix provider](https://community.citrix.com/tech-zone/automation/terraform-install-and-config/)
- [AWS EC2](https://community.citrix.com/tech-zone/build/deployment-guides/terraform-daas-aws/) via MCS
- [Azure](https://community.citrix.com/tech-zone/build/deployment-guides/citrix-daas-terraform-azure/) via MCS
- [GCP](https://community.citrix.com/tech-zone/build/deployment-guides/terraform-daas-gcp/) via MCS
- [vSphere](https://community.citrix.com/tech-zone/build/deployment-guides/terraform-daas-vsphere8/) via MCS
- [XenServer](https://community.citrix.com/tech-zone/automation/citrix-terraform-xenserver) via MCS
- [Citrix policies](https://community.citrix.com/tech-zone/automation/cvad-terraform-policies/)

## Frequently Asked Questions

### What resource is supported for different connection types?

| Connection Type | Hypervisor | Resource Pool | MCS Power Managed | MCS Provisioning | PVS | Manual/Remote PC |
|------------------|--------------------|--------------------|----------------------|----------------------|--------------------------|----------------------|
| AzureRM |:heavy_check_mark: |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |:heavy_check_mark: | :heavy_check_mark: |
| AWS EC2 |:heavy_check_mark: |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |:heavy_multiplication_x: | :heavy_check_mark: |
| GCP |:heavy_check_mark: |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |:heavy_multiplication_x: | :heavy_check_mark: |
| vSphere |:heavy_check_mark: |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |:heavy_multiplication_x: | :heavy_check_mark: |
| XenServer |:heavy_check_mark: |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |:heavy_multiplication_x: | :heavy_check_mark: |
| Nutanix |:heavy_check_mark: |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |:heavy_multiplication_x: | :heavy_check_mark: |
| SCVMM |:heavy_check_mark: |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |:heavy_multiplication_x: | :heavy_check_mark: |

## Example Usage

```terraform
Expand Down Expand Up @@ -74,6 +111,10 @@ For Citrix Cloud customers: Use this to specify Cloud API Key Client Secret.
-> **Note** Can be set via Environment Variable **CITRIX_CUSTOMER_ID**.

~> **Please Note** This parameter is required for Citrix Cloud customers to be specified in the provider configuration or via environment variable.
- `disable_daas_client` (Boolean) Disable Citrix DaaS client setup.
Set to true to skip Citrix DaaS client setup.

-> **Note** Can be set via Environment Variable **CITRIX_DISABLE_DAAS_CLIENT**.
- `disable_ssl_verification` (Boolean) Disable SSL verification against the target DDC.
Set to true to skip SSL verification only when the target DDC does not have a valid SSL certificate issued by a trusted CA.
When set to true, please make sure that your provider config is set for a known DDC hostname.
Expand Down Expand Up @@ -103,4 +144,4 @@ Optional:
- `ad_admin_password` (String) Active Directory Admin Password to connect to storefront server <br />Use this to specify AD admin password<br />Can be set via Environment Variable **SF_AD_ADMIN_PASSWORD**.<br />This parameter is **required** to be specified in the provider configuration or via environment variable.
- `ad_admin_username` (String) Active Directory Admin Username to connect to storefront server <br />Use this to specify AD admin username <br />Can be set via Environment Variable **SF_AD_ADMIN_USERNAME**.<br />This parameter is **required** to be specified in the provider configuration or via environment variable.
- `computer_name` (String) StoreFront server computer Name <br />Use this to specify StoreFront server computer name <br />Can be set via Environment Variable **SF_COMPUTER_NAME**.<br />This parameter is **required** to be specified in the provider configuration or via environment variable.
- `disable_ssl_verification` (Boolean) Disable SSL verification against the target storefront server. <br />Only applicable to customers connecting to storefront server remotely. Customers should omit this option when running storefront provider locally. Set to true to skip SSL verification only when the target DDC does not have a valid SSL certificate issued by a trusted CA. <br />When set to true, please make sure that your provider storefront_remote_host is set for a known storefront hostname. <br />Can be set via Environment Variable **SF_DISABLE_SSL_VERIFICATION**.
- `disable_ssl_verification` (Boolean) Disable SSL verification against the target storefront server. <br />Only applicable to customers connecting to storefront server remotely. Customers should omit this option when running storefront provider locally. Set to true to skip SSL verification only when the target DDC does not have a valid SSL certificate issued by a trusted CA. <br />When set to true, please make sure that your provider storefront_remote_host is set for a known storefront hostname. <br />Can be set via Environment Variable **SF_DISABLE_SSL_VERIFICATION**.
4 changes: 1 addition & 3 deletions docs/resources/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,7 @@ resource "citrix_application" "example-application" {
- `limit_visibility_to_users` (Set of String) By default, the application is visible to all users within a delivery group. However, you can restrict its visibility to only certain users by specifying them in the `limit_visibility_to_users` list.

-> **Note** Users must be in `DOMAIN\UserOrGroupName` or `user@domain.com` format
- `metadata` (Attributes List) Metadata for the Application.

~> **Please Note** Metadata once set cannot be removed. Use this field to add new metadata or update the value for an existing metadata. Subsequently, removing any metadata from config will have no effect on the existing metadata of the resource. (see [below for nested schema](#nestedatt--metadata))
- `metadata` (Attributes List) Metadata for the Application. (see [below for nested schema](#nestedatt--metadata))
- `tags` (Set of String) A set of identifiers of tags to associate with the application.

### Read-Only
Expand Down
4 changes: 1 addition & 3 deletions docs/resources/application_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,7 @@ resource "citrix_application_group" "example-application-group" {
- `included_users` (Set of String) Users who can use this application group.

-> **Note** User must be in `Domain\UserOrGroupName` or `user@domain.com` format
- `metadata` (Attributes List) Metadata for the Application Group.

~> **Please Note** Metadata once set cannot be removed. Use this field to add new metadata or update the value for an existing metadata. Subsequently, removing any metadata from config will have no effect on the existing metadata of the resource. (see [below for nested schema](#nestedatt--metadata))
- `metadata` (Attributes List) Metadata for the Application Group. (see [below for nested schema](#nestedatt--metadata))
- `restrict_to_tag` (String) The tag to restrict the application group to.
- `scopes` (Set of String) The IDs of the scopes for the application group to be a part of.
- `tags` (Set of String) A set of identifiers of tags to associate with the application group.
Expand Down
4 changes: 1 addition & 3 deletions docs/resources/aws_hypervisor.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,7 @@ resource "citrix_aws_hypervisor" "example-aws-hypervisor" {

### Optional

- `metadata` (Attributes List) Metadata for the Hypervisor.

~> **Please Note** Metadata once set cannot be removed. Use this field to add new metadata or update the value for an existing metadata. Subsequently, removing any metadata from config will have no effect on the existing metadata of the resource. (see [below for nested schema](#nestedatt--metadata))
- `metadata` (Attributes List) Metadata for the Hypervisor. (see [below for nested schema](#nestedatt--metadata))
- `scopes` (Set of String) The IDs of the scopes for the hypervisor to be a part of.

### Read-Only
Expand Down
4 changes: 1 addition & 3 deletions docs/resources/aws_hypervisor_resource_pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,7 @@ resource "citrix_aws_hypervisor_resource_pool" "example-aws-hypervisor-resource-

### Optional

- `metadata` (Attributes List) Metadata for the Hypervosor Resource Pool.

~> **Please Note** Metadata once set cannot be removed. Use this field to add new metadata or update the value for an existing metadata. Subsequently, removing any metadata from config will have no effect on the existing metadata of the resource. (see [below for nested schema](#nestedatt--metadata))
- `metadata` (Attributes List) Metadata for the Hypervosor Resource Pool. (see [below for nested schema](#nestedatt--metadata))

### Read-Only

Expand Down
5 changes: 2 additions & 3 deletions docs/resources/azure_hypervisor.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,13 @@ resource "citrix_azure_hypervisor" "example-azure-hypervisor" {

-> **Note** Expiration date format is `YYYY-MM-DD`.
- `enable_azure_ad_device_management` (Boolean) Enable Azure AD device management. Default is false.
- `metadata` (Attributes List) Metadata for the Hypervisor.

~> **Please Note** Metadata once set cannot be removed. Use this field to add new metadata or update the value for an existing metadata. Subsequently, removing any metadata from config will have no effect on the existing metadata of the resource. (see [below for nested schema](#nestedatt--metadata))
- `metadata` (Attributes List) Metadata for the Hypervisor. (see [below for nested schema](#nestedatt--metadata))
- `scopes` (Set of String) The IDs of the scopes for the hypervisor to be a part of.

### Read-Only

- `id` (String) GUID identifier of the hypervisor.
- `tenants` (Set of String) A set of identifiers of tenants to associate with the hypervisor connection.

<a id="nestedatt--metadata"></a>
### Nested Schema for `metadata`
Expand Down
4 changes: 1 addition & 3 deletions docs/resources/azure_hypervisor_resource_pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ resource "citrix_azure_hypervisor_resource_pool" "example-azure-hypervisor-resou

### Optional

- `metadata` (Attributes List) Metadata for the Hypervisor Resource Pool.

~> **Please Note** Metadata once set cannot be removed. Use this field to add new metadata or update the value for an existing metadata. Subsequently, removing any metadata from config will have no effect on the existing metadata of the resource. (see [below for nested schema](#nestedatt--metadata))
- `metadata` (Attributes List) Metadata for the Hypervisor Resource Pool. (see [below for nested schema](#nestedatt--metadata))

### Read-Only

Expand Down
7 changes: 3 additions & 4 deletions docs/resources/delivery_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,7 @@ resource "citrix_delivery_group" "example-delivery-group" {
~> **Please Note** This setting only impacts Single Session OS Random (pooled) desktops which are power managed. LHC is always enabled for Single Session OS static and Multi Session OS desktops.

-> **Note** When set to `true`, machines will remain available and allow new connections and changes to the machine caused by a user might be present in subsequent sessions. When set to `false`, machines in the delivery group will be unavailable for new connections during a Local Host Cache event.
- `metadata` (Attributes List) Metadata for the Delivery Group.

~> **Please Note** Metadata once set cannot be removed. Use this field to add new metadata or update the value for an existing metadata. Subsequently, removing any metadata from config will have no effect on the existing metadata of the resource. (see [below for nested schema](#nestedatt--metadata))
- `metadata` (Attributes List) Metadata for the Delivery Group. (see [below for nested schema](#nestedatt--metadata))
- `minimum_functional_level` (String) Specifies the minimum functional level for the VDA machines in the delivery group. Defaults to `L7_20`.
- `policy_set_id` (String) GUID identifier of the policy set.
- `reboot_schedules` (Attributes List) The reboot schedule for the delivery group. (see [below for nested schema](#nestedatt--reboot_schedules))
Expand Down Expand Up @@ -426,6 +424,7 @@ Optional:

- `description` (String) A description for the published desktop. The name and description are shown in Citrix Workspace app.
- `enabled` (Boolean) Specify whether to enable the delivery of this desktop. Default is `true`.
- `restrict_to_tag` (String) Restrict session launch to machines with tag specified in GUID.
- `restricted_access_users` (Attributes) Restrict access to this Desktop by specifying users and groups in the allow and block list. If no value is specified, all users that have access to this Delivery Group will have access to the Desktop.

~> **Please Note** For Remote PC Delivery Groups desktops, `restricted_access_users` has to be set. (see [below for nested schema](#nestedatt--desktops--restricted_access_users))
Expand Down Expand Up @@ -480,7 +479,7 @@ Optional:
- `reboot_notification_to_users` (Attributes) The reboot notification for the reboot schedule.

~> **Please Note** Not available for natural reboot. (see [below for nested schema](#nestedatt--reboot_schedules--reboot_notification_to_users))
- `restrict_to_tag` (String) The tag to which the reboot schedule is restricted.
- `restrict_to_tag` (String) Restrict reboot schedule to machines with tag specified in Guid.
- `week_in_month` (String) The week in the month on which the reboot schedule runs monthly. Can only be set to `First`, `Second`, `Third`, `Fourth`, or `Last`.

<a id="nestedatt--reboot_schedules--reboot_notification_to_users"></a>
Expand Down
Loading

0 comments on commit 0d5325d

Please sign in to comment.