Docs for Dashboard UI features in 1.5 #1793

bryk · 2016-11-25T12:29:27Z

Feature: kubernetes/enhancements#136

This change is

Feature: kubernetes/enhancements#136

bryk · 2016-11-25T12:30:06Z

@rf232 Can you do tech review and apply "Tech Review LGTM" label when happy?

bryk · 2016-11-25T13:19:12Z

cc @kubernetes/features-maintainers @kubernetes/docs This is for 1.5

idvoretskyi · 2016-11-25T14:17:27Z

@bryk thank you for adding. @kubernetes/docs, @jaredbhatti please, review.

rf232 · 2016-11-28T11:30:35Z

@bryk: Tech Review LGTM, don't think I have access to edit labels though :)

philips · 2016-11-28T22:17:56Z

docs/user-guide/ui.md


 ---


-Dashboard (the web-based user interface of Kubernetes) allows you to deploy containerized applications to a Kubernetes cluster, troubleshoot them, and manage the cluster and its resources itself. You can use it for getting an overview of applications running on the cluster, as well as for creating or modifying individual Kubernetes resources and workloads, such as Daemon sets, Pet sets, Replica sets, Jobs, Replication controllers and corresponding Services, or Pods.
+Dashboard (the web-based user interface of Kubernetes) allows you to deploy containerized applications to a Kubernetes cluster, troubleshoot them, and manage the cluster and its resources itself. You can use it for getting an overview of applications running on the cluster, as well as for creating or modifying individual Kubernetes resources and workloads, such as Daemon Sets, Stateful Sets, Replica Sets, Jobs, Replication Controllers and corresponding Services, or Pods.


Should we even mention recplication controllers?

Yeah, makes sense. Done.

devin-donnelly · 2016-12-01T21:17:34Z

This PR needs to target the release-1.5 branch to avoid being prematurely merged before the 1.5 launch. Please retarget.

devin-donnelly · 2016-12-01T21:20:59Z

docs/user-guide/ui.md


 ---


-Dashboard (the web-based user interface of Kubernetes) allows you to deploy containerized applications to a Kubernetes cluster, troubleshoot them, and manage the cluster and its resources itself. You can use it for getting an overview of applications running on the cluster, as well as for creating or modifying individual Kubernetes resources and workloads, such as Daemon sets, Pet sets, Replica sets, Jobs, Replication controllers and corresponding Services, or Pods.
+Dashboard (the web-based user interface of Kubernetes) allows you to deploy containerized applications to a Kubernetes cluster, troubleshoot them, and manage the cluster and its resources itself. You can use it for getting an overview of applications running on the cluster, as well as for creating or modifying individual Kubernetes resources and workloads, such as Daemon Sets, Stateful Sets, Replica Sets, Jobs and corresponding Services, or Pods.


"Them" pronoun is ambiguous as used. Actually, all of the pronouns in the sentence are.

"Dashboard is a web-based Kubernetes user interface. You can use Dashboard to deploy containerized applications to a Kubernetes cluster, troubleshoot your containerized application, and manage the cluster itself along with its attendant resources. You can use Dashboard to get an overview of applications running on your cluster, as well as for creating or modifying individual Kubernetes resources (such as Deployments, Jobs, DaemonSets, etc)."

Done. Applied your suggestion.

devin-donnelly · 2016-12-01T21:22:30Z

docs/user-guide/ui.md


-Dashboard also provides information on the state of Pods, Replication controllers, etc. and on any errors that might have occurred. You can inspect and manage the Kubernetes resources, as well as your deployed containerized applications. You can also change the number of replicated Pods, delete Pods, and deploy new applications using a deploy wizard.
+Dashboard also provides information on the state of Deployments, Replica Sets, etc. and on any errors that might have occurred. You can inspect and manage the Kubernetes resources and applications deployed on the cluster. For example, you can scale a Deployment, initiate a rolling update, restart a pod or deploy new applications using a deploy wizard.


"Dashboard also provides information on the state of Kubernetes resources in your cluster, and on any errors that may have occurred."

The second sentence is unnecessary (repeats information from the first paragraph, but slightly reworded).

The last sentence needs to move to the end of the previous paragraph.

Done. Applied suggestions.

devin-donnelly · 2016-12-01T21:22:42Z

docs/user-guide/ui.md


 * TOC
 {:toc}

-## Dashboard access
+## Accessing Dashboard UI


Accessing the Dashboard UI

devin-donnelly · 2016-12-01T21:24:39Z

docs/user-guide/ui.md

-The Dashboard UI lives in the `kube-system` [namespace](/docs/admin/namespaces/), but shows all resources from all namespaces in your environment.
-
-If you find that you are not able to access Dashboard, you can install and open the latest stable release by running the following command:
+### Command line proxy


Try not to nest headers underneath each other; that usually means the document has structural problems.

In this case, add an introductory sentence: "There are multiple ways you can access the Dashboard UI; either by using the kubectl command-line interface, or by accessing the Kubernetes master apiserver using your web browser."

