Merge remote-tracking branch 'origin/2.0-rc2' into doc-reorg

Author: rjeberhard

site/developer.md

@@ -93,11 +93,12 @@ If the operator's behavior or pod log is insufficient to diagnose and resolve fa
 The project includes integration tests that can be run against a Kubernetes cluster.  If you want to use these tests, you will need to provide your own Kubernetes cluster.  The Kubernetes cluster must meet the version number requirements and have Helm installed.  Ensure that the operator Docker image is in a Docker registry visible to the Kubernetes cluster.
 
 
-You will need to obtain the `kube.config` file for an administrative user and make it available on the machine running the build.  To run the tests, update the `KUBECONFIG` environment varaible to point to your config file and then execute:
+You will need to obtain the `kube.config` file for an administrative user and make it available on the machine running the build.  To run the tests, update the `KUBECONFIG` environment variable to point to your config file and then execute:
 
 ```
 $ mvn clean verify -P java-integration-tests
 ```
+**NOTE**: When you run the integrations tests, they do a cleanup of any operator or domains on that cluster.   
 
 ## Coding standards
 

site/quickstart.md

@@ -14,7 +14,7 @@ refer to the [User guide](user-guide.md).
     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).
+For this exercise, you’ll need a Kubernetes cluster. If you need help setting one up, check out our [cheat sheet](k8s_setup.md). This guide assumes a single node cluster.
 
 The operator uses Helm to create and deploy necessary resources and then run the operator in a Kubernetes cluster. For Helm installation and usage information, see [Install Helm and Tiller](install.md#install-helm-and-tiller).
 
@@ -52,7 +52,26 @@ f.	Then patch the WebLogic image according to the instructions [here](https://gi
 
 g. Copy the image to all the nodes in your cluster, or put it in a Docker registry that your cluster can access.
 
-## 2. Create a Traefik (Ingress-based) load balancer.
+## 2. Grant the Helm service account the `cluster-admin` role.
+
+```
+$ cat <<EOF | kubectl apply -f -
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: helm-user-cluster-admin-role
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: cluster-admin
+subjects:
+- kind: ServiceAccount
+  name: default
+  namespace: kube-system
+EOF
+```
+
+## 3. Create a Traefik (Ingress-based) load balancer.
 
 Use `helm` to install the [Traefik](../kubernetes/samples/charts/traefik/README.md) load balancer. Use the [values.yaml](../kubernetes/samples/charts/traefik/values.yaml) in the sample but set `kubernetes.namespaces` specifically.
 ```
@@ -64,7 +83,7 @@ $ helm install stable/traefik \
 --wait
 ```
 
-## 3. Install the operator.
+## 4. Install the operator.
 
 a.  Create a namespace for the operator:
 ```
@@ -74,26 +93,7 @@ b.	Create a service account for the operator in the operator's namespace:
 ```
 $ kubectl create serviceaccount -n sample-weblogic-operator-ns sample-weblogic-operator-sa
 ```
-c.  Grant the Helm service account the `cluster-admin` role:
-
-```
-$ cat <<EOF | kubectl apply -f -
-apiVersion: rbac.authorization.k8s.io/v1
-kind: ClusterRoleBinding
-metadata:
-  name: helm-user-cluster-admin-role
-roleRef:
-  apiGroup: rbac.authorization.k8s.io
-  kind: ClusterRole
-  name: cluster-admin
-subjects:
-- kind: ServiceAccount
-  name: default
-  namespace: kube-system
-EOF
-```
-
-d.  Use `helm` to install and start the operator from the directory you just cloned:	 
+c.  Use `helm` to install and start the operator from the directory you just cloned:	 
 
 ```
 $ helm install kubernetes/charts/weblogic-operator \
@@ -105,18 +105,18 @@ $ helm install kubernetes/charts/weblogic-operator \
   --wait
 ```
 
-e. Verify that the operator's pod is running, by listing the pods in the operator's namespace. You should see one for the operator.
+d. Verify that the operator's pod is running, by listing the pods in the operator's namespace. You should see one for the operator.
 ```
 $ kubectl get pods -n sample-weblogic-operator-ns
 ```
 
-f.  Verify that the operator is up and running by viewing the operator pod's log:
+e.  Verify that the operator is up and running by viewing the operator pod's log:
 
 ```
 $ kubectl logs -n sample-weblogic-operator-ns -c weblogic-operator deployments/weblogic-operator
 ```
 
-## 4. Prepare your environment for a domain.
+## 5. Prepare your environment for a domain.
 
 a.  Create a namespace that can host one or more domains:
 
@@ -144,7 +144,7 @@ $ helm upgrade \
   stable/traefik
 ```
 
-## 5. Create a domain in the domain namespace.
+## 6. Create a domain in the domain namespace.
 
 a. Create a Kubernetes secret containing the `username` and `password` for the domain using the [`create-weblogic-credentials`](../kubernetes/samples/scripts/create-weblogic-domain-credentials/create-weblogic-credentials.sh) script:
 
@@ -161,14 +161,11 @@ b.	Create a new image with a domain home by running the [`create-domain`](../kub
 Follow the directions in the [README](../kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/README.md) file,
 including:
 
-* Copying the sample `create-domain-inputs.yaml` file and updating your copy with the `domainUID` (`sample-domain1`),
+* Copying the sample `kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/create-domain-inputs.yaml` file and updating your copy with the `domainUID` (`sample-domain1`),
 domain namespace (`sample-domain1-ns`), and the `domainHomeImageBase` (`oracle/weblogic:12213-patch-wls-for-k8s`).
 
 * Setting `weblogicCredentialsSecretName` to the name of the secret containing the WebLogic credentials, in this case, `sample-domain1-weblogic-credentials`.
 
-  By convention, the secret will be named`domainUID-weblogic-credentials` (where `domainUID` is replaced with the
-  actual `domainUID` value).
-
 * Leaving the `image` empty unless you need to tag the new image that the script builds to a different name.
 
 For example, assuming you named your copy `my-inputs.yaml`:
@@ -251,7 +248,7 @@ $ curl -v -H 'host: sample-domain1.org' http://your.server.com:30305/weblogic/
 **Note**: Depending on where your Kubernetes cluster is running, you may need to open firewall ports or
 update security lists to allow ingress to this port.
 
-## 6. Remove the domain.
+## 7. Remove the domain.
 
 a.	Remove the domain's Ingress by using `helm`:
 ```
@@ -267,7 +264,7 @@ $ kubectl get pods -n sample-domain1-ns
 $ kubectl get domains -n sample-domain1-ns
 ```
 
-## 7. Remove the domain namespace.
+## 8. Remove the domain namespace.
 a.	Configure the Traefik load balancer to stop managing the Ingresses in the domain namespace:
 
 ```
@@ -295,7 +292,7 @@ c.	Delete the domain namespace:
 $ kubectl delete namespace sample-domain1-ns
 ```
 
-## 8. Remove the operator.
+## 9. Remove the operator.
 
 a.	Remove the operator:
 ```
@@ -306,7 +303,7 @@ b.	Remove the operator's namespace:
 ```
 $ kubectl delete namespace sample-weblogic-operator-ns
 ```
-## 9. Remove the load balancer.
+## 10. Remove the load balancer.
 a.	Remove the Traefik load balancer:
 ```
 $ helm delete --purge traefik-operator

site/scaling.md

@@ -77,7 +77,7 @@ When you POST to the `/scale` REST endpoint, you must send the following headers
 For example, when using `curl`:
 
 ```
-curl -v -k -H X-Requested-By:MyClient -H Content-Type:application/json -H Accept:application/json -H "Authorization:Bearer ..." -d { "managedServerCount": 3 } https:/.../scaling
+curl -v -k -H X-Requested-By:MyClient -H Content-Type:application/json -H Accept:application/json -H "Authorization:Bearer ..." -d '{ "managedServerCount": 3 }' https://.../scaling
 ```
 
 If you omit the header, you'll get a `400 (bad request)` response without any details explaining why the request was bad.  If you omit the Bearer Authentication header, then you'll get a `401 (Unauthorized)` response.