Traefik

# Traefik

import { Tabs, TabsContent, TabsList, TabsTrigger } from "zudoku/ui/Tabs"

{/* vale off */}
{/* THIS FILE WAS AUTOGENERATED FROM THE PUBLIC EXAMPLE REPOSITORY. DO NOT EDIT THIS FILE DIRECTLY. */}


This example uses the [`Traefik`](https://traefik.io/traefik/) cloud native app proxy.
To run it, follow these steps:

1. Install the CLI.
   Use the [unikraft CLI](/cli/unikraft) or the legacy [kraft CLI](https://unikraft.org/docs/cli/install).
   You need a [BuildKit](https://github.com/moby/buildkit) builder. The easiest way to get one is via [Docker](https://docs.docker.com/engine/install/).
   Alternatively, you can also directly set up and use BuildKit, see the [quick start](https://github.com/moby/buildkit#quick-start).

:::note
The unikraft CLI is the current standard, while kraft is the legacy version.
Choose one of the CLIs below and only run the commands associated with it for the rest of this guide.
:::

2. Clone the [`examples` repository](https://github.com/unikraft-cloud/examples) and `cd` into the `examples/traefik/` directory:

```bash
git clone https://github.com/unikraft-cloud/examples
cd examples/traefik/
```

Make sure to log into Unikraft Cloud and pick a [metro](/platform/metros) close to you.
This guide uses `fra` (Frankfurt, 🇩🇪):

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft login
```

```bash title="kraft"
# Set Unikraft Cloud access token
export UKC_TOKEN=token
# Set metro to Frankfurt, DE
export UKC_METRO=fra
```

</CodeTabs>

When done, invoke the following command to deploy this app on Unikraft Cloud:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft build . --output <my-org>/traefik:latest
unikraft run --scale-to-zero policy=on,cooldown-time=1000,stateful=true --metro fra -p 443:80/tls+http -p 8080:8080/tls -m 1G --image <my-org>/traefik:latest
```

```bash title="kraft"
kraft cloud deploy --scale-to-zero on --scale-to-zero-stateful --scale-to-zero-cooldown 1s -p 443:80/tls+http -p 8080:8080/tls -M 1Gi .
```

</CodeTabs>

The output shows the instance address and other details:

<CodeTabs syncKey="cli">

```ansi title="unikraft"
metro:        fra
name:         traefik-wqe7e
uuid:         69d25b0b-1813-4a3f-88e6-64abbc78b359
state:        [92mstarting[0m
image:        <my-org>/traefik
resources:
  memory:     1024MiB
  vcpus:      1
service:
  uuid:       ec7570da-5700-01b5-aaa1-0734498c11eb
  name:       holy-cherry-rye39b1x
  domains:
  - fqdn:     holy-cherry-rye39b1x.fra.unikraft.app
networks:
- uuid:       b59f4362-dc72-7efe-477b-1efe227e1b08
  private-ip: 10.0.28.16
  mac:        12:b0:31:58:d7:d0
timestamps:
  created:    just now
```

```ansi title="kraft"
[90m[[0m[92m●[0m[90m][0m Deployed successfully!
 [90m│[0m
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mname[0m: traefik-wqe7e
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90muuid[0m: 69d25b0b-1813-4a3f-88e6-64abbc78b359
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mmetro[0m: https://api.fra.unikraft.cloud/v1
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mstate[0m: [92mstarting[0m
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mdomain[0m: https://holy-cherry-rye39b1x.fra.unikraft.app
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mimage[0m: oci://unikraft.io/<my-org>/traefik@sha256:f6dd913a81f6a057ceb9db7844222d7287b2a83f668cca88c73c2e85554cb526
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mmemory[0m: 1024 MiB
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mservice[0m: holy-cherry-rye39b1x
 [90m├[0m[90m─[0m [90mprivate fqdn[0m: traefik-wqe7e.internal
 [90m└[0m[90m─[0m[90m─[0m[90m─[0m [90mprivate ip[0m: 10.0.28.16
```

</CodeTabs>

In this case, the instance name is `traefik-wqe7e` and the address is `https://holy-cherry-rye39b1x.fra.unikraft.app`.
They're different for each run.

Use `curl` to query the Unikraft Cloud instance of Traefik.

```bash
curl https://holy-cherry-rye39b1x.fra.unikraft.app:8080/dashboard
```

```text
<!DOCTYPE html><html><head><title>Traefik</title><meta charset=utf-8><meta name=description content="Traefik UI"> ...
```

Or better yet, point a browser at the dashboard.

:::danger
This set up exposes the dashboard on port 8080 without authentication.
Please change default.toml as needed.
:::

You can list information about the instance by running:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft instances list
```

```bash title="kraft"
kraft cloud instance list
```

</CodeTabs>

<CodeTabs syncKey="cli">

```ansi title="unikraft"
[1mMETRO[0m  [1mNAME[0m           [1mSTATE[0m    [1mIMAGE[0m             [1mARGS[0m  [1mMEMORY[0m   [1mVCPUS[0m  [1mFQDN[0m                                   [1mCREATED[0m
fra    traefik-wqe7e  [92mrunning[0m  <my-org>/traefik        1024MiB  1      holy-cherry-rye39b1x.fra.unikraft.app  2 minutes ago
```

```ansi title="kraft"
[1mNAME[0m           [1mFQDN[0m                                   [1mSTATE[0m    [1mSTATUS[0m         [1mIMAGE[0m                                          [1mMEMORY[0m    [1mVCPUS[0m  [1mARGS[0m  [1mBOOT TIME[0m
traefik-wqe7e  holy-cherry-rye39b1x.fra.unikraft.app  [92mrunning[0m  8 minutes ago  oci://unikraft.io/<my-org>/traefik@sha256:...  1024 MiB  1            53.66 ms
```

</CodeTabs>

When done, you can remove the instance:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft instances delete traefik-wqe7e
```

```bash title="kraft"
kraft cloud instance remove traefik-wqe7e
```

</CodeTabs>

## Customize your app

To customize Traefik app you can change the `default.toml` configuration file.

## Learn more

Use the `--help` option for detailed information on using Unikraft Cloud:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft --help
```

```bash title="kraft"
kraft cloud --help
```

</CodeTabs>

Or visit the [CLI Reference](/cli/unikraft) or the [legacy CLI Reference](/cli/kraft/overview).
{/* vale on */}