Skip to content

Commit 5cf2c95

Browse files
author
Uddipaan Hazarika
committed
minor doc fixes & cleanup
1 parent 8063cbd commit 5cf2c95

File tree

8 files changed

+26
-35
lines changed

8 files changed

+26
-35
lines changed

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ If you are a DCT customer, you can also request support from the [Delphix Suppor
1414

1515
| Product | Version |
1616
|--------------------------------|----------|
17-
| Data Control Tower (DCT) | v2025.1.2+ |
17+
| Data Control Tower (DCT) | v2025.2.0+ |
1818
| Delphix Continuous Data Engine | v29.0.0.0+ |
1919

2020
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.

docs/resources/appdata_dsource.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
11
# Resource: <resource name> delphix_appdata_dsource
22

33
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.
75
For Oracle, refer to the Oracle dSource resource. The Delphix Provider does not currently support SQL Server or SAP ASE.
86

97
## Note
108
* `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
1210
* 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.
1412
* 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.
1614
* 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.
1715

1816
## Example Usage
1917

2018
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.
2119

22-
# Link dSource using external backup.
20+
# Link dSource using external backup
2321

2422
```hcl
2523
resource "delphix_appdata_dsource" "pg_using_external_backup" {
@@ -49,7 +47,7 @@ resource "delphix_appdata_dsource" "pg_using_external_backup" {
4947
}
5048
```
5149

52-
# Link dSource using Delphix Initiated Backup.
50+
# Link dSource using Delphix Initiated Backup
5351

5452
```hcl
5553
resource "delphix_appdata_dsource" "pg_using_delphix_initiated_backup" {
@@ -81,7 +79,7 @@ resource "delphix_appdata_dsource" "pg_using_delphix_initiated_backup" {
8179
}
8280
```
8381

84-
# Link dSource using Single Database Ingestion.
82+
# Link dSource using Single Database Ingestion
8583

8684
```hcl
8785
resource "delphix_appdata_dsource" "pg_using_single_db_ingestion" {
@@ -125,7 +123,7 @@ resource "delphix_appdata_dsource" "pg_using_single_db_ingestion" {
125123
* `source_value` - (Required) ID or Name of the Source to link.
126124
* `description` - The notes/description for the dSource. [Updatable]
127125
* `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.
129127

130128
### Full Backup and Transactional Log requirements
131129
* `log_sync_enabled` - (Required) True if LogSync should run for this database.
@@ -141,7 +139,7 @@ resource "delphix_appdata_dsource" "pg_using_single_db_ingestion" {
141139
* `staging_mount_base` - The base mount point for the NFS mount on the staging environment.
142140
* `environment_user` - (Required) The OS user to use for linking. [Updatable]
143141
* `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]
145143
* `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]
146144
* `sync_parameters` - The JSON payload conforming to the snapshot parameters definition in a Continuous Data plugin.
147145
* `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
178176

179177
### Advanced
180178
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:
183181
* `key` - (Required) Key of the tag
184182
* `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 resource are 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.
186184

187185
## Import
188186
Use the import block to add Appdata dSources created directly in DCT into a Terraform state file.
@@ -196,4 +194,4 @@ import {
196194
```
197195

198196
## 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.

docs/resources/environment.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Environments can either be a source (where data comes from), staging (where data
55
Each environment has its own properties and information depending on the operating system, installation, purpose, etc.
66
The Delphix Environment resource allows Terraform to create, update, and delete Environments. This specifically enables the `apply`, `import`, and `destroy` Terraform commands.
77
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.
99

1010
## Example Usage
1111

@@ -79,24 +79,24 @@ resource "delphix_environment" "win_standalone" {
7979
* `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.
8080
* `is_cluster` - Whether the environment to be created is a cluster.
8181
* `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.
8585

8686
### Host Arguments
8787
* `hostname` - (Required) Host Name or IP Address of the host that being added to Delphix. [Updatable]
8888
* `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]
9090
* `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]
9292

9393
### General Authentication Arguments
9494
* `dsp_keystore_path` - DSP keystore path.
9595
* `dsp_keystore_password` - DSP keystore password.
9696
* `dsp_keystore_alias` - DSP keystore alias.
9797
* `dsp_truststore_path` - DSP truststore path.
9898
* `dsp_truststore_password` - DSP truststore password.
99-
* `use_engine_public_key` - Whether to use public key authentication.
99+
* `use_engine_public_key` - Indicates whether to use public key authentication.
100100

101101
### SQL Server Authentication Arguments
102102
* `username` - OS username to enable a connection from the engine. [Updatable]
@@ -107,7 +107,7 @@ resource "delphix_environment" "win_standalone" {
107107
* `hashicorp_vault_username_key` - Key for the username in the key-value store.
108108
* `hashicorp_vault_secret_key` - Key for the password in the key-value store.
109109
* `cyberark_vault_query_string` - Query to find a credential in the CyberArk vault.
110-
* `use_kerberos_authentication` - Whether to use Kerberos authentication.
110+
* `use_kerberos_authentication` - Indicates whether to use Kerberos authentication.
111111

112112
### SAP ASE (Sybase) Authentication Arguments
113113
* `ase_db_username` - Username for the SAP ASE database.
@@ -124,7 +124,7 @@ resource "delphix_environment" "win_standalone" {
124124
* `tags` - The tags to be created for this environment. This is a map of 2 parameters: [Updatable]
125125
* `key` - (Required) Key of the tag
126126
* `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 resource are 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.
128128

129129
## Import
130130
Use the import block to add Environments created directly in DCT into a Terraform state file.

docs/resources/oracle_dsource.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ The following arguments apply to all dSources but they are not often necessary f
116116
* `tags` - The tags to be created for dSource. This is a map of 2 parameters: [Updatable]
117117
* `key` - (Required) Key of the tag
118118
* `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.
119120

120121
### Hooks
121122
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.

docs/resources/vdb.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,7 @@ This is a map of two required parameters:
224224
* `key` - Key of the tag.
225225
* `value` - Value of the tag.
226226
* `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.
227228

228229
## Import
229230
Use the [`import` block](https://developer.hashicorp.com/terraform/language/import) to add VDBs created directly in DCT into a Terraform state file.

internal/provider/resource_database_postgresql.go

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,6 @@ func resourceSource() *schema.Resource {
124124
},
125125
},
126126
},
127-
DiffSuppressFunc: func(_, old, new string, d *schema.ResourceData) bool {
128-
if ignore, ok := d.GetOk("ignore_tag_changes"); ok && ignore.(bool) {
129-
return true
130-
}
131-
return false
132-
},
133127
},
134128
},
135129
Importer: &schema.ResourceImporter{

internal/provider/resource_environment.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ func resourceEnvironment() *schema.Resource {
162162
Optional: true,
163163
DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
164164
if old != new {
165-
tflog.Info(context.Background(), "updating ignore_tag_changes is not allowed. plan changes are suppressed")
165+
tflog.Info(context.Background(), "updating os_type is not allowed. plan changes are suppressed")
166166
}
167167
return d.Id() != ""
168168
},

internal/provider/resource_vdb.go

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1702,9 +1702,6 @@ func resourceVdbUpdate(ctx context.Context, d *schema.ResourceData, meta interfa
17021702
var updateFailure, destructiveUpdate bool = false, false
17031703
var nonUpdatableField []string
17041704

1705-
// var vdbs []dctapi.VDB
1706-
// var vdbDiags diag.Diagnostics
1707-
17081705
// if changedKeys contains non updatable field set a flag
17091706
for _, key := range changedKeys {
17101707
if !updatableVdbKeys[key] {

0 commit comments

Comments
 (0)