Skip to content

lrest doc correction #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 27, 2025
Merged

lrest doc correction #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions docs/multitenant/lrest-based/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,10 +274,11 @@ Parsing sqltext=select count(*) from pdb_plug_in_violations where name =:b1
| Name | Dcription |
--------------------------|-------------------------------------------------------------------------------|
|cdbName | Name of the container database (db) |
|lrestImage (DO NOT EDIT) | **container-registry.oracle.com/database/lrest-dboper:latest** |
|dbTnsurl | TNS alias of the container db |
|lrestImage (DO NOT EDIT) | **container-registry.oracle.com/database/lrest-dboper:latest** use the latest label availble on OCR |
|dbTnsurl | The string of the tns alias to connect to cdb. Attention: remove all white space from string |
|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/) |
|cdbAdminUser | Secret: the administrative (admin) user |
|fileNameConversions | Use file name conversion if you are not using ASM |
|cdbAdminPwd | Secret: the admin user password |
|webServerUser | Secret: the HTTPS user |
|webServerPwd | Secret: the HTTPS user password |
Expand All @@ -290,10 +291,10 @@ Parsing sqltext=select count(*) from pdb_plug_in_violations where name =:b1

### Create PDB

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

```bash
kubectl apply -f create_lrpdb1_resource.yaml
kubectl apply -f create_pdb1_resource.yaml
```
Check the status of the resource and the PDB existence on the container db:

Expand Down Expand Up @@ -391,10 +392,10 @@ test_invalid_parameter;16;spfile

### Open PDB

To open the PDB, use the file [`open_lrpdb1_resource.yaml`](./usecase/open_lrpdb1_resource.yaml):
To open the PDB, use the file [`open_pdb1_resource.yaml`](./usecase/open_pdb1_resource.yaml):

```bash
kubectl apply -f open_lrpdb1_resource.yaml
kubectl apply -f open_pdb1_resource.yaml
```

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

### Close PDB

To close the PDB, use the file [`close_lrpdb1_resource.yaml`](./usecase/close_lrpdb1_resource.yaml):
To close the PDB, use the file [`close_pdb1_resource.yaml`](./usecase/close_pdb1_resource.yaml):

```bash
kubectl apply -f close_lrpdb1_resource.yaml
kubectl apply -f close_pdb1_resource.yaml
```
**pdb closing** - parameters list
| Name | Description/Value |
Expand All @@ -429,10 +430,10 @@ kubectl apply -f close_lrpdb1_resource.yaml

### Clone PDB ###

To clone the PDB, use the file [`clone_lrpdb1_resource.yaml`](./usecase/clone_lrpdb1_resource.yaml):
To clone the PDB, use the file [`clone_pdb1_resource.yaml`](./usecase/clone_pdb1_resource.yaml):

```bash
kubeclt apply -f clone_lrpdb1_resource.yaml
kubeclt apply -f clone_pdb1_resource.yaml
```
**pdb cloning** - parameters list
| Name | Description/Value |
Expand All @@ -450,7 +451,7 @@ kubeclt apply -f clone_lrpdb1_resource.yaml

### Unplug PDB

To unplug the PDB, use the file [`unplug_lrpdb1_resource.yaml`](./usecase/unplug_lrpdb1_resource.yaml):
To unplug the PDB, use the file [`unplug_pdb1_resource.yaml`](./usecase/unplug_pdb1_resource.yaml):

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

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:
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:

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

### Delete PDB

To delete the PDB, use the file [`delete_lrpdb1_resource.yaml`](./usecase/delete_lrpdb1_resource.yaml)
To delete the PDB, use the file [`delete_pdb1_resource.yaml`](./usecase/delete_pdb1_resource.yaml)

**pdb deletion**

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

### Map PDB

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)

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)
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.


