Skip to main content
Version: v3.9.3

Getting Familiar With iofogctl

Run iofogctl without arguments to list top-level commands. v3.9.3 extends attach and detach with model, knowledge, and runtimeclass targets for fleet catalog distribution. v3.8.0 added reconcile and auth-group helpers. The legacy and rename subcommands from v3.7 are removed.

iofogctl version

Top-level commands in v3.9.3:

  • 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 iofogctl CLI Reference.

Try --help on any command:

iofogctl deploy --help
iofogctl create --help
iofogctl connect --help
iofogctl get --help
iofogctl 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 iofogctl namespace maps to a Kubernetes namespace when you deploy a Control Plane with Helm or iofogctl.

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

Configuring your current namespace​

iofogctl configure current-namespace NAMESPACE
iofogctl configure current-namespace default

View Edge Compute Network Details​

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

iofogctl get controllers
iofogctl get agents
iofogctl get applications
iofogctl get microservices
iofogctl get all

For detailed status, use describe:

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

Check log output of components​

You need SSH access to remote resources for this feature.

iofogctl logs controller NAME
iofogctl logs agent NAME
iofogctl logs microservice NAME

Move microservices to another Edgelet node​

iofogctl move microservice NAME AGENT_NAME

Prune images on an Edgelet node​

iofogctl 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.

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

Move an Edgelet node between namespaces:

iofogctl move agent agent-1 namespace-2 -n namespace-1

Attach catalog assets to Edgelet nodes​

Deploy Model, Knowledge, and RuntimeClass resources with deploy, then attach them to one or more Edgelet nodes. Use matching detach and delete commands to remove distribution or cluster objects.

iofogctl get models
iofogctl describe model wafer-defect
iofogctl attach model wafer-defect edge-c-1 edge-c-2
iofogctl get knowledge
iofogctl attach knowledge my-kb edge-c-1
iofogctl attach runtimeclass gpu-runtime edge-c-1

See AI model catalog, AI knowledge catalog, and Runtime classes.

Next steps?
Group 3See anything wrong with the document? Help us improve it!

Edit this page on GitHub!