Setting up a local development environment

This section covers how to set up your local development system, both to develop services, and how to deploy and run them on Akka Serverless. You will need the following:

Akka Serverless CLI

Linux

Recommended approach

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

brew install lightbend-labs/brew/akkasls

Alternative approach

  1. Download the latest version of akkasls from https://downloads.akkaserverless.com/stable/akkasls_linux_amd64.tar.gz

    curl -OL https://downloads.akkaserverless.com/stable/akkasls_linux_amd64.tar.gz
  2. Optionally, you can verify the integrity of the downloaded files using the SHA256 checksums.

  3. From a terminal window, navigate to the location of the download and extract the archive:

    tar xzf akkasls_linux_amd64.tar.gz
    mv akkasls ~/.local/bin
  4. Add ~/.local/bin to your PATH.

macOS

Recommended approach

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

brew install lightbend-labs/brew/akkasls

Alternative approach

  1. Download the latest version of akkasls from https://downloads.akkaserverless.com/stable/akkasls_darwin_amd64.tar.gz

    curl -OL https://downloads.akkaserverless.com/stable/akkasls_darwin_amd64.tar.gz
  2. Optionally, you can verify the integrity of the downloaded files using the SHA256 checksums.

  3. From a terminal window, navigate to the location of the download and extract the archive:

    tar xzf akkasls_darwin_amd64.tar.gz
    mv akkasls /usr/local/bin

For any macOS users who run version 10.15 ( “Catalina” ) or newer and followed the alternative installation approach, you might need to perform an additional step due to security measures. Once akkasls has been downloaded and extracted, execute the following command:

xattr -d com.apple.quarantine `which akkasls`
Windows
  1. Download the latest version of akkasls from https://downloads.akkaserverless.com/stable/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%.

You can verify that the Akka Serverless CLI has been installed successfully by running the command below:

akkasls help

This command also lists all available commands.

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.

What’s next