Merge pull request #599 from oracle/rmarano

complete review and edit

Author: markxnelson

kubernetes/samples/README.md

@@ -1,16 +1,16 @@
-# WebLogic Operator Samples
+# WebLogic operator samples
 
 ## Sample scripts
 
-* [Sample secret for WebLogic admin credentials](scripts/create-weblogic-domain/create-weblogic-credentials.sh) for creating a Kubernetes secret that contains the Administration Server credentials. This secret can be used in creating a WebLogic domain custom resource.
-* [Sample PV and PVC](scripts/create-weblogic-domain-pv-pvc/README.md) for creating a PV or PVC that can be used by a domain custom resource as the persistent storage for the WebLogic domain home or log files.
-* [Sample domain home on a persistent volume](scripts/create-weblogic-domain/domain-home-on-pv/README.md) for creating a WebLogic domain home on an existing PV or PVC, and the domain customer resource YAML file for deploying the generated WebLogic domain.
-* [Sample Elasticsearch and Kibana configuration](scripts/elasticsearch_and_kibana.yaml) for configuring the Elasticsearch and Kibana deployments and services for the operator's logs.
-* [Sample self-signed certificate and private key](scripts/generate-external-rest-identity.sh) for generating a self-signed certificate and private key that can be used for the operator's external REST API.
+* [Sample for creating a Kubernetes secret](scripts/create-weblogic-domain/create-weblogic-credentials.sh) that contains the Administration Server credentials. This secret can be used in creating a WebLogic domain resource.
+* [Sample for creating a PV or PVC](scripts/create-weblogic-domain-pv-pvc/README.md) that can be used by a domain resource as the persistent storage for the WebLogic domain home or log files.
+* [Sample for creating a WebLogic domain home on an existing PV or PVC](scripts/create-weblogic-domain/domain-home-on-pv/README.md), and the domain resource YAML file for deploying the generated WebLogic domain.
+* [Sample for configuring the Elasticsearch and Kibana](scripts/elasticsearch_and_kibana.yaml) deployments and services for the operator's logs.
+* [Sample for generating a self-signed certificate and private key](scripts/generate-external-rest-identity.sh) that can be used for the operator's external REST API.
 
 ## Sample Helm charts
 
 * [Sample Traefik Helm chart](charts/traefik/README.md) for setting up a Traefik load balancer for WebLogic clusters.
 * [Sample Voyager Helm chart](charts/voyager/README.md) for setting up a Voyager load balancer for WebLogic clusters.
-* [Sample Ingress Helm chart](charts/ingress-per-domain/README.md) for setting up a Kubernetes Ingress for each WebLogic cluster using Traefik or Voyager load balancer.
+* [Sample Ingress Helm chart](charts/ingress-per-domain/README.md) for setting up a Kubernetes Ingress for each WebLogic cluster using a Traefik or Voyager load balancer.
 * [Sample Apache  Helm chart](charts/apache-webtier/README.md) and [Apache samples using the default or custom configurations](charts/apache-samples/README.md) for setting up a load balancer for WebLogic clusters using the Apache HTTP Server with WebLogic Server Plugins.

kubernetes/samples/charts/README.md

@@ -2,12 +2,12 @@
 
 ## Load balancer sample scripts
 
-The Oracle WebLogic Server Kubernetes Operator supports three load balancers: TRAEFIK, VOYAGER, and APACHE. We provide samples that demonstrate how to install and configure each one. The samples are located in following folders:
+The Oracle WebLogic Server Kubernetes Operator supports three load balancers: Traefik, Voyager, and Apache. We provide samples that demonstrate how to install and configure each one. The samples are located in following folders:
 
 * [traefik](traefik/README.md)
 * [voyager](voyager/README.md)
-* apache-samples [custom-sample](apache-samples/custom-sample/README.md)
-* apache-samples [default-sample](apache-samples/default-sample/README.md)
+* apache-samples/[custom-sample](apache-samples/custom-sample/README.md)
+* apache-samples/[default-sample](apache-samples/default-sample/README.md)
 * [ingress-per-domain](ingress-per-domain/README.md)
 * [apache-webtier](apache-webtier/README.md)
 

kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/README.md

@@ -1,6 +1,6 @@
-# Sample Persistent Volume and Persistent Volume Claim
+# Sample persistent volume and persistent volume claim
 
-The sample scripts demonstrate the creation of a Kubernetes persistent volume (PV) and persistent volume claim (PVC), which can then be used in a domain custom resource as a persistent storage for the WebLogic domain home or log files.
+The sample scripts demonstrate the creation of a Kubernetes persistent volume (PV) and persistent volume claim (PVC), which can then be used in a domain resource as a persistent storage for the WebLogic domain home or log files.
 
 A PV and PVC can be shared by multiple WebLogic domains or dedicated to a particular domain.
 

kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/README.md

@@ -1,16 +1,16 @@
-# WebLogic Sample Domain Home in Docker Image
+# WebLogic sample domain home in Docker image
 
-The sample scripts demonstrate the creation of a WebLogic domain home in docker image. The scripts also generate the domain YAML file, which can then be used to start the Kubernetes artifacts of the corresponding domain. Optionally, the scripts start up the domain, and WebLogic Server pods and services.
+The sample scripts demonstrate the creation of a WebLogic domain home in a Docker image. The scripts also generate the domain YAML file, which can then be used to start the Kubernetes artifacts of the corresponding domain. Optionally, the scripts start up the domain, and WebLogic Server pods and services.
 
 ## Prerequisites
 
 The following prerequisites must be handled prior to running the create domain script:
-* Make sure the WebLogic Operator is running.
+* Make sure the WebLogic operator is running.
 * Create a Kubernetes namespace for the domain unless the intention is to use the default namespace.
 * Create the Kubernetes secrets `username` and `password` of the admin account in the same Kubernetes namespace as the domain.
-* Build the Oracle WebLogic image oracle/weblogic:12.2.1.3-developer . Refer to [Oracle WebLogic Server on Docker](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/dockerfiles/12.2.1.3).
+* Build the Oracle WebLogic image `oracle/weblogic:12.2.1.3-developer`. Refer to [Oracle WebLogic Server on Docker](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/dockerfiles/12.2.1.3).
 
-## Using the script to create a domain
+## Use the script to create a domain
 
 Make a copy of the `create-domain-inputs.yaml` file, and run the create script, pointing it at your inputs file and an output directory:
 
@@ -25,13 +25,13 @@ Make a copy of the `create-domain-inputs.yaml` file, and run the create script,
 The script will perform the following steps:
 
 * Create a directory for the generated properties and Kubernetes YAML files for this domain if it does not already exist.  The pathname is `/path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID>`. Note that the script fails if the directory is not empty when the `create-domain.sh` script is executed.
-* Create a proerties file, `domain.properties`, in the directory that is created above. This properties file will be used to create a sample WebLogic Server domain.
+* Create a properties file, `domain.properties`, in the directory that is created above. This properties file will be used to create a sample WebLogic Server domain.
 * Clone the weblogic docker-images project via the `git clone https://github.com/oracle/docker-images.git` into the current directory.
 * Replace the built-in username and password in the `properties/docker_build/domain_security.properties` file with the `username` and `password` that are supplied in the command line via the `-u` and `-p` options. These credentials need to match the WebLogic domain admin credentials in the secret that is specified via `weblogicCredentialsSecretName` property in the `create-domain-inputs.yaml` file.
-* Build Docker image based on Docker sample [Example Image with a WebLogic Server Domain](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples/12213-domain-home-in-image). It will create a sample WebLogic Server domain into the Docker image. You can also run the Docker sample [Example Image with a WebLogic Server Domain](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples/12213-domain-home-in-image) manually with the generated `domain.properties` to create domain home image. Note: Oracle recommends keeping the domain home image private in the local repository.
+* Build a Docker image based on the Docker sample, [Example Image with a WebLogic Server Domain](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples/12213-domain-home-in-image). It will create a sample WebLogic Server domain in the Docker image. Also, you can run the Docker sample, [Example Image with a WebLogic Server Domain](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples/12213-domain-home-in-image), manually with the generated `domain.properties` to create a domain home image. **Note**: Oracle recommends keeping the domain home image private in the local repository.
 * Create a Kubernetes domain YAML file, `domain.yaml`, in the directory that is created above. This YAML file can be used to create the Kubernetes resource using the `kubectl create -f` or `kubectl apply -f` command.
 
