Skip to main content
Version: v3.8.0

Getting Familiar With potctl

Run potctl without arguments to list top-level commands. v3.8.0 adds reconcile and auth-group helpers. The legacy and rename subcommands from v3.7 are removed.

potctl version

Top-level commands in v3.8.0:

  • attach, completion, configure, connect, create, delete, deploy, describe, detach, disconnect, exec, get, logs, move, nats, prune, rebuild, reconcile, rollback, start, stop, upgrade, version, view

Full per-command docs live in the potctl CLI Reference.

Try --help on any command:

potctl deploy --help
potctl create --help
potctl connect --help
potctl get --help
potctl attach --help

Working with Namespaces​

All actions are scoped to a single namespace. The default namespace (default) is used when you omit -n. On Kubernetes, a potctl namespace maps to a Kubernetes namespace when you deploy a Control Plane with Helm or potctl.

potctl create namespace zoo-1
potctl get namespaces
potctl delete namespace zoo-1

Configuring your current namespace​

potctl configure current-namespace NAMESPACE
potctl configure current-namespace default

View Edge Compute Network Details​

Once connected to a live ECN, list resources with get:

potctl get controllers
potctl get agents
potctl get applications
potctl get microservices
potctl get all

For detailed status, use describe:

potctl describe controlplane
potctl describe controller alpaca-1
potctl describe agent kiwi-1
potctl describe application health-care-app
potctl describe microservice health-care-ui

Check log output of components​

You need SSH access to remote resources for this feature.

potctl logs controller NAME
potctl logs agent NAME
potctl logs microservice NAME

Move microservices to another Edgelet node​

potctl move microservice NAME AGENT_NAME

Prune images on an Edgelet node​

potctl prune agent AGENT_NAME

See Image and disk pruning for scheduled pruningFrequency and on-device edgelet system prune.

Detach / Attach an Edgelet node​

Detaching an Edgelet node removes its Controller connection and stops microservices on that node. See Attach and detach for the full workflow.

potctl detach agent AGENT_NAME
potctl attach agent AGENT_NAME
potctl get all --detached

Move an Edgelet node between namespaces:

potctl move agent agent-1 namespace-2 -n namespace-1
Next steps?
Group 3See anything wrong with the document? Help us improve it!

Edit this page on GitHub!