You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ If you are a DCT customer, you can also request support from the [Delphix Suppor
14
14
15
15
| Product | Version |
16
16
|--------------------------------|----------|
17
-
| Data Control Tower (DCT) | v2025.1.2+ |
17
+
| Data Control Tower (DCT) | v2025.2.0+ |
18
18
| Delphix Continuous Data Engine | v29.0.0.0+ |
19
19
20
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.
In Delphix terminology, a dSource is an internal, read-only database copy that the Delphix Continuous Data Engine uses to create and update virtual copies of your database.
4
-
A dSource is created and managed by the Delphix Continuous Data Engine and syncs with your chosen source database.
5
-
The AppData dSource resource allows Terraform to create, update, and delete AppData dSources. This specifically enables the `apply`, `import`, and `destroy` Terraform commands.
6
-
Updating existing dSource resource parameters via the `apply` command is supported for the parameters listed below.
4
+
A dSource is created and managed by the Delphix Continuous Data Engine and syncs with your chosen source database. The AppData dSource resource in Terraform allows you to create, update, delete and import AppData dSources. Updating existing dSource resource parameters via the apply command is supported for the parameters listed below.
7
5
For Oracle, refer to the Oracle dSource resource. The Delphix Provider does not currently support SQL Server or SAP ASE.
8
6
9
7
## Note
10
8
*`status` and `enabled` are computed values and are subject to change in the tfstate file based on the dSource state.
11
-
* Parameters `credentials_env_vars` within `ops_pre_sync` and `ops_post_sync` object blocks are not updatable. Any changes reflected on the state file do not reflect the actual value of the actual infrastructure.
9
+
* Parameters `credentials_env_vars` within `ops_pre_sync` and `ops_post_sync` object blocks are not updatable. Therefore, any changes made on a Terraform state file do not reflect the actual value of the actual infrastructure
12
10
* Sensitive values in `credentials_env_vars` are stored as plain text in the state file. We recommend following Terraform’s sensitive input variables documentation.
13
-
*`source_value` and `group_id` parameters cannot be updated after the initial resource creation. However, any differences detected in these parameters are suppressed from the Terraform plan to prevent unnecessary drift detection
11
+
*`source_value` and `group_id` parameters cannot be updated after the initial resource creation. However, any differences detected in these parameters are suppressed from the Terraform plan to prevent unnecessary drift detection.
14
12
* Only valid for DCT versions 2025.1 and earlier:
15
-
*`Make_current_account_owner`,`wait_time` and `skip_wait_for_snapshot_creation` are relevant only during the creation of dsource. Note, they can only be used once and are not applicable to updates.
13
+
*`Make_current_account_owner`,`wait_time` and `skip_wait_for_snapshot_creation` are applicable only during the creation of dsource. Note, these parameters are single-use and not applicable to updates.
16
14
* Any new dSource created post Version>=3.2.1 can set wait_time to wait for snapshot creation, dSources created prior to this version will not support this capability.
17
15
18
16
## Example Usage
19
17
20
18
The linking of a dSource can be configured through various ingestion approaches. Each configuration is customized to the connector and its supported options. The three PostgreSQL parameter sets below show different ingestion configuration examples.
*`source_value` - (Required) ID or Name of the Source to link.
126
124
*`description` - The notes/description for the dSource. [Updatable]
127
125
*`group_id` - (Required) ID of the dataset group where this dSource should belong to.
128
-
*`rollback_on_failure` - dSource linking operation when fails during SnapSync creates a tainted dSource on the engine. Setting this flag to true will remove the tainted dsource from state as well as engine. By default, it is set to false, where the tainted dsource is maintained on the terraform state.
126
+
*`rollback_on_failure` - When a dSource linking operation fails during SnapSync, it results in a tainted dsource on the engine. By setting this flag to true, the tainted dSource will be removed from both the Terraform state and the engine. By default, the flag is to false, meaning the tainted dSource is maintained on the Terraform state.
129
127
130
128
### Full Backup and Transactional Log requirements
131
129
*`log_sync_enabled` - (Required) True if LogSync should run for this database.
*`staging_mount_base` - The base mount point for the NFS mount on the staging environment.
142
140
*`environment_user` - (Required) The OS user to use for linking. [Updatable]
143
141
*`staging_environment` - (Required) The environment used as an intermediate stage to pull data into Delphix. [Updatable]
144
-
*`staging_environment_user` - The environment user used to access the staging environment. [Updatable]
142
+
*`staging_environment_user` - Specifies the environment user that accesses the staging environment. [Updatable]
145
143
*`parameters` - The JSON payload is based on the type of dSource being created. Different data sources require different parameters. Available parameters can be found within the data connector’s schema.json. [Updatable]
146
144
*`sync_parameters` - The JSON payload conforming to the snapshot parameters definition in a Continuous Data plugin.
147
145
*`sync_policy_id` - The ID of the SnapSync policy for the dSource. [Updatable]
@@ -178,11 +176,11 @@ The following arguments enable the user to control how the first ingestion and s
178
176
179
177
### Advanced
180
178
The following arguments apply to all dSources but they are not often necessary for simple sources.
181
-
*`make_current_account_owner` - (Required) True/False. Whether the account creating this reporting schedule must be configured as owner of the reporting schedule.
182
-
*`tags` - The tags to be created for dSource. This is a map of 2 parameters:
179
+
*`make_current_account_owner` - (Required) True/False. Indicates whether the account creating this reporting schedule must be configured as owner of the reporting schedule.
180
+
*`tags` - The tags to be created for dSource. This is a map of two parameters:
183
181
*`key` - (Required) Key of the tag
184
182
*`value` - (Required) Value of the tag
185
-
*`ignore_tag_changes` – This flag enables whether changes in the tags are identified by terraform. By default, it is true, i.e, changes in tags of the resourceare ignored.
183
+
*`ignore_tag_changes` – This flag enables whether changes in the tags are identified by Terraform. By default, this is set to true, meaning changes to the resource's tags are ignored.
186
184
187
185
## Import
188
186
Use the import block to add Appdata dSources created directly in DCT into a Terraform state file.
@@ -196,4 +194,4 @@ import {
196
194
```
197
195
198
196
## Limitations
199
-
Not all properties are supported through the update command. Properties that are not supported by the update command are presented via an error message at runtime.
197
+
Not all properties can be updated using the update command. Attempts to update an unsupported property will return a runtime error message.
Copy file name to clipboardExpand all lines: docs/resources/environment.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ Environments can either be a source (where data comes from), staging (where data
5
5
Each environment has its own properties and information depending on the operating system, installation, purpose, etc.
6
6
The Delphix Environment resource allows Terraform to create, update, and delete Environments. This specifically enables the `apply`, `import`, and `destroy` Terraform commands.
7
7
Updating existing Delphix Environment resource parameters via the `apply` command is supported for the parameters specified below.
8
-
Note: In DCT, these are called Infrastructure Connections.
8
+
Note: In DCT, Environment are frequently referred to as Infrastructure Connections.
*`engine_id` - (Required) The DCT ID of the Engine on which to create the environment. This ID can be obtained by querying the DCT engines API. A Delphix Engine must be registered with DCT first for it to create an Engine ID.
80
80
*`is_cluster` - Whether the environment to be created is a cluster.
81
81
*`cluster_home` - Absolute path to cluster home directory. This parameter is (Required) for UNIX cluster environments. [Updatable]
82
-
*`staging_environment` - Id of the environment where Delphix (Windows) Connector is installed. This is a required parameter when creating Windows source environments.
83
-
*`connector_port` - Specify port on which Delphix connector will run. This is a (Required) parameter when creating Windows target environments. [Updatable]
84
-
*`is_target` - Whether the environment to be created is a target cluster environment. This property is used only when creating Windows cluster environments.
82
+
*`staging_environment` - ID of the environment where Delphix (Windows) Connector is installed. This is a required parameter when creating Windows source environments.
83
+
*`connector_port` - The port on which Delphix connector will run. This is a (Required) parameter when creating Windows target environments. [Updatable]
84
+
*`is_target` - Indicates whether the environment to be created is a target cluster environment. This property is used only when creating Windows cluster environments.
85
85
86
86
### Host Arguments
87
87
*`hostname` - (Required) Host Name or IP Address of the host that being added to Delphix. [Updatable]
88
88
*`ssh_port` - ssh port of the environment. [Updatable]
89
-
*`toolkit_path` - The path where Delphix toolkit can be pushed. [Updatable]
89
+
*`toolkit_path` - The path where Delphix Toolkit can be pushed. [Updatable]
90
90
*`java_home` - The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used. [Updatable]
91
-
*`nfs_addresses` - Array of ip address or hostnames. Valid values are a list of addresses. For eg: ["192.168.10.2"][Updatable]
91
+
*`nfs_addresses` - Array of IP address or hostnames. Valid values are a list of addresses. For eg: ["192.168.10.2"][Updatable]
*`tags` - The tags to be created for this environment. This is a map of 2 parameters: [Updatable]
125
125
*`key` - (Required) Key of the tag
126
126
*`value` - (Required) Value of the tag
127
-
*`ignore_tag_changes` – This flag enables whether changes in the tags are identified by terraform. By default, it is true, i.e, changes in tags of the resourceare ignored.
127
+
*`ignore_tag_changes` – This flag enables whether changes in the tags are identified by Terraform. By default, this is set to true, meaning changes to the resource's tags are ignored.
128
128
129
129
## Import
130
130
Use the import block to add Environments created directly in DCT into a Terraform state file.
Copy file name to clipboardExpand all lines: docs/resources/oracle_dsource.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -116,6 +116,7 @@ The following arguments apply to all dSources but they are not often necessary f
116
116
*`tags` - The tags to be created for dSource. This is a map of 2 parameters: [Updatable]
117
117
*`key` - (Required) Key of the tag
118
118
*`value` - (Required) Value of the tag
119
+
*`ignore_tag_changes` – This flag enables whether changes in the tags are identified by Terraform. By default, this is set to true, meaning changes to the resource's tags are ignored.
119
120
120
121
### Hooks
121
122
Any combination of the following hooks can be provided on the Oracle dSource resource. The available arguments are identical for each hook and are consolidated in a single list to save space.
Copy file name to clipboardExpand all lines: docs/resources/vdb.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -224,6 +224,7 @@ This is a map of two required parameters:
224
224
* `key` - Key of the tag.
225
225
* `value` - Value of the tag.
226
226
*`make_current_account_owner` - Default True. Boolean to determine if the account provisioning this VDB will be the "Owner" of the VDB.
227
+
*`ignore_tag_changes` – This flag enables whether changes in the tags are identified by Terraform. By default, this is set to true, meaning changes to the resource's tags are ignored.
227
228
228
229
## Import
229
230
Use the [`import` block](https://developer.hashicorp.com/terraform/language/import) to add VDBs created directly in DCT into a Terraform state file.
0 commit comments