Find your way around

The sidebar, the namespace filter, the command palette, table filters, favourites, saved views and keyboard shortcuts.

The sidebar

The sidebar starts with Clusters, which goes back to the cluster list, a Disconnect button while a cluster is open (it disconnects that cluster and returns to the list), and Search…, which opens the command palette. Below them:

  • Navigate: the Overview, then the cluster’s resources in groups: Workloads, Configuration, Network, Storage, Devices (DRA), Access Control, Admission and Cluster. Click a group to open it.
  • Custom Resources: every custom resource kind on the cluster, grouped by API group. See CRDs.
  • Saved views, once you have some.
  • Tools: Terminal, Create Resource, CRDs, Ports, Helm, ArgoCD, Flux, RBAC, Vulnerabilities, Right-sizing, Cost / Waste, Karpenter, KEDA, Upgrade Readiness, Audit Log, Timeline and Topology.
  • Favorites, once you have some, just above Tools. Click its title to collapse it; Kubebay remembers whether it is open. Hover a row and click × to remove it.
  • Settings, last.

Press ⌘ B (Ctrl B on Windows and Linux) to hide the sidebar and get the width back. Press it again, or click the button on the cluster rail, to bring it back.

Several windows

In the desktop app, File > New Window (⌘ N, Ctrl N on Windows and Linux) opens another window on the same Kubebay engine. Use it to look at two clusters side by side. On a Mac, right-click the Kubebay icon in the Dock and choose New Window for the same thing. Clicking the Dock icon when every window is closed also opens one.

  • A new window opens on the cluster list, and each window remembers its own connected cluster, so connecting one window does not change the others.
  • Theme, font and density are shared: change one in Settings and every open window follows. Favourites, table columns and sorting are shared too, and are read when a window opens, so an open window picks up another window’s change the next time it loads that table.
  • Closing a window leaves the others running. Kubebay stops its engine when the last window closes.
  • All windows use the same kubeconfig. Separate profiles with their own clusters are not available yet.

What is this?

Every page has an ⓘ beside its title, and so does each insight card, such as SPOF Radar, Attack paths or the Efficiency score. Click it, or focus it and press Enter, for a sentence on what the page is, one on how it works, and a link to its page in this manual. Esc or a click elsewhere closes it.

The namespace filter

Most pages have a namespace filter. Pick one namespace, several, or All namespaces. The choice is shared across pages and remembered for each cluster.

On clusters managed by Rancher, namespaces are grouped by Rancher project.

The namespaces you have ticked are listed first, right after All namespaces, so they are easy to untick. On a cluster with Rancher projects they form a Selected group above the project groups. Search still narrows the list.

The command palette

Press ⌘ K (Ctrl K) anywhere to open the palette, including while the cursor is in a YAML editor, then type to search:

  • every page and resource kind;
  • your saved views;
  • your clusters, to switch to one (see below);
  • active port-forwards;
  • the objects of the current cluster, by name or namespace: pods, Deployments, StatefulSets, DaemonSets, Jobs, nodes and namespaces at once; Services, Ingresses, ConfigMaps, Secrets (names only, never their values), PVCs, ServiceAccounts, Roles, CronJobs, ReplicaSets and the other built-in kinds; custom resources such as Argo Rollouts, Flux, KEDA, Karpenter, Gateway API and cert-manager; and the CRDs themselves.

Objects come in groups, one per kind, with how many matched. Pick one to open that object. A pod opens in the Pods list with its drawer open; the rest open on their own page. If a kind has more matches than rows, Show all opens its list filtered to what you typed.

  • Several words must all match, in the name or the namespace: shop gateway. shop/api means namespace shop, name api.
  • A kind word, then a space limits the search to that kind: deploy api, pod web, sts db. pod:web and ns: work too. The words are pod, deploy, sts, ds, job, node and ns, singular or plural. A kind word and a space with nothing after it lists that kind alphabetically, with Show all for the rest.
  • Matches are ranked: an exact name first, then names that start with what you typed, then words inside a name, then anywhere in the name, then the namespace.
  • With nothing typed, the palette lists what you opened last under Recent.

When you have more than one cluster connected, This cluster and All clusters at the top choose where to search. It starts on the current cluster. A result from another cluster names it, and opening it switches to that cluster.

What is searched, and what you have to name. The first seven kinds come from what Kubebay already holds, so they answer at once. The others are followed by the engine, as your account, the first time you search a cluster, so their results fill in over a few seconds and the palette says Still loading until they have. Kinds your account may not list are skipped, and named. After about five minutes without a search Kubebay stops following them.

