Skip to content

08-production-deployment.md

Latest commit

 

History

History
201 lines (149 loc) · 6.73 KB

08-production-deployment.md

File metadata and controls

201 lines (149 loc) · 6.73 KB
layout default
title Chapter 8: Production Deployment
nav_order 8
has_children false
parent Teable Database Platform

Chapter 8: Production Deployment

Welcome to Chapter 8: Production Deployment. In this part of Teable: Deep Dive Tutorial, you will build an intuitive mental model first, then move into concrete implementation details and practical production tradeoffs.

Production Teable deployments require coordinated application, database, and realtime operations.

Deployment Baseline

  • containerized API/frontend services
  • managed PostgreSQL and cache/message infrastructure
  • TLS termination and ingress policy controls
  • horizontal scaling for API and websocket workers

Operational Metrics

Track:

  • p50/p95/p99 API and query latency
  • websocket connection churn/reconnect rate
  • workspace mutation error rates
  • replication and backup health indicators

Release and Rollback Strategy

  1. stage schema migrations with backward compatibility checks
  2. run canary rollout for API/websocket nodes
  3. monitor error/latency deviations
  4. rollback quickly on sustained regression

Final Summary

You now have full Teable coverage from architecture to production-grade deployment and operations.

Related:

What Problem Does This Solve?

Most teams struggle here because the hard part is not writing more code, but deciding clear boundaries for core abstractions in this chapter so behavior stays predictable as complexity grows.

In practical terms, this chapter helps you avoid three common failures:

  • coupling core logic too tightly to one implementation path
  • missing the handoff boundaries between setup, execution, and validation
  • shipping changes without clear rollback or observability strategy

After working through this chapter, you should be able to reason about Chapter 8: Production Deployment as an operating subsystem inside Teable: Deep Dive Tutorial, with explicit contracts for inputs, state transitions, and outputs.

Use the implementation notes around execution and reliability details as your checklist when adapting these patterns to your own repository.

How it Works Under the Hood

Under the hood, Chapter 8: Production Deployment usually follows a repeatable control path:

  1. Context bootstrap: initialize runtime config and prerequisites for core component.
  2. Input normalization: shape incoming data so execution layer receives stable contracts.
  3. Core execution: run the main logic branch and propagate intermediate state through state model.
  4. Policy and safety checks: enforce limits, auth scopes, and failure boundaries.
  5. Output composition: return canonical result payloads for downstream consumers.
  6. Operational telemetry: emit logs/metrics needed for debugging and performance tuning.

When debugging, walk this sequence in order and confirm each stage has explicit success/failure conditions.

Source Walkthrough

Use the following upstream sources to verify implementation details while reading this chapter:

  • Teable Why it matters: authoritative reference on Teable (github.com).

Suggested trace strategy:

  • search upstream code for Production and Deployment to map concrete implementation paths
  • compare docs claims against actual runtime/config code before reusing patterns in production

Chapter Connections

Depth Expansion Playbook

Source Code Walkthrough

.ncurc.yml

The .ncurc module in .ncurc.yml handles a key part of this chapter's functionality:

# npm-check-updates configuration used by yarn deps:check && yarn deps:update
# convenience scripts.
# @link https://github.com/raineorshine/npm-check-updates

# Add here exclusions on packages if any
reject: [
    'vite-plugin-svgr',

    # Too early cause in esm
    'is-port-reachable',
    'nanoid',
    'node-fetch',
  ]

This module is important because it defines how Teable: Deep Dive Tutorial implements the patterns covered in this chapter.

tsconfig.base.json

The tsconfig.base module in tsconfig.base.json handles a key part of this chapter's functionality:

{
  "$schema": "https://json.schemastore.org/tsconfig",
  "compilerOptions": {
    "strict": true,
    "useUnknownInCatchVariables": true,
    "allowJs": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "noEmit": true,
    "esModuleInterop": true,
    "moduleResolution": "node",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "incremental": true,
    "newLine": "lf"
  },
  "exclude": ["**/node_modules", "**/.*/"]
}

This module is important because it defines how Teable: Deep Dive Tutorial implements the patterns covered in this chapter.

package.json

The package module in package.json handles a key part of this chapter's functionality:

{
  "name": "@teable/teable",
  "version": "1.10.0",
  "license": "AGPL-3.0",
  "private": true,
  "homepage": "https://github.com/teableio/teable",
  "repository": {
    "type": "git",
    "url": "https://github.com/teableio/teable"
  },
  "author": {
    "name": "tea artist",
    "url": "https://github.com/tea-artist"
  },
  "keywords": [
    "teable",
    "database"
  ],
  "workspaces": [
    "apps/*",
    "packages/*",
    "packages/v2/*",
    "plugins",
    "!apps/electron"
  ],
  "scripts": {
    "clean:global-cache": "rimraf ./.cache",
    "deps:check": "pnpm --package=npm-check-updates@latest dlx npm-check-updates --configFileName .ncurc.yml --workspaces --root --mergeConfig",
    "deps:update": "pnpm --package=npm-check-updates@latest dlx npm-check-updates --configFileName .ncurc.yml -u --workspaces --root --mergeConfig",
    "dev:v2": "pnpm -r --parallel --stream -F @teable/formula -F './packages/v2/*' dev",
    "clean:v2": "pnpm -r --parallel --stream -F @teable/formula -F './packages/v2/*' clean",
    "build:v2": "pnpm -r --parallel --stream -F @teable/formula -F './packages/v2/*' build",
    "build:packages": "pnpm -r -F './packages/**' build",
    "g:build": "pnpm -r run build",
    "g:build-changed": "pnpm -r -F '...[origin/main]' build",

This module is important because it defines how Teable: Deep Dive Tutorial implements the patterns covered in this chapter.

How These Components Connect

flowchart TD
    A[.ncurc]
    B[tsconfig.base]
    C[package]
    A --> B
    B --> C
Loading