diff --git a/docs/k8s-ui-explore-filter.png b/docs/k8s-ui-explore-filter.png new file mode 100644 index 00000000000..a9a53d0edf2 Binary files /dev/null and b/docs/k8s-ui-explore-filter.png differ diff --git a/docs/k8s-ui-explore-groupby.png b/docs/k8s-ui-explore-groupby.png new file mode 100644 index 00000000000..4f313af850d Binary files /dev/null and b/docs/k8s-ui-explore-groupby.png differ diff --git a/docs/k8s-ui-explore-poddetail.png b/docs/k8s-ui-explore-poddetail.png new file mode 100644 index 00000000000..ddcf6918c70 Binary files /dev/null and b/docs/k8s-ui-explore-poddetail.png differ diff --git a/docs/k8s-ui-explore.png b/docs/k8s-ui-explore.png new file mode 100644 index 00000000000..cd6b8b7bf5d Binary files /dev/null and b/docs/k8s-ui-explore.png differ diff --git a/docs/k8s-ui-nodes.png b/docs/k8s-ui-nodes.png new file mode 100644 index 00000000000..123b0267a2c Binary files /dev/null and b/docs/k8s-ui-nodes.png differ diff --git a/docs/k8s-ui-overview.png b/docs/k8s-ui-overview.png new file mode 100644 index 00000000000..ca98b28255c Binary files /dev/null and b/docs/k8s-ui-overview.png differ diff --git a/docs/ui.md b/docs/ui.md index 84fe59f23c5..2a6af90f54b 100644 --- a/docs/ui.md +++ b/docs/ui.md @@ -17,4 +17,28 @@ You can also use other web servers to serve the contents of the www/app director ### 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. +## Using the UI +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. + +### 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) + +### Dashboard Views +Click on "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) +"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 out related information of each resource. You can also click on any instance for more details. +![kubernetes UI - Nodes](k8s-ui-nodes.png) + [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/ui.md?pixel)]()