OK, thanks for reminder. Done.

devin-donnelly · 2016-12-01T21:25:06Z

docs/user-guide/ui.md

-
-If you find that you are not able to access Dashboard, you can install and open the latest stable release by running the following command:
+### Command line proxy
+The easiest way to access Dashboard is to use kubectl. Run the following command in your desktop environment:


Remove "the easiest way."

"You can access Dashboard using the kubectl command-line tool by running the following command:"

devin-donnelly · 2016-12-01T21:25:38Z

docs/user-guide/ui.md

-```
-kubectl config view
-```
+Please note, this works only if the apiserver is set up to allow authentication with username and password. This is not currently the case with the some setup tools (e.g., `kubeadm`). Refer to the  [documentation](docs/admin/authentication/) to configure it manually.


[documentation] -> [authentication admin documentation]

"to configure it manually" -> "for information on how to configure authentication manually."

devin-donnelly · 2016-12-01T21:32:43Z

docs/user-guide/ui.md

-When accessing Dashboard on an empty cluster for the first time, the Welcome page is displayed. This page contains a link to this document as well as a button to deploy your first application. In addition, you can view which system applications are running by **default** in the `kube-system` [namespace](/docs/admin/namespaces/) of your cluster, for example monitoring applications such as Heapster.
+## Welcome view
+
+When accessing Dashboard on an empty cluster, the welcome page is displayed. This page contains a link to this document as well as a button to deploy your first application. In addition, you can view which system applications are running by default in the `kube-system` [namespace](/docs/admin/namespaces/) of your cluster, for example the Dashboard itself.


"When you access Dashboard on an empty cluster, you'll see the welcome page."

devin-donnelly · 2016-12-01T21:33:53Z

docs/user-guide/ui.md


-Workloads are categorized as follows:
+#### Workloads
+Entry point view that shows all applications running in the selected namespace. The view lists applications by workload kind (e.g., Deployments, Replica Sets, Stateful Sets, etc.) and each workload kind can be viewed separately. The lists summarize actionable information about the workloads, such as the number of ready pods for a Replica Set or current memory usage for a Pod.


I think we typically keep ReplicaSet and StatefulSet as one word, since it's an API object.

Hmm... Does this apply to all objects? How about Horizontal Pod Autoscalers? Persistent Volume Claims?

I've definitely seen PersistentVolume and PersistentVolumeClaim (though usually abbreviated to PVC).

…r-1.5

bryk

PTAL, all but 1 comment applied

bryk · 2016-12-02T09:02:53Z

docs/user-guide/ui.md


 ---


-Dashboard (the web-based user interface of Kubernetes) allows you to deploy containerized applications to a Kubernetes cluster, troubleshoot them, and manage the cluster and its resources itself. You can use it for getting an overview of applications running on the cluster, as well as for creating or modifying individual Kubernetes resources and workloads, such as Daemon sets, Pet sets, Replica sets, Jobs, Replication controllers and corresponding Services, or Pods.
+Dashboard (the web-based user interface of Kubernetes) allows you to deploy containerized applications to a Kubernetes cluster, troubleshoot them, and manage the cluster and its resources itself. You can use it for getting an overview of applications running on the cluster, as well as for creating or modifying individual Kubernetes resources and workloads, such as Daemon Sets, Stateful Sets, Replica Sets, Jobs and corresponding Services, or Pods.


Done. Applied your suggestion.

bryk · 2016-12-02T09:03:54Z

docs/user-guide/ui.md


-Dashboard also provides information on the state of Pods, Replication controllers, etc. and on any errors that might have occurred. You can inspect and manage the Kubernetes resources, as well as your deployed containerized applications. You can also change the number of replicated Pods, delete Pods, and deploy new applications using a deploy wizard.
+Dashboard also provides information on the state of Deployments, Replica Sets, etc. and on any errors that might have occurred. You can inspect and manage the Kubernetes resources and applications deployed on the cluster. For example, you can scale a Deployment, initiate a rolling update, restart a pod or deploy new applications using a deploy wizard.


Done. Applied suggestions.

bryk · 2016-12-02T09:04:27Z

docs/user-guide/ui.md

-The Dashboard UI lives in the `kube-system` [namespace](/docs/admin/namespaces/), but shows all resources from all namespaces in your environment.
-
-If you find that you are not able to access Dashboard, you can install and open the latest stable release by running the following command:
+### Command line proxy


OK, thanks for reminder. Done.

bryk · 2016-12-02T09:04:49Z

docs/user-guide/ui.md

-
-If you find that you are not able to access Dashboard, you can install and open the latest stable release by running the following command:
+### Command line proxy
+The easiest way to access Dashboard is to use kubectl. Run the following command in your desktop environment:


bryk · 2016-12-02T09:06:11Z

docs/user-guide/ui.md

