traefikee Command-Line Reference

The "TraefikEE" command-line (traefikee) manages the elements in your TraefikEE cluster.

Synopsis

Check below the list of commands, with their respective flags.

traefikee    TraefikEE (Enterprise Edition) is a Cloud Native Edge Routing Platform based on Traefik,
a modern HTTP reverse proxy and load balancer made to deploy microservices with ease.
Complete documentation is available at https://docs.containo.us.

Usage: traefikee [command] [resource] [flags]

Use "traefikee [command] --help" for help on any command.

Commands:
    controller    Start a new controller
    proxy         Start a new proxy
    tokens        Get tokens from the cluster
    version       Print version

Commands

The TraefikEE command-line (CLI) provides the following commands:

Start Controller (controller)

This command starts a controller and joins it to a cluster.

Usage:

traefikee controller --name="controller-0" --advertise=172.17.0.2:4242 --discovery.static.peers=172.17.0.1:4242,172.17.0.3:4242,172.17.0.4:4242 --license="XXX" --api.bundle="./bundle.zip"

Flags:

--advertise  (Default: "")
    Address to advertise to peers

--api.addr  (Default: ":55055")
    Address to listen on for the API

--api.bundle  (Default: "")
    API certificate bundle

--api.socket  (Default: "/var/run/traefikee/teectl.sock")
    Socket to listen on for the API

--bind  (Default: "0.0.0.0:4242")
    Address to listen for peers on

--discovery.dns.bootstrapexpected  (Default: "0")
    Number of controllers needed to bootstrap the cluster (DNS Discovery Only)

--discovery.dns.domain  (Default: "")
    Domain where the controllers are exposed

--discovery.dns.port  (Default: "")
    Port where the discovered controller can be contacted on

--discovery.static.peers  (Default: "")
    Comma separated list of peers to connect to

--jointoken.file.path  (Default: "/var/run/secrets")
    The path to the join tokens

--jointoken.kubernetes.namespace  (Default: "")
    The kubernetes namespace of the join tokens

--jointoken.kubernetes.prefix  (Default: "")
    The prefix for join token naming

--jointoken.swarm.certpath  (Default: "")
    Path to the mTLS certificates

--jointoken.swarm.endpoint  (Default: "")
    Endpoint to use to access the swarm API

--jointoken.swarm.prefix  (Default: "")
    The prefix for join token naming

--jointoken.value  (Default: "")
    The value of the join token

--license  (Default: "")
    License key to use

--log.filepath  (Default: "")
    Log file path. Stdout is used when omitted or empty.

--log.format  (Default: "")
    Log format: json | common

--log.level  (Default: "")
    Log level set to restrict logs to logs.

--name  (Default: "Nicks-MBP.localdomain")
    Name of the node

--socket  (Default: "/var/run/traefikee/cluster.sock")
    Path to the control socket

--statedir  (Default: "/var/lib/traefikee")
    Path to the state directory

Start Proxy (proxy)

This command starts a proxy and joins it to a cluster.

Usage:

traefikee proxy --name="proxy-0" --discovery.static.peers=172.17.0.1:4242,172.17.0.3:4242,172.17.0.4:4242

Flags:

--discovery.dns.domain  (Default: "")
    Domain where the controllers are exposed

--discovery.dns.port  (Default: "")
    Port where the discovered server can be contacted

--discovery.static.peers  (Default: "")
    Comma separated list of peers to join

--jointoken.file.path  (Default: "/var/run/secrets")
    The path to the join tokens

--jointoken.kubernetes.namespace  (Default: "")
    The kubernetes namespace of the join tokens

--jointoken.kubernetes.prefix  (Default: "")
    The prefix for join token naming

--jointoken.swarm.certpath  (Default: "")
    Path to the mTLS certificates

--jointoken.swarm.endpoint  (Default: "")
    Endpoint to use to access the swarm API

--jointoken.swarm.prefix  (Default: "")
    The prefix for join token naming

--jointoken.value  (Default: "")
    The value of the join token

--log.filepath  (Default: "")
    Log file path. Stdout is used when omitted or empty.

--log.format  (Default: "")
    Log format: json | common

--log.level  (Default: "")
    Log level set to restrict logs to logs.

--name  (Default: "Nicks-MBP.localdomain")
    Name of the node

--statedir  (Default: "/var/lib/traefikee")
    Path to the state directory

Get Join Tokens (tokens)

This command prints the Join Tokens of the cluster.

Usage:

traefikee token

Flags:

--format  (Default: "env")
    The output format (json | yaml | toml | env)

--socket  (Default: "")
    Path to the TraefikEE socket

Show the Version (version)

This command shows the TraefikEE version.

Usage:

traefikee version