-As a convenience, using the `-e` option, the script can optionally create the domain object, which in turn results in the creation of the corresponding WebLogic Server pods and services as well.
+As a convenience, using the `-e` option, the script can optionally create the domain object, which in turn results in the creation of the corresponding WebLogic Server pods and services.
 
 The usage of the create script is as follows:
 
@@ -88,13 +88,13 @@ The following parameters can be provided in the inputs file.
 
 Note that the names of the Kubernetes resources in the generated YAML files may be formed with the value of some of the properties specified in the `create-inputs.yaml` file. Those properties include the `adminServerName`, `clusterName` and `managedServerNameBase`. If those values contain any characters that are invalid in a Kubernetes service name, those characters are converted to valid values in the generated YAML files. For example, an uppercase letter is converted to a lowercase letter and an underscore `("_")` is converted to a hyphen `("-")`.
 
-The sample demonstrates how to create a WebLogic domain home and associated Kubernetes resources for a domain that only has one cluster. In addition, the sample provides the capability for users to supply their own scripts to create the domain home for other use cases. The generated domain YAML file could also be modified to cover more use cases.
+The sample demonstrates how to create a WebLogic domain home and associated Kubernetes resources for a domain that has only one cluster. In addition, the sample provides the capability for users to supply their own scripts to create the domain home for other use cases. Also, the generated domain YAML file can be modified to cover more use cases.
 
 ## Verify the results
 
 The create script will verify that the domain was created, and will report failure if there was any error.  However, it may be desirable to manually verify the domain, even if just to gain familiarity with the various Kubernetes objects that were created by the script.
 
-Note that the example results below uses the `default` Kubernetes namespace. If you are using a different namespace, you need to replace `NAMESPACE` in the example `kubectl` commands with the actual Kubernetes namespace.
+Note that the example results below use the `default` Kubernetes namespace. If you are using a different namespace, you need to replace `NAMESPACE` in the example `kubectl` commands with the actual Kubernetes namespace.
 
 ### Generated YAML files with the default inputs
 
@@ -292,11 +292,11 @@ Status:
 Events:            <none>
 ```
 
-In the `Status` section of the output, the available servers and clusters are listed.  Note that if this command is issued very soon after the script finishes, there may be no servers available yet, or perhaps only the Administration Server but no Managed Servers.  The operator will start up the Administration Server first and wait for it to become ready before starting Managed Servers.
+In the `Status` section of the output, the available servers and clusters are listed.  Note that if this command is issued very soon after the script finishes, there may be no servers available yet, or perhaps only the Administration Server but no Managed Servers.  The operator will start up the Administration Server first and wait for it to become ready before starting the Managed Servers.
 
-### Verify pods
+### Verify the pods
 
-The following command can be used to see the pods running the servers:
+Use the following command to see the pods running the servers:
 
 ```
 kubectl get pods -n NAMESPACE
@@ -312,9 +312,9 @@ domain1-managed-server1                      1/1       Running   0          8m
 domain1-managed-server2                      1/1       Running   0          8m
 ```
 
-### Verify services
+### Verify the services
 
-The following command can be used to see the services for the domain:
+Use the following command to see the services for the domain:
 
 ```
 kubectl get services -n NAMESPACE
@@ -331,9 +331,9 @@ domain1-managed-server1                     ClusterIP   None             <none>
 domain1-managed-server2                     ClusterIP   None             <none>        8001/TCP          22m
 ```
 
-## Delete domain
+## Delete the domain
 
-Th generated YAML file in the `/path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID>` directory can also be used to delete the Kubernetes resource. The following command can be used to delete domain:
+The generated YAML file in the `/path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID>` directory can be used to delete the Kubernetes resource. Use the following command to delete the domain:
 
 ```
 $ kubectl delete -f domain.yaml