Merge pull request #10895 from JanetKuo/k8s-ui

Update UI doc for the usage of Kubernetes UI

docs/ui.md

@@ -1,20 +1,41 @@
-# Kubernetes UI Instructions
+# Kubernetes User Interface
+Kubernetes has a web-based user interface that displays the current cluster state graphically. 
 
-## Kubernetes User Interface
-Kubernetes has an extensible user interface with default functionality that describes the current cluster. See the [README](../www/README.md) in the www directory for more information.
-
-### Running locally
-Assuming that you have a cluster running locally at `localhost:8080`, as described [here](getting-started-guides/locally.md), you can run the UI against it with kubectl:
+## Accessing the UI
+By default, the Kubernetes UI is deployed as a cluster addon. To access it, visit `https://<kubernetes-master>/ui`, which redirects to `https://<kubernetes-master>/api/v1/proxy/namespaces/kube-system/services/kube-ui/#/dashboard/`.
 
+If you find that you're not able to access the UI, it may be because the kube-ui service has not been started on your cluster. In that case, you can start it manually with:
 ```sh
-kubectl proxy --www=www/app --www-prefix=/
+kubectl create -f cluster/addons/kube-ui/kube-ui-rc.yaml
+kubectl create -f cluster/addons/kube-ui/kube-ui-svc.yaml
 ```
+Normally, this should be taken care of automatically by the [`kube-addons.sh`](../cluster/saltbase/salt/kube-addons/kube-addons.sh) script that runs on the master.
 
-You should now be able to access it by visiting [localhost:8001](http://localhost:8001/).
+## Using the UI
+The Kubernetes UI can be used to introspect your current cluster, such as checking how resources are used, or looking at error messages. You cannot, however, use the UI to modify your cluster. 
 
-You can also use other web servers to serve the contents of the www/app directory, as described [here](../www/README.md#serving-the-app-during-development).
+### Node Resource Usage 
+After accessing Kubernetes UI, you'll see a homepage dynamically listing out all nodes in your current cluster, with related information including internal IP addresses, CPU usage, memory usage, and file systems usage. 
+![kubernetes UI home page](k8s-ui-overview.png)
 
-### Running remotely
-When Kubernetes is deployed remotely, the UI is deployed as a cluster addon. To access it, visit `/ui`, which redirects to `/api/v1/proxy/namespaces/default/services/kube-ui/#/dashboard/`, on your master server.
+### Dashboard Views
+Click on the "Views" button in the top-right of the page to see other views available, which include: Explore, Pods, Nodes, Replication Controllers, Services, and Events. 
+
+#### Explore View 
+The "Explore" view allows your to see the pods, replication controllers, and services in current cluster easily.  
+![kubernetes UI Explore View](k8s-ui-explore.png)
+The "Group by" dropdown list allows you to group these resources by a number of factors, such as type, name, host, etc.
+![kubernetes UI Explore View - Group by](k8s-ui-explore-groupby.png)
+You can also create filters by clicking on the down triangle of any listed resource instances and choose which filters you want to add.
+![kubernetes UI Explore View - Filter](k8s-ui-explore-filter.png)
+To see more details of each resource instance, simply click on it.  
+![kubernetes UI - Pod](k8s-ui-explore-poddetail.png)
+
+### Other Views
+Other views (Pods, Nodes, Replication Controllers, Services, and Events) simply list information about each type of resource. You can also click on any instance for more details. 
+![kubernetes UI - Nodes](k8s-ui-nodes.png)
+
+## More Information 
+For more information, see the [Kubernetes UI development document](../www/README.md) in the www directory.
 
 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/ui.md?pixel)]()