</span>
44 changes: 22 additions & 22 deletions docs/multitenant/lrest-based/usecase/makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,27 +31,27 @@
#
# ----------------------------- ----------------------------------
# oracle-database-operator.yaml : oracle database operator
# cdbnamespace_binding.yaml : role binding for cdbnamespace
# lrestnamespace_binding.yaml : role binding for lrestnamespace
# pdbnamespace_binding.yaml : role binding for pdbnamespace
# create_lrest_secret.yaml : create secrets for rest server pod
# create_lrpdb_secret.yaml : create secrets for pluggable database
# create_lrest_pod.yaml : create rest server pod
# create_pdb1_resource.yaml : create first pluggable database
# create_pdb2_resource.yaml : create second pluggable database
# open_pdb1_resource.yaml : open first pluggable database
# open_pdb2_resource.yaml : open second pluggable database
# close_pdb1_resource.yaml : close first pluggable database
# close_pdb2_resource.yaml : close second pluggable database
# create_pdb1_resource.yaml : create first pluggable database
# create_pdb2_resource.yaml : create second pluggable database
# open_pdb1_resource.yaml : open first pluggable database
# open_pdb2_resource.yaml : open second pluggable database
# close_pdb1_resource.yaml : close first pluggable database
# close_pdb2_resource.yaml : close second pluggable database
# clone_lrpdb_resource.yaml : clone thrid pluggable database
# clone_pdb2_resource.yaml : clone 4th pluggable database
# delete_pdb1_resource.yaml : delete first pluggable database
# delete_pdb2_resource.yaml : delete sencond pluggable database
# delete_pdb3_resource.yaml : delete thrid pluggable database
# unplug_pdb1_resource.yaml : unplug first pluggable database
# plug_pdb1_resource.yaml : plug first pluggable database
# map_pdb1_resource.yaml : map the first pluggable database
# clone_pdb2_resource.yaml : clone 4th pluggable database
# delete_pdb1_resource.yaml : delete first pluggable database
# delete_pdb2_resource.yaml : delete sencond pluggable database
# delete_pdb3_resource.yaml : delete thrid pluggable database
# unplug_pdb1_resource.yaml : unplug first pluggable database
# plug_pdb1_resource.yaml : plug first pluggable database
# map_pdb1_resource.yaml : map the first pluggable database
# config_map.yam : pdb parameters array
# altersystem_pdb1_resource.yaml : chage cpu_count count parameter for the first pdb
# altersystem_pdb1_resource.yaml : chage cpu_count count parameter for the first pdb
#
DATE := `date "+%y%m%d%H%M%S"`
######################
Expand Down Expand Up @@ -328,7 +328,7 @@ apiVersion: database.oracle.com/${APIVERSION}
kind: LREST
metadata:
name: cdb-dev
namespace: cdbnamespace
namespace: ${LRSNAMESPACE}
spec:
cdbName: "DB12"
lrestImage: ${LRESTIMG}
Expand Down Expand Up @@ -524,7 +524,7 @@ spec:
cdbResName: "cdb-dev"
cdbNamespace: "${LRSNAMESPACE}"
cdbName: "DB12"
pdbName: ""new_clone"
pdbName: "new_clone"
pdbState: "CLOSE"
modifyOption: "IMMEDIATE"
action: "Modify"
Expand Down Expand Up @@ -619,7 +619,7 @@ spec:
cdbNamespace: "${LRSNAMESPACE}"
cdbName: "DB12"
pdbName: "pdbdev"
xmlFileName: "/tmp/pdb.xml"
xmlFileName: "/var/tmp/pdb.$$.xml"
action: "Unplug"
EOF

Expand All @@ -636,7 +636,7 @@ spec:
cdbNamespace: "${LRSNAMESPACE}"
cdbName: "DB12"
pdbName: "pdbdev"
xmlFileName: "/tmp/pdb.xml"
xmlFileName: "/var/tmp/pdb.$$.xml"
action: "plug"
fileNameConversions: "NONE"
sourceFileNameConversions: "NONE"
Expand Down Expand Up @@ -901,10 +901,10 @@ run07.1:
$(KUBECTL) get lrpdb -n $(PDBNAMESPACE)

run99.1:
$(KUBECTL) delete lrest cdb-dev -n cdbnamespace
$(KUBECTL) delete lrest cdb-dev -n $(LRSNAMESPACE)
$(KUBECTL) wait --for=delete lrest cdb-dev -n $(LRSNAMESPACE) --timeout=$(TEST_EXEC_TIMEOUT)
$(KUBECTL) get lrest -n cdbnamespaace
$(KUBECTL) get lrpdb -n pdbnamespaace
$(KUBECTL) get lrest -n $(LRSNAMESPACE)
$(KUBECTL) get lrpdb -n $(PDBNAMESPACE)

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

Expand Down