Skip to content

Commit 7953bc7

Browse files
CarolynRountreeCarolynRountree
authored
Add parameter tables to 2.0 documentation (#1062)
* Add parameter tables to 2.0 documentation * fix for comments. standardize where necessary * quotes around parameters in table * Update DomainInfo.json
1 parent 220f4c3 commit 7953bc7

File tree

12 files changed

+149
-4
lines changed

12 files changed

+149
-4
lines changed

‎documentation/2.0/content/userguide/tools/compare.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,10 +285,17 @@ Comparing the new and old models:
285285

286286
To compare the two model files and generate the output to files, run the tool as follows:
287287

288-
$ weblogic-deploy\bin\compareModel.cmd -oracle_home c:\wls12213 -output_dir c:\cm-output ew_model.yaml old_model.yaml
288+
$ weblogic-deploy\bin\compareModel.cmd -oracle_home c:\wls12213 -output_dir c:\cm-output new_model.yaml old_model.yaml
289289

290290
The following files will be written to the directory:
291291

292292
diffed_model.json
293293
diffed_model.yaml
294294
compare_model_stdout
295+
296+
### Parameter table for compareModel
297+
| Parameter | Definition | Default |
298+
| --- | --- | --- |
299+
| `-oracle_home` | Home directory of the Oracle installation. Required if ORACLE_HOME environment variable is not set. | |
300+
| `-output_dir` | (Required) Directory in which to store the output. | |
301+
| `-variable_file` | Variable file used for token substitution. | |

‎documentation/2.0/content/userguide/tools/create.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,24 @@ topology:
5858
AdminServerName: "admin-server"
5959
ProductionModeEnabled: false
6060
```
61+
62+
### Parameter table for createDomain
63+
| Parameter | Definition | Default |
64+
| --- | --- | --- |
65+
| `-archive_file` | The path to the archive file to use. If the -model_file argument is not specified, the model file in this archive will be used. This can also be specified as a comma-separated list of archive files. The overlapping contents in each archive take precedence over previous archives in the list. | |
66+
| `-domain_home` | Required if -domain_parent is not used. The full directory and name where the domain should be created.
67+
| `-domain_parent` | Required if -domain_home is not used. The parent directory where the domain should be created. The name is the domain name in the model. | |
68+
| `-domain_type` | The type of domain (for example, WLS, JRF). | WLS |
69+
| `-java_home` | The Java Home to use for the new domain. If not specified, it defaults to the value of the JAVA_HOME environment variable. | |
70+
| `-model_file` | The location of the model file. This can also be specified as a comma-separated list of model locations, where each successive model layers on top of the previous ones. | |
71+
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if ORACLE_HOME environment variable is not set.| |
72+
| `-opss_wallet_passphrase_env` | An alternative to entering the OPSS wallet passphrase at a prompt. The value is an ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase. | |
73+
| `-opss_wallet_passphrase_file` | An alternative to entering the OPSS wallet passphrase at a prompt. The value is the name of a file with a string value which WDT will read to retrieve the passphrase.
74+
| `-passphrase_env` | An alternative to entering the encryption passphrase at a prompt. The value is an ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase. | |
75+
| `-passphrase_file` | An alternative to entering the encryption passphrase at a prompt. The value is the name of a file with a string value which WDT will read to retrieve the passphrase. | |
76+
| `-rcu_database` | The RCU database connect string. | |
77+
| `-rcu_prefix` | The RCU prefix to use. | |
78+
| `-rcu_db_user` | The RCU dbUser to use. | sys |
79+
| `-run_rcu` | Run RCU to create the database schemas specified by the domain type using the specified RCU prefix. Running RCU will drop any existing schemas with the same RCU prefix if they exist prior to trying to create them. | |
80+
| `-use_encryption` | One or more of the passwords in the model or variables file(s) are encrypted and must be decrypted. Java 8 or later required for this feature. | |
81+
| `-variable_file` | The location of the property file containing the values for variables used in the model. This can also be specified as a comma-separated list of property files, where each successive set of properties layers on top of the previous ones. | |

‎documentation/2.0/content/userguide/tools/deploy.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,23 @@ If the model or variables file contains passwords encrypted with the WDT Encrypt
4141
### Using multiple models
4242

4343
The Deploy Applications Tool supports the use of multiple models, as described in [Using multiple models]({{< relref "/concepts/model#using-multiple-models" >}}).
44+
45+
### Parameter table for deployApps
46+
| Parameter | Definition | Default |
47+
| ---- | ---- | ---- |
48+
| `-admin_pass_env` | An alternative to entering the admin password at a prompt. The value is an ENVIRONMENT VARIABLE name that WDT will use to retrieve the password. | |
49+
| `-admin_pass_file` | An alternative to entering the admin password at a prompt. The value is a the name of a file that contains a password string that the tool will read to retrieve the password. | |
50+
| `-admin_url` | The admin server URL used for online deploy. | |
51+
| `-admin_user` | The admin username used for online deploy. | |
52+
| `-archive_file` | The path to the archive file. If the model_file argument is not used, the model file in this file will be used. This can also be specified as a comma-separated list of archive files. The overlapping contents in each archive take precedence over previous archives in the list. | |
53+
| `-cancel_changes_if_restart_required` | Cancel the changes if the update requires domain restart. | |
54+
| `-discard_current_edit` | Discard all current domain edits before starting update. | |
55+
| `-domain_home` | (Required). The location of the existing domain home. | |
56+
| `-domain_type` | The type of domain. (for example, WLS, JRF) | WLS |
57+
| `-model_file` | The location of the model file. This can also be specified as a comma-separated list of model locations, where each successive model layers on top of the previous ones. | |
58+
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if ORACLE_HOME environment variable is not set.| |
59+
| `-output_dir` | If present, write restart information to this directory as restart.file, or, if cancel_changes_if_restart_required used, write non dynamic changes information to file. | |
60+
| `-passphrase_env` | An alternative to entering the encryption passphrase at a prompt. The value is an ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase. | |
61+
| `-passphrase_file` | An alternative to entering the encryption passphrase at a prompt. The value is the name of a file with a string value which WDT will read to retrieve the passphrase. | |
62+
| `-use_encryption` | One or more of the passwords in the model or variables file(s) are encrypted and must be decrypted. Java 8 or later required for this feature. | |
63+
| `-variable_file` | The location of the property file containing the values for variables used in the model. This can also be specified as a comma-separated list of property files, where each successive set of properties layers on top of the previous ones. | |

‎documentation/2.0/content/userguide/tools/discover.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,22 @@ The following environment variables may be set.
7676
### Opening an issue against Discover Domain
7777

7878
Please provide the `STDOUT` and `STDERR` log streams in the GitHub Issue. If the summary is not listed (unhandled exception stack trace occurs), be sure and include the Oracle and WDT install versions and whether the tool was run in online or offline WLST mode. If possible, provide the model, variable and archive files, and the log file, `discoverDomain.log`, from location `<install home>\weblogic-deploy\log`.
79+
80+
### Parameter table for discoverDomain
81+
| Parameter | Definition | Default |
82+
| ---- | ---- | ---- |
83+
| `-archive_file` | The path to the archive file. | |
84+
| `-admin_pass_env` | An alternative to entering the admin password at a prompt. The value is a ENVIRONMENT VARIABLE name that WDT will use to retrieve the password. | |
85+
| `-admin_pass_file` | An alternative to entering the admin password at a prompt. The value is a the name of a file that contains a password string that the tool will read to retrieve the password. | |
86+
| `-admin_url` | The admin server URL used for online discovery. | |
87+
| `-admin_user` | The admin user used for online discovery. | |
88+
| `-domain_home` | (Required). The location of the existing domain home. | |
89+
| `-domain_type` | The type of domain. (for example, WLS, JRF) | WLS |
90+
| `-java_home` | Overrides the JAVA_HOME value when discovering domain values to be replaced with the java home global token. | |
91+
| `-model_file` | The path to the model file. If not present, model file will be stored in archive file. | |
92+
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if ORACLE_HOME environment variable is not set. | |
93+
| `-output_dir` | Output directory required for -target. | |
94+
| `-skip_archive` | Do not generate an archive file. The archive_file option will be ignored. | |
95+
| `-target` | Targeting platform - k8s, wko, vz. | |
96+
| `-variable_file` | The location to write properties for attributes that have been replaced with tokens by the variable injector. If this is included, all credentials will automatically be replaced by tokens and the property written to this file. | |
97+

‎documentation/2.0/content/userguide/tools/encrypt.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,3 +219,13 @@ The variable file will now look something like the following:
219219
db.url=mydb.example.com:1539/PDBORCL
220220
db.password={AES}czFXMkNFWNG9jNTNYd0hRL2R1anBnb0hDUlp4K1liQWFBdVM4UTlvMnE0NU1aMUZ5UVhiK25oaWFBc2lIQ20\=
221221
mymailsession.password={AES}RW9nRnUzcE41WGNMdnEzNDdRQVVNWm1LMGhidkFBVXg6OUN3aXcyci82cmh3cnpNQTpmY2UycUp5YWl4UT0\=
222+
223+
### Parameter table for encrypt tool
224+
| Parameter | Definition | Default |
225+
| ---- | ---- | ---- |
226+
| `-manual` | Run without a model and get an encrypted value for a single password. | |
227+
| `-model_file` | The location of the model file or a set of model files. | |
228+
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if ORACLE_HOME environment variable is not set. | |
229+
| `-passphrase_env` | An alternative to entering the encryption passphrase at a prompt. The value is a ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase. | |
230+
| `-passphrase_file` | An alternative to entering the encryption passphrase at a prompt. The value is a the name of a file with a string value which WDT will read to retrieve the passphrase. | |
231+
| `-variable_file` | The location and name of the property file containing the variable values for all variables used in the model(s). | |

‎documentation/2.0/content/userguide/tools/kubernetes.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,13 @@ The [Model Help Tool]({{< relref "/userguide/tools/model_help.md" >}}) can be us
123123
```
124124

125125
The content in the `kubernetes` section is not generated when a model is discovered by the Discover Domain Tool.
126+
127+
### Parameter table for extractResources
128+
| Parameter | Definition | Default |
129+
| ---- | ---- | ---- |
130+
| `-archive_file` | The path to the archive file. If the -model_file argument is not specified, the model file in this archive will be used. This can also be specified as a comma-separated list of archive files. The overlapping contents in each archive take precedence over previous archives in the list. | |
131+
| `-domain_home` | (Required) The domain home directory. | |
132+
| `-domain_resource_file` | (Required) The location of the extracted domain resource file. | |
133+
| `-model_file` | The location of the model file. This can also be specified as a comma-separated list of model locations, where each successive model layers on top of the previous ones. | |
134+
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if ORACLE_HOME environment variable is not set. | |
135+
| `-variable_file` | The location of the property file containing the values for variables used in the model. This can also be specified as a comma-separated list of property files, where each successive set of properties layers on top of the previous ones. | |

‎documentation/2.0/content/userguide/tools/model_help.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,18 @@ resources:
120120
JDBCDataSourceParams:
121121
JDBCDriverParams:
122122
Properties:
123-
'Properties-1':
123+
'Properties-1'
124124
JDBCOracleParams:
125125
JDBCXAParams:
126126
SubDeployment:
127127
'SubDeployment-1':
128128
```
129+
130+
### Parameter table for model_help
131+
| Parameter | Definition | Default |
132+
| ---- | ---- | ---- |
133+
| `-attributes_only` | List only the attributes for the specified model path. | |
134+
| `-folders_only` | List only the folders for the specified model path. | |
135+
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if ORACLE_HOME environment variable is not set. | |
136+
| `-recursive` | List only the folders for the specified model path, and recursively include the folders below that path. | |
137+
| `<model_path>` | The path to the model element to be examined. The format is [^<section^>:][/^<folder^>]... | |

‎documentation/2.0/content/userguide/tools/prepare.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,13 @@ wko-domain.yaml
3737
You can then customize the `wko_variable.properties` and `create_k8s_secrets.sh` to provide environment-specific values.
3838

3939

40-
For more information about additional target environments and options, see [Target environments]({{< relref "/userguide/target_env.md" >}}).
40+
For more information about additional target environments and options, see [Target environments]({{< relref "/userguide/target_env.md" >}}).
41+
42+
### Parameter table for prepareModel
43+
| Parameter | Definition | Default |
44+
| ---- | ---- | ---- |
45+
| `-model_file` | (Required). Location of the model file. This can also be specified as a comma-separated list of models, where each successive model layers on top of the previous ones. | |
46+
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if ORACLE_HOME environment variable is not set. | |
47+
| `-output_dir` | (Required) Location where to write the output files. | |
48+
| `-target` | (Required) Name of the target configuration such as wko, vz, k8s. | |
49+
| `-variable_file` | The location of the property file containing the values for variables used in the model. This can also be specified as a comma-separated list of property files, where each successive set of properties layers on top of the previous ones. | |

‎documentation/2.0/content/userguide/tools/update.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,23 @@ If the model or variables file contains passwords encrypted with the WDT Encrypt
3737
### Using multiple models
3838

3939
The Update Domain Tool supports the use of multiple models, as described in [Using multiple models]({{< relref "/concepts/model#using-multiple-models" >}}).
40+
41+
### Parameter table for updateDomain
42+
| Parameter | Definition | Default |
43+
| ---- | ---- | ---- |
44+
| `-admin_pass_env` | An alternative to entering the admin password at a prompt. The value is a ENVIRONMENT VARIABLE name that WDT will use to retrieve the password. | |
45+
| `-admin_pass_file` | An alternative to entering the admin password at a prompt. The value is a the name of a file that contains a password string that the tool will read to retrieve the password. | |
46+
| `-admin_url` | The admin server URL for online update. | |
47+
| `-admin_user` | The admin username for online update. | |
48+
| `-archive_file` | The path to the archive file to use. If the -model_file argument is not specified, the model file in this archive will be used. This can also be specified as a comma-separated list of archive files. The overlapping contents in each archive take precedence over previous archives in the list. | |
49+
| `-cancel_changes_if_restart_required` | Cancel the changes if the update requires domain restart. | |
50+
| `-discard_current_edit` | Discard all existing domain edits before the update. | |
51+
| `-domain_home` | (Required) The location of the existing domain home. | |
52+
| `-domain_type` | The type of domain. (for example, WLS, JRF) | WLS |
53+
| `-model_file` | The location of the model file. This can also be specified as a comma-separated list of model locations, where each successive model layers on top of the previous ones. | |
54+
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if ORACLE_HOME environment variable is not set. | |
55+
| `-passphrase_env` | An alternative to entering the encryption passphrase at a prompt. The value is a ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase. | |
56+
| `-passphrase_file` | An alternative to entering the encryption passphrase at a prompt. The value is a the name of a file with a string value which WDT will read to retrieve the passphrase. | |
57+
| `-update_dir` | If present, write restart information to this directory as restart.file, or if cancel_changes_if_restart_required used, write non dynamic changes information to non_dynamic_changes file. | |
58+
| `-use_encryption` | One or more of the passwords in the model or variables file(s) are encrypted and must be decrypted. Java 8 or later required for this feature. | |
59+
| `-variable_home` | The location of the property file containing the values for variables used in the model. This can also be specified as a comma-separated list of property files, where each successive set of properties layers on top of the previous ones. | |

‎documentation/2.0/content/userguide/tools/validate.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,3 +99,14 @@ Results in output similar to that shown below, if the `simpleear.ear` file is no
9999
### Using multiple models
100100

101101
The Validate Model Tool supports the use of multiple models, as described in [Using multiple models]({{< relref "/concepts/model#using-multiple-models" >}}).
102+
103+
### Parameter table for validateModel
104+
| Parameter | Definition | Default |
105+
| ---- | ---- | ---- |
106+
| `-archive_file` | The path to the archive file to use. If the archive file is not provided, validation will only validate the artifacts provided. This can also be specified as a comma-separated list of archive files. The overlapping contents in each archive take precedence over previous archives in the list. | |
107+
| `-domain_type` | The type of domain. (for example, WLS, JRF) | WLS |
108+
| `-model_file` | The location of the model file to use. This can also be specified as a comma-separated list of model locations, where each successive model layers on top of the previous ones. If not specified, the tool will look for the model in the archive. If the model is not found, validation will only validate the artifacts provided. | |
109+
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if ORACLE_HOME environment variable is not set. | |
110+
| `-target_mode` | The target WLST mode that the tool should use to validate the model content. The only valid values are online or offline. | offline |
111+
| `-target_version` | The target version of WebLogic Server the tool should use to validate the model content. This version number can be different than the version being used to run the tool. | Oracle home version |
112+
| `-variable_file` | The location of the property file containing the variable values for all variables used in the model. If the variable file is not provided, validation will only validate the artifacts provided. | |

0 commit comments

Comments
 (0)