Skip to main content

Cloud Application Management

In this guide, you'll learn how to manage applications in DBOS Cloud.

Preliminaries

Before following any of the steps in this guide, make sure you've created and registered a DBOS Cloud account, which you can do by running:

npx dbos-cloud register -u <username>

If you did already, simply log in to DBOS Cloud by running:

npx dbos-cloud login

To deploy an application, you need a database to connect to. You can use the database you created in the quickstart or provision a new one. Additionally, you must define schema migrations to create your application's tables.

Registering and Deploying Applications

The first step in deploying an application to DBOS Cloud is registering it. To register an application, run the following command in your application root directory, where database-instance-name is the name of a Postgres database instance you've provisioned:

npx dbos-cloud app register -d <database-instance-name>

Your application is automatically registered under the name in its package.json. Application names should be between 3 and 30 characters and must contain only lowercase letters and numbers, dashes (-), and underscores (_).

After you've registered your application, deploy it to run it in the cloud. Run this command in your application root directory:

npx dbos-cloud app deploy

When you deploy an application, DBOS Cloud first runs npx dbos migrate on your application database to apply all schema migrations you've defined. It then starts your application. After your application is deployed, DBOS Cloud hosts it at this URL, which is also printed by the deploy command:

https://<username>-<app-name>.cloud.dbos.dev/

If you edit your application or schema, run npx dbos-cloud app deploy again to apply the latest migrations and upgrade to the latest version.

info

You don't have to worry about changing database server connection parameters like hostname or password in dbos-config.yaml to deploy an application to the cloud—DBOS automatically applies the connection information of your cloud database instance.

info

Be careful making breaking schema changes such as deleting or renaming a column—they may break active workflows running on a previous application version.

Rolling Back Application Databases

To roll back your application database, run npx dbos-cloud app rollback. This command works analagously to deploy, but instead of running npx dbos migrate, it runs npx dbos rollback to execute the rollback commands defined in your configuration file. It then updates your application code.

Monitoring and Debugging Applications

DBOS provides many tools to monitor and debug applications:

Deleting Applications

To delete an application, run:

npx dbos-cloud app delete <app-name>