Skip to content

Commit 4e9d909

Browse files
Merge pull request #81 from nick-mathison/main-page-update
HUBS-2073 - Main page update
2 parents acc6292 + be1b351 commit 4e9d909

File tree

1 file changed

+35
-19
lines changed

1 file changed

+35
-19
lines changed

docs/index.md

Lines changed: 35 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,53 @@
11
# <provider> Delphix Provider
22

3-
!> **NOTE**
4-
The Terraform Provider for Delphix requires the Delphix Continuous Data Platform and Data Control Tower (DCT).
3+
The Terraform Provider for Delphix enables you to natively manage data-as-code along with your infrastructure.
54

5+
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.
66

7-
The Terraform Provider for Delphix enables customers to natively manage data-as-code along with their infrastructure.
8-
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.
7+
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.
98

10-
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
9+
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.
1110

12-
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.
11+
If you are entitled to Data Control Tower then you may also send support issues through the [Delphix Support Portal](https://support.delphix.com/).
12+
13+
## System Requirements
14+
15+
| Product | Version |
16+
|--------------------------------|----------|
17+
| Data Control Tower (DCT) | v14+ |
18+
| Delphix Continuous Data Engine | v6.0.0.1+ |
19+
20+
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.
21+
22+
## Release Notes
23+
24+
The Delphix Provider's complete release notes can be found in the [Delphix Ecosystem Documentation](https://ecosystem.delphix.com/docs/main/release-notes-terraform).
25+
26+
## Connectivity and Authentication
27+
28+
All communication is performed through HTTPS. The Delphix Provider uses Data Control Tower (DCT) APIs to communicate with Delphix Continuous Data Engines.
29+
30+
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).
1331

1432
## Example Usage
1533

34+
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.
35+
1636
```hcl
1737
terraform {
1838
required_providers {
1939
delphix = {
2040
source = "delphix-integrations/delphix"
21-
version = "1.0.0"
41+
version = "3.2.0"
2242
}
2343
}
2444
}
2545
2646
# Configure the DXI Provider
2747
provider "delphix" {
28-
tls_insecure_skip = true
29-
key = "dct_api_key"
3048
host = "dct_hostname"
49+
key = "dct_api_key"
50+
tls_insecure_skip = false
3151
}
3252
3353
# Provision a VDB
@@ -37,15 +57,11 @@ resource "delphix_vdb" "vdb_name" {
3757
}
3858
```
3959

40-
## Configuration and API Key Generation
41-
42-
Delphix Provider uses DCT APIs to communicate with the Delphix engines. Authentication to DCT APIs are handled using API Keys.
43-
For generation of the API key, please refer to [Authentication](https://docs.delphix.com/dct/authentication-170164311.html).
44-
60+
### Example Global Parameter Reference
4561

46-
## Argument Reference
62+
* __host__: The hostname for DCT.
63+
* __key__ : The API Key which is used to authenticate with DCT. (Example `apk 2.abc123...`).
64+
* __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.
65+
* __host_scheme__: (Optional) Determines the configured host URL's scheme. The default value is `https`.
4766

48-
* __key__ : The API key is provided in this field that gets passed on to DCT for authentication.
49-
* __host__: The host name for where DCT APIGW is running.
50-
* __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`.
51-
* __host_scheme__: Determines the host scheme configured. By default it is `https`.
67+
Consult the documentation's Resources section for details on individual resources, such as VDB, dSource, and Environment.

0 commit comments

Comments
 (0)