Edit descriptions

Author: rjeberhard

docs/domains/Domain.json

@@ -45,6 +45,7 @@
       "type": "object",
       "properties": {
         "channels": {
+          "description": "Specifies which of the admin server\u0027s WebLogic channels should be exposed outside the Kubernetes cluster via a node port service, along with the node port for each channel. If not specified, the admin server\u0027s node port service will not be created.",
           "type": "array",
           "items": {
             "$ref": "#/definitions/Channel"
@@ -56,12 +57,17 @@
       "type": "object",
       "properties": {
         "channelName": {
+          "description": "Name of channel. default\u0027 refers to the admin server\u0027s default channel (configured via the ServerMBean\u0027s ListenPort) \u0027default-secure\u0027 refers to the admin server\u0027s default secure channel (configured via the ServerMBean\u0027s SSLMBean\u0027s ListenPort) \u0027default-admin\u0027 refers to the admin server\u0027s default administrative channel (configured via the DomainMBean\u0027s AdministrationPort) Otherwise, the name is the name of one of the admin server\u0027s network access points (configured via the ServerMBean\u0027s NetworkAccessMBeans).",
           "type": "string"
         },
         "nodePort": {
+          "description": "Specifies the port number used to access the WebLogic channel outside of the Kubernetes cluster. If not specified, defaults to the port defined by the WebLogic channel.",
           "type": "number"
         }
-      }
+      },
+      "required": [
+        "channelName"
+      ]
     },
     "Chronology": {
       "type": "object",
@@ -100,6 +106,9 @@
           "description": "Configuration affecting server pods",
           "$ref": "#/definitions/ServerPod"
         },
+        "clusterService": {
+          "$ref": "#/definitions/KubernetesResource"
+        },
         "serverStartPolicy": {
           "description": "The strategy for deciding whether to start a server. Legal values are ADMIN_ONLY, NEVER, ALWAYS, or IF_NEEDED.",
           "type": "string",
@@ -239,6 +248,7 @@
           "type": "boolean"
         },
         "webLogicCredentialsSecret": {
+          "description": "The name of a pre-created Kubernetes secret, in the domain\u0027s namepace, that holds the username and password needed to boot WebLogic under the \u0027username\u0027 and \u0027password\u0027 fields.",
           "$ref": "#/definitions/V1SecretReference"
         },
         "adminServer": {
@@ -307,11 +317,11 @@
       "type": "object",
       "properties": {
         "annotations": {
-          "description": "Annotations applied to pods",
+          "description": "The annotations to be attached to generated resources.",
           "$ref": "#/definitions/Map"
         },
         "labels": {
-          "description": "Labels applied to pods",
+          "description": "The labels to be attached to generated resources. The label names must not start with \u0027weblogic.\u0027.",
           "$ref": "#/definitions/Map"
         }
       }
@@ -336,6 +346,7 @@
           "$ref": "#/definitions/ServerPod"
         },
         "serverName": {
+          "description": "The name of the server. Required.",
           "type": "string"
         },
         "serverStartPolicy": {
@@ -352,7 +363,10 @@
           "description": "If present, every time this value is updated the operator will restart the required servers",
           "type": "string"
         }
-      }
+      },
+      "required": [
+        "serverName"
+      ]
     },
     "Map": {
       "type": "object",
@@ -411,7 +425,7 @@
           }
         },
         "annotations": {
-          "description": "Annotations applied to pods",
+          "description": "The annotations to be attached to generated resources.",
           "$ref": "#/definitions/Map"
         },
         "resources": {
@@ -434,7 +448,7 @@
           }
         },
         "labels": {
-          "description": "Labels applied to pods",
+          "description": "The labels to be attached to generated resources. The label names must not start with \u0027weblogic.\u0027.",
           "$ref": "#/definitions/Map"
         },
         "nodeSelector": {
@@ -1625,7 +1639,7 @@
       "type": "string"
     },
     "kind": {
-      "description": "The type of resource. Should be \u0027Domain\u0027",
+      "description": "The type of resource. Must be \u0027Domain\u0027",
       "type": "string"
     },
     "spec": {

docs/domains/index.html

@@ -849,7 +849,7 @@
           "type": "string"
         },
         "kind": {
-          "description": "The type of resource. Should be \u0027Domain\u0027",
+          "description": "The type of resource. Must be \u0027Domain\u0027",
           "type": "string"
         },
         "spec": {
@@ -965,6 +965,7 @@
       "type": "object",
       "properties": {
         "channels": {
+          "description": "Specifies which of the admin server\u0027s WebLogic channels should be exposed outside the Kubernetes cluster via a node port service, along with the node port for each channel. If not specified, the admin server\u0027s node port service will not be created.",
           "type": "array",
           "items": {
             "$ref": "#/definitions/Channel"
@@ -976,12 +977,17 @@
       "type": "object",
       "properties": {
         "channelName": {
+          "description": "Name of channel. default\u0027 refers to the admin server\u0027s default channel (configured via the ServerMBean\u0027s ListenPort) \u0027default-secure\u0027 refers to the admin server\u0027s default secure channel (configured via the ServerMBean\u0027s SSLMBean\u0027s ListenPort) \u0027default-admin\u0027 refers to the admin server\u0027s default administrative channel (configured via the DomainMBean\u0027s AdministrationPort) Otherwise, the name is the name of one of the admin server\u0027s network access points (configured via the ServerMBean\u0027s NetworkAccessMBeans).",
           "type": "string"
         },
         "nodePort": {
+          "description": "Specifies the port number used to access the WebLogic channel outside of the Kubernetes cluster. If not specified, defaults to the port defined by the WebLogic channel.",
           "type": "number"
         }
-      }
+      },
+      "required": [
+        "channelName"
+      ]
     },
     "Chronology": {
       "type": "object",
@@ -1020,6 +1026,9 @@
           "description": "Configuration affecting server pods",
           "$ref": "#/definitions/ServerPod"
         },
+        "clusterService": {
+          "$ref": "#/definitions/KubernetesResource"
+        },
         "serverStartPolicy": {
           "description": "The strategy for deciding whether to start a server. Legal values are ADMIN_ONLY, NEVER, ALWAYS, or IF_NEEDED.",
           "type": "string",
@@ -1159,6 +1168,7 @@
           "type": "boolean"
         },
         "webLogicCredentialsSecret": {
+          "description": "The name of a pre-created Kubernetes secret, in the domain\u0027s namepace, that holds the username and password needed to boot WebLogic under the \u0027username\u0027 and \u0027password\u0027 fields.",
           "$ref": "#/definitions/V1SecretReference"
         },
         "adminServer": {
@@ -1227,11 +1237,11 @@
       "type": "object",
       "properties": {
         "annotations": {
-          "description": "Annotations applied to pods",
+          "description": "The annotations to be attached to generated resources.",
           "$ref": "#/definitions/Map"
         },
         "labels": {
-          "description": "Labels applied to pods",
+          "description": "The labels to be attached to generated resources. The label names must not start with \u0027weblogic.\u0027.",
           "$ref": "#/definitions/Map"
         }
       }
@@ -1256,6 +1266,7 @@
           "$ref": "#/definitions/ServerPod"
         },
         "serverName": {
+          "description": "The name of the server. Required.",
           "type": "string"
         },
         "serverStartPolicy": {
@@ -1272,7 +1283,10 @@
           "description": "If present, every time this value is updated the operator will restart the required servers",
           "type": "string"
         }
-      }
+      },
+      "required": [
+        "serverName"
+      ]
     },
     "Map": {
       "type": "object",
@@ -1331,7 +1345,7 @@
           }
         },
         "annotations": {
-          "description": "Annotations applied to pods",
+          "description": "The annotations to be attached to generated resources.",
           "$ref": "#/definitions/Map"
         },
         "resources": {
@@ -1354,7 +1368,7 @@
           }
         },
         "labels": {
-          "description": "Labels applied to pods",
+          "description": "The labels to be attached to generated resources. The label names must not start with \u0027weblogic.\u0027.",
           "$ref": "#/definitions/Map"
         },
         "nodeSelector": {

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/AdminService.java

@@ -7,13 +7,16 @@
 import com.google.gson.annotations.SerializedName;
 import java.util.ArrayList;
 import java.util.List;
+import oracle.kubernetes.json.Description;
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 
 public class AdminService {
   /** */
   @SerializedName("channels")
+  @Description(
+      "Specifies which of the admin server's WebLogic channels should be exposed outside the Kubernetes cluster via a node port service, along with the node port for each channel. If not specified, the admin server's node port service will not be created.")
   private List<Channel> channels = new ArrayList<>();
 
   public AdminService withChannel(Channel port) {

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/Channel.java

@@ -5,15 +5,26 @@
 package oracle.kubernetes.weblogic.domain.v2;
 
 import com.google.gson.annotations.SerializedName;
+import javax.annotation.Nonnull;
+import oracle.kubernetes.json.Description;
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 
 public class Channel implements Comparable<Channel> {
   @SerializedName("channelName")
+  @Description(
+      "Name of channel. default' refers to the admin server's default channel (configured via the ServerMBean's ListenPort) "
+          + "'default-secure' refers to the admin server's default secure channel (configured via the ServerMBean's SSLMBean's ListenPort) "
+          + "'default-admin' refers to the admin server's default administrative channel (configured via the DomainMBean's AdministrationPort) "
+          + "Otherwise, the name is the name of one of the admin server's network access points (configured via the ServerMBean's NetworkAccessMBeans).")
+  @Nonnull
   private String channelName;
 
   @SerializedName("nodePort")
+  @Description(
+      "Specifies the port number used to access the WebLogic channel outside of the Kubernetes cluster. "
+          + "If not specified, defaults to the port defined by the WebLogic channel.")
   private Integer nodePort;
 
   public String getChannelName() {

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/Cluster.java

@@ -32,6 +32,9 @@ public class Cluster extends BaseConfiguration implements Comparable<Cluster> {
   @Range(minimum = 1)
   private Integer maxUnavailable;
 
+  // FIXME
+  private KubernetesResource clusterService;
+
   protected Cluster getConfiguration() {
     Cluster configuration = new Cluster();
     configuration.fillInFrom(this);

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/Domain.java

@@ -45,7 +45,7 @@ public class Domain {
    */
   @SerializedName("kind")
   @Expose
-  @Description("The type of resource. Should be 'Domain'")
+  @Description("The type of resource. Must be 'Domain'")
   private String kind;
   /**
    * Standard object's metadata. More info:

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/DomainSpec.java

@@ -48,7 +48,12 @@ public class DomainSpec extends BaseConfiguration {
    * Reference to secret containing WebLogic startup credentials username and password. Secret must
    * contain keys names 'username' and 'password' (Required)
    */
-  @Valid @NotNull private V1SecretReference webLogicCredentialsSecret;
+  @Description(
+      "The name of a pre-created Kubernetes secret, in the domain's namepace, that holds"
+          + " the username and password needed to boot WebLogic under the 'username' and 'password' fields.")
+  @Valid
+  @NotNull
+  private V1SecretReference webLogicCredentialsSecret;
 
   /**
    * The in-pod name of the directory to store the domain, node manager, server logs, and server

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/KubernetesResource.java

@@ -18,15 +18,16 @@ class KubernetesResource {
    *
    * @since 2.0
    */
-  @Description("Labels applied to pods")
+  @Description(
+      "The labels to be attached to generated resources. The label names must not start with 'weblogic.'.")
   private Map<String, String> labels = new HashMap<>();
 
   /**
    * The annotations to be attached to generated resources.
    *
    * @since 2.0
    */
-  @Description("Annotations applied to pods")
+  @Description("The annotations to be attached to generated resources.")
   private Map<String, String> annotations = new HashMap<>();
 
   void fillInFrom(KubernetesResource kubernetesResource1) {

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/ManagedServer.java

@@ -7,6 +7,7 @@
 import com.google.gson.annotations.Expose;
 import com.google.gson.annotations.SerializedName;
 import javax.annotation.Nonnull;
+import oracle.kubernetes.json.Description;
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.commons.lang3.builder.ToStringBuilder;
@@ -15,6 +16,8 @@ public class ManagedServer extends Server implements Comparable<ManagedServer> {
   /** The name of the managed server. Required. */
   @SerializedName("serverName")
   @Expose
+  @Description("The name of the server. Required.")
+  @Nonnull
   private String serverName;
 
   public String getServerName() {