Skip to content

Commit ffb4024

Browse files
mmalvezzoracle database
and
oracle database
authored
lrest doc correction (#165)
Co-authored-by: oracle database <oracle@mmalvezzpc.homenet.telecomitalia.it>
1 parent 3d6c6b0 commit ffb4024

File tree

2 files changed

+38
-37
lines changed

2 files changed

+38
-37
lines changed

docs/multitenant/lrest-based/README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -274,10 +274,11 @@ Parsing sqltext=select count(*) from pdb_plug_in_violations where name =:b1
274274
| Name | Dcription |
275275
--------------------------|-------------------------------------------------------------------------------|
276276
|cdbName | Name of the container database (db) |
277-
|lrestImage (DO NOT EDIT) | **container-registry.oracle.com/database/lrest-dboper:latest** |
278-
|dbTnsurl | TNS alias of the container db |
277+
|lrestImage (DO NOT EDIT) | **container-registry.oracle.com/database/lrest-dboper:latest** use the latest label availble on OCR |
278+
|dbTnsurl | The string of the tns alias to connect to cdb. Attention: remove all white space from string |
279279
|deletePdbCascade | Delete all of the PDBs associated to a CDB resource when the CDB resource is dropped using [imperative approach](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/imperative-command/) |
280280
|cdbAdminUser | Secret: the administrative (admin) user |
281+
|fileNameConversions | Use file name conversion if you are not using ASM |
281282
|cdbAdminPwd | Secret: the admin user password |
282283
|webServerUser | Secret: the HTTPS user |
283284
|webServerPwd | Secret: the HTTPS user password |
@@ -290,10 +291,10 @@ Parsing sqltext=select count(*) from pdb_plug_in_violations where name =:b1
290291

291292
### Create PDB
292293

293-
To create a pluggable database (PDB), apply the yaml file [`create_lrpdb1_resource.yaml`](./usecase/clone_lrpdb1_resource.yaml)
294+
To create a pluggable database, apply the yaml file [`create_pdb1_resource.yaml`](./usecase/create_pdb1_resource.yaml)
294295

295296
```bash
296-
kubectl apply -f create_lrpdb1_resource.yaml
297+
kubectl apply -f create_pdb1_resource.yaml
297298
```
298299
Check the status of the resource and the PDB existence on the container db:
299300

@@ -391,10 +392,10 @@ test_invalid_parameter;16;spfile
391392

392393
### Open PDB
393394

394-
To open the PDB, use the file [`open_lrpdb1_resource.yaml`](./usecase/open_lrpdb1_resource.yaml):
395+
To open the PDB, use the file [`open_pdb1_resource.yaml`](./usecase/open_pdb1_resource.yaml):
395396

396397
```bash
397-
kubectl apply -f open_lrpdb1_resource.yaml
398+
kubectl apply -f open_pdb1_resource.yaml
398399
```
399400

400401
**pdb opening** - parameters list
@@ -411,10 +412,10 @@ kubectl apply -f open_lrpdb1_resource.yaml
411412

412413
### Close PDB
413414

414-
To close the PDB, use the file [`close_lrpdb1_resource.yaml`](./usecase/close_lrpdb1_resource.yaml):
415+
To close the PDB, use the file [`close_pdb1_resource.yaml`](./usecase/close_pdb1_resource.yaml):
415416

416417
```bash
417-
kubectl apply -f close_lrpdb1_resource.yaml
418+
kubectl apply -f close_pdb1_resource.yaml
418419
```
419420
**pdb closing** - parameters list
420421
| Name | Description/Value |
@@ -429,10 +430,10 @@ kubectl apply -f close_lrpdb1_resource.yaml
429430

430431
### Clone PDB ###
431432

432-
To clone the PDB, use the file [`clone_lrpdb1_resource.yaml`](./usecase/clone_lrpdb1_resource.yaml):
433+
To clone the PDB, use the file [`clone_pdb1_resource.yaml`](./usecase/clone_pdb1_resource.yaml):
433434

434435
```bash
435-
kubeclt apply -f clone_lrpdb1_resource.yaml
436+
kubeclt apply -f clone_pdb1_resource.yaml
436437
```
437438
**pdb cloning** - parameters list
438439
| Name | Description/Value |
@@ -450,7 +451,7 @@ kubeclt apply -f clone_lrpdb1_resource.yaml
450451

451452
### Unplug PDB
452453

453-
To unplug the PDB, use the file [`unplug_lrpdb1_resource.yaml`](./usecase/unplug_lrpdb1_resource.yaml):
454+
To unplug the PDB, use the file [`unplug_pdb1_resource.yaml`](./usecase/unplug_pdb1_resource.yaml):
454455

455456
**pdb unplugging**
456457
| Name | Description/Value |
@@ -461,7 +462,7 @@ To unplug the PDB, use the file [`unplug_lrpdb1_resource.yaml`](./usecase/unplug
461462
|pdbName | Name of the pluggable database (PDB)|
462463
### Plug PDB
463464

464-
To plug in the PDB, use the file [`plug_lrpdb1_resource.yaml`](./usecase/plug_lrpdb1_resource.yaml). In this example, we plug in the PDB that was unpluged in the previous step:
465+
To plug in the PDB, use the file [`plug_pdb1_resource.yaml`](./usecase/plug_pdb1_resource.yaml). In this example, we plug in the PDB that was unpluged in the previous step:
465466

466467
**pdb plugging**
467468
| Name | Description/Value |
@@ -478,7 +479,7 @@ To plug in the PDB, use the file [`plug_lrpdb1_resource.yaml`](./usecase/plug_lr
478479

479480
### Delete PDB
480481

481-
To delete the PDB, use the file [`delete_lrpdb1_resource.yaml`](./usecase/delete_lrpdb1_resource.yaml)
482+
To delete the PDB, use the file [`delete_pdb1_resource.yaml`](./usecase/delete_pdb1_resource.yaml)
482483

483484
**pdb deletion**
484485

@@ -493,8 +494,8 @@ To delete the PDB, use the file [`delete_lrpdb1_resource.yaml`](./usecase/delete
493494

494495
### Map PDB
495496

496-
If you need to create a CRD for an existing PDB, then you can use the map option by applying the file [`map_lrpdb1_resource.yaml`](./usecase/map_lrpdb1_resource.yaml)
497-
497+
If you need to create a CRD for an existing PDB, then you can use the map option by applying the file [`map_pdb1_resource.yaml`](./usecase/map_pdb1_resource.yaml)
498+
Map functionality can be used in a situation where you have a pdb which is not registered in the operator as a CRD. It's a temporary solution while waiting the autodiscovery to be available.
498499

499500

500501
</span>

docs/multitenant/lrest-based/usecase/makefile

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -31,27 +31,27 @@
3131
#
3232
# ----------------------------- ----------------------------------
3333
# oracle-database-operator.yaml : oracle database operator
34-
# cdbnamespace_binding.yaml : role binding for cdbnamespace
34+
# lrestnamespace_binding.yaml : role binding for lrestnamespace
3535
# pdbnamespace_binding.yaml : role binding for pdbnamespace
3636
# create_lrest_secret.yaml : create secrets for rest server pod
3737
# create_lrpdb_secret.yaml : create secrets for pluggable database
3838
# create_lrest_pod.yaml : create rest server pod
39-
# create_pdb1_resource.yaml : create first pluggable database
40-
# create_pdb2_resource.yaml : create second pluggable database
41-
# open_pdb1_resource.yaml : open first pluggable database
42-
# open_pdb2_resource.yaml : open second pluggable database
43-
# close_pdb1_resource.yaml : close first pluggable database
44-
# close_pdb2_resource.yaml : close second pluggable database
39+
# create_pdb1_resource.yaml : create first pluggable database
40+
# create_pdb2_resource.yaml : create second pluggable database
41+
# open_pdb1_resource.yaml : open first pluggable database
42+
# open_pdb2_resource.yaml : open second pluggable database
43+
# close_pdb1_resource.yaml : close first pluggable database
44+
# close_pdb2_resource.yaml : close second pluggable database
4545
# clone_lrpdb_resource.yaml : clone thrid pluggable database
46-
# clone_pdb2_resource.yaml : clone 4th pluggable database
47-
# delete_pdb1_resource.yaml : delete first pluggable database
48-
# delete_pdb2_resource.yaml : delete sencond pluggable database
49-
# delete_pdb3_resource.yaml : delete thrid pluggable database
50-
# unplug_pdb1_resource.yaml : unplug first pluggable database
51-
# plug_pdb1_resource.yaml : plug first pluggable database
52-
# map_pdb1_resource.yaml : map the first pluggable database
46+
# clone_pdb2_resource.yaml : clone 4th pluggable database
47+
# delete_pdb1_resource.yaml : delete first pluggable database
48+
# delete_pdb2_resource.yaml : delete sencond pluggable database
49+
# delete_pdb3_resource.yaml : delete thrid pluggable database
50+
# unplug_pdb1_resource.yaml : unplug first pluggable database
51+
# plug_pdb1_resource.yaml : plug first pluggable database
52+
# map_pdb1_resource.yaml : map the first pluggable database
5353
# config_map.yam : pdb parameters array
54-
# altersystem_pdb1_resource.yaml : chage cpu_count count parameter for the first pdb
54+
# altersystem_pdb1_resource.yaml : chage cpu_count count parameter for the first pdb
5555
#
5656
DATE := `date "+%y%m%d%H%M%S"`
5757
######################
@@ -328,7 +328,7 @@ apiVersion: database.oracle.com/${APIVERSION}
328328
kind: LREST
329329
metadata:
330330
name: cdb-dev
331-
namespace: cdbnamespace
331+
namespace: ${LRSNAMESPACE}
332332
spec:
333333
cdbName: "DB12"
334334
lrestImage: ${LRESTIMG}
@@ -524,7 +524,7 @@ spec:
524524
cdbResName: "cdb-dev"
525525
cdbNamespace: "${LRSNAMESPACE}"
526526
cdbName: "DB12"
527-
pdbName: ""new_clone"
527+
pdbName: "new_clone"
528528
pdbState: "CLOSE"
529529
modifyOption: "IMMEDIATE"
530530
action: "Modify"
@@ -619,7 +619,7 @@ spec:
619619
cdbNamespace: "${LRSNAMESPACE}"
620620
cdbName: "DB12"
621621
pdbName: "pdbdev"
622-
xmlFileName: "/tmp/pdb.xml"
622+
xmlFileName: "/var/tmp/pdb.$$.xml"
623623
action: "Unplug"
624624
EOF
625625

@@ -636,7 +636,7 @@ spec:
636636
cdbNamespace: "${LRSNAMESPACE}"
637637
cdbName: "DB12"
638638
pdbName: "pdbdev"
639-
xmlFileName: "/tmp/pdb.xml"
639+
xmlFileName: "/var/tmp/pdb.$$.xml"
640640
action: "plug"
641641
fileNameConversions: "NONE"
642642
sourceFileNameConversions: "NONE"
@@ -901,10 +901,10 @@ run07.1:
901901
$(KUBECTL) get lrpdb -n $(PDBNAMESPACE)
902902

903903
run99.1:
904-
$(KUBECTL) delete lrest cdb-dev -n cdbnamespace
904+
$(KUBECTL) delete lrest cdb-dev -n $(LRSNAMESPACE)
905905
$(KUBECTL) wait --for=delete lrest cdb-dev -n $(LRSNAMESPACE) --timeout=$(TEST_EXEC_TIMEOUT)
906-
$(KUBECTL) get lrest -n cdbnamespaace
907-
$(KUBECTL) get lrpdb -n pdbnamespaace
906+
$(KUBECTL) get lrest -n $(LRSNAMESPACE)
907+
$(KUBECTL) get lrpdb -n $(PDBNAMESPACE)
908908

909909
runall01: run00 run01.1 run01.2 run02.1 run02.2 run03.1 run03.2 run04.1 run04.2 run05.1 run06.1 run07.1
910910

0 commit comments

Comments
 (0)