Skip to content

Commit a21857f

Browse files
authored
Conductor Docs (#320)
1 parent 450496b commit a21857f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+487
-354
lines changed

docs/explanations/system-tables.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,11 @@ Each entry represents a different event.
102102
## Provenance Tables
103103

104104
:::info
105-
The provenance database is only available for DBOS Cloud applications using the **experimental** time travel feature. To enable experimental time travel for your application, please specify `--enable-timetravel` [during deploy](../cloud-tutorials/cloud-cli#dbos-cloud-app-deploy).
105+
The provenance database is only available for DBOS Cloud applications using the **experimental** time travel feature. To enable experimental time travel for your application, please specify `--enable-timetravel` [during deploy](../production/dbos-cloud/cloud-cli#dbos-cloud-app-deploy).
106106
:::
107107

108108
DBOS Cloud optionally maintains a provenance database for your application, which is an append-only versioned replica of your application database.
109-
It is the key enabler of [Interactive Time Travel](../cloud-tutorials/interactive-timetravel.md).
109+
It is the key enabler of [Interactive Time Travel](../production/dbos-cloud/interactive-timetravel.md).
110110
The provenance database name is your application database suffixed with `_dbos_prov`.
111111
For example, if your application database is named `hello`, then your provenance database is named `hello_dbos_prov`.
112112
The provenance database contains the history (within the time travel [data retention period](https://www.dbos.dev/pricing)) of each of your database tables.

docs/index.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ sidebar_position: 1
44

55
# Welcome to DBOS!
66

7-
DBOS is a serverless platform for building reliable backend applications.
8-
Add lightweight annotations to your app to _durably execute_ it, making it resilient to any failure.
9-
Then, deploy your app to the cloud with a single command.
7+
DBOS is a library for building incredibly reliable programs.
8+
Add a few annotations to your application to **durably execute** it and make it **resilient to any failure**.
109

1110
### Get Started
1211

docs/integrations/adding-dbos-to-next.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This guide shows you how to add the open source [DBOS Transact](https://github.c
1010
- Lightweight durable execution – DBOS [workflows](../typescript/tutorials/workflow-tutorial) run to completion exactly once.
1111
- Reliable background tasks - Use DBOS [queues](../typescript/tutorials/queue-tutorial.md) to run any task in the background and guarantee it eventually completes, no matter how long it takes.
1212
- Cron-style task scheduling – Automate recurring jobs with [cron-like scheduling](../typescript/tutorials/scheduled-workflows).
13-
- Built-in tracing and replay debugging – [Find workflows in the dashboard](../cloud-tutorials/monitoring-dashboard) and [re-run them locally](../typescript/tutorials/debugging.md).
13+
- Built-in tracing and replay debugging – [Find workflows in the dashboard](../production/dbos-cloud/monitoring-dashboard) and [re-run them locally](../typescript/tutorials/debugging.md).
1414

1515
## Architectural Overview
1616
Next.js is a framework that optimizes where and when [React](https://react.dev/) UI components render—whether on the client, server, or edge—while also handling routing, data fetching, and performance optimizations. Part of this architecture involves the creation of minimized code bundles for handling requests. These bundles can be loaded quickly in a “serverless” environment, leading to minimal request latency even when the server is “cold”. This “serverless” style of deployment precludes any long-running jobs, background tasks that execute while no client requests are pending, or long-lived server objects such as WebSockets:
@@ -280,5 +280,3 @@ For Next.js server actions to work, it may be necessary to configure allowed ori
280280
- If your DBOS code is accessing the application database, check out the [transactions tutorial](../typescript/tutorials/transaction-tutorial) and consider database setup using [schema migration](../typescript/programming-guide#5-database-operations-and-transactions).
281281
- Review the [programming guide](../typescript/programming-guide) for information on job scheduling, queues, and other DBOS features.
282282
- Check out DBOS [programming examples](../examples)
283-
- Launch your Next.js app to [DBOS Cloud](../cloud-tutorials/application-management).
284-

docs/integrations/nestjs.md

-61
Original file line numberDiff line numberDiff line change
@@ -114,64 +114,3 @@ export class AppModule {}
114114
```
115115

116116
If you need multiple instances of your DBOS class, you must give them distinct names (`dbosService` in this case). You can create a dedicated provider for each or use a single provider for multiple classes, at your convenience.
117-
118-
## Running in DBOS Cloud
119-
DBOS Cloud seamlessly autoscales your application to millions of users and provides built-in dashboards for observability and monitoring.
120-
121-
#### 1. Install the DBOS Cloud CLI
122-
<section className="row list">
123-
124-
<article className="col col--6">
125-
Run this command to install it.
126-
</article>
127-
128-
<article className="col col--6">
129-
```shell
130-
npm i -g @dbos-inc/dbos-cloud@latest
131-
```
132-
</article>
133-
</section>
134-
135-
#### 2. Define a Start Command
136-
<section className="row list">
137-
<article className="col col--6">
138-
First, install the Nest.js CLI alongside your project's dependencies:
139-
</article>
140-
141-
<article className="col col--6">
142-
```shell
143-
npm install @nestjs/cli
144-
```
145-
</article>
146-
147-
<article className="col col--6">
148-
Then, set the `start` command in the `runtimeConfig` section of your [`dbos-config.yaml`](../typescript/reference/configuration.md) to `npx nest start`
149-
150-
To test that it works, try launching your application locally with `npx dbos start`.
151-
</article>
152-
153-
<article className="col col--6">
154-
155-
```yaml
156-
runtimeConfig:
157-
start:
158-
- "npx nest start"
159-
```
160-
161-
</article>
162-
</section>
163-
164-
#### 3. Deploy to DBOS Cloud
165-
<section className="row list">
166-
<article className="col col--6">
167-
Run this single command to deploy your application to DBOS Cloud!
168-
</article>
169-
170-
<article className="col col--6">
171-
172-
```shell
173-
dbos-cloud app deploy
174-
```
175-
176-
</article>
177-
</section>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "DBOS Cloud",
3+
"position": 30
4+
}
5+

docs/cloud-tutorials/account-management.md renamed to docs/production/dbos-cloud/account-management.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 30
33
title: Account Management
44
description: Learn how to manage DBOS Cloud users
55
toc_max_heading_level: 3

docs/cloud-tutorials/application-management.md renamed to docs/production/dbos-cloud/application-management.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
2-
sidebar_position: 1
2+
sidebar_position: 20
33
title: Application Management
4-
description: Learn how to manage DBOS Cloud applications
54
pagination_prev: null
65
---
76

@@ -20,7 +19,7 @@ Each time you deploy an application, the following steps execute:
2019
3. **Migration**: If you specify database migrations in your `dbos-config.yaml`, these are run on your cloud database.
2120
4. **Deployment**: Your application is deployed to a number of [Firecracker microVMs](https://firecracker-microvm.github.io/).
2221
By default, these have 1 vCPU and 512MB of RAM.
23-
The amount of memory allocated to each microVM is [configurable](../cloud-tutorials/cloud-cli.md#dbos-cloud-app-update).
22+
The amount of memory allocated to each microVM is [configurable](./cloud-cli.md#dbos-cloud-app-update).
2423

2524
After an application is deployed, it is assigned a domain of the form `https://<username>-<app-name>.cloud.dbos.dev/`.
2625
If your account is part of an [organization](./account-management.md#organization-management), organization name is used instead of username.
@@ -103,9 +102,9 @@ Here are some useful tools to monitor and debug applications:
103102

104103
- The [cloud console](https://console.dbos.dev) provides a web UI for viewing your applications and their traces and logs.
105104

106-
- To retrieve the last `N` seconds of your application's logs, run [`dbos-cloud app logs -l <N>`](../cloud-tutorials/cloud-cli.md#dbos-cloud-app-logs). Note that new log entries take a few seconds to appear.
105+
- To retrieve the last `N` seconds of your application's logs, run [`dbos-cloud app logs -l <N>`](./cloud-cli.md#dbos-cloud-app-logs). Note that new log entries take a few seconds to appear.
107106

108-
- To retrieve the status of a particular application, run [`dbos-cloud app status <app-name>`](../cloud-tutorials/cloud-cli.md#dbos-cloud-app-status). To list all applications, run [`dbos-cloud app list`](../cloud-tutorials/cloud-cli.md#dbos-cloud-app-list).
107+
- To retrieve the status of a particular application, run [`dbos-cloud app status <app-name>`](./cloud-cli.md#dbos-cloud-app-status). To list all applications, run [`dbos-cloud app list`](./cloud-cli.md#dbos-cloud-app-list).
109108

110109
### Managing Application Versions
111110

@@ -116,7 +115,7 @@ You can view all previous versions of your application from the [cloud console](
116115
dbos-cloud app versions <app-name>
117116
```
118117

119-
You can redeploy a previous version of your application by passing `--previous-version <version-id>` to the [`app deploy`](../cloud-tutorials/cloud-cli.md#dbos-cloud-app-deploy) command.
118+
You can redeploy a previous version of your application by passing `--previous-version <version-id>` to the [`app deploy`](./cloud-cli.md#dbos-cloud-app-deploy) command.
120119

121120
```shell
122121
dbos-cloud app deploy --previous-version <version-id>
@@ -132,7 +131,7 @@ To update your application metadata, run:
132131
dbos-cloud app update <app-name>
133132
```
134133

135-
See the [DBOS Cloud CLI reference](../cloud-tutorials/cloud-cli.md#dbos-cloud-app-update) for a list of properties you can update. Note that updating an application metadata does not trigger a redeploy of the code, which you can do with the [`app deploy`](../cloud-tutorials/cloud-cli.md#dbos-cloud-app-deploy) command.
134+
See the [DBOS Cloud CLI reference](./cloud-cli.md#dbos-cloud-app-update) for a list of properties you can update. Note that updating an application metadata does not trigger a redeploy of the code, which you can do with the [`app deploy`](./cloud-cli.md#dbos-cloud-app-deploy) command.
136135

137136
### Deleting Applications
138137

docs/cloud-tutorials/byod-management.md renamed to docs/production/dbos-cloud/byod-management.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 4
2+
sidebar_position: 50
33
title: Bringing Your Own Database
44
---
55

docs/cloud-tutorials/cicd.md renamed to docs/production/dbos-cloud/cicd.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 11
2+
sidebar_position: 90
33
title: CI/CD Best Practices
44
---
55

docs/cloud-tutorials/cloud-cli.md renamed to docs/production/dbos-cloud/cloud-cli.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 30
2+
sidebar_position: 1000
33
title: Cloud CLI Reference
44
description: DBOS Cloud CLI reference
55
pagination_next: null
@@ -23,7 +23,7 @@ It provides a URL to a secure login portal you can use to create an account from
2323

2424
**Arguments:**
2525
- `-u, --username <string>`: Your DBOS Cloud username. Must be between 3 and 30 characters and contain only lowercase letters, numbers, and underscores (`_`).
26-
- `-s, --secret [string]`: (Optional) An [organization secret](../cloud-tutorials/account-management.md#organization-management) given to you by an organization admin. If supplied, adds your newly registered account to the organization.
26+
- `-s, --secret [string]`: (Optional) An [organization secret](./account-management.md#organization-management) given to you by an organization admin. If supplied, adds your newly registered account to the organization.
2727

2828

2929
:::info
@@ -163,7 +163,7 @@ After restoration is complete, we recommend using [`change-database-instance`](#
163163

164164
**Description:**
165165
This command links your own Postgres database instance to DBOS Cloud.
166-
Before running this command, please first follow our [tutorial](../cloud-tutorials/byod-management) to set up your Postgres database.
166+
Before running this command, please first follow our [tutorial](./byod-management) to set up your Postgres database.
167167

168168
:::info
169169
This feature is currently only available to [DBOS Pro or Enterprise](https://www.dbos.dev/pricing) subscribers.

docs/cloud-tutorials/database-management.md renamed to docs/production/dbos-cloud/database-management.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 3
2+
sidebar_position: 40
33
title: Database Management
44
description: Learn how to manage DBOS Cloud database instances
55
---
@@ -28,7 +28,7 @@ Each application is deployed to an isolated database by default; you can configu
2828
:::
2929

3030
:::info
31-
If you forget your database password, you can always [reset it](../cloud-tutorials/cloud-cli.md#dbos-cloud-db-reset-password).
31+
If you forget your database password, you can always [reset it](./cloud-cli.md#dbos-cloud-db-reset-password).
3232
:::
3333

3434
To see a list of all provisioned instances and their statuses, run:
@@ -72,15 +72,15 @@ Database recovery is not available for [linked databases](./byod-management.md)
7272
:::
7373

7474
DBOS Cloud can use [PostgreSQL point-in-time-recovery](https://www.postgresql.org/docs/current/continuous-archiving.html) to restore your database to a previous state, for example to recover from data corruption or loss.
75-
First, run the [`database restore`](../cloud-tutorials/cloud-cli.md#dbos-cloud-db-restore) to create a new database instance containing the state of your database instance at a previous point in time:
75+
First, run the [`database restore`](./cloud-cli.md#dbos-cloud-db-restore) to create a new database instance containing the state of your database instance at a previous point in time:
7676

7777
```shell
7878
dbos-cloud db restore <database-name> -t <timestamp> -n <new-db-instance-name>
7979
```
8080

8181
The timestamp must be in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) format and must be within the backup retention period of your database (24 hours for free-tier users).
8282

83-
After the database is restored, you can redeploy your applications to it with [`app change-database-instance`](../cloud-tutorials/cloud-cli.md#dbos-cloud-app-change-database-instance).
83+
After the database is restored, you can redeploy your applications to it with [`app change-database-instance`](./cloud-cli.md#dbos-cloud-app-change-database-instance).
8484
For each application connected to the original database instance, run:
8585

8686
```shell

0 commit comments

Comments
 (0)