GitHub Deployment Redeploy

Documentation Index

Fetch the complete documentation index at: https://docs.deploystack.io/llms.txt

Use this file to discover all available pages before exploring further.

​

Why Redeploy Exists

• New tools are added
• Bugs are fixed
• Features are updated

​

Architecture Context

​

Per-User Instance Model

1 Installation × N Team Members = N Process Instances

Example:
- Team "Acme Corp" installs custom GitHub MCP server
- Team has 3 members: Alice, Bob, Charlie
- Result: 3 separate running processes (one per user)

• Installation: Team-level MCP server record (mcpServerInstallations table)
• Instance: Per-user running process with merged config (mcpServerInstances table)
• ProcessId: Unique identifier including user: {slug}-{team}-{user}-{installation-id}

​

Shared Deployment Directory

• One installation = one GitHub repository
• Download and build artifacts ONCE
• All user instances execute from the same code
• Reduces disk usage and build time

installationId: config.installation_id  // Not userId - shared directory

​

Redeploy vs Restart vs Update

​

Complete Redeploy Flow

​

Step 1: User Action (Frontend)

1. User clicks “Redeploy” button in DeployStack dashboard
2. Frontend sends POST request to backend: /api/github-deployments/:installationId/redeploy

​

Step 2: Backend Operations

1. Fetch Latest SHA from GitHub:
   • Uses GitHub App API to get latest commit SHA
   • Updates mcpServers.git_commit_sha with new SHA
   Critical: Backend updates mcpServers.git_commit_sha with the new SHA. The template_args field is NOT updated - it continues to store the base GitHub reference without SHA (e.g., github:owner/repo). This separation allows the satellite to dynamically reconstruct args with the latest SHA during redeploy.
2. Update All Instance Statuses:
   • Sets ALL user instances to status: 'restarting'
   • Query: UPDATE mcpServerInstances SET status='restarting' WHERE installation_id=...
3. Notify Satellites:
   • Calls satelliteCommandService.notifyMcpRedeploy(installation_id, team_id, user_id)
   • Creates configure command with priority immediate
   • Command sent to ALL satellites (global deployment)

{
  "commandType": "configure",
  "priority": "immediate",
  "payload": {
    "event": "mcp_redeploy",
    "installation_id": "wDhLsJlAryOnfcK9qX5CE",
    "team_id": "4vj7igb2fcwzmko",
    "user_id": "plhdo1j4kuit0et",
    "commit_sha": "abc123def456...",
    "branch": "main"
  }
}

​

Step 3: Satellite Command Processing

1. Route to Handler:
   • Checks payload.event === 'mcp_redeploy'
   • Routes to handleMcpRedeploy() method
2. Find ALL Instances:
   // Find ALL instances for this installation (not just one user)
   for (const [name, config] of Object.entries(servers)) {
     if (config.installation_id === installation_id) {
       instanceNames.push(name);  // Collect ALL user instances
     }
   }
   
3. Stop ALL Instances:
   // Loop through ALL instances
   for (const instanceName of instanceNames) {
     await processManager.removeServerCompletely(instanceName);
   }
   
4. Clear Tool Cache:
   // Clear tools for ALL instances
   for (const instanceName of instanceNames) {
     stdioDiscoveryManager.clearServerTools(instanceName);
   }
   
5. Trigger Config Refresh:
   await onConfigurationUpdate({});
   

• Stopping ALL instances ensures no process uses old code
• removeServerCompletely() sets isUninstallShutdown flag
• Termination handler detects flag and deletes deployment directory
• Config refresh downloads fresh code from GitHub
• ALL instances respawn from new code

​

Step 4: Process Termination & Cleanup

1. Process Termination:
   • Send SIGTERM for graceful shutdown
   • Wait for timeout (10 seconds)
   • Send SIGKILL if needed
2. Deployment Directory Deletion (only if isUninstallShutdown = true):
   if (processInfo.config.temp_dir && processInfo.isUninstallShutdown) {
     const isTmpfs = await tmpfsManager.isTmpfs(temp_dir);
   
     if (isTmpfs) {
       // Production: Unmount tmpfs
       await tmpfsManager.removeTmpfs(temp_dir);
     } else {
       // Development: Delete directory
       await rm(temp_dir, { recursive: true, force: true });
     }
   }
   

• ALL processes stopped
• Shared deployment directory deleted
• Old code completely removed from filesystem

​

Step 5: Fresh Download & Build

1. Reconstruct Args with New SHA:
   • Satellite receives config with args WITHOUT SHA: ["github:owner/repo"]
   • Receives git_commit_sha as separate field: "def456..."
   • Combines them: ["github:owner/repo#def456..."]
   • See Dynamic Args Reconstruction
2. Download Repository:
   • Fetches tarball from GitHub using reconstructed SHA reference
   • Uses GitHub App installation token for authentication
3. Create New Deployment Directory:
   • Production: mount -t tmpfs -o size=300M tmpfs /opt/mcp-deployments/{team}/{install}
   • Development: mkdir /tmp/mcp-{new-uuid}
4. Extract Tarball:
   • Extracts repository contents to deployment directory
5. Install Dependencies:
   • Node.js: npm install --omit=dev
   • Python: uv sync or uv pip install
6. Run Build (if configured):
   • Node.js: npm run build (if scripts.build exists)
   • Python: No build step typically
