> ## Documentation Index
> Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Kubernetes

在 Kubernetes 上執行 OpenClaw 的最小起點，並非可用於生產環境的部署。它涵蓋核心資源，並預期你會依自己的環境調整。

## 為什麼不用 Helm

OpenClaw 是單一容器加上一些設定檔。真正需要客製化的是代理內容（Markdown 檔案、Skills、設定覆寫），不是基礎設施樣板。Kustomize 可以處理覆蓋層，而不需要 Helm chart 的額外負擔。如果你的部署變得更複雜，可以在這些 manifests 之上再疊加 Helm chart。

## 你需要什麼

* 執行中的 Kubernetes 叢集（AKS、EKS、GKE、k3s、kind、OpenShift 等）
* 已連線到叢集的 `kubectl`
* 至少一個模型提供者的 API 金鑰

## 快速開始

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
# Replace with your provider: ANTHROPIC, GEMINI, OPENAI, or OPENROUTER
export <PROVIDER>_API_KEY="..."
./scripts/k8s/deploy.sh

kubectl port-forward svc/openclaw 18789:18789 -n openclaw
open http://localhost:18789
```

`deploy.sh` 預設會建立權杖驗證。擷取產生的閘道權杖供 Control UI 使用：

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
kubectl get secret openclaw-secrets -n openclaw -o jsonpath='{.data.OPENCLAW_GATEWAY_TOKEN}' | base64 -d
```

若要進行本機偵錯，`./scripts/k8s/deploy.sh --show-token` 會在部署後列印權杖。

## 使用 Kind 進行本機測試

如果你沒有叢集，請使用 [Kind](https://kind.sigs.k8s.io/) 在本機建立一個：

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
./scripts/k8s/create-kind.sh           # auto-detects docker or podman
./scripts/k8s/create-kind.sh --delete  # tear down
```

接著照常使用 `./scripts/k8s/deploy.sh` 部署。

## 逐步操作

### 1) 部署

**選項 A：環境中的 API 金鑰（一步完成）**

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
# Replace with your provider: ANTHROPIC, GEMINI, OPENAI, or OPENROUTER
export <PROVIDER>_API_KEY="..."
./scripts/k8s/deploy.sh
```

此指令碼會使用 API 金鑰和自動產生的閘道權杖建立 Kubernetes Secret，然後進行部署。如果 Secret 已存在，它會保留目前的閘道權杖，以及任何未變更的提供者金鑰。

**選項 B：分開建立 secret**

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
export <PROVIDER>_API_KEY="..."
./scripts/k8s/deploy.sh --create-secret
./scripts/k8s/deploy.sh
```

在任一命令加入 `--show-token`，即可將權杖列印到 stdout 以供本機測試。

### 2) 存取閘道

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
kubectl port-forward svc/openclaw 18789:18789 -n openclaw
open http://localhost:18789
```

## 會部署哪些內容

```text theme={"theme":{"light":"min-light","dark":"min-dark"}}
Namespace: openclaw (configurable via OPENCLAW_NAMESPACE)
├── Deployment/openclaw        # Single pod, init container + gateway
├── Service/openclaw           # ClusterIP on port 18789
├── PersistentVolumeClaim      # 10Gi for agent state and config
├── ConfigMap/openclaw-config  # openclaw.json + AGENTS.md
└── Secret/openclaw-secrets    # Gateway token + API keys
```

## 客製化

### 代理指示

編輯 `scripts/k8s/manifests/configmap.yaml` 中的 `AGENTS.md`，然後重新部署：

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
./scripts/k8s/deploy.sh
```

### 閘道設定

編輯 `scripts/k8s/manifests/configmap.yaml` 中的 `openclaw.json`。完整參考請參閱[閘道設定](/zh-TW/gateway/configuration)。

### 新增提供者

匯出額外金鑰後重新執行：

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
export ANTHROPIC_API_KEY="..."
export OPENAI_API_KEY="..."
./scripts/k8s/deploy.sh --create-secret
./scripts/k8s/deploy.sh
```

除非你覆寫，否則既有提供者金鑰會保留在 Secret 中。

或直接修補 Secret：

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
kubectl patch secret openclaw-secrets -n openclaw \
  -p '{"stringData":{"<PROVIDER>_API_KEY":"..."}}'
kubectl rollout restart deployment/openclaw -n openclaw
```

### 自訂命名空間

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
OPENCLAW_NAMESPACE=my-namespace ./scripts/k8s/deploy.sh
```

### 自訂映像

編輯 `scripts/k8s/manifests/deployment.yaml` 中的 `image` 欄位：

```yaml theme={"theme":{"light":"min-light","dark":"min-dark"}}
image: ghcr.io/openclaw/openclaw:slim # primary; official Docker Hub mirror: openclaw/openclaw
```

### 暴露到 port-forward 以外

預設 manifests 會將閘道繫結到 Pod 內的 loopback。這可搭配 `kubectl port-forward` 使用，但無法搭配需要直接連到 Pod IP 的 Kubernetes `Service` 或 Ingress 路徑。

若要透過 Ingress 或負載平衡器暴露閘道：

* 將 `scripts/k8s/manifests/configmap.yaml` 中的閘道繫結從 `loopback` 改為符合你部署模型的非 loopback 繫結。
* 保持啟用閘道驗證，並使用適當的 TLS 終止進入點。
* 使用支援的 Web 安全性模型設定 Control UI 的遠端存取（例如 HTTPS/Tailscale Serve，並在需要時明確設定允許的 origins）。

## 重新部署

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
./scripts/k8s/deploy.sh
```

這會套用所有 manifests，並重新啟動 Pod 以載入任何設定或 secret 變更。

## 清除

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
./scripts/k8s/deploy.sh --delete
```

這會刪除命名空間和其中所有資源，包括 PVC。

## 架構備註

* 閘道預設會繫結到 Pod 內的 loopback，因此隨附的設定適用於 `kubectl port-forward`。
* 沒有叢集範圍資源；所有內容都位於單一命名空間中。
* 安全性強化：`readOnlyRootFilesystem`、`drop: ALL` capabilities、非 root 使用者（UID 1000）。
* 預設設定會讓 Control UI 保持在較安全的本機存取路徑：loopback 繫結加上 `kubectl port-forward` 到 `http://127.0.0.1:18789`。
* 如果你要超出 localhost 存取範圍，請使用支援的遠端模型：HTTPS/Tailscale，加上適當的閘道繫結與 Control UI origin 設定。
* Secrets 會在暫存目錄中產生並直接套用到叢集；不會將任何 secret 資料寫入 repo checkout。

## 檔案結構

```text theme={"theme":{"light":"min-light","dark":"min-dark"}}
scripts/k8s/
├── deploy.sh                   # Creates namespace + secret, deploys via kustomize
├── create-kind.sh              # Local Kind cluster (auto-detects docker/podman)
└── manifests/
    ├── kustomization.yaml      # Kustomize base
    ├── configmap.yaml          # openclaw.json + AGENTS.md
    ├── deployment.yaml         # Pod spec with security hardening
    ├── pvc.yaml                # 10Gi persistent storage
    └── service.yaml            # ClusterIP on 18789
```

## 相關

* [Docker](/zh-TW/install/docker)
* [Docker VM 執行階段](/zh-TW/install/docker-vm-runtime)
* [安裝概覽](/zh-TW/install)