CClaude Code 中文教程
文档 / claude-apps-gateway-on-gcp

在 Google Cloud 上部署 Claude apps gateway

官方中文文档· 查看原文 ↗ ·官方译文,未经机器翻译

在 Google Cloud 上运行 Claude apps gateway 的实际示例:Cloud Run 或 GKE、Cloud SQL for PostgreSQL、Secret Manager 和 Agent Platform 的服务账户身份验证。

提示

本页介绍在 Google Cloud 上运行 Claude apps gateway 的一种方式。该配置是客户管理基础设施的工作示例,而不是受支持的生产部署;使用它来了解各个部分如何组合在一起,然后再根据您自己的环境进行调整。有关平台无关的要求,请参阅部署指南

此示例在 Google Cloud 上配置 Claude apps gateway,使用 Google Cloud 的 Agent Platform 作为模型上游,使用 Cloud Run 或 GKE 进行计算。Google Workspace 是示例身份提供商 (IdP),但任何符合 OpenID Connect (OIDC) 的 IdP 都可以工作;只有 oidc 块会改变。有关每个 IdP 的详细信息,请参阅身份提供商设置

您将构建的内容 {#what-you’ll-build}

Google Cloud 上 Claude apps gateway 的图表:Claude Code 客户端通过 HTTPS 连接到网关(Cloud Run 或 GKE),网关在 VPC 内运行,旁边是用于会话状态的私有 IP Cloud SQL 数据库。网关通过 OIDC 针对 Google Workspace 对用户进行签名,从 Secret Manager 读取配置和机密,将模型请求转发到 Google Cloud 的 Agent Platform,并在部署时从 Artifact Registry 拉取其镜像。

参考配置配置以下内容:

  • Cloud Run 服务或 GKE Deployment 运行网关容器
  • Artifact Registry 存储库用于网关镜像
  • Cloud SQL for PostgreSQL 实例,仅限私有 IP,用于网关的存储
  • Secret Manager 机密用于 gateway.yaml、JWT 签名密钥、OIDC 客户端机密和 Postgres URL
  • 服务账户,具有 roles/aiplatform.user,直接附加到 Cloud Run 或通过 Workload Identity 绑定到 GKE
  • 内部应用负载均衡器在 Cloud Run 上,或在 GKE 上的内部 GKE Ingress,类别为 gce-internal,用于 HTTPS

前置条件

  • 启用了计费的 GCP 项目,以及创建上述资源的权限
  • gcloud CLI,使用 gcloud auth login 进行身份验证,并在本地安装了 Docker
  • 对于 GKE 路径:kubectl 和在下面演练中创建的 VPC 上的 GKE 集群
  • 在 Model Garden 中访问您需要的 Claude 模型,在发布这些模型的区域中
  • Google Workspace OAuth 2.0 网络应用程序客户端,重定向 URI 为 https://<gateway-host>/oauth/callback;请参阅身份提供商设置
  • 网关的 TLS 主机名,通常是指向负载均衡器的内部 DNS 名称

设置项目和区域一次:

export PROJECT_ID=<your-project>
export REGION=us-east5   # a region where the Claude models you need are published in Model Garden
gcloud config set project "$PROJECT_ID"

部署网关

下面的步骤使用 gcloud 命令配置完整的部署。

  1. 启用 API

    启用演练使用的服务 API:

    ```bash theme={null}
    gcloud services enable \
      aiplatform.googleapis.com \
      artifactregistry.googleapis.com \
      sqladmin.googleapis.com \
      secretmanager.googleapis.com \
      iamcredentials.googleapis.com \
      iam.googleapis.com \
      compute.googleapis.com \
      servicenetworking.googleapis.com \
      run.googleapis.com \
      container.googleapis.com
    ```
    
    您需要的 API 取决于部署路径:
    
    * `compute` 和 `servicenetworking`:私有 IP Cloud SQL 路径所需
    * `run`:仅限 Cloud Run
    * `container`:仅限 GKE
    
  2. 创建服务账户并授予 IAM

    网关作为专用服务账户运行,具有调用 Google Cloud 的 Agent Platform 的权限。它通过 VPC 使用密码用户到达 Cloud SQL,因此不需要 Cloud SQL IAM 角色:

    ```bash theme={null}
    gcloud iam service-accounts create claude-gateway --display-name="Claude apps gateway"
    SA="claude-gateway@${PROJECT_ID}.iam.gserviceaccount.com"
    
    gcloud projects add-iam-policy-binding "$PROJECT_ID" \
      --member="serviceAccount:${SA}" --role="roles/aiplatform.user" --condition=None
    ```
    
    然后在 Model Garden 中为项目启用 Claude 模型;模型发布到特定区域,因此请检查每个模型卡。
    
  3. 构建镜像并将其推送到 Artifact Registry

    根据容器镜像要求构建镜像,使用 linux-x64 glibc 二进制文件,并推送它:

    ```bash theme={null}
    gcloud artifacts repositories create claude-gateway \
      --repository-format=docker --location="$REGION"
    gcloud auth configure-docker "${REGION}-docker.pkg.dev" --quiet
    
    # Cloud Run requires linux/amd64. --provenance=false avoids a buildx OCI
    # image index that Cloud Run rejects.
    docker build --platform=linux/amd64 --provenance=false \
      -t "${REGION}-docker.pkg.dev/${PROJECT_ID}/claude-gateway/gateway:<version>" .
    docker push "${REGION}-docker.pkg.dev/${PROJECT_ID}/claude-gateway/gateway:<version>"
    ```
    
  4. 配置 Cloud SQL for PostgreSQL

    通过 Private Services Access 在 VPC 上创建实例,使其没有公共 IP;这也满足强制执行 constraints/sql.restrictPublicIp 的项目:

    ```bash theme={null}
    VPC=cc-gateway-vpc
    gcloud compute networks create "$VPC" --subnet-mode=custom
    gcloud compute networks subnets create cc-gateway-subnet \
      --network="$VPC" --region="$REGION" --range=10.0.0.0/24
    
    # Private Services Access: one-time per VPC
    gcloud compute addresses create "google-managed-services-${VPC}" \
      --global --purpose=VPC_PEERING --prefix-length=16 --network="$VPC"
    gcloud services vpc-peerings connect \
      --service=servicenetworking.googleapis.com \
      --ranges="google-managed-services-${VPC}" --network="$VPC"
    
    gcloud sql instances create claude-gateway-db \
      --database-version=POSTGRES_16 --tier=db-g1-small --region="$REGION" \
      --network="projects/${PROJECT_ID}/global/networks/${VPC}" --no-assign-ip
    gcloud sql databases create claude_gateway --instance=claude-gateway-db
    PGPASS="$(openssl rand -hex 24)"
    gcloud sql users create gateway --instance=claude-gateway-db --password="$PGPASS"
    
    PRIVATE_IP="$(gcloud sql instances describe claude-gateway-db \
      --format='value(ipAddresses[0].ipAddress)')"
    GATEWAY_POSTGRES_URL="postgres://gateway:${PGPASS}@${PRIVATE_IP}:5432/claude_gateway?sslmode=require"
    ```
    
    Cloud Run 或 GKE 运行时必须在此 VPC 上或路由到此 VPC。
    
  5. 编写 gateway.yaml

    upstreams 块使用 auth: {} 指向 Google Cloud 的 Agent Platform,因此网关通过运行时服务账户的应用默认凭据进行身份验证。有关每个字段,请参阅配置参考

    两个 `listen` 字段取决于什么在网关前面:
    
    * `public_url`:在 Cloud Run 或 GKE Ingress 后面时需要。网关仅从此值构建 IdP `redirect_uri` 和其发现文档,从不从 `X-Forwarded-*` 标头构建。
    * `trusted_proxies`:前端的源范围。网关仅当 TCP 对等体在此列表中时才遵守 `X-Forwarded-For`,然后遍历链越过受信任的跳跃,因此按 IP 的登录速率限制和审计事件记录开发人员 IP 而不是负载均衡器的。
    
    设置 `trusted_proxies` 以匹配您的前端。类别为 `gce` 的外部 GKE Ingress 未列出:它配置一个公共转发规则地址,`/login` [私有网络检查](/docs/zh-CN/claude-apps-gateway#prerequisites)拒绝该地址。
    
    | 前端                               | `trusted_proxies`                |
    | -------------------------------- | -------------------------------- |
    | 直接到达的 Cloud Run,无负载均衡器           | `[169.254.0.0/16]`               |
    | Cloud Run 前面的内部应用负载均衡器           | `169.254.0.0/16` 加上您的仅代理子网的 CIDR |
    | GKE 内部 Ingress,类别 `gce-internal` | 您的仅代理子网的 CIDR                    |
    
    下面的示例使用内部负载均衡器前面的 Cloud Run 值。
    
    ```yaml gateway.yaml theme={null}
    listen:
      host: 0.0.0.0
      port: 8080
      public_url: https://claude-gateway.internal.example.com
      trusted_proxies: [169.254.0.0/16, <your-proxy-only-subnet-cidr>]
    
    oidc:
      issuer: https://accounts.google.com
      client_id: <your-oauth-client-id>
      client_secret: ${OIDC_CLIENT_SECRET}           # GKE: ${file:/secrets/oidc-client-secret}
      allowed_email_domains: [example.com]
      # Google ignores offline_access; these yield refresh tokens:
      scopes: [openid, profile, email]
      extra_auth_params: { access_type: offline, prompt: consent }
    
    session:
      jwt_secret: ${GATEWAY_JWT_SECRET}              # GKE: ${file:/secrets/jwt-secret}
    
    store:
      postgres_url: ${GATEWAY_POSTGRES_URL}          # GKE: ${file:/secrets/postgres-url}
    
    upstreams:
      - provider: vertex
        region: <your-region>                        # must match $REGION
        project_id: <your-project>
        auth: {} # ADC via the runtime service account
    ```
    
    提示

    Google id_tokens 不携带 groups 声明。要在 managed.policies 中使用基于组的策略,并将 Google Workspace 作为 IdP,请配置 oidc.google_groups,它使用具有域范围委派的服务账户通过 Admin SDK Directory API 查找每个用户的组。没有它,改为匹配 email_domain

  6. 在 Secret Manager 中存储机密

    创建四个机密并授予 roles/secretmanager.secretAccessorclaude-gateway 服务账户:

    | 机密                           | 来源                                     |
    | ---------------------------- | -------------------------------------- |
    | `gateway-jwt-secret`         | `openssl rand -base64 32`              |
    | `gateway-oidc-client-secret` | Google Cloud Console → OAuth 客户端       |
    | `gateway-postgres-url`       | Cloud SQL 步骤中的 `$GATEWAY_POSTGRES_URL` |
    | `gateway-config`             | 前一步中的完整 `gateway.yaml`                 |
    
    机密到达容器的方式因路径而异:
    
    * 在 GKE 上,它们通过 Secret Manager CSI 驱动程序作为文件挂载,`gateway.yaml` 引用 `${file:/secrets/...}`。
    * 在 Cloud Run 上,它无法将多个机密挂载到一个目录中,`gateway.yaml` 作为文件挂载,其他三个作为环境变量注入,因此 `gateway.yaml` 改为引用 `${GATEWAY_JWT_SECRET}`、`${OIDC_CLIENT_SECRET}` 和 `${GATEWAY_POSTGRES_URL}`。
    
  7. 部署 下面的命令在内部负载均衡器后面为生产部署。
        ```bash theme={null}
        gcloud run deploy claude-gateway \
          --image="${REGION}-docker.pkg.dev/${PROJECT_ID}/claude-gateway/gateway:<version>" \
          --region="$REGION" \
          --service-account="claude-gateway@${PROJECT_ID}.iam.gserviceaccount.com" \
          --min-instances=1 \
          --timeout=3600 \
          --ingress=internal-and-cloud-load-balancing \
          --network="$VPC" --subnet=cc-gateway-subnet --vpc-egress=private-ranges-only \
          --set-secrets=/etc/claude/gateway.yaml=gateway-config:latest,GATEWAY_JWT_SECRET=gateway-jwt-secret:latest,OIDC_CLIENT_SECRET=gateway-oidc-client-secret:latest,GATEWAY_POSTGRES_URL=gateway-postgres-url:latest \
          --no-invoker-iam-check
        ```
    
        直接 VPC 出口,通过 `--network`、`--subnet` 和 `--vpc-egress=private-ranges-only`,让服务直接到达 Cloud SQL 私有 IP。到 Google Cloud 的 Agent Platform 端点和 `accounts.google.com` 的公共出口直接进入互联网,而不是通过 VPC,因此不需要 Cloud NAT。
    
        调用者 IAM 检查必须打开或禁用。网关运行自己的 OIDC,其客户端不携带 GCP 令牌,因此 Cloud Run 的调用者检查必须允许未经身份验证的请求。网关的 OIDC 登录在请求到达容器后对其进行身份验证,使用 `allowed_email_domains` 限制哪些域可以登录。
    
        两个标志允许未经身份验证的请求:
    
        * `--no-invoker-iam-check`:禁用检查,无需管理 `allUsers` 绑定,并在域受限共享下工作
        * `--allow-unauthenticated`:授予 `allUsers` `run.invoker` 角色;如果您的组织不允许 `--no-invoker-iam-check`,请使用它
    
        通过 `--ingress` 的入口限制是与调用者检查独立的单独层;保持设置以将服务限制在您的公司网络。
    
        默认情况下,Cloud Run `*.run.app` URL 解析为公共地址,`/login` [私有网络检查](/docs/zh-CN/claude-apps-gateway#prerequisites)拒绝该地址。两种拓扑为开发人员提供私有可解析的主机名,Cloud Run 都不为您配置:
    
        * **内部应用负载均衡器**,上面部署命令假设的拓扑:使用 `--ingress=internal-and-cloud-load-balancing` 部署,在服务前面配置内部应用负载均衡器,具有内部 DNS 名称和证书,并将 `listen.public_url` 设置为该主机名。
        * **仅限内部入口,无负载均衡器**:使用 `--ingress=internal` 部署,并将 `listen.public_url` 保留为 `*.run.app` URL,下面[参考资产](#terraform-reference)中的默认值。为了让 `*.run.app` 私有解析,您的网络团队必须已经运营 Google API 的 Private Service Connect 端点、解析 `*.run.app` 到它的 Cloud DNS 私有区域,以及到该端点的本地路由。
    
        Google 的 [Cloud Run 私有网络指南](https://cloud.google.com/run/docs/securing/private-networking)涵盖了两个选项都需要的基础设施。在网关在私有主机名上提供服务后验证登录;在那之前,从 Cloud Run 中的日志确认容器启动。
    
        在第一次登录前更新 OAuth 客户端的授权重定向 URI 为 `<public_url>/oauth/callback`。更改 `public_url` 后重新部署,因为网关仅从该设置构建其公共源,忽略 `X-Forwarded-Host` 和 `X-Forwarded-Proto`。`X-Forwarded-For` 仅在设置 `listen.trusted_proxies` 时才被遵守用于客户端 IP。
      </Tab>
    
      <Tab title="GKE">
        集群必须在 Cloud SQL 步骤中创建的 `$VPC` 上,以便 pod 可以到达数据库的私有 IP;仅 VPC 对等不起作用,因为 Cloud SQL 私有 IP 本身是对等网络,对等是非传递的。要在该 VPC 上创建新集群,请将 `--network="$VPC" --subnetwork=cc-gateway-subnet` 传递给 `gcloud container clusters create`。
    
        在集群及其节点池上启用 Workload Identity,然后将 Google 服务账户绑定到 Kubernetes 服务账户,以便 pod 继承其凭据:
    
        ```bash theme={null}
        gcloud container clusters update <cluster> --region="$REGION" \
          --workload-pool="${PROJECT_ID}.svc.id.goog"
        # On a Standard cluster, existing node pools also need GKE_METADATA;
        # Autopilot enables this by default.
        gcloud container node-pools update <pool> --cluster=<cluster> \
          --region="$REGION" --workload-metadata=GKE_METADATA
    
        kubectl create namespace claude-gateway
        kubectl create serviceaccount gateway -n claude-gateway
    
        gcloud iam service-accounts add-iam-policy-binding \
          "claude-gateway@${PROJECT_ID}.iam.gserviceaccount.com" \
          --role roles/iam.workloadIdentityUser \
          --member "serviceAccount:${PROJECT_ID}.svc.id.goog[claude-gateway/gateway]"
    
        kubectl annotate serviceaccount gateway -n claude-gateway \
          iam.gke.io/gcp-service-account="claude-gateway@${PROJECT_ID}.iam.gserviceaccount.com"
        ```
    
        将网关部署为标准 Deployment 加上 Service 和内部 Ingress,类别 `gce-internal`,如[Kubernetes 部署](/docs/zh-CN/claude-apps-gateway-deploy#kubernetes)中所述,具有:
    
        * `serviceAccountName: gateway`
        * Secret Manager CSI 驱动程序在 `/secrets` 处挂载机密
        * 就绪探针指向 `GET /readyz`
    
        将具有提高的 `timeoutSec` 的 BackendConfig 附加到网关 Service:GKE Ingress 后面的负载均衡器后端服务默认为 30 秒超时,这会切断长流式响应。
    
        不要在 Workload Identity 集群上应用阻止 `169.254.169.254` 的出口 NetworkPolicy;pod 必须到达元数据服务器以获取凭据。网关的内置 [SSRF 防护](/docs/zh-CN/claude-apps-gateway-deploy#threat-model-summary)是那里的防御。
    
        网关记录启动警告,指出元数据端点可达,并建议应用出口 NetworkPolicy。在 Workload Identity 下,该警告是预期的,因为 pod 需要端点。
      </Tab>
    </Tabs>
    
  8. 将网关 URL 推送到开发人员机器

    网关现在正在运行,但开发人员在网关 URL 在其机器上之前无法从 /login 到达它。在您通过 MDM 部署到每个设备的托管设置文件中设置 forceLoginMethodforceLoginGatewayUrl。登录选择器中没有网关选项供开发人员手动选择。

Terraform 参考

参考部署资产自动化本页的 Cloud Run 路径;配置和镜像资产适用于两条路径:

  • setup.sh:一个幂等的 gcloud 配置程序,遍历完整的 Cloud Run 路径,从启用 API 到第一次部署
  • terraform/:相同的部署作为基础设施即代码,用于绿地部署:创建 Artifact Registry 存储库的目标应用,然后构建和推送镜像,然后完整应用
  • gateway.yaml.example 和用于 distroless 运行时镜像的 Dockerfile

工件默认 Cloud Run 入口为 internal,因此不需要负载均衡器。要匹配本页的生产后面 ALB 部署,使用 INGRESS=internal-and-cloud-load-balancing 运行 setup.sh,或将 Terraform 变量 ingress 设置为 INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER。工件还默认调用者层为 allUsers run.invoker 授予而不是 --no-invoker-iam-check,与本页演练相反;两者都有效,选择取决于您的组织的策略约束。

资产作为工作示例提供,而不是受支持的生产工件;查看并根据您的环境调整它们。

故障排除

有关网关启动和登录错误,请参阅平台无关的故障排除表。下面的条目特定于 Google Cloud。

症状 原因 修复
Cloud Run 在到达容器前返回 403 Forbidden 调用者 IAM 检查仍然启用 使用 --no-invoker-iam-check 部署,或使用 --allow-unauthenticated 授予 allUsers run.invoker 角色
--no-invoker-iam-check 被拒绝,显示 invoker_iam_disabled is not currently available constraints/run.managed.requireInvokerIam 阻止 使用 --allow-unauthenticated。如果通过 constraints/iam.allowedPolicyMemberDomains 的域受限共享也阻止了它,请使用 GKE 路径,它在网络层公开网关,无需 allUsers 绑定。
部署时 Container manifest type … must support amd64/linux 镜像在非 amd64 主机上构建,或 buildx 发出了 OCI 镜像索引 使用 --platform=linux/amd64 --provenance=false 构建
网关启动在 Cloud Run 上以 Postgres 连接超时错误退出 服务未附加到 VPC,或 Cloud SQL 在该 VPC 上没有私有 IP;存储在 5 秒后停止等待 使用 --network--subnet 部署以进行直接 VPC 出口,并使用 --no-assign-ip--network 指向同一 VPC 创建 Cloud SQL 实例
Google Cloud 的 Agent Platform 请求返回 403 PERMISSION_DENIED 运行时未使用 claude-gateway 服务账户,或模型未在 Model Garden 中为项目启用 在 Cloud Run 上设置 --service-account 或在 GKE 上绑定 Workload Identity,并在 Model Garden 中为目标区域启用每个 Claude 模型
流式响应在固定持续时间后切断 前端请求超时:GKE Ingress 后面的负载均衡器后端服务默认为 30 秒,Cloud Run 默认为 300 秒 在 GKE 上附加具有提高的 timeoutSec 的 BackendConfig,或在 Cloud Run 上使用 --timeout=3600 部署

后续步骤