Working with projects

An Akka Serverless project is a collection of services and configuration that comprise your application. Each Akka Serverless project runs in its own namespace. Projects support team collaboration: Multiple people can be work on a single project, and each person can be a member of many projects.

Project naming conventions

An Akka Serverless project must have a name and can have a description. It is good practice to name and describe the project so that you and other project members can identify it and its purpose.

Project names must conform to the following:

  • Up to 63 characters

  • Can include:

    • lowercase letters

    • numbers

    • hyphens (-)

  • Must not:

    • start or end with hyphens (-)

  • Cannot include:

    • underscores (_)

    • spaces

    • non-alphanumeric characters

Create a project

To create a project:

Browser
  1. Sign into your Akka Serverless account at: https://console.cloudstate.com/

    The My Projects page opens.

  2. Click new project.

  3. Enter a Project name following the constraints described above.

  4. Enter a user-friendly name in the Project description field.

  5. Click submit.

    Your project should appear in the My projects list. An Akka Serverless administrator will need to activate the project before you can use it.

CLI
  1. Log into your account:

    akkasls auth login

    The web UI launches in a browser.

  2. Enter your credentials.

    An authorization page displays.

  3. Click Authorize

  4. Create a project by substituting your project name and placing a descriptive name in quotes:

    akkasls project new <projectname> “friendly name”

At this point, your project is empty, and you are the only member.

Project status

Along with the project name and description, you will see a project status. During our Beta program, the status will be PENDING until the project has been approved by an Akka Serverless administrator, at which point it will show as ACTIVE, and you can continue using the project to deploy services.

If your project does not change to ACTIVE status, please email us at support@lightbend.com and let us know the project name and ID.

You can also use the command line, akkasls project list, to see a list of all projects you have access to (or have created). See Managing projects for more information.

Using the CLI to manage projects

To use the akkasls CLI, you need to authenticate it with your Akka Serverless account each time you start a new session. To work with an existing project, you must set it to be the target of subsequent commands. Follow these steps to authenticate the CLI and set the target project:

  1. In a command prompt, authenticate akkasls by entering:

    akkasls auth login

    The web UI launches in a browser.

  2. If you are not already logged in, enter your credentials.

    An authorization page displays.

  3. Click Authorize.

  4. Set the target project for subsequent commands:

    akkasls config set project <projectname>

What’s next

If you are new to Akka Serverless, we recommend working through the examples and tutorials to learn some basics. Design Services provides design suggestions and introduces how you can take advantage of Cloudstate’s state management system.