Merge branch 'userguide' of https://github.com/oracle/weblogic-kubernetes-operator into 2.0-rc1-final-doc-review

Author: markxnelson

kubernetes/samples/scripts/elasticsearch-and-kibana/README.md

@@ -19,10 +19,10 @@ to, therefore, the customer only needs to set `elkIntegrationEnabled` to `true`
 
 To install ElasticSearch and Kibana, use:
 ```
-  kubectl apply -f kubernetes/samples/scripts/elasticsearch-and-kibana/elasticsearch_and_kibana.yaml
+$  kubectl apply -f kubernetes/samples/scripts/elasticsearch-and-kibana/elasticsearch_and_kibana.yaml
 ```
 
 To remove them, use:
 ```
-  kubectl delete -f kubernetes/samples/scripts/elasticsearch-and-kibana/elasticsearch_and_kibana.yaml
+$  kubectl delete -f kubernetes/samples/scripts/elasticsearch-and-kibana/elasticsearch_and_kibana.yaml
 ```

site/helm-charts.md

@@ -12,13 +12,13 @@ Helm has two parts: a client (helm) and a server (tiller). Tiller runs inside of
 
 The operator Helm chart is pre-configured with default values for the configuration of the operator.
 
-The user can override these values by doing one of the following:
-- create a custom YAML file with the only values to be overridden, and specify the `--value` option on the Helm command line
-- override individual values directly on the helm command line, using the `--set` option 
+You can override these values by doing one of the following:
+- Create a custom YAML file with only the values to be overridden, and specify the `--value` option on the Helm command line
+- Override individual values directly on the Helm command line, using the `--set` option
 
