Skip to content

Commit 691215e

Browse files
author
Uddipaan Hazarika
committed
hashicorp docs changes
1 parent 6d4efa8 commit 691215e

File tree

13 files changed

+120
-112
lines changed

13 files changed

+120
-112
lines changed

docs/resources/vdb.md

Lines changed: 44 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,11 @@ resource "delphix_vdb" "vdb_name2" {
2525
timestamp = "2021-05-01T08:51:34.148000+00:00"
2626
2727
post_refresh {
28-
name = "HOOK_NAME"
29-
command = "COMMAND"
28+
command = "COMMAND"
29+
element_id = "ELEMENT_ID"
30+
has_credentials = false
31+
name = "NAME"
32+
shell = "SHELL"
3033
}
3134
}
3235
@@ -47,21 +50,26 @@ resource "delphix_vdb" "vdb_name" {
4750
source_data_id = "DATASOURCE_ID"
4851
4952
pre_refresh {
50-
name = "HOOK_NAME"
51-
command = "COMMAND"
53+
command = "COMMAND"
54+
element_id = "ELEMENT_ID"
55+
has_credentials = false
56+
name = "NAME"
57+
shell = "SHELL"
5258
}
5359
}
5460
```
5561

5662
## Argument Reference
5763

64+
* `provision_type` - (Optional) The type of provisioning to be carried out. Defaults to snapshot. Valid values are `[snapshot, bookmark, timestamp]`
65+
5866
* `source_data_id` - (Optional) The ID or name of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source.
5967

6068
* `engine_id` - (Optional) The ID or name of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored.
6169

6270
* `target_group_id` - (Optional) The ID of the group into which the VDB will be provisioned. If unset, a group is selected randomly on the Engine.
6371

64-
* `name` - (Optional) The unique name of the provisioned VDB within a group. If unset, a name is randomly generated.
72+
* `name` - (Optional) [Updatable] The unique name of the provisioned VDB within a group. If unset, a name is randomly generated.
6573

6674
* `database_name` - (Optional) The name of the database on the target environment. Defaults to name.
6775

@@ -87,14 +95,14 @@ resource "delphix_vdb" "vdb_name" {
8795

8896
* `auto_select_repository` - (Optional) Option to automatically select a compatible environment and repository. Mutually exclusive with repository_id.
8997

90-
* `pre_refresh` - (Optional) The commands to execute on the target environment before refreshing the VDB. This is a map of 5 parameters:
98+
* `pre_refresh` - (Optional) [Updatable] The commands to execute on the target environment before refreshing the VDB. This is a map of 5 parameters:
9199
* `name` - Name of the hook
92100
* `command` - (Required)Command to be executed
93101
* `shell` - Type of shell. Valid values are `[bash, shell, expect, ps, psd]`
94102
* `element_id` - Element ID for the hook
95103
* `has_credentials` - Flag to indicate if it has credentials
96104

97-
* `post_refresh` - (Optional) The commands to execute on the target environment after refreshing the VDB. This is a map of 5 parameters:
105+
* `post_refresh` - (Optional) [Updatable] The commands to execute on the target environment after refreshing the VDB. This is a map of 5 parameters:
98106
* `name` - Name of the hook
99107
* `command` - (Required)Command to be executed
100108
* `shell` - Type of shell. Valid values are `[bash, shell, expect, ps, psd]`
@@ -122,40 +130,40 @@ resource "delphix_vdb" "vdb_name" {
122130
* `element_id` - Element ID for the hook
123131
* `has_credentials` - Flag to indicate if it has credentials
124132

125-
* `pre_snapshot` - (Optional) The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting. This is a map of 5 parameters:
133+
* `pre_snapshot` - (Optional) [Updatable] The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting. This is a map of 5 parameters:
126134
* `name` - Name of the hook
127135
* `command` - (Required)Command to be executed
128136
* `shell` - Type of shell. Valid values are `[bash, shell, expect, ps, psd]`
129137
* `element_id` - Element ID for the hook
130138
* `has_credentials` - Flag to indicate if it has credentials
131139

132-
* `post_snapshot` - (Optional) The commands to execute on the target environment after snapshotting a virtual source. This is a map of 5 parameters:
140+
* `post_snapshot` - (Optional) [Updatable] The commands to execute on the target environment after snapshotting a virtual source. This is a map of 5 parameters:
133141
* `name` - Name of the hook
134142
* `command` - (Required)Command to be executed
135143
* `shell` - Type of shell. Valid values are `[bash, shell, expect, ps, psd]`
136144
* `element_id` - Element ID for the hook
137145
* `has_credentials` - Flag to indicate if it has credentials
138146

139-
* `pre_start` - (Optional) The commands to execute on the target environment before starting a virtual source. This is a map of 5 parameters:
147+
* `pre_start` - (Optional) [Updatable] The commands to execute on the target environment before starting a virtual source. This is a map of 5 parameters:
140148
* `name` - Name of the hook
141149
* `command` - (Required)Command to be executed
142150
* `shell` - Type of shell. Valid values are `[bash, shell, expect, ps, psd]`
143151

144-
* `post_start` - (Optional) The commands to execute on the target environment after starting a virtual source. This is a map of 5 parameters:
152+
* `post_start` - (Optional) [Updatable] The commands to execute on the target environment after starting a virtual source. This is a map of 5 parameters:
145153
* `name` - Name of the hook
146154
* `command` - (Required)Command to be executed
147155
* `shell` - Type of shell. Valid values are `[bash, shell, expect, ps, psd]`
148156
* `element_id` - Element ID for the hook
149157
* `has_credentials` - Flag to indicate if it has credentials
150158

151-
* `pre_stop` - (Optional) The commands to execute on the target environment before stopping a virtual source. This is a map of 5 parameters:
159+
* `pre_stop` - (Optional) [Updatable] The commands to execute on the target environment before stopping a virtual source. This is a map of 5 parameters:
152160
* `name` - Name of the hook
153161
* `command` - (Required)Command to be executed
154162
* `shell` - Type of shell. Valid values are `[bash, shell, expect, ps, psd]`
155163
* `element_id` - Element ID for the hook
156164
* `has_credentials` - Flag to indicate if it has credentials
157165

158-
* `post_stop` - (Optional) The commands to execute on the target environment after stopping a virtual source. This is a map of 5 parameters:
166+
* `post_stop` - (Optional) [Updatable] The commands to execute on the target environment after stopping a virtual source. This is a map of 5 parameters:
159167
* `name` - Name of the hook
160168
* `command` - (Required)Command to be executed
161169
* `shell` - Type of shell. Valid values are `[bash, shell, expect, ps, psd]`
@@ -178,7 +186,7 @@ resource "delphix_vdb" "vdb_name" {
178186

179187
* `vcdb_database_name` - (Optional) When provisioning an Oracle Multitenant vCDB (when the cdb_id property is not set), the database name of the provisioned vCDB. Defaults to the value of the vcdb_name property. (Oracle Multitenant Only).
180188

181-
* `mount_point` - (Optional) Mount point for the VDB (Oracle, ASE Only).
189+
* `mount_point` - (Optional) [Updatable] Mount point for the VDB (Oracle, ASE Only).
182190

183191
* `open_reset_logs` - (Optional) Whether to open the database after provision (Oracle Only).
184192

@@ -226,30 +234,30 @@ Environment variable to be set when the engine creates a VDB. See the Engine doc
226234

227235
* `make_current_account_owner` - (Optional) Whether the account provisioning this VDB must be configured as owner of the VDB.
228236

229-
* `config_params` - (Optional) Database configuration parameter overrides
237+
* `config_params` - (Optional) [Updatable] Database configuration parameter overrides
230238

231-
* `appdata_source_params` - The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.
239+
* `appdata_source_params` - [Updatable] The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated.
232240

233-
* `appdata_config_params` - (Optional) The list of parameters specified by the source config schema in the toolkit
241+
* `instance_name` - (Optional) The instance name name of this single instance VDB
234242

235-
* `additional_mount_points` - (Optional) Specifies additional locations on which to mount a subdirectory of an AppData container
243+
* `additional_mount_points` - (Optional) [Updatable] Specifies additional locations on which to mount a subdirectory of an AppData container
236244
* `shared_path` - (Required) Relative path within the container of the directory that should be mounted.
237-
* `mount_path` - (Required) Absolute path on the target environment were the filesystem should be mounted
238-
* `environment_id` - (Required) The entity ID of the environment on which the file system will be mounted.
245+
* `mount_path` - (Optional) Absolute path on the target environment were the filesystem should be mounted
246+
* `environment_id` - (Optional) The entity ID of the environment on which the file system will be mounted.
239247

240248
* `vcdb_tde_key_identifier` - (Optional) ID of the key created by Delphix. (Oracle Multitenant Only)
241249

242-
* `cdb_tde_keystore_password` - (Optional) The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)
250+
* `cdb_tde_keystore_password` - (Optional) [Updatable] The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)
243251

244-
* `target_vcdb_tde_keystore_path` - (Optional) Path to the keystore of the target vCDB. (Oracle Multitenant Only)
252+
* `target_vcdb_tde_keystore_path` - (Optional) [Updatable] Path to the keystore of the target vCDB. (Oracle Multitenant Only)
245253

246-
* `tde_key_identifier` - (Optional) ID of the key created by Delphix. (Oracle Multitenant Only)
254+
* `tde_key_identifier` - (Optional) [Updatable] ID of the key created by Delphix. (Oracle Multitenant Only)
247255

248256
* `tde_exported_key_file_secret` - (Optional) Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only)
249257

250-
* `parent_tde_keystore_password` - (Optional) The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)
258+
* `parent_tde_keystore_password` - (Optional) [Updatable] The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)
251259

252-
* `parent_tde_keystore_path` - (Optional) Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)
260+
* `parent_tde_keystore_path` - (Optional) [Updatable] Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)
253261

254262
* `oracle_rac_custom_env_vars` - (Optional) Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
255263
* `node_id` - (Required) The node id of the cluster.
@@ -286,3 +294,14 @@ Environment variable to be set when the engine creates a VDB. See the Engine doc
286294
* `tags` - A list of key value pair.
287295

288296
* `creation_date` - The date this VDB was created.
297+
298+
## Import
299+
300+
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import VDBs using the word `delphix_vdb`. For example:
301+
302+
```terraform
303+
import {
304+
to = delphix_vdb.vdb_import_demo
305+
id = "vdb_id"
306+
}
307+
```

examples/vdb/hana/bookmark/main.tf

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,6 @@ resource "delphix_vdb" "example" {
4848
tSystemUserName = "<USERNAME>"
4949
tSystemUserPassword ="<PASSWORD>"
5050
})
51-
config_params jsonencode({
52-
processes = 150
53-
})
54-
appdata_config_params jsonencode({
55-
param = "value"
56-
})
5751
additional_mount_points = [{
5852
shared_path = "/",
5953
mount_path = "/work",

examples/vdb/hana/snapshot/main.tf

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,6 @@ resource "delphix_vdb" "example" {
4949
tSystemUserName = "<USERNAME>"
5050
tSystemUserPassword ="<PASSWORD>"
5151
})
52-
config_params jsonencode({
53-
processes = 150
54-
})
55-
appdata_config_params jsonencode({
56-
param = "value"
57-
})
5852
additional_mount_points = [{
5953
shared_path = "/",
6054
mount_path = "/work",

examples/vdb/hana/timestamp/main.tf

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,6 @@ resource "delphix_vdb" "example" {
5050
tSystemUserName = "<USERNAME>"
5151
tSystemUserPassword ="<PASSWORD>"
5252
})
53-
config_params jsonencode({
54-
processes = 150
55-
})
56-
appdata_config_params jsonencode({
57-
param = "value"
58-
})
5953
additional_mount_points = [{
6054
shared_path = "/",
6155
mount_path = "/work",

examples/vdb/mysql/snapshot/main.tf

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,7 @@ resource "delphix_vdb" "example" {
4646
vdbPass: XXXX,
4747
vdbUser: XXXX
4848
})
49-
config_params = jsonencode({
50-
processes = 150
51-
})
52-
appdata_config_params = jsonencode({
53-
param = "value"
54-
})
49+
5550
additional_mount_points = [{
5651
shared_path = "/",
5752
mount_path = "/work",

examples/vdb/oracle/bookmark/main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ resource "delphix_vdb" "example" {
4545
new_dbid = true
4646
cluster_node_ids = ["ORACLE_CLUSTER_NODE-ID"]
4747
auxiliary_template_id = "aux-template-1"
48-
oracle_instance_name = "dbdhcp2"
48+
instance_name = "dbdhcp2"
4949
retention_policy_id = "test_retention_policy"
5050
template_id = "template-1"
5151
repository_id = ""

examples/vdb/oracle/snapshot/main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ resource "delphix_vdb" "example" {
4646
auxiliary_template_id = "aux-template-1"
4747
database_name = "dbname_to_be_created"
4848
mount_point = "/var/mnt"
49-
oracle_instance_name = "dbdhcp2"
49+
instance_name = "dbdhcp2"
5050
retention_policy_id = "test_retention_policy"
5151
template_id = "template-1"
5252
cdb_id = ""

examples/vdb/oracle/timestamp/main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ resource "delphix_vdb" "example" {
4646
file_mapping_rules = "/datafile/dbdhcp3/oradata/dbdhcp3:/data\n/u03/app/ora11202/product/11.2.0/dbhome_1/dbs/dbv_R2V4.dbf:/data/dbv_R2V4.dbf"
4747
new_dbid = true
4848
auxiliary_template_id = "aux-template-1"
49-
oracle_instance_name = "dbdhcp2"
49+
instance_name = "dbdhcp2"
5050
retention_policy_id = "test_retention_policy"
5151
template_id = "template-1"
5252
listener_ids = ["id"]

examples/vdb/postgresql/bookmark/main.tf

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,6 @@ resource "delphix_vdb" "example" {
4141
postgresPort = 5434
4242
configSettingsStg = [{ propertyName: "timezone", value:"GMT", commentProperty:false}]
4343
})
44-
config_params jsonencode({
45-
processes = 150
46-
})
47-
appdata_config_params jsonencode({
48-
param = "value"
49-
})
5044
additional_mount_points = [{
5145
shared_path = "/",
5246
mount_path = "/work",

examples/vdb/postgresql/snapshot/main.tf

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,6 @@ resource "delphix_vdb" "example" {
4242
postgresPort = 5434
4343
configSettingsStg = [{ propertyName: "timezone", value:"GMT", commentProperty:false}]
4444
})
45-
config_params = jsonencode({
46-
processes = 150
47-
})
48-
appdata_config_params = jsonencode({
49-
param = "value"
50-
})
5145
additional_mount_points = [{
5246
shared_path = "/",
5347
mount_path = "/work",

0 commit comments

Comments
 (0)