Developer Documentation

Projects & regions

Project is always associated to a single AWS region, where all the project’s resources reside. The region can’t be changed after creation.

Creation

Projects can either be created from the dashboard, or during CLI deployment.

Deploying to a specific project, whether it already exists or not, is a governed by the --project-name argument. If it’s not specified during envirobly deploy, and there is no .envirobly/defaults/project present, the project name defaults to the current directory name.

For example:

cd my-super-duper-project

# Given `.envirobly/defaults` doesn't exist yet.
envirobly deploy

# Project by name of "my-super-duper-project" will be created, 
# or deployed to, if it already exists.

# After the first deployment, `.envirobly/defaults` will be populated.
# Further deployments will be governed by `.envirobly/defaults/project`
# unless overridden by arguments.

# You can create a new project, by specifying a new name:
envirobly deploy --project-name project-2

# If you'd like to create the project in a non-default region:
envirobly deploy --project-name project-3 --region eu-north-1

# If you have multiple AWS accounts connected, 
# you can choose the account to deploy to:
envirobly deploy --account-id <envirobly-account-id>
# combined with other options:
envirobly deploy --account-id 123 --project-name project-4

Renaming Projects

If you’d like to rename a project, navigate to the project from the dashboard, and use the ellipsis menu in the top right corner of the project page.

Deployments that rely on .envirobly/defaults/project, which contains the project ID, will continue to be deployed to this project, even after a rename.

Deployments that rely on --project-name argument, are affected by the rename and need to update to the new name, or the deployment will result in a creation of a new project, based on the name.

Renaming a project doesn’t affect the uptime of the services under it.