Update based on review comments

Author: moreaut

README.md

@@ -193,7 +193,7 @@ To remove more than one operator, repeat these steps for each operator namespace
 
 # Recent Changes
 
-See [Recent changes](site/recent-changes.md) for recent changes to the weblogic operator, including any backwards incompatible changes.
+See [Recent changes](site/recent-changes.md) for recent changes to the operator, including any backwards incompatible changes.
 
 
 # Developer guide

kubernetes/internal/generate-weblogic-operator-cert.sh

@@ -40,9 +40,6 @@ OP_KEY_PEM="${CERT_DIR}/${OP_PREFIX}.key.pem"
 rm -rf ${CERT_DIR}
 mkdir ${CERT_DIR}
 
-# TBD - validate that keytool and openssl are available
-# should we import utility.sh so that we can call its 'fail' function?
-
 # generate a keypair for the WebLogic Operator, putting it in a keystore
 keytool \
   -genkey \

site/creating-domain.md

@@ -119,10 +119,10 @@ The following parameters must be provided in the input file:
 | t3ChannelPort | Port for the T3Channel of the NetworkAccessPoint. | 30012 |
 | t3PublicAddress | Public address for the t3 channel. | kubernetes |
 | weblogicCredentialsSecretName | Name of the Kubernetes secret for the Administration Server's username and password. | domain1-weblogic-credentials |
-| weblogicDomainStoragePath | Physical path of the storage for the weblogic domain. | no default |
-| weblogicDomainStorageSize | Total storage allocated for weblogic domain. | 10Gi |
-| weblogicDomainStorageType | Type of storage for the weblogic domain. Legal values are 'NFS' and 'HOST_PATH". | HOST_PATH |
-| weblogicDomainStorageNFSServer| The name of ip address of the NFS server for the weblogic domain's storage. | no default |
+| weblogicDomainStoragePath | Physical path of the storage for the domain. | no default |
+| weblogicDomainStorageSize | Total storage allocated for the domain. | 10Gi |
+| weblogicDomainStorageType | Type of storage for the domain. Legal values are 'NFS' and 'HOST_PATH". | HOST_PATH |
+| weblogicDomainStorageNFSServer| The name of IP address of the NFS server for the domain's storage. | no default |
 | weblogicImagePullSecretName | Name of the Kubernetes secret for the Docker Store, used to pull the WebLogic Server image. | docker-store-secret |
 
 You must uncomment and customize `domainUID` and `weblogicDomainStoratePath`.
@@ -140,7 +140,7 @@ Oracle intends to remove these limitations in a future release.
 
 At this point, you've created a customized copy of the inputs file.
 
-Next, choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory.
+Next, choose and create a directory that generated operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory.
 
 Finally, run the create script, pointing it at your inputs file and output directory:
 

site/developer.md

@@ -77,7 +77,7 @@ These tests assume that the RBAC definitions exist on the Kubernetes cluster.
 
 To create them, first, make a copy of the inputs file (`create-weblogic-operator-inputs.yaml`) and update it.
 
-Next, choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory.
+Next, choose and create a directory that generated operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory.
 
 Finally, run the operator installation script with the "generate only" option as shown below, pointing it at your inputs file and your output directory.  (see the [installation](installation.md) page for details about this script and the inputs):
 
