Local node

Use kind: LocalAgent to install Edgelet on the same machine that runs potctl and register it with the Controller.

This is an extra local Edgelet node. The control plane system node is a different object. On a local control plane that system node is spec.systemAgent. A LocalAgent is for development, CI, and desktop testing next to a local or remote control plane.

A control plane must already be in the namespace.

What deploy -f does

potctl deploy -f local-agent.yaml -n my-ecn

deploy

The pipeline matches a remote node, with these differences:

• No SSH. The host OS is the OS of the potctl process.
• metadata.name defaults to local when you omit it.
• Port 54321 must be free. It conflicts with the default local system node layout.

AgentConfig still runs first, including a synthesized record from spec.config. Then potctl bootstraps Edgelet and provisions. See Deploy phases.

Prerequisites

• A control plane in the namespace.
• For a native Linux install, sudo may be required for bootstrap layers.
• For container Edgelet on macOS or Windows, Docker (or another supported engine) must already be installed. potctl does not install the engine.

Host identity

Field	Precedence for the Controller host
spec.config.host	Preferred when set
spec.host	Fallback
(default)	localhost

When spec.config.deploymentType is container on macOS or Windows, bootstrap skips writing host config.yaml and uses the desktop wait and configure path. See Desktop container.

Examples

Native local node. Set arch to the machine you are on.

local-agent.yaml

apiVersion: datasance.com/v3
kind: LocalAgent
metadata:
  name: local-edge
spec:
  package:
    version: "1.1.0"
  config:
    description: Local Edgelet on the CLI machine
    arch: amd64
    deploymentType: native
    containerEngine: edgelet
    upstreamRouters:
      - default-router
    routerConfig:
      routerMode: edge
      messagingPort: 5671
    upstreamNatsServers:
      - default-nats-hub
    natsConfig:
      natsMode: leaf
      natsServerPort: 4222

Desktop container. The engine must already be running.

desktop-container.yaml

apiVersion: datasance.com/v3
kind: LocalAgent
metadata:
  name: desktop-edge
spec:
  package:
    container:
      image: ghcr.io/datasance/edgelet:1.1.0
  config:
    arch: amd64
    deploymentType: container
    containerEngine: docker
    upstreamRouters:
      - default-router
    routerConfig:
      routerMode: edge
    upstreamNatsServers:
      - default-nats-hub
    natsConfig:
      natsMode: leaf

Fields

LocalAgent fields

See anything wrong with the document? Help us improve it!

Edit this page on GitHub!