-The user can find out the configuration values that the Helm chart supports, as well as the default values, using this command:
+You can find out the configuration values that the Helm chart supports, as well as the default values, using this command:
 ```
-helm inspect values kubernetes/charts/weblogic-operator
+$ helm inspect values kubernetes/charts/weblogic-operator
 ```
 
 The available configuration values are explained by category in [Operator Helm configuration values](#operator-helm-configuration-values) below.
@@ -41,9 +41,9 @@ More detailed information about configuration values can be found in [Operator H
 ### SSL certificate and private key for the REST interface
 
 For testing purposes, the WebLogic Kubernetes Operator project provides a sample script that generates a self-signed certificate and private key for the operator REST interface and outputs them out in YAML format. These values can be added to the user's custom YAML configuration file, for use when the operator's Helm chart is installed.
-   
+
 ___This script should not be used in a production environment (since self-signed certificates are normally not considered safe).___
-   
+
 The script takes the subject alternative names that should be added to the certificate - i.e. the list of hostnames that clients can use to access the external REST interface. In this example, the output is directly appended to the user's custom YAML configuration:
 ```
 kubernetes/samples/scripts/rest/generate-external-rest-identity.sh "DNS:${HOSTNAME},DNS:localhost,IP:127.0.0.1" >> custom-values.yaml
@@ -71,7 +71,7 @@ The `helm install` command is used to install the operator Helm chart. As part o
 
 The user can override default configuration values in the operator Helm chart by doing one of the following:
 - create a custom YAML file containing the values to be overridden, and specify the `--value` option on the Helm command line
-- override individual values directly on the helm command line, using the `--set` option 
+- override individual values directly on the helm command line, using the `--set` option
 
 The user supplies the `–namespace` argument from the `helm install` command line to specify the namespace in which the operator should be installed.  If not specified, it defaults to `default`.  If the namespace does not already exist, Helm will automatically create it (and create a default service account in the new namespace), but will not remove it when the release is deleted.  If the namespace already exists, Helm will re-use it.  These are standard Helm behaviors.
 
@@ -170,7 +170,7 @@ Example:
 serviceAccount: "weblogic-operator"
 ```
 
-#### javaLoggingLevel 
+#### javaLoggingLevel
 
 Specifies the level of Java logging that should be enabled in the operator. Valid values are:  "SEVERE", "WARNING", "INFO", "CONFIG", "FINE", "FINER", and "FINEST".
 
@@ -183,7 +183,7 @@ javaLoggingLevel:  "FINE"
 
 ### Creating the operator pod
 
-#### image 
+#### image
 
 Specifies the Docker image containing the operator code.
 
@@ -249,7 +249,7 @@ Example:
 elkIntegrationEnabled:  true
 ```
 
-#### logStashImage 
+#### logStashImage
 
 Specifies the Docker image containing Logstash.  This parameter is ignored if `elkIntegrationEnabled` is false.
 
@@ -260,7 +260,7 @@ Example:
 logStashImage:  "logstash:6.2"
 ```
 
-#### elasticSearchHost 
+#### elasticSearchHost
 Specifies the hostname where Elasticsearch is running. This parameter is ignored if `elkIntegrationEnabled` is false.
 
 Defaults to `elasticsearch.default.svc.cluster.local`
@@ -270,7 +270,7 @@ Example:
 elasticSearchHost: "elasticsearch2.default.svc.cluster.local"
 ```
 
-#### elasticSearchPort 
+#### elasticSearchPort
 
 Specifies the port number where Elasticsearch is running. This parameter is ignored if `elkIntegrationEnabled` is false.
 
@@ -349,7 +349,7 @@ externalOperatorKey: QmFnIEF0dHJpYnV0ZXMKICAgIGZyaWVuZGx5TmFtZTogd2VibG9naWMtb3B
 
 #### remoteDebugNodePortEnabled
 
-Specifies whether or not the operator will start a Java remote debug server on the provided port and suspend execution until a remote debugger has attached. 
+Specifies whether or not the operator will start a Java remote debug server on the provided port and suspend execution until a remote debugger has attached.
 
 Defaults to `false`
 
@@ -404,7 +404,7 @@ You can't fix it by rolling back this release since it is not in the 'DEPLOYED'
 
 You can't fix it by deleting the previous release since it removes the operator's resources too
 
-All you can do is delete both operator releases and reinstall the original operator. 
+All you can do is delete both operator releases and reinstall the original operator.
 See https://github.com/helm/helm/issues/2349
 
 ### Install an operator and tell it to manage a domain namespace that another operator is already managing

site/prepare-k8s.md

@@ -1,18 +1,22 @@
-**TODO** write me
+# Preparing your Kubernetes environment
 
-## Preparing your Kubernetes environment
 
-**TODO** write intro 
 
-### Set up your Kubernetes cluster
+## Set up your Kubernetes cluster
 
 If you need help setting up a Kubernetes environment, check our [cheat sheet](site/k8s_setup.md).
 
 After creating Kubernetes clusters, you can optionally:
 * Create load balancers to direct traffic to backend domains.
 * Configure Kibana and Elasticsearch for your operator logs.
 
+
+### Load balancing with an Ingress controller or a web server
+
+You can choose a load balancer provider for your WebLogic domains running in a Kubernetes cluster. Please refer to the [WebLogic Operator Load Balancer Samples](../kubernetes/samples/charts/README.md) for information about the current capabilities and setup instructions for each of the supported load balancers,
+
+
 ### Configuring Kibana and Elasticsearch
 
-You can send the operator logs to Elasticsearch, to be displayed in Kibana. Use 
+You can send the operator logs to Elasticsearch, to be displayed in Kibana. Use
 this [sample script](/kubernetes/samples/scripts/elasticsearch-and-kibana/README.md) to configure Elasticsearch and Kibana deployments and services.

site/user-guide.md

@@ -1,25 +1,25 @@
-# User Guide
+# User guide
 
-This document provides detailed information that is targeted at the user of the Oracle WebLogic 
-Server Kubernetes Operator.  It provides instructions on how to install the operator in your 
+This document provides detailed information that is targeted at the user of the Oracle WebLogic
+Server Kubernetes Operator.  It provides instructions on how to install the operator in your
 Kubernetes cluster and how to use it to manage WebLogic domains.  
 
-If you are looking for information about how the operator is designed, implemented, built, etc., then 
+If you are looking for information about how the operator is designed, implemented, built, and such, then
 you should refer to the [Developer guide](developer.md).
 
 ## Table of contents
 
-The information in this guide is organized in the order that you would most likely need to use it.  If you 
-want to set up an operator and use it to create and manage WebLogic domains, you should 
-follow this guide from top to bottom, and the necessary information will be 
+The information in this guide is organized in the order that you would most likely need to use it.  If you
+want to set up an operator and use it to create and manage WebLogic domains, you should
+follow this guide from top to bottom, and the necessary information will be
 presented in the correct order.
 
 * [Important terms](#important-terms)
 * [Getting started](#getting-started)
 * [Prerequisites](#prerequisites)
 * [Preparing your Kubernetes environment to run the operator](prepare-k8s.md)
   * [Set up your Kubernetes cluster](prepare-k8s.md#set-up-your-kubernetes-cluster)
-  * [Set up load balancers](load-balancing.md)
+  * [Set up load balancers](prepare-k8s.md#load-balancing-with-an-ingress-controller-or-a-web-server)
   * [Configuring Kibana and Elasticsearch](prepare-k8s.md#configuring-kibana-and-elasticsearch)
 * [Install and manage the operator](install.md)
   * [Using the Helm charts](helm-charts.md)
@@ -70,4 +70,3 @@ Before using the operator, you might want to read the [design philosophy](design
 * Helm 2.8.2+ (check with `helm version`).
 * Oracle WebLogic Server 12.2.1.3.0 with patch 28076014.
 * You must have the `cluster-admin` role to install the operator.
-