Skip to content

configuration.md

Latest commit

 

History

History
61 lines (46 loc) · 1.98 KB

configuration.md

File metadata and controls

61 lines (46 loc) · 1.98 KB
Raw

Configuration

Customize the left sidebar with ~/.config/ku/config.yaml.

Quick Start

ku config init          # write the default config to populate from
ku config init --force  # overwrite an existing config with the defaults
ku config path          # print the config file location

After seeding the file, edit it and restart ku. The running TUI reads config once at startup and never writes it.

Files

File Purpose
~/.config/ku/config.yaml user-authored config file
~/.config/ku/state.json auto-saved context and namespace state

The config file is separate from session state. config.yaml is only written by you or by ku config init; state.json is managed automatically.

Sidebar

Today the config customizes the left sidebar menu. When a sidebar: list is present it replaces the built-in default menu. Without a config file the built-in defaults are used.

The Overview entry is always available. Resources the cluster does not expose are dropped, and empty sections are hidden.

sidebar:
  - section: Workloads
    items:
      - { label: Pods, resource: pods }
      - { label: Deployments, resource: deployments }
      - { label: HPAs, resource: horizontalpodautoscalers }
      - { label: ScaledObjects, resource: scaledobjects }
  - section: Network
    items:
      - { label: Services, resource: services }

The resource field accepts anything the resource picker resolves: a plural, singular, kind, short name, or group-qualified key, such as scaledobjects.keda.sh.

Built-In Defaults

The default sidebar includes Pods, Deployments, StatefulSets, DaemonSets, ReplicaSets, Jobs, CronJobs, Services, Ingresses, Endpoints, ConfigMaps, Secrets, ServiceAccounts, PVCs, PVs, StorageClasses, Nodes, Namespaces, and Events.

HPAs, KEDA ScaledObjects, and OpenTelemetry collectors are not in the default menu. Add them to sidebar: when your cluster exposes them. A freshly seeded config lists them as commented opt-in examples.