Skip to main content
Version: v3.9.0

Quick Start With Local Deployment

Platform train v3.9.0

This guide targets Datasance PoT v3.9.0 (Controller and potctl v3.9.0, Edgelet v1.1.0). Upgrading an existing v3.8.0 ECN? See Upgrading to v3.9.0. Greenfield from v3.7.x or older starts at Migrating to v3.8.0.

This guide deploys a minimal local ECN on one machine:

  1. LocalControlPlane with embedded OIDC
  2. A system Edgelet node on the same host (via spec.systemAgent)
  3. A pointer to deploy sample workloads (Acme Smart Plant Tutorial)

You do not deploy a separate LocalAgent. The system Edgelet is part of the Control Plane YAML. See Control plane in Learn.

Version pins​

ComponentVersion
CLIv3.9.0
Controllerv3.9.0
Edgeletv1.1.0
EdgeOps Consolev1.1.0

Pair Edgelet v1.1.0 with Controller v3.9.0 on platform train v3.9.0. The CLI row is potctl v3.9.0.

Choose your platform​

PlatformContainer enginecontainerEngineUrlTypical deploymentType
Linuxedgeletunix:///run/edgelet/containerd.socknative
macOS / Windowsdockerunix:///var/run/docker.sockcontainer

Use the manifest and prerequisites for your OS below. Both paths produce the same local ECN: Controller, Router, and system Edgelet on one host.

Authentication

Datasance PoT v3.9.0 uses embedded OIDC by default. You do not need an external IdP for this quick start.

Want to know more about the CLI?

We keep this guide short. For CLI design and workflows, see the potctl introduction.

Linux​

Prerequisites​

Docker is not required on this path. The system Edgelet uses the embedded edgelet engine and containerd socket.

Manifest​

Save as quick-start.yaml:

quick-start.yaml (Linux)
---
apiVersion: datasance.com/v3
kind: LocalControlPlane
metadata:
  name: ecn
spec:
  iofogUser:
    name: Quick
    surname: Start
    email: [email protected]
    password: QuickStartUser12!
  controller:
    publicUrl: http://<your-host-ip>:51121
    consoleUrl: http://<your-host-ip>
    package:
      image: ghcr.io/datasance/controller:v3.9.0
  auth:
    mode: embedded
    insecureAllowHttp: true
    bootstrap:
      username: admin
      password: QuickStart12!
  nats:
    enabled: true
  systemAgent:
    package:
      version: 1.1.0
    config:
      arch: amd64
      deploymentType: native
      containerEngine: edgelet
      containerEngineUrl: unix:///run/edgelet/containerd.sock

Set systemAgent.config.arch to match your CPU (arm64, riscv64, or arm on 32-bit ARM hosts).

Deploy​

potctl deploy -f quick-start.yaml

Continue with Verify the deployment.

macOS and Windows​

Prerequisites​

On Windows, use Docker Desktop with Linux containers (WSL2 or Hyper-V backend). Run potctl from an environment that can reach the Docker socket (WSL2 is recommended).

Manifest​

Save as quick-start.yaml:

quick-start.yaml (macOS / Windows)
---
apiVersion: datasance.com/v3
kind: LocalControlPlane
metadata:
  name: ecn
spec:
  iofogUser:
    name: Quick
    surname: Start
    email: [email protected]
    password: QuickStartUser12!
  controller:
    publicUrl: http://<your-host-ip>:51121
    consoleUrl: http://<your-host-ip>
    package:
      image: ghcr.io/datasance/controller:v3.9.0
  auth:
    mode: embedded
    insecureAllowHttp: true
    bootstrap:
      username: admin
      password: QuickStart12!
  nats:
    enabled: true
  systemAgent:
    package:
      container:
        image: ghcr.io/datasance/edgelet:1.1.0
    config:
      arch: amd64
      deploymentType: container
      containerEngine: docker
      containerEngineUrl: unix:///var/run/docker.sock

Deploy​

potctl deploy -f quick-start.yaml

Continue with Verify the deployment.

Verify the deployment​

Check potctl resources:

potctl get all

Expected output (fields may vary):

NAMESPACE
default

CONTROLLER      STATUS    AGE           UPTIME      ADDR             PORT
ecn             online    22m29s        22m35s      0.0.0.0          51121

AGENT           STATUS    AGE           UPTIME      ADDR             VERSION
ecn             RUNNING   22m7s         22m7s       192.168.1.10     1.1.0

APPLICATION     STATUS    MICROSERVICES

MICROSERVICE    STATUS    AGENT         ROUTES      VOLUMES          PORTS

VOLUME          SOURCE    DESTINATION   PERMISSIONS   AGENTS

ROUTE           SOURCE MSVC     DEST MSVC

The Controller row is the control plane API. The Agent row named ecn is the system Edgelet node from spec.systemAgent (same name as metadata.name).

Note: Edgelet node status may show UNKNOWN for up to 30 seconds while the node reports liveness to the Controller.

Linux: Edgelet service​

On the native Linux path, confirm Edgelet is running:

edgelet system status

Or:

systemctl status edgelet

List system microservices (Controller, Router) deployed through Edgelet:

edgelet ms ls

macOS / Windows: Docker containers​

On the Docker path, Controller, Router, and Edgelet workloads run as containers:

docker ps

You should see controller, router, and edgelet images from your distribution registry (same prefix as in the YAML above).

See Edgelet introduction and Control plane in Learn for field details.

Sign in to EdgeOps Console​

Open http://<your-host-ip> in a browser, or run:

potctl view

Sign in with bootstrap user admin and password QuickStart12!, or the registered iofogUser [email protected] and password QuickStartUser12!. See Embedded OIDC for MFA and CLI login.

Deploy sample workloads​

This quick start stops after the Control Plane and system Edgelet node are running. To deploy applications and microservices on your local ECN:

Teardown​

Remove the local ECN and any deployed microservices:

potctl delete all

Next steps​

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

Edit this page on GitHub!