Merge pull request #555 from bryk/release-install

Update docs after 1.0 release

Author: bryk

README.md

@@ -7,20 +7,30 @@ Kubernetes Dashboard is a general purpose, web-based UI for Kubernetes clusters.
 manage applications running in the cluster and troubleshoot them, as well as manage the cluster
 itself.
 
-## Users questionnaire 
+## Users questionnaire
 Fill out the form to prioritize our work and help us make the UI better: http://goo.gl/forms/DloIYjsJBr
 
 ## Usage
 
-The Dashboard is currently under active development and is not ready for production use (yet!). To run the latest _unstable_ version execute the following command:
+It is likely that Dashboard is already installed on your cluster. To access it navigate in your
+browser to one of the following URLs: `https://<kubernetes-master>/ui` which redirects to
+`https://<kubernetes-master>/api/v1/proxy/namespaces/kube-system/services/kubernetes-dashboard`.
 
-`kubectl create -f https://raw.githubusercontent.com/kubernetes/dashboard/master/src/deploy/kubernetes-dashboard-canary.yaml`
+If you find that you’re not able to access the Dashboard you can install and open the latest
+stable release by running the following commands:
+```bash
+kubectl create -f https://rawgit.com/kubernetes/dashboard/master/src/deploy/kubernetes-dashboard.yaml
+kubectl proxy --port=8080
+```
+And then navigate to `http://localhost:8080/api/v1/proxy/namespaces/kube-system/services/kubernetes-dashboard`
 
 ## Documentation
 
-* The [Design overview](docs/design/README.md) describes design concepts of Dashboard
+* The [user guide](http://kubernetes.io/docs/user-guide/ui/) is an entry point for users of Dashboard
 
-* The [Developer guide](docs/devel/README.md) is for anyone wanting to contribute to Dashboard
+* The [design overview](docs/design/README.md) describes design concepts of Dashboard
+
+* The [developer guide](docs/devel/README.md) is for anyone wanting to contribute to Dashboard
 
 
 ## License

docs/devel/release.md

@@ -9,7 +9,7 @@ the steps below.
 
 1. Send a pull request that increases Kubernetes Dashboard version number in `build/conf.js`.
    The property name is `deploy.version.release`. Follow versioning guidelines.
-   Keep `package.json` version in sync.
+   Keep `package.json` and `src/deploy/kubernetes-dashboard.yaml` versions in sync.
 1. Get the pull request reviewed and merged.
 1. Create a git [release tag](https://github.com/kubernetes/dashboard/releases/) for the merged
    pull request. Release description should include changelog.

src/deploy/kubernetes-dashboard-canary.yaml

@@ -1,3 +1,21 @@
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Configuration to deploy canary version of the Dashboard UI.
+#
+# Example usage: kubectl create -f <this_file>
+
 kind: List
 apiVersion: v1
 items:

src/deploy/kubernetes-dashboard.yaml

@@ -0,0 +1,72 @@
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Configuration to deploy release version of the Dashboard UI.
+#
+# Example usage: kubectl create -f <this_file>
+
+kind: List
+apiVersion: v1
+items:
+- kind: ReplicationController
+  apiVersion: v1
+  metadata:
+    labels:
+      app: kubernetes-dashboard-canary
+      version: canary
+    name: kubernetes-dashboard-canary
+    namespace: kube-system
+  spec:
+    replicas: 1
+    selector:
+      app: kubernetes-dashboard-canary
+      version: canary
+    template:
+      metadata:
+        labels:
+          app: kubernetes-dashboard-canary
+          version: canary
+      spec:
+        containers:
+        - name: kubernetes-dashboard-canary
+          image: gcr.io/google_containers/kubernetes-dashboard-amd64:v1.0.0
+          imagePullPolicy: Always
+          ports:
+          - containerPort: 9090
+            protocol: TCP
+          args:
+            # Uncomment the following line to manually specify Kubernetes API server Host
+            # If not specified, Dashboard will attempt to auto discover the API server and connect
+            # to it. Uncomment only if the default does not work.
+            # - --apiserver-host=http://my-address:port
+          livenessProbe:
+            httpGet:
+              path: /
+              port: 9090
+            initialDelaySeconds: 30
+            timeoutSeconds: 30
+- kind: Service
+  apiVersion: v1
+  metadata:
+    labels:
+      app: kubernetes-dashboard-canary
+    name: dashboard-canary
+    namespace: kube-system
+  spec:
+    type: NodePort
+    ports:
+    - port: 80
+      targetPort: 9090
+    selector:
+      app: kubernetes-dashboard-canary