Merge pull request #774 from oracle/rc2-doc-updates

Rc2 doc updates

Author: rjeberhard

README.md

@@ -22,7 +22,7 @@ The fastest way to experience the operator is to follow the [Quick start guide](
 
 ```diff
 + The current release of the operator is 2.0-rc2, a release candidate for our 2.0 release.
-+ This release candidate was published on Jan. 10, 2019.
++ This release candidate was published on Jan. 17, 2019.
 + We expect to publish the final 2.0 release later in January, 2019.
 + We expect that there will be some minor changes to documentation and samples in the final 2.0 release.
 + However, this release candidate is suitable for testing and early adopters.

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

@@ -53,11 +53,11 @@ The PV and PVC creation inputs can be customized by editing the `create-pv-pvc-i
 | `domainUID` | ID of the domain resource to which the generated PV and PVC will be dedicated. Leave it empty if the PV and PVC are going to be shared by multiple domains. | no default |
 | `namespace` | Kubernetes namespace to create the PVC. | `default` |
 | `baseName` | Base name of the PV and PVC. The generated PV and PVC will be `<baseName>-pv` and `<baseName>-pvc` respectively. | `weblogic-sample` |
-| `weblogicDomainStoragePath` | Physical path of the storage for the PV. | no default |
+| `weblogicDomainStoragePath` | Physical path of the storage for the PV.  When `weblogicDomainStorageType` is set to `HOST_PATH`, this value should be set the to path to the domain storage on the Kubernetes host.  When `weblogicDomainStorageType` is set to NFS, then `weblogicDomainStorageNFSServer` should be set to the IP address or name of the DNS server, and this value should be set to the exported path on that server.  Note that the path where the domain is mounted in the WebLogic containers is not affected by this setting, that is determined when you create your domain. | no default |
 | `weblogicDomainStorageReclaimPolicy` | Kubernetes PVC policy for the persistent storage. The valid values are: `Retain`, `Delete`, and `Recycle`. | `Retain` |
 | `weblogicDomainStorageSize` | Total storage allocated for the PVC. | `10Gi` |
 | `weblogicDomainStorageType` | Type of storage. Legal values are `NFS` and `HOST_PATH`. If using `NFS`, `weblogicDomainStorageNFSServer` must be specified. | `HOST_PATH` |
-| `weblogicDomainStorageNFSServer`| Name of the IP address of the NFS server. This setting only applies if `weblogicDomainStorateType` is `NFS`.  | no default |
+| `weblogicDomainStorageNFSServer`| Name or IP address of the NFS server. This setting only applies if `weblogicDomainStorateType` is `NFS`.  | no default |
 
 ## Shared versus dedicated PVC
 

kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/create-pv-pvc-inputs.yaml

@@ -25,6 +25,13 @@ weblogicDomainStorageType: HOST_PATH
 #weblogicDomainStorageNFSServer: nfsServer
 
 # Physical path of the persistent storage.
+# When weblogicDomainStorageType is set to HOST_PATH, this value should be set the to path to the
+# domain storage on the Kubernetes host.
+# When weblogicDomainStorageType is set to NFS, then weblogicDomainStorageNFSServer should be set
+# to the IP address or name of the DNS server, and this value should be set to the exported path
+# on that server.
+# Note that the path where the domain is mounted in the WebLogic containers is not affected by this
+# setting, that is determined when you create your domain.
 # The following line must be uncomment and customized:
 #weblogicDomainStoragePath: /scratch/k8s_dir
 

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

@@ -123,7 +123,7 @@ The following parameters can be provided in the inputs file.
 | `productionModeEnabled` | Boolean indicating if production mode is enabled for the domain. | `true` |
 | `serverStartPolicy` | Determines which WebLogic Servers will be started up. Legal values are `NEVER`, `IF_NEEDED`, `ADMIN_ONLY`. | `IF_NEEDED` |
 | `t3ChannelPort` | Port for the T3 channel of the NetworkAccessPoint. | `30012` |
-| `t3PublicAddress` | Public address for the T3 channel. | `kubernetes` |
+| `t3PublicAddress` | Public address for the T3 channel.  This should be set to the public address of the Kubernetes cluster.  This would normally be a load balancer address. <p/>For development environments only: In a single server (all-in-one) Kubernetes deployment this may be set to the address of the master, or at the very least it must be set to the address of one of the worker nodes. | `kubernetes` |
 | `weblogicCredentialsSecretName` | Name of the Kubernetes secret for the Administration Server's username and password. | `domain1-weblogic-credentials` |
 
 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 `("-")`.

site/domains.md

@@ -111,6 +111,10 @@ You can modify the WebLogic domain configuration for both the "domain in persist
 
 Configuration overrides allow changing a configuration without modifying its original `config.xml` or system resource XML files, and also support parameterizing overrides so that you can inject values into them from Kubernetes secrets.   For example, you can inject database user names, passwords, and URLs that are stored in a secret.
 
+### About the Domain resource
+
+More information about the Domain resource can be found [here](domain-resource.md).
+
 ### Managing lifecycle operations including shutting down and deleting domains
 
 In Operator 2.0, you can perform lifecycle operations on WebLogic servers, clusters, or domains.

site/quickstart.md

@@ -46,7 +46,8 @@ e.	Pull the WebLogic 12.2.1.3 install image:
 ```
 $ docker pull store/oracle/weblogic:12.2.1.3
 ```
-f.	Then patch the WebLogic image according to these [instructions](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples/12213-patch-wls-for-k8s),
+f.	**TODO** remove this item when Monica has published the new image with the patch in it **TODO**
+    Then patch the WebLogic image according to these [instructions](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples/12213-patch-wls-for-k8s),
     and copy the image to all nodes in your cluster, or put it in a Docker registry that your cluster can access.
 
 g.  Grant the Helm service account the `cluster-admin` role:
@@ -97,6 +98,7 @@ c.  Use `helm` to install and start the operator from the directory you just clo
 $ helm install kubernetes/charts/weblogic-operator \
   --name sample-weblogic-operator \
   --namespace sample-weblogic-operator-ns \
+  --set image=oracle/weblogic-kubernetes-operator:2.0-rc2 \
   --set serviceAccount=sample-weblogic-operator-sa \
   --set "domainNamespaces={}" \
   --wait

site/recent-changes.md

@@ -4,7 +4,7 @@ This document tracks recent changes to the operator, especially ones that introd
 
 | Date | Version | Introduces backward incompatibilities | Change |
 | --- | --- | --- | --- |
-| January 10, 2019 | v2.0-rc2 | yes | 
+| January 17, 2019 | v2.0-rc2 | yes | Schema updates are completed, and various bug fixes.
 | December 20, 2018 | v2.0-rc1 | yes | Operator is now installed via Helm charts, replacing the earlier scripts.  The operator now supports the domain home on persistent volume or in Docker image use cases, which required a redesign of the domain schema.  You can override the domain configuration using configuration override templates.  Now load balancers and Ingresses can be independently configured.  You can direct WebLogic logs to a persistent volume or to the pod's log.  Added lifecycle support for servers and significantly enhanced configurability for generated pods.  The final v2.0 release will be the initial release where the operator team intends to provide backward compatibility as part of future releases.
 | March 20, 2018 | v1.1 | yes | Several files and input parameters have been renamed.  This affects how operators and domains are created.  It also changes generated Kubernetes artifacts, therefore customers must recreate their operators and domains.
 | April 4, 2018 | v1.0 | yes | Many Kubernetes artifact names and labels have changed. Also, the names of generated YAML files for creating a domain's PV and PVC have changed.  Because of these changes, customers must recreate their operators and domains.

site/user-guide.md

@@ -64,5 +64,5 @@ Before using the operator, you might want to read the [design philosophy](design
 * Flannel networking v0.9.1-amd64 (check with `docker images | grep flannel`).
 * Docker 18.03.1.ce (check with `docker version`).
 * Helm 2.8.2+ (check with `helm version`).
-* Oracle WebLogic Server 12.2.1.3.0 with patch 28076014.
+* Oracle WebLogic Server 12.2.1.3.0 with patch 29135930.
 * You must have the `cluster-admin` role to install the operator.

site/weblogic-docker-images.md

@@ -19,7 +19,7 @@ as described in [this section](#creating-a-custom-image-with-your-domain-inside-
 
 ## Setting up secrets to access the Docker Store
 
-**Note**: This version of the operator requires WebLogic Server 12.2.1.3.0 plus patch 28076014, so pulling an unpatched image directly to the Kubernetes cluster is not particularly useful.  However, we have left this information in the documentation for reference purposes.
+**Note**: This version of the operator requires WebLogic Server 12.2.1.3.0 plus patch 29135930, so pulling an unpatched image directly to the Kubernetes cluster is not particularly useful.  However, we have left this information in the documentation for reference purposes.
 
 In order for Kubernetes to obtain the WebLogic Server Docker image from the Docker Store, which requires authentication, a Kubernetes secret containing the registry credentials must be created. To create a secret with Docker Store credentials, issue the following command:
 
@@ -64,7 +64,7 @@ Docker Store.
 
 ## Creating a custom image with patches applied
 
-The Oracle WebLogic Server Kubernetes Operator requires patch 28076014.
+The Oracle WebLogic Server Kubernetes Operator requires patch 29135930.
 This patch does have some prerequisites that will also need to be applied.
 
 [This sample](https://github.com/oracle/docker-images/blob/master/OracleWebLogic/samples/12213-patch-wls-for-k8s/README.md) in