Skip to main content

shell (Beta)

This topic describes the options available with the Embedded Cluster shell command.

The shell command opens a shell on a cluster node with the environment already configured to reach the cluster. Use it for the Kubernetes-level operations that the persistent admin console does not cover, such as inspecting or deleting Pods, reading container logs, and viewing Secrets.

The shell sets KUBECONFIG to the cluster's admin kubeconfig and extends PATH with the bundled cluster tools, so kubectl, k0s, and helm are available without any further setup. The application's namespace is the default context, so kubectl get pods works without passing -n.

Running shell requires command-line access to a node. There is no browser equivalent. For what end users can do without that access, see What enabling the console adds.

Usage

sudo ./<app-slug> shell [flags]

Flags

FlagTypeDescription
-c, --commandstringCommand to run instead of starting an interactive shell.
-h, --helpHelp for shell.

Examples

Open an interactive shell:

sudo ./APP_SLUG shell

Run a single command and exit:

sudo ./APP_SLUG shell -c "kubectl get pods -A"