Skip to content

Commit 0682f7c

Browse files
d-bytebaseclaude
andauthored
docs: convert Production Setup to comprehensive checklist format (#796)
- Reorganized content into a checklist format for easier tracking - Added Prerequisites section with links to essential configuration guides - Simplified CPU/RAM requirements table for better readability - Added Azure to cloud provider recommendations - Streamlined monitoring and container configuration sections 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Claude <[email protected]>
1 parent e696d2e commit 0682f7c

File tree

1 file changed

+27
-50
lines changed

1 file changed

+27
-50
lines changed

mintlify/get-started/self-host/production-setup.mdx

Lines changed: 27 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
title: Production Setup
33
---
44

5-
This page describes how to set up Bytebase in production environment.
5+
This page provides a comprehensive checklist for setting up Bytebase in a production environment.
66

77
## System Requirements
88

99
### CPU and RAM
1010

11-
| Usage | Bytebase | [External PostgreSQL](/get-started/self-host/external-postgres/) if used |
12-
| ------------------------------- | ------------------------- | ---------------------------------------------------------------------- |
13-
| 5 users and 5 instances | 1 CPU cores and 2 GB RAM | 1 CPU cores and 2 GB RAM |
14-
| 20 users and 20 instances | 2 CPU cores and 4 GB RAM | 1 CPU cores and 2 GB RAM |
15-
| 50 users and 50 instances | 4 CPU cores and 8 GB RAM | 2 CPU cores and 4 GB RAM |
16-
| Above 250 users or 50 instances | 8 CPU cores and 16 GB RAM | 2 CPU cores and 4 GB RAM |
11+
| Users & Instances | Bytebase | [External PostgreSQL](/get-started/self-host/external-postgres/) |
12+
|-------------------|----------|-------------------|
13+
| Up to 5 users / 5 instances | 1 CPU / 2 GB RAM | 1 CPU / 2 GB RAM |
14+
| Up to 20 users / 20 instances | 2 CPU / 4 GB RAM | 1 CPU / 2 GB RAM |
15+
| Up to 50 users / 50 instances | 4 CPU / 8 GB RAM | 2 CPU / 4 GB RAM |
16+
| 250+ users or 50+ instances | 8 CPU / 16 GB RAM | 2 CPU / 4 GB RAM |
1717

1818
### Storage
1919

@@ -24,55 +24,32 @@ Bytebase uses a PostgreSQL database to store SQL statements and other metadata.
2424

2525
Teams that frequently work with large SQL files may need more.
2626

27-
## Enable HTTPS and WebSocket
27+
## Production Setup Checklist
2828

29-
You can use [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy) or [Nginx](https://www.nginx.com/). Check out the [configuration example](/get-started/self-host/external-access).
29+
### Prerequisites
3030

31-
## Configure External URL
31+
- Review system requirements (see above)
32+
- [Configure External PostgreSQL](/get-started/self-host/external-postgres/)
33+
- [Configure External Access](/get-started/self-host/external-access)
34+
- [Configure External URL](/get-started/self-host/external-url)
35+
- Pin Docker image to specific version instead of `latest` ([changelog](https://docs.bytebase.com/changelog))
3236

33-
See [Configure External URL](/get-started/self-host/external-url).
37+
### Monitoring
3438

35-
## Store metadata in External PostgreSQL
39+
- Telemetry metrics available at `/metrics` endpoint
3640

37-
See [Configure External PostgreSQL](/get-started/self-host/external-postgres).
41+
### Cloud Provider Recommendations
3842

39-
## Telemetry
43+
If deploying on a cloud provider, use the recommended stack:
4044

41-
Access telemetry at `/metrics` (e.g. https://demo.bytebase.com/metrics).
45+
#### AWS
46+
- **Compute**: EC2 or ECS/EKS
47+
- **Database**: RDS for PostgreSQL
4248

43-
## High Availability (HA)
49+
#### GCP
50+
- **Compute**: GCE or GKE
51+
- **Database**: Cloud SQL for PostgreSQL
4452

45-
You can only run a single Bytebase workspace at a time. In other words, you can scale up the workspace but cannot scale it out to multiple replicas.
46-
47-
Restarting the Bytebase workspace usually takes under 10 seconds. To minimize the downtime, you should
48-
store the metadata in an [external PostgreSQL database](#store-metadata-in-external-postgresql) and make sure the PostgreSQL instance is highly available.
49-
50-
## Kubernetes
51-
52-
### Set `replicas: 1`
53-
54-
Make sure to set the replicas to **1**, otherwise, it may cause data race issues.
55-
56-
### Stateless Architecture
57-
58-
Bytebase is now stateless and does not require persistent volumes. All metadata should be stored in an [external PostgreSQL database](/get-started/self-host/external-postgres).
59-
60-
## Docker Image Versioning
61-
62-
For production deployments, pin to a specific version (e.g., `bytebase/bytebase:3.9.0`) instead of using `latest` to prevent unexpected updates.
63-
64-
See the latest versions in our [changelog](https://docs.bytebase.com/changelog).
65-
66-
## Cloud vendor stack
67-
68-
If you self-host Bytebase in the cloud provider, below is the recommended stack.
69-
70-
### AWS
71-
72-
- EC2 + RDS for PostgreSQL.
73-
- ECS/EKS + RDS for PostgreSQL.
74-
75-
### GCP
76-
77-
- GCE + Cloud SQL for PostgreSQL.
78-
- GKE + Cloud SQL for PostgreSQL.
53+
#### Azure
54+
- **Compute**: Virtual Machines or AKS
55+
- **Database**: Azure Database for PostgreSQL

0 commit comments

Comments
 (0)