Copy page

Guides

Skipper

This example uses Skipper, an HTTP router and reverse proxy for service composition

To run this example, follow these steps:

1. Install the CLI and a container runtime engine, for example Docker. Use the unikraft CLI or the legacy kraft CLI.

2. Clone the examples repository and cd into the examples/skipper0.18/ directory:

Code
git clone https://github.com/unikraft-cloud/examples
cd examples/skipper0.18/

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

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

The output shows the instance address and other details:

Code
[●] Deployed successfully!
 │
 ├────────── name: skipper018-mx4ai
 ├────────── uuid: 34e3d740-c2b0-4644-b7e1-647350f688dc
 ├───────── state: running
 ├─────────── url: https://aged-sea-o7d3c42s.fra.unikraft.app
 ├───────── image: skipper018@sha256:5483eaf3612cca2116ceaab9be42557686324f1d30337ae15d0495eef63d0386
 ├───── boot time: 43.71 ms
 ├──────── memory: 256 MiB
 ├─────── service: aged-sea-o7d3c42s
 ├── private fqdn: skipper018-mx4ai.internal
 ├──── private ip: 172.16.6.4
 └────────── args: /usr/bin/skipper -address :9090 -routes-file /etc/skipper/example.eskip

In this case, the instance name is skipper018-mx4ai and the address is https://aged-sea-o7d3c42s.fra.unikraft.app. They're different for each run.

Use curl to query the Unikraft Cloud instance of Skipper.

Code
curl https://aged-sea-o7d3c42s.fra.unikraft.app

Code
Hello, world from Skipper on Unikraft!

You can list information about the instance by running:

Code
NAME              FQDN                                STATE    STATUS        IMAGE                         MEMORY   VCPUS  ARGS                                          BOOT TIME
skipper018-mx4ai  aged-sea-o7d3c42s.fra.unikraft.app  running  1 minute ago  skipper018@sha256:5483eaf...  256 MiB  1      /usr/bin/skipper -address :9090 -routes-f...  43709us

When done, you can remove the instance:

Customize your app

To customize Skipper you can change the example.eskip configuration file.

Learn more

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

Or visit the CLI Reference or the legacy CLI Reference.