Skip to content

Commit e36db90

Browse files
committed
Merge branch 'douglas_williams-master-patch-71492' into 'master'
Update docs/adb/README.md to reflect consistency, spelling and style changes,... See merge request rac-docker-dev/oracle-database-operator!259
2 parents 087c0aa + 83f5f15 commit e36db90

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/adb/README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ As indicated in the prerequisites (see above), to interact with OCI services, ei
66

77
## Required Permissions
88

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

1111
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.
1212

@@ -26,23 +26,23 @@ After you create the resource, you can use the operator to perform the following
2626
* [Stop/Start/Terminate](#stopstartterminate) an Autonomous Database
2727
* [Delete the resource](#delete-the-resource) from the cluster
2828

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

3131
## Provision an Autonomous Database
3232

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

3535
1. Get the `Compartment OCID`.
3636

37-
Login Cloud Console and click `Compartment`.
37+
Log in to the Cloud Console and click `Compartment`.
3838

3939
![compartment-1](/images/adb/compartment-1.png)
4040

4141
Click on the compartment name where you want to create your database, and **copy** the `OCID` of the compartment.
4242

4343
![compartment-2](/images/adb/compartment-2.png)
4444

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

4747
You can skip this step if you want to create a Autonomous Database on Shared Exadata Infrastructure (ADB-S).
4848

@@ -54,13 +54,13 @@ Follow the steps to provision an Autonomous Database that will map objects in yo
5454

5555
![acd-id-2](/images/adb/acd-id-1.png)
5656

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

5959
![acd-id-3](/images/adb/acd-id-2.png)
6060

6161
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.**
6262

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

6565
```sh
6666
kubectl create secret generic admin-password --from-literal=admin-password='password_here'
@@ -111,9 +111,9 @@ Follow the steps to provision an Autonomous Database that will map objects in yo
111111
112112
5. Choose the type of network access (optional):
113113
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.
115115
116-
6. Apply the yaml:
116+
6. Apply the YAML:
117117
118118
```sh
119119
kubectl apply -f config/samples/adb/autonomousdatabase_create.yaml
@@ -170,9 +170,9 @@ The operator also generates the `AutonomousBackup` custom resources if a databas
170170
171171
## Scale the OCPU core count or storage
172172
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.
174174
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.
176176
177177
1. An example YAML file is available here: [config/samples/adb/autonomousdatabase_scale.yaml](./../../config/samples/adb/autonomousdatabase_scale.yaml)
178178
@@ -339,14 +339,14 @@ To use the secret in a deployment, refer to [Using Secrets](https://kubernetes.i
339339

340340
> 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.
341341

342-
Users can start/stop/terminate a database using the `lifecycleState` attribute.
342+
To start, stop, or terminate a database, use the `lifecycleState` attribute.
343343
Here's a list of the values you can set for `lifecycleState`:
344344
345345
* `AVAILABLE`: to start the database
346346
* `STOPPED`: to stop the database
347347
* `TERMINATED`: to terminate the database
348348
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)
350350
351351
```yaml
352352
---
@@ -376,9 +376,9 @@ Here's a list of the values you can set for `lifecycleState`:
376376
377377
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.
378378
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:
380380
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.
382382
383383
```yaml
384384
---
@@ -415,25 +415,25 @@ Now, you can verify that the database is in TERMINATING state on the Cloud Conso
415415
416416
### Show the details of the resource
417417
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:
419419
420420
```sh
421421
kubectl describe adb/autonomousdatabase-sample
422422
```
423423
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.
425425

426426
### Check the logs of the pod where the operator deploys
427427

428-
Follow the steps to check the logs.
428+
To check the logs, use these steps:
429429

430430
1. List the pod replicas
431431

432432
```sh
433433
kubectl get pods -n oracle-database-operator-system
434434
```
435435

436-
2. Use the below command to check the logs of the Pod which has a failure
436+
2. Use the following command to check the logs of the Pod that has a failure
437437

438438
```sh
439439
kubectl logs -f pod/oracle-database-operator-controller-manager-78666fdddb-s4xcm -n oracle-database-operator-system

0 commit comments

Comments
 (0)