DEV Community

loading...
Cover image for Deploy a Rust Web App With Rocket
Koyeb

Deploy a Rust Web App With Rocket

Edouard Bonlieu
CPO at @gokoyeb, formerly VP Product & Marketing at @scaleway.
Originally published at koyeb.com ・5 min read

Introduction

Rust is a popular programming language offering blazingly fast performance, and guaranteeing memory and thread safety.

In this tutorial, we will explain how to deploy a Rust web application using Rocket, a fast, easy, and flexible web framework.
We will then deploy the Rust web application on the Koyeb serverless platform offering a simple way to deploy Rust applications and offering native autoscaling, automatic HTTPS (SSL), auto-healing, and global load-balancing across our edge network with zero configuration.

Requirements

To successfully follow and complete this guide, you need:

  • Docker installed on your machine
    • A Koyeb account to deploy and run the Rust web application
    • The Koyeb CLI installed to interact with Koyeb from the command line
    • Have a registry we will use to store our Rust web app Docker image and deploy it on Koyeb

Steps

To successfully deploy a Rust web application on Koyeb Serverless Platform, you need to follow these steps:

  1. Create a Rust web app using Rocket
  2. Dockerize the Rust web app
  3. Push the Docker image to a container registry
  4. Deploy the Dockerized Rust web app on Koyeb

Create a Rust web app using Rocket

Install Rust

To get started, let's start by configuring a Rust environment we will use to create the application.

If you do not have Rust installed on your machine, you can install using rustup. In your terminal, run the command below:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Enter fullscreen mode Exit fullscreen mode

Once rustup is installed, you may need to restart your current shell to reload your PATH environment variable. You can avoid this by configuring your current shell running:

source $HOME/.cargo/env
Enter fullscreen mode Exit fullscreen mode

To ensure the latest toolchain is properly installed, in your terminal run:

rustup default stable
Enter fullscreen mode Exit fullscreen mode

Write the Rust web app using Rocket

To create our application, in your terminal run:

cargo new rust-rocket-app --bin
Enter fullscreen mode Exit fullscreen mode

The command above uses Cargo, the Rust package manager to create a new package. The --bin option indicates to make a binary program.
Cargo created a rust-rocket-app directory containing two files:

  • Cargo.toml: containing the metadata Cargo needs to compile our package
  • src/main.rs: a "hello world" program Cargo generated for us
$ cd rust-rocket-app
$ tree .
.
├── Cargo.toml
└── src
    └── main.rs

1 directory, 2 files
Enter fullscreen mode Exit fullscreen mode

As our web app uses Rocket, we need to add it as a package dependency. In the rust-rocket-app directory, open the Cargo.toml file and add rocket as a dependency under the [dependencies] section.

[dependencies]
rocket = "0.5.0-rc.1"
Enter fullscreen mode Exit fullscreen mode

Open and modify the src/main.rs with the code below:

#[macro_use] extern crate rocket;

#[get("/")]
fn index() -> &'static str {
    "Hello, world!"
}

#[get("/hello/<name>")]
fn hello(name: &str) -> String {
    format!("Hello, {}!", name)
}


#[launch]
fn rocket() -> _ {
    rocket::build()
        .mount("/", routes![index])
        .mount("/", routes![hello])
}
Enter fullscreen mode Exit fullscreen mode

The code above creates two routes: /, returning "Hello, world!" and /hello/<name> returning "Hello, name!" where "name" is the route parameter. Then it mounts the routes and launches the application.

Finally, create a Rocket.to

To run and test the application locally, run:

cargo run
Enter fullscreen mode Exit fullscreen mode

If everything goes fine, your app starts and you can test the routes using curl:

$curl localhost:8000/
Hello, world!
$curl localhost:8000/hello/koyeb
Hello, koyeb!
Enter fullscreen mode Exit fullscreen mode

Dockerize the Rust web app

To Dockerize our Rust web app, create a Dockerfile in your project directory.
In this guide, we use Docker multi-stage build to keep the image layers size as small as possible and to ensure our image contains only what is needed to run.

In your Dockerfile, copy the content below:

FROM rust:1 as builder
WORKDIR /app
COPY . .
RUN cargo install --path .


FROM debian:buster-slim as runner
COPY --from=builder /usr/local/cargo/bin/rust-rocket-app /usr/local/bin/rust-rocket-app
ENV ROCKET_ADDRESS=0.0.0.0
EXPOSE 8000
CMD ["rust-rocket-app"]
Enter fullscreen mode Exit fullscreen mode

The first stage is used to build our application, in the second one we copy the application binary from stage one and use it to run the application.

To build the Docker image execute the following command:

docker build . -t <DOCKER_HUB_USERNAME>/rust-rocket-app
Enter fullscreen mode Exit fullscreen mode

In this guide we will push the Docker image to the Docker Hub. You are free to use another different registry as Koyeb allows you to deploy from any container registry.

Once the build is completed, you can run a container using the image locally to validate everything is working as expected running:

docker run -p 8000:8000 <DOCKER_HUB_USERNAME>/rust-rocket-app
Enter fullscreen mode Exit fullscreen mode

If everything goes fine, your container starts properly and you can test the routes using curl:

$curl localhost:8000/
Hello, world!
Enter fullscreen mode Exit fullscreen mode

Push the Docker image to a container registry

With the Docker image built and functional, we can now upload it to the Docker Hub container registry.
In your terminal run the command below to push the image:

docker push <DOCKER_HUB_USERNAME>/rust-rocket-app
Enter fullscreen mode Exit fullscreen mode

Once the push command is completed, you will see your Docker image available on the Docker Hub.

Deploy the Dockerized Rust web app on Koyeb

We are now ready to deploy our Rust web application on Koyeb. First, create a Koyeb Secret to store your container registry configuration.
In this guide, we will deploy our app from the Docker Hub. For other container registries example, check out the related documentation.

If your Docker image is public, there is no need to create a secret containing your container registry configuration.

echo \
'{ \
  "auths": { \
    "index.docker.io/v1/": { \
      "username": "<REPLACE_ME_WITH_DOCKER_HUB_USERNAME>", \
      "password": "<REPLACE_ME_WITH_DOCKER_HUB_TOKEN>" \
    } \
  } \
}' | koyeb secrets create docker-hub-credentials
Enter fullscreen mode Exit fullscreen mode

We can now deploy the Rust web application on Koyeb Serverless Platform running:

koyeb app init rust-rocket-app --docker "<REPLACE_ME_WITH_DOCKER_HUB_USERNAME>/rust-rocket-app" --ports 8000:http --routes /:8000 --docker-private-registry-secret docker-hub-credentials
Enter fullscreen mode Exit fullscreen mode

This command creates a new Koyeb App and deploys our Rust application exposing port 8000 and making it publicly accessible on the / route of your Koyeb App URL.

To retrieve your Koyeb App URL and access your application, run:

$koyeb app get rust-rocket-app
ID                                      NAME            DOMAINS                                 UPDATED AT
d58ebed1-48c0-46b7-a2f1-91f3ffdbccf2    rust-rocket-app rust-rocket-app-<YOUR_ORG>.koyeb.app    2021-06-23 09:46:55.411403 +0000 UTC
Enter fullscreen mode Exit fullscreen mode

Open the URL in your browser to access your application running on Koyeb and natively offering autoscaling, automatic HTTPS (SSL), auto-healing, and global load-balancing across our edge network.

Discussion (0)