@@ -129,7 +129,7 @@ Verify that you have the right image by running `docker images | grep webloogic-
 
 To create and deploy the operator, first, make a copy of the inputs file (`create-weblogic-operator-inputs.yaml`) and update it, making sure that `weblogicOperatorImagePullPolicy` is set to `Never` and `weblogicOperatorImage` matches the name you used in your `docker build` command.
 
-Next, choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory.
+Next, choose and create a directory that generated operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory.
 
 Finally, run the operator installation script to deploy the operator, pointing it at your inputs file and your output directory:
 
@@ -157,7 +157,7 @@ This project has adopted the following coding standards:
 This project has the following directory structure:
 
 * docs: Generated javadoc and swagger
-* kubernetes: BASH scripts and yaml templates for operator installation and WebLogic domain creation job.
+* kubernetes: BASH scripts and YAML templates for operator installation and WebLogic domain creation job.
 * site: This documentation
 * src/main/java: Java source code for the operator
 * src/test/java: Java unit-tests for the operator

site/installation.md

@@ -121,7 +121,7 @@ To enable the ELK integration, set the `elkIntegrationEnabled` option to `true`.
 
 At this point, you've created a custom inputs file, or you've decided to use the default one.
 
-Next, choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory.
+Next, choose and create a directory that generated operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory.
 
 Finally, run the operator installation script to deploy the operator, pointing it at your inputs file and your output directory:
 

site/manually-creating-domain.md

@@ -15,7 +15,7 @@ The `create-weblogic-domain.sh` script described in the previous section can be
 
 First, make a copy of `create-weblogic-domain-inputs.yaml` and customize it.
 
-Next, choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory
+Next, choose and create a directory that generated operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory
 
 Then, execute the script, pointing it at your inputs file and output directory:
 

site/name-changes.md

@@ -5,8 +5,8 @@ The initial version of the WebLogic Server Kubernetes Operator did not use consi
 We've recently addressed this by:
 * standardizing the names of scripts and input files for creating operators and domains
 * standardizing the input parameter names and values
-* standardizing the names of the generated yaml files
-* requiring that the custom create and specify a directory that the operators' and domains' generated yaml files will be stored in
+* standardizing the names of the generated YAML files
+* requiring that the customer create and specify a directory that the operators' and domains' generated YAML files will be stored in
 
 This changes how operators and domains are created, and also changes the generated artifacts for operators and domains.
 
@@ -30,8 +30,8 @@ The following files are used to create the operator and to create and delete dom
 
 ### Generated YAML Files for Operators and Domains
 
-The create scripts generate a number of yaml files that are used to configure the corresponding Kubernetes artifacts for the operator and the domains.
-Normally, customers do not use these yaml files.  However, customers can look at them.  They can also change the operator and domain configuration by editing these files and reapplying them.
+The create scripts generate a number of YAML files that are used to configure the corresponding Kubernetes artifacts for the operator and the domains.
+Normally, customers do not use these YAML files.  However, customers can look at them.  They can also change the operator and domain configuration by editing these files and reapplying them.
 
 #### Directory for the Generated YAML Files
 
@@ -43,15 +43,19 @@ The customer must create a directory that will parent the per-operator and per-d
 The pathname can either be a full path name, or a relative path name.  If it's a relative pathname, then it's relative to the directory of the shell invoking the create script.
 
 The per-operator directory name is:
-  <user project dir from -o>/weblogic-operators/<operator namespace from the input yaml file's namespace property>
+  <user project dir from -o>/weblogic-operators/<operator namespace from the input YAML file's namespace property>
 
 Similarly, the per-domain directory name is:
-  <user project dir from -o>/weblogic-domains/<domain uid from the input yaml file's domainUid property>
+  <user project dir from -o>/weblogic-domains/<domain uid from the input YAML file's domainUid property>
 
 #### What If I Mess Up Creating a Domain or Operator And Want To Do It Again?
 
-* TBD - destroy the operator / domain - I don't think we provide scripts for this yet, but will soon
-* either remove the directory that was generated for that operator / domain, or remove the generated yaml files and the copy of the input file from it
+* Remove the resources that were created for the operator:
+  * kubectl delete -f weblogic-operator.yaml
+  * kubectl delete -f weblogic-operator-security.yaml
+* Remove the resources that were created for the domain:
+  * kubernetes/delete-weblogic-domain-resources.sh <domainUID>
+* either remove the directory that was generated for that operator / domain, or remove the generated YAML files and the copy of the input file from it
 * make whatever changes you need in your inputs file
 * re-run the create script
 
@@ -65,7 +69,7 @@ If -i is not specified, kubernetes/create-weblogic-operator.sh uses kubernetes/c
 
 Previously, kubernetes/create-domain-job.sh used kubernetes/create-domain-job-inputs.yaml as the input file if -i was not specified.  This behavior has been changed.  The customer must select a Kubernetes cluster wide unique id for the domain and set the domainUid property in the inputs file to that value.  This means that the customer must always modify the inputs file.
 
-Also, we do not want the customer to have to change files in the weblogic operator's install directory.  Because of this, the -i option MUST be specified when calling kubernetes/create-weblogic-operator.sh.  The basic flow is:
+Also, we do not want the customer to have to change files in the operator's install directory.  Because of this, the -i option MUST be specified when calling kubernetes/create-weblogic-operator.sh.  The basic flow is:
 
 * pick a user projects directory, e.g. /scratch/my-user-projects
 * mkdir /scratch/my-user-projects