You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/adb/README.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ As indicated in the prerequisites (see above), to interact with OCI services, ei
6
6
7
7
## Required Permissions
8
8
9
-
The opeartor must be given the required type of access in a policy written by an administrator to manage the Autonomous Databases. See [Let database and fleet admins manage Autonomous Databases](https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/commonpolicies.htm#db-admins-manage-adb) for sample Autonomous Database policies.
9
+
The operator must be given the required type of access in a policy written by an administrator to manage the Autonomous Databases. See [Let database and fleet admins manage Autonomous Databases](https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/commonpolicies.htm#db-admins-manage-adb) for sample Autonomous Database policies.
10
10
11
11
The permission to view the workrequests is also required, so that the operator will update the resources when the work is done. See [Viewing Work Requests](https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengviewingworkrequests.htm#contengviewingworkrequests) for sample work request policies.
12
12
@@ -26,23 +26,23 @@ After you create the resource, you can use the operator to perform the following
26
26
*[Stop/Start/Terminate](#stopstartterminate) an Autonomous Database
27
27
*[Delete the resource](#delete-the-resource) from the cluster
28
28
29
-
To debug the Oracle Autonomous Databases with Oracle Database Operator, see [Debugging and troubleshooting](#debugging-and-troubleshooting)
29
+
To debug the Oracle Autonomous Databases with Oracle Database operator, see [Debugging and troubleshooting](#debugging-and-troubleshooting)
30
30
31
31
## Provision an Autonomous Database
32
32
33
-
Follow the steps to provision an Autonomous Database that will map objects in your cluster.
33
+
Follow these steps to provision an Autonomous Database that will map objects in your cluster.
34
34
35
35
1. Get the `Compartment OCID`.
36
36
37
-
Login Cloud Console and click `Compartment`.
37
+
Log in to the Cloud Console and click `Compartment`.
38
38
39
39

40
40
41
41
Click on the compartment name where you want to create your database, and **copy** the `OCID` of the compartment.
42
42
43
43

44
44
45
-
2. To create an Autonomous Database on Dedicated Exadata Infrastructure (ADB-D), the OCID of Oracle Autonomous Container Database is required.
45
+
2. To create an Autonomous Database on Dedicated Exadata Infrastructure (ADB-D), the OCID of the Oracle Autonomous Container Database is required.
46
46
47
47
You can skip this step if you want to create a Autonomous Database on Shared Exadata Infrastructure (ADB-S).
48
48
@@ -54,13 +54,13 @@ Follow the steps to provision an Autonomous Database that will map objects in yo
54
54
55
55

56
56
57
-
Click on the name of Autonomous Container Database and copy the `Autonomous Container Database OCID` from Cloud Console.
57
+
Click on the name of Autonomous Container Database and copy the `Autonomous Container Database OCID` from the Cloud Console.
58
58
59
59

60
60
61
61
3. Create a Kubernetes Secret to hold the password of the ADMIN user. **The key and the name of the secret must be the same.**
62
62
63
-
You can create this secret with the following command (as an example):
63
+
You can create this secret by using a command similar to the following example:
@@ -111,9 +111,9 @@ Follow the steps to provision an Autonomous Database that will map objects in yo
111
111
112
112
5. Choose the type of network access (optional):
113
113
114
-
By default, the network access type is set to PUBLIC, which allows secure connections from anywhere. Uncomment the code block if you want configure the netowrk acess. See [Configuring Network Access of Autonomous Database](./NETWORK_ACCESS_OPTIONS.md) for more information.
114
+
By default, the network access type is set to PUBLIC, which allows secure connections from anywhere. Uncomment the code block if you want configure the network acess. See [Configuring Network Access of Autonomous Database](./NETWORK_ACCESS_OPTIONS.md) for more information.
@@ -170,9 +170,9 @@ The operator also generates the `AutonomousBackup` custom resources if a databas
170
170
171
171
## Scale the OCPU core count or storage
172
172
173
-
> Note: this operation requires an `AutonomousDatabase` object to be in your cluster. This example assumes either the provision operation or the bind operation has been done by the users and the operator is authorized with API Key Authentication.
173
+
> Note: this operation requires an `AutonomousDatabase` object to be in your cluster. To use this example, either the provision operation or the bind operation must be done, and the operator is authorized with API Key Authentication.
174
174
175
-
Users can scale up or scale down the Oracle Autonomous Database OCPU core count or storage by updating the `cpuCoreCount` and `dataStorageSizeInTBs` parameters. The `isAutoScalingEnabled` indicates whether auto scaling is enabled. Here is an example of scaling the CPU count and storage size (TB) up to 2 and turning off the auto-scaling by updating the `autonomousdatabase-sample` custom resource.
175
+
You can scale up or scale down the Oracle Autonomous Database OCPU core count or storage by updating the `cpuCoreCount` and `dataStorageSizeInTBs` parameters. The `isAutoScalingEnabled` indicates whether auto scaling is enabled. In this example, the CPU count and storage size (TB) are scaled up to 2 and the auto-scaling is turned off by updating the `autonomousdatabase-sample` custom resource.
176
176
177
177
1. An example YAML file is available here: [config/samples/adb/autonomousdatabase_scale.yaml](./../../config/samples/adb/autonomousdatabase_scale.yaml)
178
178
@@ -339,14 +339,14 @@ To use the secret in a deployment, refer to [Using Secrets](https://kubernetes.i
339
339
340
340
> Note: this operation requires an `AutonomousDatabase` object to be in your cluster. This example assumes the provision operation or the bind operation has been done by the users and the operator is authorized with API Key Authentication.
341
341
342
-
Users can start/stop/terminate a database using the `lifecycleState` attribute.
342
+
To start, stop, or terminate a database, use the `lifecycleState` attribute.
343
343
Here's a list of the values you can set for `lifecycleState`:
344
344
345
345
* `AVAILABLE`: to start the database
346
346
* `STOPPED`: to stop the database
347
347
* `TERMINATED`: to terminate the database
348
348
349
-
1. A sample .yaml file is available here: [config/samples/adb/autonomousdatabase_stop_start_terminate.yaml](./../../config/samples/adb/autonomousdatabase_stop_start_terminate.yaml)
349
+
1. An example .yaml file is available here: [config/samples/adb/autonomousdatabase_stop_start_terminate.yaml](./../../config/samples/adb/autonomousdatabase_stop_start_terminate.yaml)
350
350
351
351
```yaml
352
352
---
@@ -376,9 +376,9 @@ Here's a list of the values you can set for `lifecycleState`:
376
376
377
377
The `hardLink` defines the behavior when the resource is deleted from the cluster. If the `hardLink` is set to true, the Operator terminates the Autonomous Database in OCI when the resource is removed; otherwise, the database remains unchanged. By default the value is `false` if it is not explicitly specified.
378
378
379
-
Follow the steps to delete the resource and terminate the Autonomous Database.
379
+
To delete the resource and terminate the Autonomous Database, complete these steps:
380
380
381
-
1. Use the example [autonomousdatabase_delete_resource.yaml](./../../config/samples/adb/autonomousdatabase_delete_resource.yaml) which sets the attribute `hardLink` to true.
381
+
1. Use the example [autonomousdatabase_delete_resource.yaml](./../../config/samples/adb/autonomousdatabase_delete_resource.yaml), which sets the attribute `hardLink` to true.
382
382
383
383
```yaml
384
384
---
@@ -415,25 +415,25 @@ Now, you can verify that the database is in TERMINATING state on the Cloud Conso
415
415
416
416
### Show the details of the resource
417
417
418
-
If you edit and re-apply the `.yaml` file, the Autonomous Database controller will only update the parameters that the file contains. The parameters which are not in the file will not be impacted. To get the verbose output of the current spec, use below command:
418
+
If you edit and reapply the `.yaml` file, then the Autonomous Database controller will only update the parameters that the file contains. The parameters that are not in the file will not be updated. To obtain the verbose output of the current spec, use the following command:
419
419
420
420
```sh
421
421
kubectl describe adb/autonomousdatabase-sample
422
422
```
423
423
424
-
If any error occurs during the reconciliation loop, the Operator reports the error using the resource's event stream, which shows up in kubectl describe output.
424
+
If any error occurs during the reconciliation loop, then the operator reports the error using the resource's event stream, which shows up in kubectl describe output.
425
425
426
426
### Check the logs of the pod where the operator deploys
427
427
428
-
Follow the steps to check the logs.
428
+
To check the logs, use these steps:
429
429
430
430
1. List the pod replicas
431
431
432
432
```sh
433
433
kubectl get pods -n oracle-database-operator-system
434
434
```
435
435
436
-
2. Use the belowcommand to check the logs of the Pod which has a failure
436
+
2. Use the followingcommand to check the logs of the Pod that has a failure
0 commit comments