Skip to main content
Kubernetes
InfrastructureSourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the Kubernetes panel with new terminalsbooleanfalseShow the Kubernetes panel beside every SSH terminal that has Kubernetes on. You can still open and close it from the button on the right edge.
Kubernetes panel sideselect"right"Where the Kubernetes panel sits next to a terminal.
Kubernetes panel sizenumber380Width in pixels, or height when it is at the bottom. You can also drag its edge.
Show the panel buttonbooleantrueShow a small button on the right edge of a terminal that opens the Kubernetes panel.

Host​

Set per host in the host editor, on the plugin's tab. Host defaults can set them for many hosts at once.

SettingTypeDefaultWhat it does
Enable KubernetesbooleanfalseRun kubectl on this host over SSH to manage the cluster it can reach.
Kubernetes flavorselect"kubectl"Which command runs kubectl on this host.
Kubeconfig pathstringLeave empty to use the default for the SSH user (~/.kube/config or KUBECONFIG).
Default contextstringLeave empty to use the current context in the kubeconfig. You can switch contexts in the Kubernetes tab.
Default namespacestringThe namespace the Kubernetes tab opens with.
Run with sudobooleanfalseRun kubectl with sudo -n, for k3s and MicroK8s setups where only root can read the cluster config. The SSH user needs passwordless sudo.
Alert on cluster problemsbooleanfalseSend an alert when a node is not ready or a pod is failing.
Read onlybooleanfalseOnly look. Blocks scaling, restarts, deletes, YAML changes, Helm changes and pod shells for everyone on this host.
Show Kubernetes panel in terminalsbooleantrueAllow the Kubernetes panel to open beside SSH terminals on this host.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
kubernetes.useadmin, userOpen the Kubernetes view and pod shells on hosts with Kubernetes turned on.
kubernetes.secretsadminShow the decoded values of Kubernetes secrets. Every reveal is written to the audit log.

Actions​

Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.

ActionRuns onRiskInputs
kubernetes.list-pods
List pods
A hostRead only
kubernetes.list-workloads
List workloads
A hostRead only
kubernetes.summary
Failing pods
A hostRead only
kubernetes.restart-workload
Restart workload
One item on a hostChanges
kubernetes.scale-workload
Scale workload
One item on a hostChangesreplicas
kubernetes.delete-pod
Delete pod
One item on a hostDestructive

Capabilities​

What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.

CapabilityRiskWhat it means
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
users:impersonateHighAct as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
network:serveMediumAccept connections. It opens a port on the Termix server.
events:coreMediumWatch everything happening. Including activity from other users, not just yours.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
operations:provideMediumOffer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
hosts:readLowSee your host list. Names and addresses for hosts you can already see.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.
kv:ownLowRemember small settings. Kept separate from other plugins.

Services​

Services are how plugins call each other. Plugin authors can use these.

ProvidesVersionPermission
kubernetes.workloads1.0.0kubernetes.use
kubernetes.events1.0.0kubernetes.use

API​

The plugin's HTTP routes are in the API reference.

Platforms​

Linux, Windows, macOS