|
1 |
| -# <provider> Delphix Provider |
2 |
| - |
3 |
| -The Terraform Provider for Delphix enables you to natively manage data-as-code along with your infrastructure. |
4 |
| - |
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. |
6 |
| - |
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. |
8 |
| - |
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. |
10 |
| - |
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) | v22+ | |
18 |
| -| Delphix Continuous Data Engine | v16.0.0.0+ | |
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). |
31 |
| - |
32 |
| -## Example Usage |
33 |
| - |
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 |
| - |
36 |
| -```hcl |
37 |
| -terraform { |
38 |
| - required_providers { |
39 |
| - delphix = { |
40 |
| - source = "delphix-integrations/delphix" |
41 |
| - version = "3.3.0" |
42 |
| - } |
43 |
| - } |
44 |
| -} |
45 |
| -
|
46 |
| -# Configure the DXI Provider |
47 |
| -provider "delphix" { |
48 |
| - host = "dct_hostname" |
49 |
| - key = "dct_api_key" |
50 |
| - tls_insecure_skip = false |
51 |
| -} |
52 |
| -
|
53 |
| -# Provision a VDB |
54 |
| -resource "delphix_vdb" "vdb_name" { |
55 |
| - auto_select_repository = true |
56 |
| - source_data_id = "DATASOURCE_ID" |
57 |
| -} |
58 |
| -``` |
59 |
| - |
60 |
| -### Example Global Parameter Reference |
61 |
| - |
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`. |
66 |
| - |
67 |
| -Consult the documentation's Resources section for details on individual resources, such as VDB, dSource, and Environment. |
68 |
| - |
69 |
| -## Support Matrix |
70 |
| - |
71 |
| -Feature/Product | Provider Version | DCT version |
72 |
| ---- |------------------| --- | |
73 |
| -delphix_vdb | v 1.0.0 | v 2.0.0 |
74 |
| -delphix_vdb_group | v 1.0.0 | v 2.0.0 |
75 |
| -delphix_environment | v 1.0.0 | v 2.0.0 |
76 |
| -delphix_appdata_dsource | v 2.1.0 | v 10.0.0 |
77 |
| -delphix_oracle_dsource | v 3.1.0 | v 10.0.0 |
78 |
| -delphix_database_postgresql | v 3.2.0 | v 14.0.0 |
79 |
| -delphix_vdb update<br>delphix_database_postgresql import | v 3.3.0 | v 22.0.0 |
80 |
| - |
| 1 | +# <provider> Delphix Provider |
| 2 | + |
| 3 | +The [Terraform Provider for Delphix](https://help.delphix.com/eh/current/content/terraform.htm) enables you to natively manage data-as-code along with your infrastructure. |
| 4 | + |
| 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. |
| 6 | + |
| 7 | +The Delphix 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. |
| 8 | + |
| 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/). Please [submit a GitHub issue](https://github.com/delphix-integrations/terraform-provider-delphix/issues) if you have any questions. |
| 10 | + |
| 11 | +If you are a DCT customer, you can also request support from the [Delphix Support Portal](https://support.delphix.com/). |
| 12 | + |
| 13 | +## System Requirements |
| 14 | + |
| 15 | +| Product | Version | |
| 16 | +|--------------------------------|----------| |
| 17 | +| Data Control Tower (DCT) | v2025.1.2+ | |
| 18 | +| Delphix Continuous Data Engine | v29.0.0.0+ | |
| 19 | + |
| 20 | +Note: The DCT and Continuous Data versions 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 release notes can be found in the [Delphix Ecosystem Documentation](https://help.delphix.com/eh/current/Content/Ecoystem/Release_notes__Terraform_.htm). |
| 25 | + |
| 26 | +## Connectivity and Authentication |
| 27 | + |
| 28 | +All communication is performed through HTTPS. The Delphix Provider uses DCT APIs to communicate with Delphix Continuous Data Engines. |
| 29 | + |
| 30 | +Authentication with DCT APIs is managed using API Keys. For generation of an API key, please refer to [DCT API Keys](https://dct.delphix.com/docs/latest/api-keys). For example: `apk 2.12345...` |
| 31 | + |
| 32 | +## Example Usage |
| 33 | + |
| 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 | + |
| 36 | +```hcl |
| 37 | +
|
| 38 | +# Install the Delphix Provider |
| 39 | +terraform { |
| 40 | + required_providers { |
| 41 | + delphix = { |
| 42 | + source = "delphix-integrations/delphix" |
| 43 | + version = "3.4.0" |
| 44 | + } |
| 45 | + } |
| 46 | +} |
| 47 | + |
| 48 | +# Connect the Delphix Provider to DCT |
| 49 | +provider "delphix" { |
| 50 | + host = "<insert_dct_hostname>" |
| 51 | + key = "<insert_dct_api_key>" |
| 52 | + tls_insecure_skip = false |
| 53 | +} |
| 54 | + |
| 55 | +# Provision a VDB with the latest snapshot of data source |
| 56 | +resource "delphix_vdb" "vdb_name" { |
| 57 | + auto_select_repository = true |
| 58 | + source_data_id = "<insert datasource_id>" |
| 59 | +} |
| 60 | +``` |
| 61 | + |
| 62 | +### Example Global Parameter Reference |
| 63 | + |
| 64 | +* __host__: The hostname for DCT. |
| 65 | +* __key__: The API Key which is used to authenticate with DCT. (Example `apk 2.abc123...`). |
| 66 | +* __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. |
| 67 | +* __host_scheme__: (Optional) Determines the configured host URL's scheme. The default value is `https`. |
| 68 | + |
| 69 | +Consult the Resources section for details on individual resources, such as VDB, dSource, and Environment. |
| 70 | + |
| 71 | +## Support Matrix |
| 72 | + |
| 73 | +| Feature | Provider Version | DCT Version | |
| 74 | +|---------------------------------------------|------------------|-------------| |
| 75 | +| delphix_vdb | v 1.0.0 | v 2.0.0 | |
| 76 | +| delphix_vdb_group | v 1.0.0 | v 2.0.0 | |
| 77 | +| delphix_environment | v 1.0.0 | v 2.0.0 | |
| 78 | +| delphix_appdata_dsource | v 2.1.0 | v 10.0.0 | |
| 79 | +| delphix_oracle_dsource | v 3.1.0 | v 10.0.0 | |
| 80 | +| delphix_database_postgresql | v 3.2.0 | v 14.0.0 | |
| 81 | +| delphix_vdb update<br>delphix_database_postgresql import | v 3.3.0 | v 22.0.0 | |
| 82 | +| delphix_oracle_dsource update<br>delphix_oracle_dsource import | v 3.4.0 | v 2025.1.2 | |
0 commit comments