-```
-kubectl config view
-```
+Please note, this works only if the apiserver is set up to allow authentication with username and password. This is not currently the case with the some setup tools (e.g., `kubeadm`). Refer to the  [documentation](docs/admin/authentication/) to configure it manually.


bryk · 2016-12-02T09:06:32Z

docs/user-guide/ui.md

-When accessing Dashboard on an empty cluster for the first time, the Welcome page is displayed. This page contains a link to this document as well as a button to deploy your first application. In addition, you can view which system applications are running by **default** in the `kube-system` [namespace](/docs/admin/namespaces/) of your cluster, for example monitoring applications such as Heapster.
+## Welcome view
+
+When accessing Dashboard on an empty cluster, the welcome page is displayed. This page contains a link to this document as well as a button to deploy your first application. In addition, you can view which system applications are running by default in the `kube-system` [namespace](/docs/admin/namespaces/) of your cluster, for example the Dashboard itself.


bryk · 2016-12-02T09:08:25Z

docs/user-guide/ui.md


-Workloads are categorized as follows:
+#### Workloads
+Entry point view that shows all applications running in the selected namespace. The view lists applications by workload kind (e.g., Deployments, Replica Sets, Stateful Sets, etc.) and each workload kind can be viewed separately. The lists summarize actionable information about the workloads, such as the number of ready pods for a Replica Set or current memory usage for a Pod.


Hmm... Does this apply to all objects? How about Horizontal Pod Autoscalers? Persistent Volume Claims?

devin-donnelly · 2016-12-02T19:04:05Z

Thanks for getting to that. I think this one can probably be merged; the only other comment was more of a quibble.

janetkuo · 2016-12-05T03:11:34Z

docs/user-guide/ui.md

-```
-kubectl config view
-```
+Please note, this works only if the apiserver is set up to allow authentication with username and password. This is not currently the case with the some setup tools (e.g., `kubeadm`). Refer to the  [authentication admin documentation](docs/admin/authentication/) for information on how to configure authentication manually.


@bryk the link should be /docs/admin/authentication/

Docs for Dashboard UI features in 1.5

f840e4b

Feature: kubernetes/enhancements#136

bryk added this to the 1.5 milestone Nov 25, 2016

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 25, 2016

k8s-github-robot assigned jaredbhatti Nov 25, 2016

Replace images with those that have sparklines fixed

96e43ad

bryk mentioned this pull request Nov 28, 2016

Update docu for 1.5 kubernetes/dashboard#1446

Closed

bryk added the Tech Review LGTM label Nov 28, 2016

philips reviewed Nov 28, 2016

View reviewed changes

bryk added 2 commits November 29, 2016 09:25

Remove mention about RCs - they are deprecated

707bade

Merge branch 'master' into ui-docs-for-1.5

ab3782c

devin-donnelly suggested changes Dec 1, 2016

View reviewed changes

devin-donnelly added Docs Review: Open Issues cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Dec 1, 2016

bryk added 2 commits December 2, 2016 10:09

Apply @devin-donnelly comments

ba95bed

Merge remote-tracking branch 'origin/ui-docs-for-1.5' into ui-docs-fo…

7431c10

…r-1.5

bryk commented Dec 2, 2016

View reviewed changes

bryk changed the base branch from master to release-1.5 December 2, 2016 09:10

devin-donnelly approved these changes Dec 2, 2016

View reviewed changes

devin-donnelly assigned devin-donnelly and unassigned jaredbhatti Dec 2, 2016

devin-donnelly merged commit 5b007f8 into release-1.5 Dec 2, 2016

bryk deleted the ui-docs-for-1.5 branch December 4, 2016 23:05

janetkuo reviewed Dec 5, 2016

View reviewed changes


		Dashboard also provides information on the state of Pods, Replication controllers, etc. and on any errors that might have occurred. You can inspect and manage the Kubernetes resources, as well as your deployed containerized applications. You can also change the number of replicated Pods, delete Pods, and deploy new applications using a deploy wizard.
		Dashboard also provides information on the state of Deployments, Replica Sets, etc. and on any errors that might have occurred. You can inspect and manage the Kubernetes resources and applications deployed on the cluster. For example, you can scale a Deployment, initiate a rolling update, restart a pod or deploy new applications using a deploy wizard.

Docs for Dashboard UI features in 1.5 #1793

Docs for Dashboard UI features in 1.5 #1793

Conversation

bryk commented Nov 25, 2016 • edited by thockin Loading

bryk commented Nov 25, 2016

bryk commented Nov 25, 2016 • edited Loading

idvoretskyi commented Nov 25, 2016 • edited Loading

rf232 commented Nov 28, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devin-donnelly commented Dec 1, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bryk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devin-donnelly commented Dec 2, 2016

janetkuo Dec 5, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bryk commented Nov 25, 2016 •

edited by thockin

Loading

bryk commented Nov 25, 2016 •

edited

Loading

idvoretskyi commented Nov 25, 2016 •

edited

Loading

janetkuo Dec 5, 2016 •

edited

Loading