Some kinds are only searched when you name them: Events, Leases, Endpoints, EndpointSlices, ControllerRevisions, report objects such as Vulnerability Reports, and custom resources from groups Kubebay doesn’t know. They are large or change constantly, so following them in advance would cost more than it’s worth. Name one and it is followed for as long as you keep searching: events crashloop, endpoints api, certificate web. When there are such kinds, the palette lists them under your results.

The words that name a kind are the usual short names: svc, ing, cm, pvc, sa, cj, rs, hpa, crd, event. For a custom resource it is the plural, the singular, a short name, or plural.group, such as rollouts.argoproj.io. A very large kind is searched up to a limit, and the palette says when it hit it.

A word that names a kind lists that kind’s objects, so you don’t need to know what they’re called. scaled finds your ScaledObjects and ScaledJobs, keda every KEDA kind, rollout the Rollouts, config the ConfigMaps. From four letters it matches the start of the kind’s name, its short name or its API group, and an exact short name such as svc works at any length. Add a name to narrow it: scaled orders. An object whose name contains the word still ranks above one that only belongs to the kind, and Show all opens the whole list.

A CRD result opens the objects it defines, such as the ScaledObjects for scaledobjects.keda.sh. A Service, Ingress, ConfigMap or custom resource opens on its own page.

Switching cluster

The palette is the fastest way to change cluster.

  • With the box empty, Switch cluster is the first thing listed: the clusters you used last, pinned ones first. The current cluster isn’t in it. A line under the list always reminds you: @ to switch cluster.
  • Type part of a cluster’s name, or its alias, and it appears: stag finds Staging.
  • switch , cluster , ctx or @ followed by words lists clusters first: switch prod, @stage. A bare @ lists them all.

Pick one and Kubebay opens it exactly as the Clusters page does: it connects, makes it the current cluster and lands on its Overview. A cluster whose kubeconfig is broken can’t be opened, so picking it takes you to the Clusters page, which says why.

Use ↑ and ↓ to move, Enter to open, and Esc to close.

Filtering a table

Every resource table has a filter box. Press / to jump to it, and Esc in the box to clear it. It understands a small query language:

You type It matches
web rows that show web anywhere. Every word must match
ns:shop rows in namespace shop (namespace: works too)
name:api rows whose name contains api
status:running a column’s value. Any column with a filter key works, such as node:
label:app=web rows with label app set to web. label:app matches any value, and l: is short for label:
-word, -ns:kube-system rows that don’t match

Matching ignores case, except label keys and values, which Kubernetes compares exactly. A key:value the table doesn’t know, such as system:node, is matched as plain text.

Click a column header to sort by it. The Columns button shows, hides and reorders columns; Name always stays first. Drag a header’s edge to resize it. Kubebay remembers your columns and sort for each kind.

Tick rows to select them, then delete them together. The whole cell around a checkbox ticks the row, not only the box, and clicking it doesn’t open the row. The bar above the table says what the selection covers, including rows the filter hides, and Deselect hidden drops those. Esc clears the selection.

Moving through a table with the keyboard

Key Does
↓ or j next row
↑ or k previous row
Enter open the row
x select the row
/ jump to the filter

Keys are ignored while you’re typing in a field, or while a drawer or dialog is open.

Favourites

Click the ☆ next to a resource table’s title to add the table to Favorites in the sidebar. Click ★ to remove it. You can star a custom resource kind or a whole API group too.

You can star a single object of any kind, a pod, Deployment, Service, Ingress or a custom resource: click the ☆ after its name in its drawer, or choose Add to favorites in its row’s menu in a table. Clicking it in Favorites switches to its cluster and opens its drawer. If the object has been deleted its row is dimmed; click × to remove it. Starred objects also appear under Favorites in the command palette when its box is empty.

Saved views

A saved view keeps a table as you have it: the cluster, the kind, the namespaces, the filter, the columns and the sort. Click Save view on a resource table and give it a name, such as Crashing shop pods.

Saved views are listed in the sidebar and in the command palette. Opening one switches to its cluster and opens its table. In Settings you can delete them, Export them to a file, and Import… a file, for example one a teammate shared.

Keyboard shortcuts

Shortcut Does
⌘ K open the command palette
⌘ B hide or show the sidebar
⌘ N open a new window (desktop app)
/ jump to a table’s filter
j k Enter x move, open and select in a table
Esc close a drawer, dialog, ⓘ or the palette
⌘ ⇧ S split a resource’s drawer, to see two of its tabs side by side

On Windows and Linux, use Ctrl for ⌘.