Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 27 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
[![Terraform](https://img.shields.io/badge/Terraform-%3E%3D1.5-844fba?logo=terraform&logoColor=white)](https://www.terraform.io)
[![DigitalOcean](https://img.shields.io/badge/DigitalOcean-Droplet-0080ff?logo=digitalocean&logoColor=white)](https://www.digitalocean.com)
[![Azure](https://img.shields.io/badge/Azure-VM-0078d4?logo=microsoft-azure&logoColor=white)](https://azure.microsoft.com)
[![GCP](https://img.shields.io/badge/GCP-CloudRun-4285F4?logo=googlecloud&logoColor=white)](https://cloud.google.com/run)
[![GCP](https://img.shields.io/badge/GCP-ComputeEngine-4285F4?logo=googlecloud&logoColor=white)](https://cloud.google.com/compute)
[![OpenRouter](https://img.shields.io/badge/OpenRouter-Free%20Tier-ff6b35?logoColor=white)](https://openrouter.ai)
[![OpenClaw](https://img.shields.io/badge/OpenClaw-2026-00e5cc?logoColor=white)](https://openclaw.bot)
[![Telegram](https://img.shields.io/badge/Telegram-Bot-26a5e4?logo=telegram&logoColor=white)](https://telegram.org)
[![Slack](https://img.shields.io/badge/Slack-Bot-4a154b?logo=slack&logoColor=white)](https://slack.com)

One-command deployment of an [OpenClaw](https://openclaw.bot) AI agent on DigitalOcean, Azure VM, or GCP Cloud Run with Telegram and Slack support. After `terraform apply`, the bot is fully operational with no manual SSH steps required.
One-command deployment of an [OpenClaw](https://openclaw.bot) AI agent on DigitalOcean, Azure VM, or GCP VM with Telegram and Slack support. After `terraform apply`, the bot is fully operational with no manual SSH steps required.

## Features

Expand All @@ -29,7 +29,7 @@ One-command deployment of an [OpenClaw](https://openclaw.bot) AI agent on Digita
- SSH key pair
- DigitalOcean account + API token (for DO path)
- Azure subscription + service principal credentials (for Azure path)
- GCP project with Cloud Run + Storage + Secret Manager enabled (for Cloud Run path)
- GCP project with Compute Engine API enabled (for GCP VM path)
- OpenRouter API key
- Telegram bot token (from [@BotFather](https://t.me/BotFather))
- Slack App-Level token (starts with `xapp-`)
Expand Down Expand Up @@ -98,10 +98,10 @@ swap_size = 2
openclaw_memory_limit_mb = 800
```

#### Option C: GCP Cloud Run
#### Option C: GCP VM

```bash
cd terraform/gcp_cloudrun
cd terraform/gcp_vm
cp terraform.tfvars.example terraform.tfvars
```

Expand All @@ -110,27 +110,28 @@ Edit `terraform.tfvars`:
```hcl
project_id = "your-gcp-project-id"
region = "us-west1"
service_name = "openclaw"

# Leave empty to use Artifact Registry GHCR proxy
container_image = ""
enable_ghcr_proxy = true
ghcr_remote_repository_id = "ghcr-remote"
ghcr_image_path = "openclaw/openclaw"
ghcr_image_tag = "latest"

bucket_name = "your-gcp-project-id-openclaw-state"
min_instances = 1
max_instances = 1
zone = "us-west1-b"
vm_name = "openclaw-e2-micro"
machine_type = "e2-micro"
boot_disk_size_gb = 30

admin_username = "openclaw"
ssh_public_key_path = "~/.ssh/id_rsa.pub"
network_name = "default"

# Replace with your public IP/CIDR
ssh_allowed_cidrs = ["203.0.113.10/32"]
gateway_allowed_cidrs = ["203.0.113.10/32"]

swap_size = 3
openclaw_memory_limit_mb = 800
```

Cloud Run deployment in this repo uses:
- `2 vCPU`, `4Gi` memory
- CPU always allocated (`cpu_idle = false`)
- `min_instances = 1`
- Runtime state on local ephemeral storage (`/tmp/openclaw-state`) for startup stability
- Config persistence via mounted GCS bucket (`openclaw.json`, mounted read-only)
- `bonjour` plugin disabled for Cloud Run compatibility (avoids mDNS probing crash loop)
GCP VM deployment in this repo uses:
- Compute Engine VM (default `e2-micro`)
- 30GB boot disk
- optional swap + systemd memory cap for OpenClaw process
- firewall rules for SSH (`22`) and OpenClaw gateway (`18789`)

### 3. Load secrets via direnv

Expand All @@ -152,20 +153,14 @@ Wait ~5 minutes for bootstrap to complete. The bot will start automatically.
### 5. Verify

```bash
terraform output cloud_run_url
terraform output ssh_command
```

Then:
- Open the Cloud Run URL to confirm service is reachable.
- SSH to the VM using the output command.
- Send a Telegram message to confirm bot response.
- (Optional) send a Slack message if Slack tokens are configured.

## Cloud Run Notes

- This Cloud Run setup intentionally does **not** persist full runtime/plugin cache state.
- Only required static/config artifacts are persisted in GCS.
- If you destroy infra but want to keep APIs enabled, this repo sets `disable_on_destroy = false` for required GCP services.

## Switching Models

In Telegram, use `/model <alias>`:
Expand Down
21 changes: 21 additions & 0 deletions terraform/gcp_vm/.envrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Auto-load secrets from .env into Terraform variables
# Requires: brew install direnv && eval "$(direnv hook zsh)" >> ~/.zshrc

dotenv ../../.env

export TF_VAR_project_id="$GCP_PROJECT_ID"
export TF_VAR_gcp_credentials_json="${GCP_CREDENTIALS_JSON:-}"
if [ -n "${GCP_CREDENTIALS_FILE:-}" ]; then
credentials_file_expanded="${GCP_CREDENTIALS_FILE/#\~/$HOME}"
if [ -f "${credentials_file_expanded}" ]; then
export TF_VAR_gcp_credentials_json="$(cat "${credentials_file_expanded}")"
fi
fi

export TF_VAR_openrouter_api_key="$OPENROUTER_API_KEY"
export TF_VAR_telegram_bot_token="$TELEGRAM_BOT_TOKEN"
export TF_VAR_openclaw_gateway_token="$OPENCLAW_GATEWAY_TOKEN"
export TF_VAR_brave_api_key="${BRAVE_API_KEY:-}"
export TF_VAR_telegram_owner_id="${TELEGRAM_OWNER_ID:-}"
export TF_VAR_slack_app_token="${SLACK_APP_TOKEN:-}"
export TF_VAR_slack_bot_token="${SLACK_BOT_TOKEN:-}"
48 changes: 48 additions & 0 deletions terraform/gcp_vm/approve_operator_approvals.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
#!/usr/bin/env python3
"""Grant operator.approvals on paired devices; clear processed pending requests."""
import json
import time

PENDING_FILE = "/root/.openclaw/devices/pending.json"
PAIRED_FILE = "/root/.openclaw/devices/paired.json"

pending = {}
for _ in range(12):
try:
with open(PENDING_FILE) as f:
pending = json.load(f)
if pending:
break
except Exception:
pass
time.sleep(5)

# Even if no pending requests, approve operator.approvals for all paired devices.
try:
with open(PAIRED_FILE) as f:
paired = json.load(f)
except Exception:
paired = {}

for request in pending.values():
device_id = request.get("deviceId")
if device_id in paired:
for key in ("scopes", "approvedScopes"):
if "operator.approvals" not in paired[device_id].get(key, []):
paired[device_id].setdefault(key, []).append("operator.approvals")
print(f"Approved via pending: {device_id}")

# Ensure all paired operator devices have operator.approvals regardless of pending state
for device_id, device in paired.items():
if "operator" in device.get("roles", []):
for key in ("scopes", "approvedScopes"):
if "operator.approvals" not in device.get(key, []):
device.setdefault(key, []).append("operator.approvals")
print(f"Granted operator.approvals to {device_id[:16]}...")

if paired:
with open(PAIRED_FILE, "w") as f:
json.dump(paired, f, indent=2)
if pending:
with open(PENDING_FILE, "w") as f:
json.dump({}, f)
182 changes: 182 additions & 0 deletions terraform/gcp_vm/bootstrap.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
#!/bin/bash
set -e

export HOME=/root
export USER=root
export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

# ── 1. System setup ──────────────────────────────────────────
apt-get update -y

# ── Create swap file ─────────────────────────────────────────
swap_size_gb=${swap_size}
swap_size_mb=$((swap_size_gb * 1024))
swap_path="/swapfile"

echo "Setting up $${swap_size_gb}GB swap at $${swap_path}..."
if dd if=/dev/zero of="$${swap_path}" bs=1M count="$${swap_size_mb}"; then
chmod 600 "$${swap_path}"
mkswap "$${swap_path}"
swapon "$${swap_path}"
if ! grep -q "$${swap_path} none swap" /etc/fstab; then
echo "$${swap_path} none swap sw 0 0" >> /etc/fstab
fi
else
echo "WARNING: Swap creation failed; continuing without swap."
fi

# ── Kernel swappiness tuning ─────────────────────────────────
cat > /etc/sysctl.d/99-swappiness.conf << 'SYSCTLEOF'
vm.swappiness = 20
vm.overcommit_memory = 1
SYSCTLEOF
sysctl -p /etc/sysctl.d/99-swappiness.conf

# ── Install Node.js 24.x ────────────────────────────────────
curl -fsSL https://deb.nodesource.com/setup_24.x | bash -
apt-get install -y nodejs

# ── 2. Install OpenClaw ──────────────────────────────────────
export OPENCLAW_ONBOARD_NON_INTERACTIVE=1
export OPENCLAW_INSTALL_METHOD=npm
curl -fsSL https://openclaw.bot/install.sh | bash -s -- --install-method npm --no-onboard

npm install -g grammy @grammyjs/runner @grammyjs/transformer-throttler \
@slack/bolt @slack/socket-mode @slack/web-api

# ── 3. Write config ──────────────────────────────────────────
mkdir -p /root/.openclaw

# Write injected openclaw.json (provided by Terraform)
cat > /root/.openclaw/openclaw.json << 'JSONEOF'
${openclaw_json_content}
JSONEOF

mkdir -p /root/.openclaw/workspace
if ! grep -q "ALWAYS_REPLY_IN_DM" /root/.openclaw/workspace/AGENTS.md 2>/dev/null; then
cat >> /root/.openclaw/workspace/AGENTS.md << 'AGENTSEOF'

## Channel Output Rule (OpenClaw)

- ALWAYS_REPLY_IN_DM: For any direct message on Telegram/Slack, always send at least one plain-text assistant message.
- Never end a DM turn with tool calls only, empty payload, or metadata-only output.
- If uncertain, send a brief fallback text: "I can help with that. Could you share a bit more detail?"
AGENTSEOF
fi

# ── 4. Write .env and export secrets ─────────────────────────
cat > /root/.openclaw/.env << 'ENVEOF'
OPENROUTER_API_KEY=${openrouter_api_key}
TELEGRAM_BOT_TOKEN=${telegram_bot_token}
OPENCLAW_GATEWAY_TOKEN=${openclaw_gateway_token}
BRAVE_API_KEY=${brave_api_key}
OPENCLAW_ONBOARD_NON_INTERACTIVE=1
ENVEOF

export OPENROUTER_API_KEY=${openrouter_api_key}
export TELEGRAM_BOT_TOKEN=${telegram_bot_token}
export OPENCLAW_GATEWAY_TOKEN=${openclaw_gateway_token}
export BRAVE_API_KEY=${brave_api_key}

# ── 5. Onboard ───────────────────────────────────────────────
openclaw doctor --fix || true

loginctl enable-linger root
export XDG_RUNTIME_DIR=/run/user/0
mkdir -p "$XDG_RUNTIME_DIR"
systemctl start user@0.service || true

openclaw onboard --non-interactive --accept-risk --install-daemon || true

# Fix models.json baseUrl (onboard may have written wrong /v1 instead of /api/v1)
MODELS_JSON=/root/.openclaw/agents/main/agent/models.json
if [ -f "$MODELS_JSON" ]; then
sed -i 's|https://openrouter.ai/v1|https://openrouter.ai/api/v1|g' "$MODELS_JSON"
echo "Fixed models.json baseUrl: /v1 -> /api/v1"
fi

# ── Write agent auth-profiles (OpenRouter key) ───────────────
mkdir -p /root/.openclaw/agents/main/agent
cat > /root/.openclaw/agents/main/agent/auth-profiles.json << 'AUTHEOF'
{
"openrouter": {
"apiKey": "${openrouter_api_key}"
}
}
AUTHEOF

openclaw gateway install --force

# ── 6. Create systemd service override with memory limits ────
mkdir -p /root/.config/systemd/user/openclaw-gateway.service.d
cat > /root/.config/systemd/user/openclaw-gateway.service.d/override.conf << 'OVERRIDEEOF'
[Service]
TimeoutStartSec=180
TimeoutStopSec=60
RestartSec=5
MemoryLimit=${openclaw_memory_limit_mb}M
OVERRIDEEOF

systemctl --user daemon-reload
systemctl --user restart openclaw-gateway.service

# ── 7. Auto-approve operator.approvals scope ─────────────────
echo "Waiting for approval requests..."
sleep 120

mkdir -p /root/.openclaw/bootstrap
cat > /root/.openclaw/bootstrap/approve_operator_approvals.py << 'APPROVEPYEOF'
${approve_operator_script}
APPROVEPYEOF
chmod 700 /root/.openclaw/bootstrap/approve_operator_approvals.py
python3 /root/.openclaw/bootstrap/approve_operator_approvals.py

# ── 8. Setup unattended security updates ─────────────────────
apt-get install -y unattended-upgrades

cat > /etc/apt/apt.conf.d/50unattended-upgrades << 'UNATTENDEDEOF'
Unattended-Upgrade::Allowed-Origins {
"$${distro_id}:$${distro_codename}-security";
};
Unattended-Upgrade::AutoFixInterruptedDpkg "true";
Unattended-Upgrade::MinimalSteps "true";
Unattended-Upgrade::Remove-Unused-Kernel-Packages "true";
Unattended-Upgrade::Remove-Unused-Dependencies "true";
Unattended-Upgrade::Automatic-Reboot "true";
Unattended-Upgrade::Automatic-Reboot-Time "03:00";
UNATTENDEDEOF

# ── 9. Setup cleanup cron jobs ───────────────────────────────
cat > /etc/cron.d/openclaw-cleanup << 'CRONEOF'
# OpenClaw cleanup and maintenance tasks
SHELL=/bin/bash
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
CRON_TZ=America/Los_Angeles

# Weekly npm cache cleanup (Sunday 2:00 Pacific)
0 2 * * 0 root npm cache clean --force >> /var/log/openclaw-cleanup.log 2>&1

# Daily disk space logging (2:00 Pacific)
0 2 * * * root df -h > /var/log/openclaw-diskspace.log 2>&1
CRONEOF

# ── 10. Setup logrotate for OpenClaw logs ────────────────────
mkdir -p /var/log/openclaw

cat > /etc/logrotate.d/openclaw << 'LOGROTATEEOF'
/var/log/openclaw-*.log {
daily
rotate 7
compress
delaycompress
notifempty
create 0644 root root
missingok
}
LOGROTATEEOF

echo "=== GCP Bootstrap Complete ==="
echo "Swap: $${swap_size_gb}GB at $${swap_path}"
echo "Memory Limit: ${openclaw_memory_limit_mb}MB (systemd cgroup)"
echo "OpenClaw Web: http://localhost:18789/health (test locally)"
echo "Check systemd: systemctl --user status openclaw-gateway"
Loading
Loading