7. Resolve Entry Point:
   • Node.js: bin or main from package.json
   • Python: Installed script or standalone file

​

Step 6: Respawn ALL Instances

1. Spawn Process:
   • Launches process with transformed config
   • Uses NEW entry point from fresh code
   • Applies user-specific environment variables
2. Status Updates:
   • provisioning → Process starting
   • connecting → Establishing MCP connection
   • discovering_tools → Calling tools/list
   • syncing_tools → Syncing to backend
   • online → Ready for use
3. Tool Discovery:
   • Discovers NEW tools from fresh code
   • Updates tool cache
   • Syncs to backend database

• All team members have NEW code
• New/updated tools are available
• Old tools (if removed) are gone

​

What Gets Deleted on Redeploy

​

Always Deleted

​

Never Deleted

​

Performance Impact

​

Logs During Redeploy

​

Backend Logs

{
  "operation": "github_redeploy_started",
  "installation_id": "wDhLsJlAryOnfcK9qX5CE",
  "repository": "owner/repo",
  "old_sha": "abc123...",
  "new_sha": "def456..."
}

{
  "operation": "github_redeploy_instances_updated",
  "instance_count": 3,
  "status": "restarting"
}

{
  "operation": "github_redeploy_satellites_notified",
  "command_count": 1,
  "satellite_ids": ["sat-global-1"]
}

​

Satellite Logs

{
  "operation": "mcp_redeploy_received",
  "installation_id": "wDhLsJlAryOnfcK9qX5CE",
  "instance_count": 3
}

{
  "operation": "mcp_redeploy_removing_instance",
  "instance_name": "calculator-acme-alice-wDh"
}

{
  "operation": "github_cleanup_tmpfs_success",
  "deployment_dir": "/opt/mcp-deployments/team-abc/install-xyz"
}

{
  "operation": "github_deployment_started",
  "repository": "owner/repo",
  "commit_sha": "def456..."
}

{
  "operation": "github_deployment_ready",
  "entry_point": "/opt/mcp-deployments/team-abc/install-xyz/dist/index.js"
}

{
  "operation": "mcp_redeploy_success",
  "instance_count": 3,
  "restart_time_ms": 35420
}

​

Verification Steps

​

How to Verify Redeploy Worked

1. Before Redeploy:
   • Check deployment directory: ls -la /opt/mcp-deployments/{team}/{install}/
   • Note the directory modification time
   • Check tool list: GET /api/mcp-tools?installation_id=...
2. Push New Code:
   • Add a new tool to your MCP server
   • Commit and push to GitHub: git push origin main
3. Trigger Redeploy:
   • Click “Redeploy” button in DeployStack dashboard
   • Wait for status to progress: restarting → online
4. Verify:
   • Check satellite logs for “GitHub deployment directory deleted”
   • Check satellite logs for “Downloading repository from GitHub”
   • Verify new tool appears: GET /api/mcp-tools?installation_id=...
   • Check directory modification time (should be recent)
   • Test new tool: POST /api/mcp-proxy/execute

​

Debugging Failed Redeployments

1. Check Backend Logs:
   • Look for GitHub API errors (rate limits, auth failures)
   • Verify commit SHA was updated in database
2. Check Satellite Logs:
   • Search for mcp_redeploy_failed operation
   • Check for tmpfs unmount errors
   • Look for download/install/build failures
3. Check Instance Status:
   • Query: SELECT status, status_message FROM mcpServerInstances WHERE installation_id=...
   • Look for error status: failed, error, requires_reauth
4. Common Issues:
   • GitHub token expired: Re-authorize GitHub App
   • Build script failed: Check build logs, validate dependencies
   • Quota exceeded: Deployment too large (>300MB)
   • Process still running: Old process didn’t terminate properly

​

Edge Cases

​

Multiple Users Redeploying Simultaneously

• Backend processes requests sequentially (database lock)
• Only one mcp_redeploy command created
• Satellite processes command once
• Both users see the same result

​

Redeploy During Active Requests

1. Active processes receive SIGTERM
2. Processes finish current requests (graceful shutdown)
3. After 10 seconds, SIGKILL if not terminated
4. New processes spawn with fresh code
5. Clients reconnect automatically (if using persistent connections)

​

Redeploy with Dormant Instances

• removeServerCompletely() handles both:
  • Active: Terminates process, deletes directory
  • Dormant: Clears dormant config (no directory exists yet)
• Deployment directory deleted once (shared)
• ALL instances respawn from fresh code

​

Failed Download After Deletion

1. Directory deletion succeeds
2. GitHub download fails (rate limit, network error)
3. Installation status set to failed
4. Next config refresh retries download
5. Eventually succeeds or requires user intervention

​

HTTP/SSE Servers (Non-GitHub)

// HTTP/SSE redeploy - trigger tool re-discovery for all instances
for (const instanceName of instanceNames) {
  const tools = await remoteToolDiscoveryManager.discoverServerTools(instanceName);
}

• HTTP/SSE servers are externally hosted
• No deployment directory to manage
• Redeploy = “refresh tool list from remote server”

​

Related Documentation

• GitHub Deployment - Complete deployment flow
• Instance Lifecycle - Per-user instance management
• Satellite Commands - Command types and payloads
• Process Management - Process lifecycle and termination
• Idle Process Management - Dormant state handling
• Backend Events - Status tracking and event emission