Eric Tune c47693c0d5 Separated user, dev, and design docs.

Renamed: logging.md -> devel/logging.m
Renamed: access.md -> design/access.md
Renamed: identifiers.md -> design/identifiers.md
Renamed:    labels.md -> design/labels.md
Renamed:    namespaces.md -> design/namespaces.md
Renamed:    security.md -> design/security.md
Renamed:    networking.md -> design/networking.md

Added abbreviated user user-focused document in place of most moved docs.

Added docs/README.md explains how docs are organized.
Added short, user-oriented documentation on labels
Added a glossary.
Fixed up some links.

2014-10-31 08:35:53 -07:00

1.5 KiB

Raw Blame History

Kubernetes UX instructions

Kubernetes User Interface

Kubernetes currently supports a simple web user interface.

Running locally

Start the server:

cluster/kubecfg.sh -proxy -www $PWD/www

The UX should now be running on localhost

Running remotely

When Kubernetes is deployed, the server deploys the UX, you can visit /static/index.html#/groups//selector on your master server.

Interacting with the user interface.

The Kubernetes user interface is a query-based visualization of the Kubernetes API. The user interface is defined by two functional primitives:

GroupBy

GroupBy takes a label key as a parameter, places all objects with the same value for that key within a single group. For example /groups/host/selector groups pods by host. /groups/name/selector groups pods by name. Groups are hiearchical, for example /groups/name/host/selector first groups by pod name, and then by host.

Select

Select takes a label selector and uses it to filter, so only resources which match that label selector are displayed. For example, /groups/host/selector/name=frontend, shows pods, grouped by host, which have a label with the name frontend.

Rebuilding the UX

The UX relies on go-bindata

To install go-bindata:

go get github.com/jteeuwen/go-bindata/...

To rebuild the UX, run the following:

go-bindata -o pkg/ui/datafile.go -prefix ${PWD} -pkg ui www/...

1.5 KiB Raw Blame History