Skip to content
faros Docs
Sections
Open console

Enter a topic to search documentation.

    faros agent join

    Persistently join an edge to the hub (installs systemd, launchd, or Kubernetes deployment)

    Synopsis

    Join this edge to the hub as a persistent installation.

    For Linux server-type edges (bare-metal / VM):

    Terminal
    Installs a systemd service that runs "faros agent run" and survives reboots.
    Requires root. The service is named faros-agent-<edge-name>.service.

    For macOS service edges:

    Terminal
    Installs a system LaunchDaemon that runs as the configured non-root worker
    account and survives reboots. Requires root on macOS; use --dry-run on Linux
    to inspect the plist without installing it.

    For kubernetes-type edges:

    Terminal
    Applies a Deployment and RBAC into the faros-agent namespace of the target
    cluster so the agent runs as an in-cluster workload.

    To run the agent as a foreground process (containers / dev / e2e) use:

    Terminal
    faros agent run

    Terminal
    faros agent join [flags]

    Options

    TEXT
          --cluster string                 kcp logical cluster name (e.g. '1tww43gelbj45g0k'); required when using static token auth without a cluster-scoped hub kubeconfig
          --context string                 Kubeconfig context to use
          --debug-addr string              Bind address for the debug HTTP server exposing /healthz and /debug/pprof/* (e.g. "127.0.0.1:6060"). Empty disables the server.
          --dry-run                        Print the macOS LaunchDaemon and skip installation (works on Linux)
          --edge-name string               Name of this edge
      -h, --help                           help for join
          --hub-context string             Kubeconfig context for hub cluster
          --hub-insecure-skip-tls-verify   Skip TLS certificate verification for the hub connection (insecure, for development only)
          --hub-kubeconfig string          Kubeconfig for hub cluster
          --hub-url string                 Hub server URL
          --kubeconfig string              Path to target cluster kubeconfig
          --labels stringToString          Labels for this edge (default [])
          --launchd-plist string           LaunchDaemon plist path (default: /Library/LaunchDaemons/com.faros.agent.<edge>.plist)
          --ssh-password string            SSH password for password-based authentication (prefer --ssh-private-key for security)
          --ssh-private-key string         Path to SSH private key file for key-based authentication
          --ssh-proxy-port int             Local port of the SSH daemon to proxy connections to (default 22; set to a different port in test environments) (default 22)
          --ssh-user string                SSH username for server-type edges (default: current user)
          --svc-allow-cidr strings         CIDR the Service proxy may dial besides loopback (and cluster DNS in kubernetes mode), e.g. 192.168.1.0/24. Repeatable. Link-local, unspecified and multicast addresses are never allowed. Env: FAROS_AGENT_SVC_ALLOW_CIDR
          --svc-policy string              What the Service proxy does with a target outside loopback/--svc-allow-cidr: enforce (403, never dialed), warn (dialed but logged; response carries X-Faros-Svc-Policy: warn) or allow-any (allow list disabled; logged at startup). The default flips to enforce in the next release. Env: FAROS_AGENT_SVC_POLICY (default "warn")
          --token string                   Bootstrap token
          --tunnel-url string              Hub tunnel URL (defaults to hub URL)
          --type string                    Edge type: "kubernetes" (Kubernetes cluster), "server" (Linux host with SSH), or "macos" (macOS service host) (default "kubernetes")
          --worker-user string             Existing non-root account for a macOS LaunchDaemon (required when run as root)

    Inherited options

    TEXT
          --insecure-skip-tls-verify   Skip TLS certificate verification when talking to the hub

    See also

    • faros agent — Run, install or upgrade the edge agent on a cluster or server