Merge pull request #711 from oracle/doc-design

Design and recent changes doc

Author: rjeberhard

site/design.md

@@ -1,5 +1,3 @@
-**TODO** review and update, links to schema resources in particular
-
 # Design philosophy
 
 The Oracle WebLogic Server Kubernetes Operator (the “operator”) is designed to fulfill a similar role to that which a human operator would fill in a traditional data center deployment.  It contains a set of useful built-in knowledge about how to perform various lifecycle operations on a domain correctly.
@@ -24,17 +22,6 @@ The operator is designed to avoid imposing any arbitrary restriction on how WebL
 
 The operator learns of WebLogic domains through instances of a domain Kubernetes resource.  When the operator is installed, it creates a Kubernetes [Custom Resource Definition](https://kubernetes.io/docs/concepts/api-extension/custom-resources/).  This custom resource definition defines the domain resource type.  After this type is defined, you can manage domain resources using `kubectl` just like any other resource type.  For instance, `kubectl get domain` or `kubectl edit domain domain1`.  
 
-**TODO** RYAN these json files don't exist in the source tree
-
-Schema for domain resources:
-* [Domain](../model/src/main/resources/schema/domain.json)
-* [DomainSpec](../model/src/main/resources/schema/spec.json)
-* [ServerStartup](../model/src/main/resources/schema/serverstartup.json)
-* [ClusterStartup](../model/src/main/resources/schema/clusterstartup.json)
-* [DomainStatus](../model/src/main/resources/schema/status.json)
-* [DomainCondition](../model/src/main/resources/schema/condition.json)
-* [ServerStatus](../model/src/main/resources/schema/serverstatus.json)
-* [ServerHealth](../model/src/main/resources/schema/serverhealth.json)
-* [SubsystemHealth](../model/src/main/resources/schema/subsystemhealth.json)
+Schema for Domain resources is [here](https://oracle.github.io/weblogic-kubernetes-operator/domains/Domain.json).
 
 The schema for the domain resource is designed to be as sparse as possible.  It includes the connection details for the Administration Server, but all of the other content is operational details about which servers should be started, environment variables, and details about what should be exposed outside the Kubernetes cluster.  This way, the WebLogic domain's configuration remains the normative configuration.

site/recent-changes.md

@@ -1,11 +1,10 @@
-**TODO** update for 2.0
-
 # Recent changes to the Oracle WebLogic Server Kubernetes Operator
 
 This document tracks recent changes to the operator, especially ones that introduce backward incompatibilities.
 
-| Date | Introduces backward incompatibilities | Change |
-| --- | --- | --- |
-| March 20, 2018 | 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 | 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.
-| May 7, 2018 | no | Added support for dynamic clusters, the Apache HTTP Server, the Voyager Ingress Controller, and for PV in NFS storage for multi-node environments.
+| Date | Version | Introduces backward incompatibilities | Change |
+| --- | --- | --- | --- |
+| December 20, 2018 | v2.0-rc1 | yes | Operator is now installed via Helm charts, replacing the earlier scripts.  The operator now supports domain home on persistent volume or in Docker image use cases, which required a redesign of the Domain schema.  Customers can override domain configuration using configuration override templates.  Load balancers and Ingress can now be independently configured.  WebLogic logs can be directed to a persistent volume or WebLogic server console out can be directed to the pod log.  Added lifecycle support for servers and significantly more configurability for generated pods.  The final v2.0 release will be initial release where the operator team intends to provide backward compatability 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.
+| May 7, 2018 |   | no | Added support for dynamic clusters, the Apache HTTP Server, the Voyager Ingress Controller, and for PV in NFS storage for multi-node environments.