Merge branch 'cleanup-persistent-storage-and-README' of orahub.oci.oraclecorp.com:weblogic-cloud/weblogic-kubernetes-operator into cleanup-persistent-storage-and-README

Author: ankedia

documentation/site/content/managing-domains/persistent-storage/_index.md

@@ -1,11 +1,11 @@
 +++
-title = "Persistent Storage"
+title = "Persistent storage"
 date = 2019-02-23T16:45:09-05:00
 weight = 7.5
 pre = "<b> </b>"
 description = "Use a Kubernetes PersistentVolume (PV) and PersistentVolumeClaim (PVC) to store WebLogic domain homes and log files."
 +++
 
-This section provides general information about setting up Persistent storage, which can be used for the WebLogic domain homes and log files. 
+This section provides general information about setting up persistent storage, which can be used for WebLogic domain homes and log files.
 
 {{% children style="h4" description="true" %}}

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

@@ -11,32 +11,27 @@ an update to properly initialize the file ownership on the persistent volume
 when the domain is initially created."
 ---
 
-#### References
-
-- [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.
-- [Setting up storage for kubernetes clusters](https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengcreatingpersistentvolumeclaim.htm) in the OCI documentation.
-
 Oracle recommends using Oracle Cloud Infrastructure File Storage (FSS) for persistent volumes to store
 the WebLogic domain home or log files when running the Kubernetes cluster on Oracle Container Engine
 for Kubernetes (OKE). When using the FSS with OKE for domain home or log files,  the file system
-handling will require an update to properly initialize the file ownership on the persistent volume 
+handling will require an update to properly initialize the file ownership on the persistent volume
 when the domain is initially created.  
 
 {{% notice note %}}
 File permission handling on persistent volumes can differ between
 cloud providers and even with the underlying storage handling on
-Linux-based systems. 
+Linux-based systems.
 The operator requires permission to create directories on the persistent volume under the shared mount path.
 The following instructions provide an option to update the file ownership and permissions.
 {{% /notice %}}
 
 
-#### Updating the permissions of shared directory on Persistent storage
-The operator provides a utility script `pv-pvc-helper.sh` as part of the lifecycle scripts to change the ownership and permissions of the shared directory on the Persistent storage.
+#### Updating the permissions of shared directory on persistent storage
+The operator provides a utility script, `pv-pvc-helper.sh`, as part of the lifecycle scripts to change the ownership and permissions of the shared directory on the persistent storage.
 
-This script launches a Pod and mounts the specified PVC in the Pod containers at the specified mount path. You can then exec in the Pod and manually change the permissions or ownership.
+This script launches a Pod and mounts the specified PVC in the Pod containers at the specified mount path. You can then `exec` in the Pod and manually change the permissions or ownership.
 
-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.
+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.
 
 For example, run the following command to create the Pod.
 
@@ -67,13 +62,18 @@ spec:
       claimName: wko-domain-on-pv-pvc
 ```
 
-Run the following command to exec into the Pod.
+Run the following command to `exec` into the Pod.
 ```
 $ kubectl -n sample-domain1-ns exec -it pvhelper -- /bin/sh
 ```
 
-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,
+After you get a shell to the running Pod container, change the directory to `/shared`, and you can change the ownership or permissions using the appropriate `chown` or `chmod` commands. For example,
 
 ```
-chown 1000:0 /shared/. && find /shared/. -maxdepth 1 ! -name '.snapshot' ! -name '.' -print0 | xargs -r -0 chown -R 1000:0
+$ chown 1000:0 /shared/. && find /shared/. -maxdepth 1 ! -name '.snapshot' ! -name '.' -print0 | xargs -r -0 chown -R 1000:0
 ```
+
+#### References
+
+- [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.
+- [Setting up storage for Kubernetes clusters](https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengcreatingpersistentvolumeclaim.htm) in the OCI documentation.

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

@@ -1,5 +1,5 @@
 +++
-title = "Persistent Volumes and Persistent Volume Claims"
+title = "PersistentVolumes and PersistentVolumeClaims"
 date = 2019-02-23T16:45:09-05:00
 weight = 1
 description = "Use a Kubernetes PersistentVolume (PV) and PersistentVolumeClaim (PVC) to store WebLogic domain homes and log files."
@@ -15,15 +15,15 @@ The following prerequisites must be fulfilled before proceeding with the creatio
 * Make sure that all the servers in the WebLogic domain are able to reach the storage location.
 * Make sure that the host directory that will be used, already exists and has the appropriate file permissions set.
 
-### Persistent Volume Storage locations
+### Persistent volume storage locations
 PersistentVolumes can point to different storage locations, for example NFS servers or a local directory path. For a list of available options, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/storage/persistent-volumes/).
 
-**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.
+**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.
 
-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.
+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 the [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.
 
-#### Persistent Volumes using HostPath approach
-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:
+#### Persistent volumes using HostPath approach
+The `HOST_PATH` provider is the simplest case for creating a PersistentVolume. It requires creating a directory on the Kubernetes master and ensuring that it has the correct permissions:
 
 ```shell
 $ mkdir -m 777 -p /path/to/domain1PersistentVolume
@@ -57,4 +57,3 @@ This section provides details of common problems that might occur while running
 Possibly the most common problem experienced during testing was the incorrect configuration of the PersistentVolume provider. The PersistentVolume must be accessible to all Kubernetes Nodes, and must be able to be mounted as `Read/Write/Many`. If this is not the case, the PersistentVolume creation will fail.
 
 The simplest case is where the `HOST_PATH` provider is used. This can be either with one Kubernetes Node, or with the `HOST_PATH` residing in shared storage available at the same location on every node (for example, on an NFS mount). In this case, the path used for the PersistentVolume must have its permission bits set to 777.
-

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

@@ -281,20 +281,20 @@ $ waitForDomain.sh -n my-namespace -d my-domain -p 0
 
 ### Examine, change, or delete PV contents
 
-#### `pv-pvc-helper.sh` 
+#### `pv-pvc-helper.sh`
 
 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.
 The script launches a Kubernetes pod named 'pvhelper' using the provided persistent volume claim name and the mount path.
-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.
-Use 'kubectl delete pvhelper -n <namespace>' command to delete the Pod after it's no longer needed.
+You can run the 'kubectl exec' command 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.
+Use the 'kubectl delete pvhelper -n <namespace>' command to delete the Pod after it's no longer needed.
 
 Use the following command for script usage:
 
 ```
 $ domain-on-pv-helper.sh -h
 ```
 
-Following is an example command to launch the helper pod with PVC name `sample-domain1-weblogic-sample-pvc` and mount path `/shared`.
+The following is an example command to launch the helper pod with the PVC name `sample-domain1-weblogic-sample-pvc` and mount path `/shared`.
 
 ```
 $ domain-on-pv-helper.sh -n sample-domain1-ns -c sample-domain1-weblogic-sample-pvc -m /shared
@@ -306,9 +306,9 @@ After the Pod is created, use the following command to get a shell to the runnin
 $ kubectl -n sample-domain1-ns exec -it pvhelper -- /bin/sh
 ```
 
-After you get a shell to the running pod container, you can recursively delete the contents of the domain home and applications 
-directories using rm -rf /shared/domains/sample-domain1 and rm -rf /shared/applications/sample-domain1 commands. Since these 
-commands will delete files on the persistent storage, we recommend you understand and execute these commands carefully.
+After you get a shell to the running pod container, you can recursively delete the contents of the domain home and applications
+directories using the `rm -rf /shared/domains/sample-domain1` and `rm -rf /shared/applications/sample-domain1` commands. Because these
+commands will delete files on the persistent storage, we recommend that you understand and execute these commands carefully.
 
 Use the following command to delete the Pod after it's no longer needed.
 
@@ -318,11 +318,11 @@ $ kubectl delete pod pvhelper -n <namespace>
 
 ### OPSS Wallet utility
 
-#### `opss-wallet.sh` 
+#### `opss-wallet.sh`
 
-The OPSS wallet utility is a helper script for the JRF-type domains that can save an OPSS key
-wallet from a running domain's introspector configmap to a file and
-restore an OPSS key wallet file to a Kubernetes secret for use by a
+The OPSS wallet utility is a helper script for JRF-type domains that can save an OPSS key
+wallet from a running domain's introspector ConfigMap to a file and
+restore an OPSS key wallet file to a Kubernetes Secret for use by a
 domain that you're about to run.
 
 Use the following command for script usage:
@@ -331,13 +331,13 @@ Use the following command for script usage:
 $ opss-wallet.sh -?
 ```
 
-For example, run the following command to save an OPSS key wallet from a running domain to file './ewallet.p12':
+For example, run the following command to save an OPSS key wallet from a running domain to the file './ewallet.p12':
 
 ```
 $ opss-wallet.sh -s
 ```
 
-Run the following command to restore the OPSS key wallet from file './ewallet.p12' to secret
+Run the following command to restore the OPSS key wallet from the file './ewallet.p12' to the secret
 'sample-domain1-opss-walletfile-secret' for use by a domain you're about to run:
 
 ```