Doc update
This commit is contained in:
20
README.md
20
README.md
@@ -23,6 +23,22 @@ This script (`oracle_clone.sh`) performs a clone of an Oracle database using the
|
||||
- `-b <pdb1,pdb2>` Comma-separated list of PDBs to clone (include only these PDBs. `PDB$SEED` is always included)
|
||||
- `-c <channels>` Number of RMAN channels to use (sets `numChannels` in the API payload)
|
||||
- `-d` Dry run mode - show API payload without executing
|
||||
- `--refresh` Refresh target database before cloning (if it exists)
|
||||
|
||||
### Refresh Functionality
|
||||
|
||||
The `--refresh` flag provides an automated way to refresh the target database before cloning:
|
||||
|
||||
- If a database with the target name already exists on the target host, it will be refreshed first
|
||||
- The script monitors the database status and waits for it to enter 'relic' state
|
||||
- Once the database is in relic state, the cloning process proceeds normally
|
||||
- The refresh operation has a 2-minute timeout to prevent indefinite waiting
|
||||
- Use Ctrl+C to cleanly abort the refresh process at any time
|
||||
|
||||
**Example with refresh:**
|
||||
```bash
|
||||
./oracle_clone.sh -s prod-db01 -d PRODDB -t test-db01 -n TESTDB --refresh
|
||||
```
|
||||
|
||||
## Configuration (`rbk_api.conf`)
|
||||
|
||||
@@ -31,14 +47,12 @@ Before running the script, you must configure Rubrik API access in the `rbk_api.
|
||||
- `RUBRIK_IP`: The IP address or DNS name of your Rubrik CDM cluster.
|
||||
- `ID`: The service account ID or user credential for API authentication.
|
||||
- `SECRET`: The secret or password for the service account/user.
|
||||
- `RSC_HOST`: API endpoint host for SLA modification and other GraphQL calls
|
||||
|
||||
**Example `rbk_api.conf`:**
|
||||
```properties
|
||||
RUBRIK_IP=<cdm IP address>
|
||||
RUBRIK_IP=cdm-cluster.example.com
|
||||
ID="client|your-service-account-id"
|
||||
SECRET=your-service-account-secret
|
||||
RSC_HOST=customername.my.rubrik.com
|
||||
```
|
||||
|
||||
> **Note:** Do not share your `rbk_api.conf` file or secrets publicly.
|
||||
|
||||
Reference in New Issue
Block a user