Skip to content

Commit ec71daa

Browse files
committed
Various Main Page Updates
1 parent 0f6c290 commit ec71daa

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

docs/index.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,48 @@
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 customers to natively manage data-as-code along with their infrastructure.
4+
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.
55

6+
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.
67

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.
8+
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.
9+
10+
Customers who are entitled to Data Control Tower may also send support issues through the [Delphix Support Portal](https://support.delphix.com/).
11+
12+
## System Requirements
13+
14+
| Product | Version |
15+
|--------------------------------|----------|
16+
| Data Control Tower (DCT) | v14+ |
17+
| Delphix Continuous Data Engine | v6.0.0.1+ |
18+
19+
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.
20+
21+
## Connectivity and Authentication
922

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
23+
All communication is performed through HTTPS. The Delphix Provider uses Data Control Tower (DCT) APIs to communicate with Delphix Continuous Data Engines.
1124

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.
25+
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).
1326

1427
## Example Usage
1528

29+
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.
30+
1631
```hcl
1732
terraform {
1833
required_providers {
1934
delphix = {
2035
source = "delphix-integrations/delphix"
21-
version = "1.0.0"
36+
version = "3.1.0"
2237
}
2338
}
2439
}
2540
2641
# Configure the DXI Provider
2742
provider "delphix" {
28-
tls_insecure_skip = true
29-
key = "dct_api_key"
3043
host = "dct_hostname"
44+
key = "dct_api_key"
45+
tls_insecure_skip = true
3146
}
3247
3348
# Provision a VDB
@@ -37,15 +52,11 @@ resource "delphix_vdb" "vdb_name" {
3752
}
3853
```
3954

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-
55+
### Example Global Parameter Reference
4556

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

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`.
62+
Consult the documentation's Resources section for details on individual resources, such as VDB, dSource, and Environment.

0 commit comments

Comments
 (0)