Configuring your development environment

This section covers how to set up your local machine. To develop and deploy Akka Serverless services, you will need the following:

Akka Serverless CLI

The Akka Serverless CLI, akkasls enables you to interact with Akka Serverless deployment projects. To install it, follow these steps:

Linux

Download the latest version of akkasls:

curl -sL https://developer.lightbend.com/docs/akka-serverless/get.sh | bash

You can pass options to the installer script with -s -- e.g.:

curl -sL https://developer.lightbend.com/docs/akka-serverless/get.sh | bash -s -- --prefix=$HOME --version=2.0.22 --verbose
curl -sL https://developer.lightbend.com/docs/akka-serverless/get.sh | bash -s -- -P $HOME -v 2.0.22 -V
macOS

Recommended approach

The recommended approach to install akkasls on macOS, is using brew

brew install lightbend-labs/brew/akkasls

Alternative approach

curl -sL https://developer.lightbend.com/docs/akka-serverless/get.sh | bash

You can pass options to the installer script with -s -- e.g.:

curl -sL https://developer.lightbend.com/docs/akka-serverless/get.sh | bash -s -- --prefix=$HOME --version=2.0.22 --verbose
curl -sL https://developer.lightbend.com/docs/akka-serverless/get.sh | bash -s -- -P $HOME -v 2.0.22 -V
Windows
  1. Download the latest version of akkasls from https://downloads.akkaserverless.com/latest/akkasls_windows_amd64.zip

  2. Optionally, you can verify the integrity of the downloaded files using the SHA256 checksums.

  3. Extract the zip file and move akkasls.exe to a location on your %PATH%.

Verify that the Akka Serverless CLI has been installed successfully by running the following to list all available commands:

akkasls help

Docker

If you have Docker version 19.03 or higher, skip to Container registry. You can check by entering docker version in a command window.

Install Docker using the procedures for your OS:

Linux

To install Docker, follow the installation instructions for your Linux distribution on the Docker website.

macOS

Recommended approach

The recommended approach to install Docker on macOS, is using brew.

# Install Docker
brew cask install docker
# Start Docker
open /Applications/Docker.app

Alternative approach

Download the installer from the Docker website.

Windows

Download and run the Docker installer from: https://hub.docker.com/editions/community/docker-ce-desktop-windows/.

Container registry

You can use any private or public registry, such as Google’s Container Registry or Docker Hub. Any registry you use must be accessible by Akka Serverless so that it can retrieve the images to deploy. See Configuring Docker registries for more information.

The grpcurl tool

The grpcurl tool makes it possible to invoke Akka Serverless services from the command line using RPC calls. See the grpcurl Github repository for installation instructions.