byted-vedb-mysql

Files (13)

• .gitignore
• LICENSE
• SKILL.md
• .env.example · scripts/
• create_vedbm_instance.py · scripts/
• describe_instance.py · scripts/
• downgrade_instance_spec.py · scripts/
• get_instance_endpoint.py · scripts/
• list_db_accounts.py · scripts/
• list_instances.py · scripts/
• requirements.txt · scripts/
• test_spec_matching.py · scripts/
• upgrade_instance_spec.py · scripts/

SKILL.md (first lines)

# 火山引擎 VEDB 管理技能

本技能用于管理火山引擎VeDB MySQL 版实例，包含以下功能：

1. **创建实例**：支持用户自定义实例规格，默认使用 2C8G 规格，用户名 root，密码随机生成
2. **查看实例列表**：查询指定地域下的所有 VEDB 实例
3. **查看数据库账号列表**：查询指定实例中的所有数据库账号及其状态
4. **查看实例连接地址**：查询指定实例的连接地址信息（域名、端口、IP等）

## ✨ 新特性

- **智能规格匹配**：支持用户输入简单格式（如 "2c8g"、"4c16g"）
- **灵活默认值**：默认使用 2C8G 规格
- **自动降级/升级**：如果用户提供的规格不存在，自动选择最接近的可用规格

## 使用流程

### 第一步：收集必要信息

当用户触发此技能时，先检查是否有必要信息。如果没有，引导用户提供：

| 信息 | 必填 | 说明 |
|------|------|------|
| VPC ID | ✅ | 虚拟私有云 ID |
| 子网 ID | ✅ | 子网 ID |
| 可用区 ID | ✅ | 可用区（如 cn-guangzhou-a） |
| AccessKey ID | ✅ | 火山引擎访问密钥 ID |
| Secret Access Key | ✅ | 火山引擎秘密访问密钥 |

### 第二步：信息收集方式

#### 方式 A：对话引导（推荐首次使用）

询问用户：
> "好的，我来帮你创建 VEDBM 实例！需要你提供一些信息：
>
> 1. VPC ID 是什么？
> 2. 子网 ID 是什么？
> 3. 想用哪个可用区？（如 cn-guangzhou-a）
> 4. AccessKey ID 是什么？
> 5. Secret Access Key 是什么？"

#### 方式 B：环境变量配置（推荐频繁使用）

提示用户配置环境变量：

```bash
# 配置环境变量
export VOLCENGINE_ACCESS_KEY="你的AccessKeyId"
export VOLCENGINE_SECRET_KEY="你的SecretAccessKey"
export VEDBM_VPC_ID="你的VPC ID"
export VEDBM_SUBNET_ID="你的子网 ID"
export VEDBM_ZONE_ID="cn-guangzhou-a"
```

或者使用 `.env` 文件：

```bash
cd scripts
cp .env.example .env
# 编辑 .env 文件填入真实信息
```

### 第三步：执行创建

收集完信息后，执行创建命令。

## 访问密钥配置

### 方式 1（推荐）：环境变量

```bash
export VOLCENGINE_ACCESS_KEY="your-access-key-id"
export VOLCENGINE_SECRET_KEY="your-secret-access-key"
export VEDBM_VPC_ID="your-vpc-id"
export VEDBM_SUBNET_ID="your-subnet-id"
export VEDBM_ZONE_ID="cn-guangzhou-a"

python scripts/create_vedbm_instance.py
```

### 方式 2（推荐）：`.env` 文件

```bash
cd scripts
cp .env.example .env
# 编辑 .env 文件填入真实信息（.env 已被 .gitignore 忽略，不会提交）
python create_vedbm_instance.py
```

### 方式 3：命令行传入非敏感参数

VPC ID、子网 ID、可用区等**非敏感**参数可通过命令行传入；AK/SK 仍从环境变量读取，不要出现在命令行中：

```bash
export VOLCENGINE_ACCESS_KEY="your-access-key-id"
export VOLCENGINE_SECRET_KEY="your-secret-access-key"

python scripts/create_vedbm_instance.py \
  --vpc-id <你的VPC ID> \
  --subnet-id <你的子网 ID> \
  --zone-id cn-guangzhou-a
```

## 可用区说明

广州区域可用区：

- `cn-guangzhou-a` - 可用区 A
- `cn-guangzhou-c` - 可用区 C

**注意**：没有 `cn-guangzhou-b`

## 节点规格

| 规格 | CPU | 内存 | 说明 |
|------|-----|------|------|
| `vedb.mysql.x2.large` | 2核 | 8GB | **默认**，入门级 |
| `vedb.mysql.x4.large` | 4核 | 16GB | 性价比高 |

From bytedance/agentkit-samples, Apache-2.0.

More from bytedance/agentkit-samples