Getting Started with Traefik Enterprise Edition's Installation

We recommend using traefikeectl to install TraefikEE.

But for experts who need to fine-tune every step of the installation, we provide advanced installation guides.

Network requirements

The TraefiKEE control plane requires access to the internet in order to operate correctly. Please make sure that all the bootstrap and control nodes can access the URL https://v3.license.containous.cloud:8443.

Install traefikeectl

First, download traefikeectl, a tool that will help you install and operate your cluster, using one of the following links:

Check the integrity of the downloaded file

Use the sha256 checksums of the binaries:

# Compare this value to the one found in traefikee_checksums.txt
sha256sum ./traefikeectl_v1.0.7_linux_amd64.tar.gz
# Compare this value to the one found in traefikee_checksums.txt
shasum -a256 ./traefikeectl_v1.0.7_darwin_amd64.tar.gz
# Compare this value to the one found in traefikee_checksums.txt
Get-FileHash traefikeectl_v1.0.7_windows_amd64.zip -Algorithm SHA256
Extract the downloaded archive 
# Extract the downloaded archive
tar -zxvf traefikeectl_v1.0.7_linux_amd64.tar.gz
# Compare this value to the one found in traefikee_checksums.txt
tar -zxvf -a256 ./traefikeectl_v1.0.7_darwin_amd64.tar.gz
# Compare this value to the one found in traefikee_checksums.txt
Expand-Archive traefikeectl_v1.0.7_windows_amd64.zip

Copy the traefikeectl binary to your PATH or add its location to your environment ($PATH or %PATH% depending on your OS) and make sure it's executable:

# Example with /usr/local/bin
# These command may need sudo rights
cp ./traefikeectl /usr/local/bin/traefikeectl
chmod a+x /usr/local/bin/traefikeectl

# Should print "/usr/local/bin/traefikeectl"
command -v traefikeectl
# Example with C:\Program Files
Copy-Item "traefikeectl.exe" -Destination "C:\Program Files\traefikeectl.exe"

# Should print "C:\Program Files\traefikeectl.exe"
where traefikeectl

You can now test your installation by executing traefikeectl:

traefikeectl
Usage: traefikeectl [flags] <command> [<arguments>]

Use "traefikeectl <command> --help" for help on any command.

Use traefikeectl to Install TraefikEE on Your Cluster

To setup your cluster, traefikeectl will need the following information:

  • Your license key
  • The cluster name

Once you've gathered the required information, refer to one of the following guide depending on your infrastructure solution:

Verify Your Installation

To certify that your TraefikEE installation is ready, you can query the nodes' state with the following command:

traefikeectl list-nodes

This command prints the list of all deployed nodes from both the Control Plane and the Data Plane.

Example output for a TraefikEE cluster with 3 nodes in the control plane and 2 nodes in the data plane:

Name                                            Role
----                                            ----
bootstrap-traefikee-bootstrap-647965c6b5-xfktd  CONTROL NODE (Current Leader)
traefikee-control-node-1                        CONTROL NODE
data-node-traefikee-data-node-68d856488c-5vx5n  DATA NODE
data-node-traefikee-data-node-68d856488c-stgns  DATA NODE
traefikee-control-node-2                        CONTROL NODE
traefikee-control-node-0                        CONTROL NODE

Congratulations! Your TraefikEE cluster is ready.

Next Steps

Now that you have installed a TraefikEE cluster, you can: