Merge branch 'master' of github.com:oracle/weblogic-kubernetes-operator

Author: Lily He

README.md

@@ -63,7 +63,7 @@ please consult this table of contents:
   various tasks related to the operator.
 * The [Developer guide](site/developer.md) provides details for people who want to understand how the operator is built, tested, and so on. Those who wish to contribute to the operator code will find useful information here.  This section also includes
   API documentation (Javadoc) and Swagger/OpenAPI documentation for the REST APIs.
-* The [Contributing](#contributing-to-the-operator) section provides information about conribution requirements.
+* The [Contributing](#contributing-to-the-operator) section provides information about contribution requirements.
 
 
 # User guide

kubernetes/internal/utility.sh

@@ -184,15 +184,35 @@ function toDNS1123Legal {
 
 #
 # Function to check if a value is lowercase
-# $1 - value to check
-# $2 - name of object being checked
+# $1 - name of object being checked
+# $2 - value to check
 function validateLowerCase {
   local lcVal=$(toLower $2)
   if [ "$lcVal" != "$2" ]; then
     validationError "The value of $1 must be lowercase: $2"
   fi
 }
 
+# 
+# Function to lowercase a value and make it a legal DNS1123 name 
+# $1 - value to convert to DNS legal name
+function toDNS1123Legal { 
+  local val=`echo $1 | tr "[:upper:]" "[:lower:]"` 
+  val=${val//"_"/"-"} 
+  echo "$val" 
+}
+
+# 
+# Function to check if a value is lowercase and legal DNS name 
+# $1 - name of object being checked 
+# $2 - value to check 
+function validateDNS1123LegalName { 
+  local val=$(toDNS1123Legal $2) 
+  if [ "$val" != "$2" ]; then 
+    validationError "The value of $1 contains invalid charaters (uppercase letters or "_"): $2" 
+  fi 
+}
+
 #
 # Function to check if a value is lowercase and legal DNS name
 # $1 - value to check

kubernetes/src/test/java/oracle/kubernetes/operator/utils/DomainValues.java

@@ -87,8 +87,8 @@ protected String convertNullToEmptyString(String val) {
   public DomainValues withTestDefaults() {
     return this.adminNodePort("30702")
         .adminPort("7002")
-        .adminServerName("TestAdminServer")
-        .clusterName("TestCluster")
+        .adminServerName("test-admin-server")
+        .clusterName("test-cluster")
         .clusterType(CLUSTER_TYPE_DYNAMIC)
         .domainName("TestDomain")
         .weblogicImage("store/oracle/weblogic:19.1.0.0")
@@ -97,7 +97,7 @@ public DomainValues withTestDefaults() {
         .loadBalancerDashboardPort("31315")
         .loadBalancerWebPort("31305")
         .configuredManagedServerCount("4")
-        .managedServerNameBase("TestManagedServer")
+        .managedServerNameBase("test-managed-server")
         .managedServerPort("8002")
         .initialManagedServerReplicas("3")
         .weblogicDomainStorageNFSServer("TestDomainStorageNFSServer")

operator/src/test/java/oracle/kubernetes/operator/steps/ReadHealthStepTest.java

@@ -20,6 +20,7 @@
 import oracle.kubernetes.operator.ProcessingConstants;
 import oracle.kubernetes.operator.http.HttpClient;
 import oracle.kubernetes.operator.steps.ReadHealthStep.ReadHealthWithHttpClientStep;
+import oracle.kubernetes.operator.work.Component;
 import oracle.kubernetes.operator.work.NextAction;
 import oracle.kubernetes.operator.work.Packet;
 import oracle.kubernetes.operator.work.Step;
@@ -79,6 +80,12 @@ PacketStub withServerName(String serverName) {
       return this;
     }
 
+    PacketStub addSpi(Class clazz, Object spiObject) {
+      Component component = Component.createFor(spiObject);
+      this.getComponents().put(clazz.getName(), component);
+      return this;
+    }
+
     @Override
     public Object get(Object key) {
       if (HttpClient.KEY.equals(key)) {

site/architecture.md

@@ -7,7 +7,15 @@ The operator consists of the following two main parts:
 *	The operator itself, a process that runs in a Docker container deployed into a Kubernetes pod and which performs the actual management tasks.
 *	A Kubernetes job which can be used to create a WebLogic domain.
 
-The operator is packaged in a Docker image `container-registry.oracle.com/middleware/weblogic-operator:latest`.  This image can be deployed to a Kubernetes cluster.  It is recommended that the operator be deployed in its own namespace.  Only one operator is permitted in a namespace; however, multiple operators may be deployed in a Kubernetes cluster provided they are each in their own namespace and the list of namespaces they manage do not overlap.
+The operator is packaged in a [Docker image](https://hub.docker.com/r/oracle/weblogic-kubernetes-operator/) which you can access using the following `docker pull` command:  
+
+```
+
+docker pull oracle/weblogic-kubernetes-operator:1.1
+
+```
+
+This image can be deployed to a Kubernetes cluster.  It is recommended that the operator be deployed in its own namespace.  Only one operator is permitted in a namespace; however, multiple operators may be deployed in a Kubernetes cluster provided they are each in their own namespace and the list of namespaces they manage do not overlap.
 
 Scripts are provided to deploy the operator to a Kubernetes cluster.  These scripts also provide options to install and configure a load balancer and Elastic Stack integration.
 

site/helm-charts.md

@@ -4,6 +4,15 @@
 
 The WebLogic Kubernetes Operator uses Helm to create and deploy any necessary resources and then run the operator in a Kubernetes cluster. Helm helps you manage Kubernetes applications. Helm charts help you define and install applications into the Kubernetes cluster. The operator's Helm chart is located in the `kubernetes/charts/weblogic-operator` directory.
 
+> If you have an old version of the operator installed on your cluster you must remove
+  it before installing this version.  You should remove the deployment (for example `kubectl delete deploy weblogic-operator -n your-namespace`) and the custom
+  resource definition (for example `kubectl delete crd domain`).  If you do not remove
+  the custom resource definition you may see errors like this: 
+  
+    `Error from server (BadRequest): error when creating "/scratch/output/uidomain/weblogic-domains/uidomain/domain.yaml": 
+    the API version in the data (weblogic.oracle/v2) does not match the expected API version (weblogic.oracle/v1`
+
+
 ## Install Helm and Tiller
 
 Helm has two parts: a client (helm) and a server (tiller). Tiller runs inside of your Kubernetes cluster, and manages releases (installations) of your charts.  See https://github.com/kubernetes/helm/blob/master/docs/install.md for detailed instructions on installing helm and tiller.

site/quickstart.md

@@ -4,6 +4,14 @@ Use this quick start guide to create a WebLogic deployment in a Kubernetes clust
 These instructions assume that you are already familiar with Kubernetes.  If you need more detailed instructions, please
 refer to the [User guide](user-guide.md).
 
+> If you have an old version of the operator installed on your cluster you must remove
+  it before installing this version.  You should remove the deployment (for example `kubectl delete deploy weblogic-operator -n your-namespace`) and the custom
+  resource definition (for example `kubectl delete crd domain`).  If you do not remove
+  the custom resource definition you may see errors like this: 
+  
+    `Error from server (BadRequest): error when creating "/scratch/output/uidomain/weblogic-domains/uidomain/domain.yaml": 
+    the API version in the data (weblogic.oracle/v2) does not match the expected API version (weblogic.oracle/v1`
+
 ## Prerequisites
 For this exercise, you’ll need a Kubernetes cluster. If you need help setting one up, check out our [cheat sheet](k8s_setup.md).
 
@@ -164,9 +172,14 @@ domain namespace (`sample-domain1-ns`) and the `domainHomeImageBase` (`oracle/we
 For example, assuming you named your copy `my-inputs.yaml`:
 ```
 $ cd kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image
-$ ./create-domain.sh -i my-inputs.yaml -o /some/output/directory -e -v
+$ ./create-domain.sh -i my-inputs.yaml -o /some/output/directory -u username -p password -e
 ```
 
+You need to provide the WebLogic administration username and password in the `-u` and `-p` options
+respectively, as shown in the example.  If you specify the `-e` option, the script will generate the 
+Kubernetes YAML files *and* apply them to your cluster.  If you omit the `-e` option, the 
+script will just generate the YAML files, but will not take any action on your cluster.
+
 c.	Confirm that the operator started the servers for the domain:
 * Use `kubectl` to show that the domain resource was created:
 ```

site/v1.0/creating-domain.md

@@ -109,7 +109,7 @@ The following parameters must be provided in the input file.
 | `exposeAdminNodePort` | Boolean indicating if the Administration Server is exposed outside of the Kubernetes cluster. | `false` |
 | `exposeAdminT3Channel` | Boolean indicating if the T3 administrative channel is exposed outside the Kubernetes cluster. | `false` |
 | `initialManagedServerReplicas` | Number of Managed Servers to initially start for the domain. | `2` |
-| `javaOptions` | Java options for starting the Administration and Managed Servers. | `-Dweblogic.StdoutDebugEnabled=false` |
+| `javaOptions` | Java options for starting the Administration and Managed Servers. A Java option can have references to one or more of the following pre-defined variables to obtain WebLogic domain information: $(DOMAIN_NAME), $(DOMAIN_HOME), $(ADMIN_NAME), $(ADMIN_PORT), and $(SERVER_NAME). | `-Dweblogic.StdoutDebugEnabled=false` |
 | `loadBalancer` | Type of load balancer to create.  Legal values are `NONE` and `TRAEFIK`. | `TRAEFIK` |
 | `loadBalancerDashboardPort` | Node port for the load balancer to accept dashboard traffic. | `30315` |
 | `loadBalancerWebPort` | Node port for the load balancer to accept user traffic. | `30305` |

site/v1.1/apache.md

@@ -18,7 +18,7 @@ You need to build the Docker image for the Apache HTTP Server that embeds the Or
 
 ```
 
-For more information about the Apache plugin, see [Apache HTTP Server with Oracle WebLogic Server Proxy Plugin on Docker](https://docs.oracle.com/middleware/12213/webtier/develop-plugin/apache.htm#PLGWL395).
+For more information about the Apache plugin, see [Configuring the Plug-In for Apache HTTP Server](https://docs.oracle.com/middleware/12213/webtier/develop-plugin/apache.htm#PLGWL395).
 
 After you have access to the Docker image of the Apache HTTP Server, you can follow the instructions below to set up and start the Kubernetes resources for the Apache HTTP Server.
 
@@ -250,7 +250,7 @@ You can fine tune the behavior of the Apache plugin by providing your own Apache
 loadBalancerVolumePath: <host-config-dir>
 ```
 
-After the `loadBalancerVolumePath` property is specified, the `create-weblogic-domain.sh` script will use the `custom_mod_wl_apache.conf` file in `<host-config-dir>` directory to replace what is in the Docker image.
+After the `loadBalancerVolumePath` property is specified, the `create-weblogic-domain.sh` script will use the `custom_mod_wl_apache.conf` file in the `<host-config-dir>` directory to replace what is in the Docker image.
 
 The generated YAML files will look similar except with un-commented entries like below:
 
@@ -270,7 +270,7 @@ The generated YAML files will look similar except with un-commented entries like
 
 ## Use the Apache load balancer with a manually created WebLogic Domain
 
-If your WebLogic domain is not created by the WebLogic Operator, you need to manually create and start all Kubernetes' resources for the Apache HTTP Server.
+If your WebLogic domain is not created by the WebLogic Operator, you need to manually create and start all Kubernetes resources for the Apache HTTP Server.
 
   1. Create your own `custom_mod_wl_apache.conf` file, and put it in a local directory, for example, `<host-conf-dir>`. See the instructions in [Apache Web Server with Oracle WebLogic Server Proxy Plugin on Docker](https://docs.oracle.com/middleware/1213/webtier/develop-plugin/apache.htm#PLGWL395).