mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-10-31 13:50:01 +00:00
c47693c0d5
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.
44 lines
1.5 KiB
Markdown
44 lines
1.5 KiB
Markdown
# Kubernetes UX instructions
|
|
|
|
## Kubernetes User Interface
|
|
Kubernetes currently supports a simple web user interface.
|
|
|
|
### Running locally
|
|
Start the server:
|
|
|
|
```sh
|
|
cluster/kubecfg.sh -proxy -www $PWD/www
|
|
```
|
|
|
|
The UX should now be running on [localhost](http://localhost:8001/static/index.html#/groups//selector)
|
|
|
|
### 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](./labels.md) 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](https://github.com/jteeuwen/go-bindata)
|
|
|
|
To install go-bindata:
|
|
|
|
```sh
|
|
go get github.com/jteeuwen/go-bindata/...
|
|
```
|
|
|
|
To rebuild the UX, run the following:
|
|
|
|
```sh
|
|
go-bindata -o pkg/ui/datafile.go -prefix ${PWD} -pkg ui www/...
|
|
```
|