一、1. 安装 Serverless Cloud Framework
使用 npm 安装 Serverless Cloud Framework,详情请参见 安装 Serverless Cloud Framework。
二、2. 创建新目录
创建并进入一个全新目录:
mkdir tencent-tdsqlc && cd tencent-tdsqlc
三、3. 配置文件
在新目录下创建 serverless.yml 文件:
Mac 系统Linux 系统Windows 系统touch serverless.ymltouch serverless.ymlecho. > serverless.yml
在 serverless.yml 文件中进行如下配置(查看全量配置):
# serverless.ymlcomponent: cynosdbname: cynosdbDemoinputs: region: ap-guangzhou zone: ap-guangzhou-4 vpcConfig: vpcId: vpc-xxx subnetId: subnet-xxx
注意:当前仅支持北京三区、广州四区、上海二区、南京一区四个地域的创建和部署,因此在填写 yaml 中的地域可用区时需要填写为正确的地域和对应的 VPC 子网信息。
四、4. 部署
如你的账号未 登录 或 注册 腾讯云,你可以直接通过微信扫描命令行中的二维码进行授权登录和注册。
通过 scf 命令进行部署,并可以添加 –debug 参数查看部署过程中的信息。
$ scf deploy
注意:说明:
注意:scf 命令是 serverless 命令的缩写。
部署完成后,可以在命令行看到创建的数据库实例信息:
五、4.1 开启外网访问
如果需要数据库实例开启外网访问,只需添加 enablePublicAccess 配置为 true,如下:
# serverless.ymlapp: appDemostage: devcomponent: cynosdbname: cynosdbDemoinputs: region: ap-guangzhou zone: ap-guangzhou-4 enablePublicAccess: true vpcConfig: vpcId: vpc-xxx subnetId: subnet-xxx
然后重新执行部署:
$ scf deploy
六、4.2 重置密码
组件只支持重置 root 用户密码。例如,需要将密码重置为 123456@abc 只需运行如下命令:
$ scf resetpwd –inputs adminPassword=123456@abc
七、5. 查看状态
在 serverless.yml 文件所在的目录下,通过如下命令查看部署状态:
$ scf info
八、6. 账号配置(可选)
当前默认支持 CLI 扫描二维码登录,如你希望配置持久的环境变量/密钥信息,也可以本地创建 .env 文件:
$ touch .env # 腾讯云的配置信息
在 .env 文件中配置腾讯云的 SecretId 和 SecretKey 信息并保存:
# .envTENCENT_SECRET_ID=123TENCENT_SECRET_KEY=123
注意:说明:
九、7. 移除
执行以下命令移除部署的服务:
·仅删除云函数相关的配置、代码。
·关联的其他云资源(如 COS、CLS 等),平台均不会关联删除,你可以前往对应产品控制台删除,避免不必要的计费。
scf remove
十、完整配置
app: appDemo # (可选) 该应用名称,字符串stage: dev # (可选) 用于区分环境信息,默认值为 dev,字符串component: cynosdb # (必填) 组件名称,此处为 cynosdbname: cynosdbDemo # (必填) 实例名称inputs: region: ap-shanghai # 可选 ap-guangzhou, ap-shanghai, ap-nanjing zone: ap-shanghai-2 # 可选 ap-guangzhou-4, ap-shanghai-2, ap-beijing-3, ap-nanjing-1 enablePublicAccess: false vpcConfig: vpcId: vpc-123 subnetId: subnet-123 # 如果只创建 serverless 版本,以下两个参数可忽略 dbMode: SERVERLESS payMode: 0
十一、配置说明
主要参数说明如下:
| 参数 | 必选 | 类型 | 默认值 | 描述 |
| region | 是 | string | – | 数据库的所属地区 |
| zone | 是 | string | – | 数据库所在地区的区域 |
| vpcConfig.vpcId | 是 | string | – | VPC 的 ID |
| vpcConfig.subnetId | 是 | string | – | Subnet 的 ID |
| enablePublicAccess | 否 | boolean | false | 是否开启外网访问 |
| dbMode | 否 | string | SERVERLESS | 数据库类型 |
| payMode | number | number | 0 | 付费类型 |
注意:说明:
注意:Serverless Cynosdb 当前支持可用区为:ap-guangzhou-4, ap-shanghai-2, ap-beijing-3, ap-nanjing-1。
十二、dbMode 说明
SERVERLESS – serverless 版本NORMAL – 正常版本
十三、payMode 说明
只有在 dbMode 配置为 NORMAL 时,才生效。
0 – 按量计费1 – 包年包月,目前只支持购买一个月