From ec71daa271799dc30ecaa34cbc625c025f60f387 Mon Sep 17 00:00:00 2001 From: Nick Mathison <114104601+nick-mathison@users.noreply.github.com> Date: Thu, 7 Mar 2024 09:14:16 -0500 Subject: [PATCH 1/4] Various Main Page Updates --- docs/index.md | 49 ++++++++++++++++++++++++++++++------------------- 1 file changed, 30 insertions(+), 19 deletions(-) diff --git a/docs/index.md b/docs/index.md index f8eaaa6..7b05864 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,33 +1,48 @@ # Delphix Provider -!> **NOTE** -The Terraform Provider for Delphix requires the Delphix Continuous Data Platform and Data Control Tower (DCT). +The Terraform Provider for Delphix enables customers to natively manage data-as-code along with their infrastructure. +With Terraform and Delphix, customers can now automatically provision, manage, and teardown any number of ephemeral data environments to drive enterprise DevOps workflows, such as test data management. +This provider communicates directly with Data Control Tower (DCT) to generated virtual database and other objects. Therefore, DCT must be registered with one or more Delphix Continuous Data Engines. -The Terraform Provider for Delphix enables customers to natively manage data-as-code along with their infrastructure. -With Terraform and Delphix, customers can now automatically provision, manage and teardown any number of ephemeral data environments to drive enterprise DevOps workflows including test data management. +To learn more about Delphix and DCT APIs, refer to [Delphix Documentation](https://documentation.delphix.com/docs/) and [DCT Documentation](https://dct.delphix.com/docs/latest/) respectively. Please [Contact us](ask-integrations@delphix.com) (ask-integrations@delphix.com) with any questions. + +Customers who are entitled to Data Control Tower may also send support issues through the [Delphix Support Portal](https://support.delphix.com/). + +## System Requirements + +| Product | Version | +|--------------------------------|----------| +| Data Control Tower (DCT) | v14+ | +| Delphix Continuous Data Engine | v6.0.0.1+ | + +Note: The DCT version above guarantees full provider support. However, each resource might support older versions. Refer to the specific resource documentation page for more information. + +## Connectivity and Authentication -This provider leverages the Delphix APIs available with the Delphix Data Control Tower (DCT). The provider must be configured with the proper API key generated by DCT and registered with associated Delphix engines before use +All communication is performed through HTTPS. The Delphix Provider uses Data Control Tower (DCT) APIs to communicate with Delphix Continuous Data Engines. -To learn more about Delphix and DCT APIs, refer to [Delphix Docs](https://docs.delphix.com) and [DCT Docs](https://docs.delphix.com/dct) respectively. Please [Contact us](ask-integrations@delphix.com) (ask-integrations@delphix.com) with any questions. +Authentication with DCT APIs are managed using API Keys. For generation of an API key, please refer to [DCT API Keys](https://dct.delphix.com/docs/latest/api-keys). ## Example Usage +The following script demonstrates how to configure the Delphix Provider to connect with Data Control Tower and then provision a VDB. Additional resource guides and documentation can be found on the left hand side. + ```hcl terraform { required_providers { delphix = { source = "delphix-integrations/delphix" - version = "1.0.0" + version = "3.1.0" } } } # Configure the DXI Provider provider "delphix" { - tls_insecure_skip = true - key = "dct_api_key" host = "dct_hostname" + key = "dct_api_key" + tls_insecure_skip = true } # Provision a VDB @@ -37,15 +52,11 @@ resource "delphix_vdb" "vdb_name" { } ``` -## Configuration and API Key Generation - -Delphix Provider uses DCT APIs to communicate with the Delphix engines. Authentication to DCT APIs are handled using API Keys. -For generation of the API key, please refer to [Authentication](https://docs.delphix.com/dct/authentication-170164311.html). - +### Example Global Parameter Reference -## Argument Reference +* __host__: The hostname for DCT. +* __key__ : The API Key which is used to authenticate with DCT. (Example `apk 2.abc123...`). +* __tls_insecure_skip__: (Optional) A boolean value which determines whether to skip the SSL/TLS check. The dfault value is `false`. Skipping any SSL/TLS check is not recommended for production environments. +* __host_scheme__: (Optional) Determines the configured host URL's scheme. The default value is `https`. -* __key__ : The API key is provided in this field that gets passed on to DCT for authentication. -* __host__: The host name for where DCT APIGW is running. -* __tls_insecure_skip__: This takes a boolean value which determines whether to skip the TLS check. tls_insecure_skip is really unsafe to set it to true. By default it is `false`. -* __host_scheme__: Determines the host scheme configured. By default it is `https`. +Consult the documentation's Resources section for details on individual resources, such as VDB, dSource, and Environment. From 0325c7d776081f37366ea512be7498c7fe3cf9f6 Mon Sep 17 00:00:00 2001 From: Nick Mathison <114104601+nick-mathison@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:17:55 -0500 Subject: [PATCH 2/4] Update index.md --- docs/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/index.md b/docs/index.md index 7b05864..c4a2999 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,6 +18,10 @@ Customers who are entitled to Data Control Tower may also send support issues th Note: The DCT version above guarantees full provider support. However, each resource might support older versions. Refer to the specific resource documentation page for more information. +## Release Notes + +The Delphix Provider's complete release notes can be found in the [Delphix Ecosystem Documentation](https://ecosystem.delphix.com/docs/main/release-notes-terraform). + ## Connectivity and Authentication All communication is performed through HTTPS. The Delphix Provider uses Data Control Tower (DCT) APIs to communicate with Delphix Continuous Data Engines. From ca5c0b40823ff1efa8ff3a00dce3861bab23627e Mon Sep 17 00:00:00 2001 From: Nick Mathison <114104601+nick-mathison@users.noreply.github.com> Date: Mon, 18 Mar 2024 14:25:22 -0400 Subject: [PATCH 3/4] Review Comments --- docs/index.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/index.md b/docs/index.md index c4a2999..7309ac2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,13 +1,14 @@ # Delphix Provider -The Terraform Provider for Delphix enables customers to natively manage data-as-code along with their infrastructure. -With Terraform and Delphix, customers can now automatically provision, manage, and teardown any number of ephemeral data environments to drive enterprise DevOps workflows, such as test data management. +The Terraform Provider for Delphix enables you to natively manage data-as-code along with your infrastructure. + +With Terraform and Delphix, you can now automatically provision, manage, and teardown any number of ephemeral data environments to drive enterprise DevOps workflows, such as test data management. This provider communicates directly with Data Control Tower (DCT) to generated virtual database and other objects. Therefore, DCT must be registered with one or more Delphix Continuous Data Engines. To learn more about Delphix and DCT APIs, refer to [Delphix Documentation](https://documentation.delphix.com/docs/) and [DCT Documentation](https://dct.delphix.com/docs/latest/) respectively. Please [Contact us](ask-integrations@delphix.com) (ask-integrations@delphix.com) with any questions. -Customers who are entitled to Data Control Tower may also send support issues through the [Delphix Support Portal](https://support.delphix.com/). +If you are entitled to Data Control Tower then you may also send support issues through the [Delphix Support Portal](https://support.delphix.com/). ## System Requirements @@ -46,7 +47,7 @@ terraform { provider "delphix" { host = "dct_hostname" key = "dct_api_key" - tls_insecure_skip = true + tls_insecure_skip = false } # Provision a VDB @@ -60,7 +61,7 @@ resource "delphix_vdb" "vdb_name" { * __host__: The hostname for DCT. * __key__ : The API Key which is used to authenticate with DCT. (Example `apk 2.abc123...`). -* __tls_insecure_skip__: (Optional) A boolean value which determines whether to skip the SSL/TLS check. The dfault value is `false`. Skipping any SSL/TLS check is not recommended for production environments. +* __tls_insecure_skip__: (Optional) A boolean value which determines whether to skip the SSL/TLS check. The default value is `false`. Skipping any SSL/TLS check is not recommended for production environments. * __host_scheme__: (Optional) Determines the configured host URL's scheme. The default value is `https`. Consult the documentation's Resources section for details on individual resources, such as VDB, dSource, and Environment. From be1b351f0a7df81c4dd0d1c0d9d7167dcebfca1d Mon Sep 17 00:00:00 2001 From: Nick Mathison <114104601+nick-mathison@users.noreply.github.com> Date: Tue, 19 Mar 2024 12:42:52 -0400 Subject: [PATCH 4/4] Update index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 7309ac2..84ce70e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -38,7 +38,7 @@ terraform { required_providers { delphix = { source = "delphix-integrations/delphix" - version = "3.1.0" + version = "3.2.0" } } }