Cynosdb

CynosDB 组件，允许用户创建部署一个 CynosDB 数据库实例。配合其他组件进行数据库相关应用开发。

腾讯云 CynosDB 组件

简介

腾讯云 CynosDB 组件通过使用 Serverless Framework，基于云上 Serverless 服务，可以快速方便的创建，部署和管理腾讯云的 Cynosdb 产品。

快速开始

安装
创建
配置
部署
4.1 开启外网访问
4.2 重置密码
查看状态
移除

1. 安装

通过 npm 全局安装最新版本的 Serverless Framework

$ npm install -g serverless

2. 创建

创建并进入一个全新目录：

$ mkdir tencent-cynosdb && cd tencent-cynosdb

3. 配置

在新目录下创建 serverless.yml 文件，在其中进行如下配置

$ touch serverless.yml

# serverless.yml
org: orgDemo
app: appDemo
stage: dev
component: cynosdb
name: cynosdbDemo

inputs:
  region: ap-guangzhou
  zone: ap-guangzhou-4
  vpcConfig:
    vpcId: vpc-xxx
    subnetId: subnet-xxx

更多配置

注：当前仅支持 北京三区，广州四区，上海二区，南京一区 四个地域的创建和部署，因此在填写 yaml 中的地域可用区时需要注意填写为正确的地域和对应的 VPC 子网信息。

4. 部署

如您的账号未登录或注册腾讯云，您可以直接通过微信扫描命令行中的二维码进行授权登陆和注册。

通过sls命令进行部署，并可以添加--debug参数查看部署过程中的信息

注：sls命令是serverless命令的缩写

$ sls deploy

4.1 开启外网访问

如果需要 serverless cynosdb 实例开启外网访问，只需添加 enablePublicAccess 配置为 true，如下：

# serverless.yml
org: orgDemo
app: appDemo
stage: dev
component: cynosdb
name: cynosdbDemo

inputs:
  region: ap-guangzhou
  zone: ap-guangzhou-4
  enablePublicAccess: true
  vpcConfig:
    vpcId: vpc-xxx
    subnetId: subnet-xxx

然后重新执行部署：

$ sls deploy

说明：如果鉴权失败，请参考权限配置进行授权。

部署成功后控制台输出参数介绍请参考 output 文档

4.2 重置密码

组件只支持重置 root 用户密码，比如需要将密码重置为 123456@abc 只需运行如下命令:

$ sls resetpwd --inputs adminPassword=123456@abc

5. 查看状态

在serverless.yml文件所在的目录下，通过如下命令查看部署状态：

$ sls info

6. 移除

通过以下命令移除部署的 DB 实例，移除后该组件会对应删除云上部署时所创建的所有相关资源。

$ sls remove

和部署类似，支持通过 sls remove --debug 命令查看移除过程中的实时日志信息，sls是 serverless 命令的缩写。

账号配置（可选）

当前默认支持 CLI 扫描二维码登录，如您希望配置持久的环境变量/秘钥信息，也可以本地创建 .env 文件

$ touch .env # 腾讯云的配置信息

在 .env 文件中配置腾讯云的 SecretId 和 SecretKey 信息并保存

如果没有腾讯云账号，可以在此注册新账号。

如果已有腾讯云账号，可以在API 密钥管理中获取 SecretId 和SecretKey.

# .env
TENCENT_SECRET_ID=123
TENCENT_SECRET_KEY=123

License

MIT License