Merge pull request #223 from gertipoppel/master

Updated the dashboard documentation
This commit is contained in:
Brian Grant 2016-04-13 14:01:20 -07:00
commit f398d2737e
6 changed files with 60 additions and 33 deletions

View File

@ -16,6 +16,8 @@ toc:
path: /docs/user-guide/walkthrough/ path: /docs/user-guide/walkthrough/
- title: Kubernetes 201 - title: Kubernetes 201
path: /docs/user-guide/walkthrough/k8s201/ path: /docs/user-guide/walkthrough/k8s201/
- title: Accessing the Kubernetes Web UI
path: /docs/user-guide/ui-access/
- title: User Guide - title: User Guide
path: /docs/user-guide/ path: /docs/user-guide/
@ -142,7 +144,7 @@ toc:
path: /docs/user-guide/resizing-a-replication-controller/ path: /docs/user-guide/resizing-a-replication-controller/
- title: Service Operations - title: Service Operations
path: /docs/user-guide/services/operations/ path: /docs/user-guide/services/operations/
- title: Using Nodes, Pods, and Containers - title: Using Nodes, Pods, and Containers
section: section:
- title: The Container Environment - title: The Container Environment
@ -151,7 +153,7 @@ toc:
path: /docs/user-guide/simple-nginx/ path: /docs/user-guide/simple-nginx/
- title: Working with Containers - title: Working with Containers
path: /docs/user-guide/production-pods/ path: /docs/user-guide/production-pods/
- title: Overriding Default Container Behavior - title: Overriding Default Container Behavior
path: /docs/user-guide/containers/ path: /docs/user-guide/containers/
- title: Running Commands in a Container with kubectl exec - title: Running Commands in a Container with kubectl exec
path: /docs/user-guide/getting-into-containers/ path: /docs/user-guide/getting-into-containers/
@ -202,7 +204,7 @@ toc:
path: /docs/admin/master-node-communication/ path: /docs/admin/master-node-communication/
- title: Network Plugins - title: Network Plugins
path: /docs/admin/network-plugins/ path: /docs/admin/network-plugins/
- title: Configuring Kubernetes - title: Configuring Kubernetes
section: section:
- title: Using Configuration Files - title: Using Configuration Files
@ -246,6 +248,8 @@ toc:
path: /docs/user-guide/rolling-updates/ path: /docs/user-guide/rolling-updates/
- title: Launching, Exposing, and Killing Applications - title: Launching, Exposing, and Killing Applications
path: /docs/user-guide/quick-start/ path: /docs/user-guide/quick-start/
- title: Web Interface
path: /docs/user-guide/ui/
- title: Testing and Monitoring - title: Testing and Monitoring
section: section:

View File

@ -8,8 +8,6 @@ toc:
section: section:
- title: Debugging Pods and Replication Controllers - title: Debugging Pods and Replication Controllers
path: /docs/user-guide/debugging-pods-and-replication-controllers/ path: /docs/user-guide/debugging-pods-and-replication-controllers/
- title: Web Interface
path: /docs/user-guide/ui/
- title: Application Introspection and Debugging - title: Application Introspection and Debugging
path: /docs/user-guide/introspection-and-debugging/ path: /docs/user-guide/introspection-and-debugging/
- title: Retrieving Logs - title: Retrieving Logs

View File

@ -127,7 +127,7 @@ If all goes well, you should be able to see the container image listed in the co
## Create your cluster ## Create your cluster
A cluster consists of a master API server and a set of worker VMs called nodes. A cluster consists of a master API server and a set of worker VMs called nodes.
Create a cluster via the Console: *Compute > Container Engine > Container Clusters > New container cluster*. Leave all the options default, and you should get a Kubernetes cluster with three nodes, ready to receive your container image. Create a cluster via the Console: *Compute > Container Engine > Container Clusters > New container cluster*. Leave all the options default, and you should get a Kubernetes cluster with three nodes, ready to receive your container image.
@ -277,7 +277,7 @@ First, lets modify the application. On the development machine, edit server.j
We can now build and publish a new container image to the registry with an incremented tag: We can now build and publish a new container image to the registry with an incremented tag:
```shell ```shell
docker build -t gcr.io/PROJECT_ID/hello-node:v2 . docker build -t gcr.io/PROJECT_ID/hello-node:v2 .
gcloud docker push gcr.io/PROJECT_ID/hello-node:v2 gcloud docker push gcr.io/PROJECT_ID/hello-node:v2
``` ```
@ -362,9 +362,20 @@ While this is happening, the users of the services should not see any interrupti
Hopefully with these deployment, scaling and update features youll agree that once youve setup your environment (your GKE/Kubernetes cluster here), Kubernetes is here to help you focus on the application rather than the infrastructure. Hopefully with these deployment, scaling and update features youll agree that once youve setup your environment (your GKE/Kubernetes cluster here), Kubernetes is here to help you focus on the application rather than the infrastructure.
## Observe the Kubernetes Web UI (optional)
With Kubernetes 1.2, a graphical web user interface (dashboard) has been introduced. It is enabled by default for 1.2 clusters.
This user interface allows you to get started quickly and enables some of the functionality found in the CLI as a more approachable and discoverable way of interacting with the system.
Enjoy the Kubernetes graphical dashboard and use it for deploying containerized applications, as well as for monitoring and managing your clusters!
![image](/images/docs/ui-dashboard-cards-menu.png)
Learn more about the web interface by taking the [Dashboard tour](/docs/user-guide/ui/).
## That's it! Time to tear it down ## That's it! Time to tear it down
That's it for the demo! So you don't leave this all running and incur charges, let's learn how to tear things down. That's it for the demo! So you don't leave this all running and incur charges, let's learn how to tear things down.
Delete the Deployment (which also deletes the running pods) and Service (which also deletes your external load balancer): Delete the Deployment (which also deletes the running pods) and Service (which also deletes your external load balancer):

