Skip to content

Commit 0b37e81

Browse files
committed
Minor edits.
1 parent 92e3d9c commit 0b37e81

File tree

4 files changed

+20
-20
lines changed

4 files changed

+20
-20
lines changed

documentation/site/content/managing-domains/persistent-storage/oci-fss-pv.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@ when the domain is initially created."
1616
- [Provisioning PVCs on the File Storage Service (FSS)](https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengcreatingpersistentvolumeclaim_Provisioning_PVCs_on_FSS.htm#Provisioning_Persistent_Volume_Claims_on_the_FileStorageService) in the OCI documentation.
1717
- [Setting up storage for kubernetes clusters](https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengcreatingpersistentvolumeclaim.htm) in the OCI documentation.
1818

19-
If you are running your Kubernetes cluster on Oracle Container Engine
20-
for Kubernetes (commonly known as OKE), and you use Oracle Cloud Infrastructure File Storage (FSS)
21-
for persistent volumes to store the WebLogic domain home or log files, then the file system
19+
Oracle recommends using Oracle Cloud Infrastructure File Storage (FSS) for persistent volumes to store
20+
the WebLogic domain home or log files when running the Kubernetes cluster on Oracle Container Engine
21+
for Kubernetes (OKE). When using the FSS with OKE for domain home or log files, the file system
2222
handling will require an update to properly initialize the file ownership on the persistent volume
2323
when the domain is initially created.
2424

2525
{{% notice note %}}
2626
File permission handling on persistent volumes can differ between
2727
cloud providers and even with the underlying storage handling on
28-
Linux based systems.
29-
The operator requires permissions to create directories on the persistent volume under the shared mount path.
28+
Linux-based systems.
29+
The operator requires permission to create directories on the persistent volume under the shared mount path.
3030
The following instructions provide an option to update the file ownership and permissions.
3131
{{% /notice %}}
3232

@@ -38,13 +38,13 @@ This script launches a Pod and mounts the specified PVC in the Pod containers at
3838

3939
See the `pv-pvc-helper.sh` in `Examine, change permissions or delete PV contents` section in the [README](https://github.com/oracle/weblogic-kubernetes-operator/tree/{{< latestMinorVersion >}}/kubernetes/samples/scripts/domain-lifecycle/README.md) file for the script details.
4040

41-
For example, run the following command to create the pod.
41+
For example, run the following command to create the Pod.
4242

4343
```
4444
$ pv-pvc-helper.sh -n sample-domain1-ns -r -c sample-domain1-weblogic-sample-pvc -m /shared
4545
```
4646

47-
This will create a pod with following specifications.
47+
The script will create a Pod with the following specifications.
4848
```
4949
apiVersion: v1
5050
kind: Pod
@@ -72,7 +72,7 @@ Run the following command to exec into the Pod.
7272
$ kubectl -n sample-domain1-ns exec -it pvhelper -- /bin/sh
7373
```
7474

75-
After you get a shell to the running pod container, change the directory to `/shared` and you can change the ownership or permissions using appropriate `chown` or `chmod` commands. For example,
75+
After you get a shell to the running Pod container, change the directory to `/shared`, and you can change the ownership or permissions using appropriate `chown` or `chmod` commands. For example,
7676

7777
```
7878
chown 1000:0 /shared/. && find /shared/. -maxdepth 1 ! -name '.snapshot' ! -name '.' -print0 | xargs -r -0 chown -R 1000:0

documentation/site/content/managing-domains/persistent-storage/pv-pvc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ PersistentVolumes can point to different storage locations, for example NFS serv
2020

2121
**Note regarding HostPath**: In a single-node Kubernetes cluster, such as may be used for testing or proof of concept activities, `HOST_PATH` provides the simplest configuration. In a multinode Kubernetes cluster, a `HOST_PATH` that is located on shared storage mounted by all nodes in the Kubernetes cluster is the simplest configuration. If nodes do not have shared storage, then NFS is probably the most widely available option. There are other options listed in the referenced table.
2222

23-
The operator provides a sample script to create the PersistentVolume and PersistentVolumeClaim for the domain. this script must be executed before creating the domain. Beginning with Operator 4.1.0, for Domain on PV [domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}), the operator provides options to create the PV and PVC during the domain initialization. See [Domain on PV documentation]({{< relref "/managing-domains/domain-on-pv/_index.md" >}}) or the `domain.spec.configuration.initializeDomainOnPV` section in the domain resource [schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/documentation/domains/Domain.md) for more details.
23+
The operator provides a sample script to create the PersistentVolume and PersistentVolumeClaim for the domain. This script must be executed before creating the domain. Beginning with operator version 4.1.0, for the Domain on PV [domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}), the operator provides options to create the PV and PVC during the domain initialization. See [Domain on PV documentation]({{< relref "/managing-domains/domain-on-pv/_index.md" >}}) or the `domain.spec.configuration.initializeDomainOnPV` section in the domain resource [schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/documentation/domains/Domain.md) for more details.
2424

2525
#### Persistent Volumes using HostPath approach
2626
The `HOST_PATH` provider is the simplest case for creating a Persistent Volume. It requires creating a directory on the Kubernetes master and ensuring that it has the correct permissions:
@@ -35,7 +35,7 @@ Persistent volumes and claims are described in YAML files. For each PersistentVo
3535

3636
For sample YAML templates, refer to the [PersistentVolumes example]({{< relref "/samples/storage/_index.md" >}}).
3737

38-
For more details, refer to [Kubernetes examples](https://github.com/kubernetes/examples/), and the PV/PVC examples [here](https://github.com/kubernetes/examples/tree/master/staging/volumes).
38+
For more details, refer to Kubernetes PV/PVC examples [here](https://github.com/kubernetes/examples/tree/master/staging/volumes).
3939

4040
#### Verify the results
4141

kubernetes/samples/scripts/domain-lifecycle/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -283,10 +283,10 @@ $ waitForDomain.sh -n my-namespace -d my-domain -p 0
283283

284284
#### `pv-pvc-helper.sh`
285285

286-
Use this helper script for examining, changing permissions or deleting the contents of persistent volume (such as domain files or logs) for a WebLogic Domain on PV or Model in Image domain.
287-
The script launches a a Kubernetes pod named as 'pvhelper' using the provided persistent volume claim name and the mount path.
288-
You can run the 'kubectl exec' to get a shell to the running pod container and run commands to examine or clean up the contents of shared directories on persistent volume.
289-
Use 'kubectl delete pvhelper -n <namespace>' command to delete the pod after it's no longer needed.
286+
Use this helper script for examining, changing permissions, or deleting the contents of the persistent volume (such as domain files or logs) for a WebLogic Domain on PV or Model in Image domain.
287+
The script launches a Kubernetes pod named 'pvhelper' using the provided persistent volume claim name and the mount path.
288+
You can run the 'kubectl exec' to get a shell to the running pod container and run commands to examine or clean up the contents of shared directories on the persistent volume.
289+
Use 'kubectl delete pvhelper -n <namespace>' command to delete the Pod after it's no longer needed.
290290

291291
Use the following command for script usage:
292292

@@ -300,17 +300,17 @@ Following is an example command to launch the helper pod with PVC name `sample-d
300300
$ domain-on-pv-helper.sh -n sample-domain1-ns -c sample-domain1-weblogic-sample-pvc -m /shared
301301
```
302302

303-
After the pod is created, use following command to get a shell to the running pod container.
303+
After the Pod is created, use the following command to get a shell to the running pod container.
304304

305305
```
306306
$ kubectl -n sample-domain1-ns exec -it pvhelper -- /bin/sh
307307
```
308308

309309
After you get a shell to the running pod container, you can recursively delete the contents of the domain home and applications
310310
directories using rm -rf /shared/domains/sample-domain1 and rm -rf /shared/applications/sample-domain1 commands. Since these
311-
commands will actually delete files on the persistent storage, we recommend that you understand and execute these commands carefully.
311+
commands will delete files on the persistent storage, we recommend you understand and execute these commands carefully.
312312

313-
Use the following command to delete the pod after it's no longer needed.
313+
Use the following command to delete the Pod after it's no longer needed.
314314

315315
```
316316
$ kubectl delete pod pvhelper -n <namespace>
@@ -320,8 +320,8 @@ $ kubectl delete pod pvhelper -n <namespace>
320320

321321
#### `opss-wallet.sh`
322322

323-
The OPSS wallet utility is a helper script for JRF type domains that can save an OPSS key
324-
wallet from a running domain's introspector configmap to a file, and/or
323+
The OPSS wallet utility is a helper script for the JRF-type domains that can save an OPSS key
324+
wallet from a running domain's introspector configmap to a file and
325325
restore an OPSS key wallet file to a Kubernetes secret for use by a
326326
domain that you're about to run.
327327

kubernetes/samples/scripts/domain-lifecycle/pv-pvc-helper.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ initGlobals() {
2525
usage() {
2626
cat << EOF
2727
28-
This is a helper script for examining, changing permissions, or deleting the contents of persistent
28+
This is a helper script for examining, changing permissions, or deleting the contents of the persistent
2929
volume (such as domain files or logs) for a WebLogic Domain on PV or Model in Image domain.
3030
The script launches a a Kubernetes pod named as 'pvhelper' using the provided persistent volume claim name and the mount path.
3131
You can run the '${KUBERNETES_CLI} exec' to get a shell to the running pod container and run commands to examine or clean up the contents of

0 commit comments

Comments
 (0)