Skip to content

Commit b3b1f78

Browse files
author
Uddipaan Hazarika
committed
doc changes added
1 parent fbe7c98 commit b3b1f78

File tree

6 files changed

+224
-231
lines changed

6 files changed

+224
-231
lines changed

‎docs/resources/appdata_dsource.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ The following arguments apply to all dSources but they are not often necessary f
184184
* `value` - (Required) Value of the tag
185185
* `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.
186186

187-
## Import (Beta)
187+
## Import
188188
Use the import block to add Appdata dSources created directly in DCT into a Terraform state file.
189189

190190
For example:
@@ -195,7 +195,5 @@ import {
195195
}
196196
```
197197

198-
This is a beta feature. Delphix offers no guarantees of support or compatibility.
199-
200198
## Limitations
201199
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.

‎docs/resources/database_postgresql.md‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -24,45 +24,25 @@ resource "delphix_database_postgresql" "source" {
2424
## Argument Reference
2525

2626
* `name` - (Required) The name of the new source.
27-
2827
* `repository_value` - (Required) The Id or Name of the Repository onto which the source will be created..
29-
3028
* `environment_value` - The Id or Name of the environment to create the source on.
31-
3229
* `engine_value` - The Id or Name of the engine to create the source on.
33-
3430
* `id` - The Source object entity ID.
35-
3631
* `database_type` - The type of this source database.
37-
3832
* `namespace_id` - The namespace id of this source database.
39-
4033
* `namespace_name` - The namespace name of this source database.
41-
4234
* `is_replica` - Is this a replicated object.
43-
4435
* `database_version` - The version of this source database.
45-
4636
* `data_uuid` - A universal ID that uniquely identifies this source database.
47-
4837
* `ip_address` - The IP address of the source's host.
49-
5038
* `fqdn` - The FQDN of the source's host.
51-
5239
* `size` - The total size of this source database, in bytes.
53-
5440
* `jdbc_connection_string` - The JDBC connection URL for this source database.
55-
5641
* `plugin_version` - The version of the plugin associated with this source database.
57-
5842
* `toolkit_id` - The ID of the toolkit associated with this source database(AppData only).
59-
6043
* `is_dsource` - Is this associated with dSource.
61-
6244
* `repository` - The repository id for this source.
63-
6445
* `appdata_source_type` - The type of this appdata source database (Appdata Only).
65-
6646
* `tags` - The tags to be created for database. This is a map of 2 parameters:
6747
* `key` - Key of the tag
6848
* `value` - Value of the tag

‎docs/resources/environment.md‎

Lines changed: 104 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,110 @@ resource "delphix_environment" "unix_env_name" {
3939
}
4040
```
4141

42+
### Creating a WINDOWS standalone target environment
43+
```hcl
44+
resource "delphix_environment" "win_tgt" {
45+
engine_id = 2
46+
os_type = "WINDOWS"
47+
name = "wintgt"
48+
description = "This is a windows target."
49+
username = "xxx"
50+
password = "xxx"
51+
hosts {
52+
hostname = "xxx"
53+
ssh_port = 22
54+
}
55+
connector_port = 9100
56+
}
57+
```
58+
### Creating a WINDOWS standalone source environment
59+
```hcl
60+
resource "delphix_environment" "win_standalone" {
61+
engine_id = 2
62+
os_type = "WINDOWS"
63+
name = "WindowsSrc"
64+
username = "xxx"
65+
password = "xxx"
66+
hosts {
67+
hostname = "db.host.com"
68+
}
69+
staging_environment = delphix_environment.wintgt.id
70+
}
71+
```
72+
73+
## Argument Reference
74+
75+
### General Linking Requirements
76+
* `name` - The name of the environment. [Updatable]
77+
* `description` - The environment description. [Updatable]
78+
* `os_type` - (Required) Operating system type of the environment. Valid values are [UNIX, WINDOWS]
79+
* `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+
* `is_cluster` - Whether the environment to be created is a cluster.
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.
85+
86+
### Host Arguments
87+
* `hostname` - (Required) Host Name or IP Address of the host that being added to Delphix. [Updatable]
88+
* `ssh_port` - ssh port of the environment. [Updatable]
89+
* `toolkit_path` - The path where Delphix toolkit can be pushed. [Updatable]
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]
92+
93+
### General Authentication Arguments
94+
* `dsp_keystore_path` - DSP keystore path.
95+
* `dsp_keystore_password` - DSP keystore password.
96+
* `dsp_keystore_alias` - DSP keystore alias.
97+
* `dsp_truststore_path` - DSP truststore path.
98+
* `dsp_truststore_password` - DSP truststore password.
99+
* `use_engine_public_key` - Whether to use public key authentication.
100+
101+
### SQL Server Authentication Arguments
102+
* `username` - OS username to enable a connection from the engine. [Updatable]
103+
* `password` - OS user's password. [Updatable]
104+
* `vault` - The name or reference of the vault from which to read the host credentials.
105+
* `hashicorp_vault_engine` – The Hashicorp Vault engine name where the credential is stored.
106+
* `hashicorp_vault_secret_path` - Path in the Hashicorp Vault engine where the credential is stored.
107+
* `hashicorp_vault_username_key` - Key for the username in the key-value store.
108+
* `hashicorp_vault_secret_key` - Key for the password in the key-value store.
109+
* `cyberark_vault_query_string` - Query to find a credential in the CyberArk vault.
110+
* `use_kerberos_authentication` - Whether to use Kerberos authentication.
111+
112+
### SAP ASE (Sybase) Authentication Arguments
113+
* `ase_db_username` - Username for the SAP ASE database.
114+
* `ase_db_password` - Password for the SAP ASE database.
115+
* `ase_db_vault` - The name or reference of the vault from which to read the SAP ASE database credentials.
116+
* `ase_db_hashicorp_vault_engine` – The Hashicorp Vault engine name where the credential is stored.
117+
* `ase_db_hashicorp_vault_secret_path` - Path in the Hashicorp Vault engine where the credential is stored.
118+
* `ase_db_hashicorp_vault_username_key` - Key for the username in the key-value store.
119+
* `ase_db_hashicorp_vault_secret_key` - Key for the password in the key-value store.
120+
* `ase_db_cyberark_vault_query_string` - Query to find a credential in the CyberArk vault.
121+
* `ase_db_use_kerberos_authentication` - Whether to use Kerberos authentication for SAP ASE DB discovery.
122+
123+
### Advanced Arguments
124+
* `tags` - The tags to be created for this environment. This is a map of 2 parameters: [Updatable]
125+
* `key` - (Required) Key of the tag
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 resource are ignored.
128+
129+
## Import
130+
Use the import block to add Environments created directly in DCT into a Terraform state file.
131+
132+
For example:
133+
```hcl
134+
import {
135+
to = delphix_environment.env_import_demo
136+
id = "env_id"
137+
}
138+
```
139+
140+
## Limitations
141+
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.
142+
143+
## Appendix
144+
Here are some additional examples:
145+
42146
### Create UNIX cluster
43147
```hcl
44148
resource "delphix_environment" "unix_cluster" {
@@ -93,38 +197,6 @@ resource "delphix_environment" "unix_with_ca_vault" {
93197
}
94198
```
95199

