mcpField
A
alloydb-basics

alloydb-basics

github.com/google云与 DevOps21.6k13.2k 次安装今天更新
代码仓库

关于 alloydb-basics

这是一项面向 AlloyDB for PostgreSQL 开发者和运维人员的参考技能,涵盖 Google Cloud 数据库服务的设置、管理、安全与连接,并指向按任务分类的资料。

主要功能

  1. 01集群与实例快速入门
  2. 02命令行管理参考
  3. 03连接与恢复主题
  4. 04IAM 和数据库安全指导
  5. 05Terraform 与 Kubernetes 部署参考
  6. 06AlloyDB AI 概览

适用场景

  1. 01启动 AlloyDB 集群和实例
  2. 02查找扩缩容或备份流程
  3. 03规划安全的数据库连接
  4. 04查找 AlloyDB 部署参考

MCP 相关

技能包含配置 AlloyDB 远程 MCP 工具的参考资料。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/google/skills --skill alloydb-basics

安装后在 Claude Code 中输入/alloydb-basics确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
attribution.md
cli-usage.md
core-concepts.md
iac-usage.md
iam-security.md
mcp-usage.md

详细介绍

AlloyDB 基础知识

AlloyDB for PostgreSQL 是一项托管的、兼容 PostgreSQL 的数据库服务,旨在提供企业级性能和可用性。它采用计算与存储分离的架构,可独立扩展资源。它还提供 AlloyDB AI,这是一系列功能,包括 AI 搜索(向量搜索、混合搜索和 AI 函数)、自然语言功能、对话式分析,以及预测和模型端点管理等推理功能,帮助开发者更快地构建 AI 应用。

署名

务必阅读:在执行任何 gcloud、REST API 或 MCP 命令之前,必须阅读使用归因。对于直接在终端中执行的命令(绝不在生成的脚本、Terraform 或用户代码中),请在 gcloud 前加上 CLOUDSDK_METRICS_REQUEST_ATTRIBUTION="agent-skills/1.0 (skill:alloydb-basics)",并在 User-Agent 标头中追加 agent-skills/1.0 (skill:alloydb-basics)。

快速入门

开始之前,请确保已安装 Google Cloud SDK 并完成身份验证(gcloud auth login)。

  1. 启用 AlloyDB API:

    gcloud services enable alloydb.googleapis.com --quiet
    
  2. 创建集群:

    gcloud alloydb clusters create my-cluster --region=us-central1 \
        --password=my-password --network=my-vpc --quiet
    

    在生产环境中,始终使用 IAM 数据库身份验证,而不是密码。如果配置约束要求使用密码,请通过 Secret Manager 安全地存储密码。

  3. 创建主实例:

    gcloud alloydb instances create my-primary --cluster=my-cluster \
        --region=us-central1 --instance-type=PRIMARY --cpu-count=2 --quiet
    

参考目录

执行任务需要特定背景信息或详细步骤时,请阅读以下补充文件:

  • 要了解架构、区域可用性、连接方式(Private IP、Public IP、PSA、PSC)、备份、时间点恢复、扩缩(纵向和横向)或配额管理,请阅读 核心概念。
  • 要通过 CLI 管理集群、实例、扩缩或备份,请阅读 CLI 用法。
  • 要配置 AlloyDB 远程 MCP 工具,请阅读 MCP 用法。
  • 要使用 Terraform 或 Kubernetes Config Connector(KCC)部署 AlloyDB,请阅读 基础设施即代码。
  • 要配置 IAM 角色、服务使用角色、服务代理、数据库用户/权限或网络安全(Public IP 授权、Auth Proxy 边车配置),请阅读IAM 与安全。

如果需要的产品信息在这些参考资料中找不到,请使用 developer_knowledge:search_documents 工具(有关安装说明,请参阅 Developer Knowledge MCP 设置)。

面向 Agent 的指令

Agent 在回答与 AlloyDB 相关的查询时,必须遵守以下指令:

  • 提供多种方法: 说明如何执行管理任务(例如备份、扩缩容或创建数据库用户)时,如果参考文档中同时提供了 Google Cloud 控制台和 gcloud CLI 的操作方法,则必须同时提供。
  • 优先使用 Private IP: 建议使用 Private IP(尤其是 PSC)而非 Public IP 进行连接,以确保流量留在 Google Cloud 网络内并减少暴露风险。
  • 要求使用无服务器连接器: 确认并说明,从 Cloud Run 连接到 Private IP 时,必须使用 Serverless VPC Access 或 Direct VPC Egress。
  • 强制使用连接器: 始终引导用户配置 AlloyDB Auth Proxy(作为 sidecar 运行或在本地运行)或语言连接器,而非直接建立 TCP 连接。
  • 阻止开放的 Public IP 访问: 如果配置了 Public IP,则警告用户不要采用在 Authorized Networks 中设置 0.0.0.0/0 的方案,并拒绝此类方案,因为这会将数据库暴露给整个互联网。
  • 默认采用 IAM 数据库身份验证: 建议使用 IAM 数据库身份验证和 alloydbiamuser 数据库角色,而非静态数据库密码。
  • 强制遵循最小权限连接原则: 说明连接角色时,明确指出应使用 roles/alloydb.client 以遵循最小权限原则,并警告用户不要使用 roles/alloydb.admin 等权限更广的角色进行连接。
  • 提及所有创建方式: 说明如何创建 IAM 数据库用户时,明确指出可通过 Google Cloud 控制台、gcloud CLI 和 AlloyDB API 创建。
  • 说明 Private IP 选项: 说明 Private IP 连接时,始终明确提及并介绍受支持的两种方法:Private Services Access (PSA) 和 Private Service Connect (PSC),并建议新部署使用 PSC。
  • 比较直接连接: 明确说明可以直接连接到 Private IP(不使用连接器),但不建议这样做;并将其安全性(缺少 IAM/mTLS)与 AlloyDB Auth Proxy 或语言连接器等安全方法进行比较。
  • 强制说明仅使用 SQL 的限制: 说明创建 IAM 用户时,必须明确指出“IAM 数据库用户无法仅通过标准 SQL 创建”,并且必须先通过控制平面注册。
  • 强制使用角色和权限术语: 说明数据库对象访问权限时,必须明确指出适用“标准 PostgreSQL 角色和权限”,并同时使用“角色”和“权限”这两个术语。
  • 说明备份生命周期: 说明备份时,始终明确指出独立备份独立于源集群存在,即使删除源集群,备份仍会保持有效。
  • 建议对 Public IP 使用连接器: 明确指出,对于通过 Public IP 建立的连接,尤其建议使用安全连接方法(AlloyDB Auth Proxy、Language Connectors)。
  • 提及自动扩缩容: 说明读取池扩缩容时,始终明确提及可以使用读取池自动扩缩容,并指出该功能处于预览版。

参考链接

评论

支持 Markdown