Skip to content

Commit 1ffd731

Browse files
adding -opss_wallet documentation (#1428)
* adding -opss_wallet documentation * adding help output for -opss_wallet to the shell scripts
1 parent 03d3f05 commit 1ffd731

File tree

4 files changed

+35
-0
lines changed

4 files changed

+35
-0
lines changed

documentation/3.0/content/userguide/database/connect-db.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,30 @@ WDT will use the information you provided in the command line or in the `RCUDbin
3131
For some advanced use cases, such as using an Oracle Active GridLink data source or Multi Data Sources, you can provide a sparse model of the data sources in a separate model file
3232
during domain creation. See [Advance use cases](#advanced-jrf-database-use-cases).
3333

34+
### Creating a new domain to connect to an existing RCU schema
35+
36+
If you ever find a situation where your JRF domain home directory is corrupted or lost, it is possible to create a new
37+
domain home directory using the existing RCU schemas provided that you have previously exported the domain's encryption
38+
key into an Oracle wallet. To export the encryption key into a wallet, use the OPSS WLST offline [exportEncryptionKey](https://docs.oracle.com/en/middleware/fusion-middleware/platform-security/12.2.1.4/idmcr/security_wlst.html#GUID-3EF2815D-45B9-46EE-A4D7-34A6841195DB)
39+
function.
40+
41+
When you want to recreate the JRF domain home, you have two options:
42+
43+
1. Use the Create Domain tool's `-opss_wallet <path-to-wallet-file>` argument and one of the following arguments to pass
44+
the wallet passphrase:
45+
46+
- `-opss_wallet_passphrase_env <environment-variable-name>` - Simply pass the name of the environment variable to read
47+
to get the wallet passphrase.
48+
- `-opss_wallet_passphrase_file <path-to-file>` - Simply pass the file name for the file containing the wallet passphrase.
49+
50+
2. Add the OPSS wallet to the archive file in the prescribed location (i.e., `wlsdeploy/opsswallet/`) using the Archive
51+
Helper tool's `add opssWallet` command and then provide the passphrase in the `domainInfo` section's `OPSSSecrets` field.
52+
53+
```yaml
54+
domainInfo:
55+
OPSSSecrets: MySecureOPSSWalletPassphrase
56+
```
57+
3458
### Access a database using a wallet
3559
3660
When accessing a database, such as ATP or SSL, using a wallet, you need to obtain the wallet from your DBA and information about the database:

documentation/3.0/content/userguide/tools/create.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ topology:
7070
| `-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. | |
7171
| `-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. | |
7272
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if the `ORACLE_HOME` environment variable is not set.| |
73+
| `-opss_wallet` | The location of the Oracle wallet containing the domain's encryption key required to reconnect to an existing set of RCU schemas. | |
7374
| `-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. | |
7475
| `-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.
7576
| `-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. | |

installer/src/main/bin/createDomain.cmd

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ ECHO [-archive_file ^<archive_file^>]
8181
ECHO [-variable_file ^<variable_file^>]
8282
ECHO [-passphrase_env ^<passphrase_env^>]
8383
ECHO [-passphrase_file ^<passphrase_file^>]
84+
ECHO [-opss_wallet] ^<opss_wallet_file^>]
8485
ECHO [-opss_wallet_passphrase_env ^<opss_wallet_passphrase_env^>]
8586
ECHO [-opss_wallet_passphrase_file ^<opss_wallet_passphrase_file^>]
8687
ECHO [-wlst_path ^<wlst_path^>]
@@ -141,6 +142,10 @@ ECHO at a prompt. The value is the name of a file with
141142
ECHO string value which WDT will read to retrieve the
142143
ECHO passphrase.
143144
ECHO.
145+
ECHO opss_wallet_file - The path to the Oracle wallet containing the domain
146+
ECHO encryption key to use to reconnect the new domain to
147+
ECHO the existing RCU schemas.
148+
ECHO.
144149
ECHO opss_wallet_passphrase_env - An alternative to entering the OPSS
145150
ECHO wallet passphrase at a prompt. The value is an
146151
ECHO ENVIRONMENT VARIABLE name that WDT will use to

installer/src/main/bin/createDomain.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ usage() {
4040
echo " [-java_home <java_home>]"
4141
echo " [-archive_file <archive_file>]"
4242
echo " [-variable_file <variable_file>]"
43+
echo " [-opss_wallet <opss_wallet_file>]"
4344
echo " [-opss_wallet_passphrase_env <opss_wallet_passphrase_env>]"
4445
echo " [-opss_wallet_passphrase_file <opss_wallet_passphrase_file>]"
4546
echo " [-passphrase_env <passphrase_env>]"
@@ -102,6 +103,10 @@ usage() {
102103
echo " string value which WDT will read to retrieve the"
103104
echo " passphrase."
104105
echo ""
106+
echo " opss_wallet_file - The path to the Oracle wallet containing the domain"
107+
echo " encryption key to use to reconnect the new domain to"
108+
echo " the existing RCU schemas."
109+
echg ""
105110
echo " opss_wallet_passphrase_env - An alternative to entering the OPSS"
106111
echo " wallet passphrase at a prompt. The value is an"
107112
echo " ENVIRONMENT VARIABLE name that WDT will use to"

0 commit comments

Comments
 (0)