96-
### Creating a WINDOWS standalone target environment
97-
```hcl
98-
resource "delphix_environment" "win_tgt" {
99-
engine_id = 2
100-
os_type = "WINDOWS"
101-
name = "wintgt"
102-
description = "This is a windows target."
103-
username = "xxx"
104-
password = "xxx"
105-
hosts {
106-
hostname = "xxx"
107-
ssh_port = 22
108-
}
109-
connector_port = 9100
110-
}
111-
```
112-
113-
### Creating a WINDOWS standalone source environment
114-
```hcl
115-
resource "delphix_environment" "win_standalone" {
116-
engine_id = 2
117-
os_type = "WINDOWS"
118-
name = "WindowsSrc"
119-
username = "xxx"
120-
password = "xxx"
121-
hosts {
122-
hostname = "db.host.com"
123-
}
124-
staging_environment = delphix_environment.wintgt.id
125-
}
126-
```
127-
128200
### Creating a WINDOWS cluster source environment
129201
```hcl
130202
resource "delphix_environment" "winsrc_cluster" {
@@ -182,76 +254,3 @@ resource "delphix_environment" "win_fc_tgt_cluster" {
182254
is_cluster = true
183255
}
184256
```
185-
186-
## Argument Reference
187-
188-
### General Linking Requirements
189-
* `name` - The name of the environment. [Updatable]
190-
* `description` - The environment description. [Updatable]
191-
* `os_type` - (Required) Operating system type of the environment. Valid values are [UNIX, WINDOWS]
192-
* `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.
193-
* `is_cluster` - Whether the environment to be created is a cluster.
194-
* `cluster_home` - Absolute path to cluster home directory. This parameter is (Required) for UNIX cluster environments. [Updatable]
195-
* `staging_environment` - Id of the environment where Delphix (Windows) Connector is installed. This is a required parameter when creating Windows source environments.
196-
* `connector_port` - Specify port on which Delphix connector will run. This is a (Required) parameter when creating Windows target environments. [Updatable]
197-
* `is_target` - Whether the environment to be created is a target cluster environment. This property is used only when creating Windows cluster environments.
198-
199-
### Host Arguments
200-
* `hostname` - (Required) Host Name or IP Address of the host that being added to Delphix. [Updatable]
201-
* `ssh_port` - ssh port of the environment. [Updatable]
202-
* `toolkit_path` - The path where Delphix toolkit can be pushed. [Updatable]
203-
* `java_home` - The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used. [Updatable]
204-
* `nfs_addresses` - Array of ip address or hostnames. Valid values are a list of addresses. For eg: ["192.168.10.2"] [Updatable]
205-
206-
### General Authentication Arguments
207-
* `dsp_keystore_path` - DSP keystore path.
208-
* `dsp_keystore_password` - DSP keystore password.
209-
* `dsp_keystore_alias` - DSP keystore alias.
210-
* `dsp_truststore_path` - DSP truststore path.
211-
* `dsp_truststore_password` - DSP truststore password.
212-
* `use_engine_public_key` - Whether to use public key authentication.
213-
214-
### SQL Server Authentication Arguments
215-
* `username` - OS username to enable a connection from the engine. [Updatable]
216-
* `password` - OS user's password. [Updatable]
217-
* `vault` - The name or reference of the vault from which to read the host credentials.
218-
* `hashicorp_vault_engine` – The Hashicorp Vault engine name where the credential is stored.
219-
* `hashicorp_vault_secret_path` - Path in the Hashicorp Vault engine where the credential is stored.
220-
* `hashicorp_vault_username_key` - Key for the username in the key-value store.
221-
* `hashicorp_vault_secret_key` - Key for the password in the key-value store.
222-
* `cyberark_vault_query_string` - Query to find a credential in the CyberArk vault.
223-
* `use_kerberos_authentication` - Whether to use Kerberos authentication.
224-
225-
### SAP ASE (Sybase) Authentication Arguments
226-
* `ase_db_username` - Username for the SAP ASE database.
227-
* `ase_db_password` - Password for the SAP ASE database.
228-
* `ase_db_vault` - The name or reference of the vault from which to read the SAP ASE database credentials.
229-
* `ase_db_hashicorp_vault_engine` – The Hashicorp Vault engine name where the credential is stored.
230-
* `ase_db_hashicorp_vault_secret_path` - Path in the Hashicorp Vault engine where the credential is stored.
231-
* `ase_db_hashicorp_vault_username_key` - Key for the username in the key-value store.
232-
* `ase_db_hashicorp_vault_secret_key` - Key for the password in the key-value store.
233-
* `ase_db_cyberark_vault_query_string` - Query to find a credential in the CyberArk vault.
234-
* `ase_db_use_kerberos_authentication` - Whether to use Kerberos authentication for SAP ASE DB discovery.
235-
236-
### Advanced Arguments
237-
* `tags` - The tags to be created for this environment. This is a map of 2 parameters: [Updatable]
238-
* `key` - (Required) Key of the tag
239-
* `value` - (Required) Value of the tag
240-
* `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.
241-
242-
## Import (Beta)
243-
Use the import block to add Appdata dSources created directly in DCT into a Terraform state file.
244-
245-
For example:
246-
```hcl
247-
import {
248-
to = delphix_environment.env_import_demo
249-
id = "env_id"
250-
}
251-
```
252-
253-
This is a beta feature. Delphix offers no guarantees of support or compatibility.
254-
255-
## Limitations
256-
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.
257-

‎docs/resources/oracle_dsource.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Any combination of the following hooks can be provided on the Oracle dSource res
142142
* `azure_vault_secret_key` - Azure vault key in the key-value store.
143143
* `cyberark_vault_query_string` - Query to find a credential in the CyberArk vault.
144144

145-
## Import (Beta)
145+
## Import
146146
Use the [`import` block](https://developer.hashicorp.com/terraform/language/import) to add Oracle Dsources created directly in DCT into a Terraform state file.
147147

148148
For example:
@@ -152,7 +152,6 @@ import {
152152
id = "dsource_id"
153153
}
154154
```
155-
*This is a beta feature. Delphix offers no guarantees of support or compatibility.*
156155

157156
## Limitations
158157

‎docs/resources/vdb.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ This is a map of two required parameters:
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.
227227

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

231231
For example:
@@ -235,7 +235,6 @@ import {
235235
id = "vdb_id"
236236
}
237237
```
238-
*This is a beta feature. Delphix offers no guarantees of support or compatibility.*
239238

240239
## Limitations
241240

0 commit comments

Comments
 (0)