View File

@ -0,0 +1,32 @@
---
---
By default, the Kubernetes Dashboard is deployed as a cluster addon. For 1.2 clusters, it is enabled by default.
If you want to manually install it, visit
`https://<kubernetes-master>/ui`, which redirects to
`https://<kubernetes-master>/api/v1/proxy/namespaces/kube-system/services/kubernetes-dashboard`.
If you find that you're not able to access the Dashboard, it may be because the
`kubernetes-dashboard` service has not been started on your cluster. In that case,
you can start it manually as follows:
```shell
kubectl create -f cluster/addons/dashboard/dashboard-controller.yaml --namespace=kube-system
kubectl create -f cluster/addons/dashboard/dashboard-service.yaml --namespace=kube-system
```
Normally, this should be taken care of automatically by the
[`kube-addons.sh`](http://releases.k8s.io/{{page.githubbranch}}/cluster/saltbase/salt/kube-addons/kube-addons.sh)
script that runs on the master. Release notes and development versions of the Dashboard can be
found at https://github.com/kubernetes/dashboard/releases.
## Walkthrough
For information on how to use the Dashboard, take the [Dashboard tour](/docs/user-guide/ui/).
## More Information
For more information, see the
[Kubernetes Dashboard repository](https://github.com/kubernetes/dashboard).

View File

@ -5,34 +5,16 @@
Kubernetes has a web-based user interface that allows you to deploy containerized Kubernetes has a web-based user interface that allows you to deploy containerized
applications to a Kubernetes cluster, troubleshoot them, and manage the cluster itself. applications to a Kubernetes cluster, troubleshoot them, and manage the cluster itself.
## Accessing the Dashboard By default, the Kubernetes Dashboard is deployed as a cluster addon. It is enabled by default in Kubernetes 1.2 clusters. Click [here](/docs/user-guide/ui-access/) to learn more about the Dashboard access.
By default, the Kubernetes Dashboard is deployed as a cluster addon. To access it, visit ## Using the Dashboard
`https://<kubernetes-master>/ui`, which redirects to
`https://<kubernetes-master>/api/v1/proxy/namespaces/kube-system/services/kubernetes-dashboard`.
If you find that you're not able to access the Dashboard, it may be because the
`kubernetes-dashboard` service has not been started on your cluster. In that case,
you can start it manually as follows:
```shell
kubectl create -f cluster/addons/dashboard/dashboard-controller.yaml --namespace=kube-system
kubectl create -f cluster/addons/dashboard/dashboard-service.yaml --namespace=kube-system
```
Normally, this should be taken care of automatically by the
[`kube-addons.sh`](http://releases.k8s.io/{{page.githubbranch}}/cluster/saltbase/salt/kube-addons/kube-addons.sh)
script that runs on the master. Release notes and development versions of the Dashboard can be
found at https://github.com/kubernetes/dashboard/releases.
## Using the Dashboard
The Dashboard can be used to get an overview of applications running on the cluster, and to provide information on any errors that have occurred. You can also inspect your replication controllers and corresponding services, change the number of replicated Pods, and deploy new applications using a deploy wizard. The Dashboard can be used to get an overview of applications running on the cluster, and to provide information on any errors that have occurred. You can also inspect your replication controllers and corresponding services, change the number of replicated Pods, and deploy new applications using a deploy wizard.
When accessing the 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. When accessing the 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.
![Kubernetes Dashboard welcome page](/images/docs/ui-dashboard-zerostate.png) ![Kubernetes Dashboard welcome page](/images/docs/ui-dashboard-zerostate.png)
### Deploying applications ### Deploying applications
The Dashboard lets you create and deploy a containerized application as a Replication Controller with a simple wizard: The Dashboard lets you create and deploy a containerized application as a Replication Controller with a simple wizard:
@ -45,7 +27,7 @@ The wizard expects that you provide the following information:
- **App name** (mandatory): Name for your application. A [label](/docs/user-guide/labels/) with the name will be added to the Replication Controller and Service, if any, that will be deployed. - **App name** (mandatory): Name for your application. A [label](/docs/user-guide/labels/) with the name will be added to the Replication Controller and Service, if any, that will be deployed.
The application name must be unique within the selected Kubernetes namespace. It must start with a lowercase character, and contain only lowercase letters, numbers and dashes (-). It is limited to 24 characters. The application name must be unique within the selected Kubernetes [namespace](/docs/admin/namespaces/). It must start with a lowercase character, and contain only lowercase letters, numbers and dashes (-). It is limited to 24 characters.
- **Container image** (mandatory): The URL of a public Docker [container image](/docs/user-guide/images/) on any registry, or a private image (commonly hosted on the Google Container Registry or Docker Hub). - **Container image** (mandatory): The URL of a public Docker [container image](/docs/user-guide/images/) on any registry, or a private image (commonly hosted on the Google Container Registry or Docker Hub).

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 38 KiB