Lifecycle
These verbs change an Edgelet node after the first deploy -f. Field reference stays on Remote node, Local node, and AgentConfig. Where Get started already has the steps, this page points there.
Start, stop, and rename are microservice verbs. They do not start or stop the Edgelet node. See Applications and Microservices. move agent moves the node between namespaces. Microservice move is a workload action.
What each verb touches
| Command | Controller API | Edgelet on the host | CLI namespace config |
|---|---|---|---|
deploy -f (Agent or LocalAgent) | Create or update through AgentConfig | Bootstrap and provision | Node record stored |
deploy -f (AgentConfig only) | Create or update the node | No | No host record unless paired with a node kind |
delete agent | Delete the node when reachable | Deprovision and uninstall with data removal | Remove the node and trim volumes |
detach agent | Delete the node | Deprovision only | Move to the detached store |
attach agent | Recreate and provision | Uses the stored SSH or local spec | Attach to the namespace |
prune agent | Prune API | Host cleanup for that node type | Unchanged |
upgrade agent | Schedule a node upgrade | Async on the node | Unchanged |
reconcile agent | Platform reconcile | Async | Unchanged |
configure agent | No | No | SSH cache only (remote) |
move agent | Detach, then attach | Same as detach and attach | Namespace change |
The system Edgelet node on a Controller host is removed with control plane or controller delete, not with delete agent on a reserved system name. See Remote and Local.
Logs and an interactive shell are in Node logs and exec. That page covers logs agent, exec agent, and enabling exec.
Delete, detach, attach, and move
delete agent deprovisions Edgelet, deletes the Controller record, and uninstalls Edgelet with data removal. It also drops the node from volume records in the CLI config.
Attach, detach, and move
Detach removes the node from the cluster and keeps Edgelet installed so you can attach it later. Attach pushes AgentConfig and provisions from the stored spec. Move is detach in the source namespace and attach in the destination. Delete, --force, and SSH-only updates are in the same guide: Attach and detach.
If SSH host, user, or key are missing, remote deprovision is skipped. Restore them with configure agent, then retry.
Upgrade and rollback Edgelet
upgrade agent asks the Controller to upgrade that Edgelet node. It is asynchronous. Poll with describe agent. This is not the same as redeploying bootstrap with a new package.version. Rollback targets the previous Edgelet version. Steps, on-host OTA, and workload impact are in Upgrade and rollback.
On this train, fleet nodes use Edgelet v1.1.0 after the control plane is healthy. See Control plane.
Prune
prune agent asks the Controller to reclaim images and disk on that node. It does not remove the node from the namespace. Scheduled thresholds use pruningFrequency and availableDiskThreshold. The commands are in Image pruning.
Reconcile
reconcile agent enqueues platform reconcile and waits until provisioning finishes. Use it when router or NATS state on the node has drifted. The cases and the command are in Reconcile.
EdgeGuard
edgeGuardFrequency sets how often the node scans hardware. 0 disables the scan. What a signature change does is in EdgeGuard. The field is on AgentConfig fields.
Configure SSH
configure agent updates ssh.user, ssh.keyFile, and ssh.port in the CLI cache for a remote node. It does not change AgentConfig on the Controller. Runtime limits, router, and NATS settings go through deploy -f with AgentConfig or spec.config. LocalAgent has no SSH cache. The flags are in Attach and detach.
Describe
describe agent merges the stored spec with live status from the Controller. describe agent-config prints the Controller configuration, including nested routerConfig and natsConfig. Host metrics in that output are status. Do not set them in deploy YAML.
Config push
Limits, log paths, router mode, and NATS mode are an AgentConfig deploy or a console edit. How the push reaches the host is in Configuration updates.
Volumes and offline images
kind: Volume stages files onto listed Edgelet nodes through the CLI config. It is not a Controller API object. Distribution steps are in Volume distribution.
kind: OfflineImage loads images onto remote nodes. See Offline images.
kind: VolumeMount is a Controller object. Attach it after the node is enrolled. See Volume mounts.
delete agent still trims Volume records in the CLI namespace config. A volume that listed only that node is removed. A shared volume loses that node name.