本文以创建一个阿里云专有网络(VPC)实例为例,为您介绍如何在TypeScript语言环境使用ROS CDK。
步骤一:初始化工程
每个ROS CDK应用都要求创建在一个独立的工程目录下,且该应用需要使用独立工程目录中模块的依赖项。所以在创建应用之前,需要先创建一个工程目录并进行初始化。
执行以下命令,创建工程目录并初始化工程。
mkdir demo
cd demo
ros-cdk init --language=typescript --generate-only=true
步骤二:配置阿里云凭证信息
- 执行以下命令,配置阿里云凭证信息。
- 根据界面提示输入配置信息。
endpoint(optional, default:https://ros.aliyuncs.com):
defaultRegionId(optional, default:cn-hangzhou):cn-beijing
[1] AK
[2] StsToken
[3] RamRoleArn
[4] EcsRamRole
[0] CANCEL
Authenticate mode [1...4 / 0]: 1
accessKeyId:************************
accessKeySecret:******************************
✅ Your cdk configuration has been saved successfully!
配置内容说明如下:
- endpoint:ROS服务地址。默认值为https://ros.aliyuncs.com。
- defaultRegionId:ROS资源栈部署的地域。默认值为cn-hangzhou。
- Authenticate mode:鉴权方式。本示例的鉴权方式为AccessKey,您需要输入accessKeyId和accessKeySecret。
步骤三:预览工程结构
执行以下命令,预览工程结构。
tree .
执行命令后,输出以下内容:
.
├── bin
│ └── demo.ts
├── cdk.json
├── jest.config.js
├── lib
│ └── demo-stack.ts
├── package.json
├── README.md
├── test
│ └── demo.test.ts
└── tsconfig.json
3 directories, 8 files
工程结构说明如下:
bin/demo.ts
:入口文件。
示例中创建了一个应用(类型为ros.App)和一个资源栈(类型为DemoStack,名称为DemoStack),并将资源栈添加到应用中。demo.ts
文件内容如下:
#!/usr/bin/env node
import * as ros from '@alicloud/ros-cdk-core';
import { DemoStack } from '../lib/demo-stack';
const app = new ros.App({outdir: './cdk.out'});
new DemoStack(app, 'DemoStack');
lib/demo-stack.ts
:资源栈的定义文件。
您可以将资源添加到资源栈中,动态构建资源栈。初始化生成的代码中,只为资源栈添加了描述信息。demo-stack.ts
文件内容如下:
import * as ros from '@alicloud/ros-cdk-core';
export class DemoStack extends ros.Stack {
constructor(scope: ros.Construct, id: string, props?: ros.StackProps) {
super(scope, id, props);
new ros.RosInfo(this, ros.RosInfo.description, "This is the simple ros cdk app example.");
// The code that defines your stack goes here
}
}
test/demo.test.ts
:单元测试文件。
用于验证构建资源栈的逻辑是否符合预期。demo.test.ts
文件内容如下:
import { expect as expectCDK, matchTemplate, MatchStyle } from '@alicloud/ros-cdk-assert';
import * as ros from '@alicloud/ros-cdk-core';
import * as Demo from '../lib/demo-stack';
test('Stack with version.', () => {
const app = new ros.App();
// WHEN
const stack = new Demo.DemoStack(app, 'MyTestStack');
// THEN
expectCDK(stack).to(
matchTemplate(
{
ROSTemplateFormatVersion: '2015-09-01',
Description: "This is the simple ros cdk app example."
},
MatchStyle.EXACT,
),
);
});
步骤四:安装依赖
- 修改
package.json
文件,添加ECS依赖包。{
"name": "demo",
"version": "0.1.0",
"bin": {
"demo": "bin/demo.js"
},
"scripts": {
"build": "tsc",
"test": "jest"
},
"devDependencies": {
"@types/jest": "^25.2.1",
"@types/node": "10.17.5",
"typescript": "^3.9.7",
"jest": "^25.5.0",
"ts-jest": "^25.3.1",
"ts-node": "^8.1.0",
"babel-jest": "^26.6.3",
"@babel/core": "^7.12.9",
"@babel/preset-env": "7.12.7",
"@babel/preset-typescript": "^7.12.7",
"@alicloud/ros-cdk-assert": "^1.0.0"
},
"dependencies": {
"@alicloud/ros-cdk-core": "^1.0.0",
"@alicloud/ros-cdk-ecs": "^1.0.0"
}
}
- 执行以下命令,安装依赖。
步骤五:创建资源
- 修改
lib/demo-stack.ts
文件,添加VPC。import * as ros from '@alicloud/ros-cdk-core';
import * as ecs from '@alicloud/ros-cdk-ecs';
export class DemoStack extends ros.Stack {
constructor(scope: ros.Construct, id: string, props?: ros.StackProps) {
super(scope, id, props);
new ros.RosInfo(this, ros.RosInfo.description, "This is the simple ros cdk app example.");
// The code that defines your stack goes here
new ecs.Vpc(this, 'vpc-from-ros-cdk', {
vpcName: 'test-ros-cdk',
cidrBlock: '10.0.0.0/8',
description: 'This is ros cdk test'
});
}
}
- 执行以下命令,生成模板文件。
ros-cdk synth --json
执行命令后,输出以下内容:
{
"Description": "This is the simple ros cdk app example.",
"ROSTemplateFormatVersion": "2015-09-01",
"Resources": {
"vpc-from-ros-cdk": {
"Type": "ALIYUN::ECS::VPC",
"Properties": {
"CidrBlock": "10.0.0.0/8",
"Description": "This is ros cdk test",
"EnableIpv6": false,
"VpcName": "test-ros-cdk"
}
}
}
}
步骤六:单元测试
- 修改
test/demo.test.ts
文件,验证资源栈创建VPC的可行性。import { expect as expectCDK, matchTemplate, MatchStyle } from '@alicloud/ros-cdk-assert';
import * as ros from '@alicloud/ros-cdk-core';
import * as Demo from '../lib/demo-stack';
test('Stack with version.', () => {
const app = new ros.App();
// WHEN
const stack = new Demo.DemoStack(app, 'MyDemoStack');
// THEN
expectCDK(stack).to(
matchTemplate(
{
"Description": "This is the simple ros cdk app example.",
"ROSTemplateFormatVersion": "2015-09-01",
"Resources": {
"vpc-from-ros-cdk": {
"Type": "ALIYUN::ECS::VPC",
"Properties": {
"CidrBlock": "10.0.0.0/8",
"Description": "This is ros cdk test",
"EnableIpv6": false,
"VpcName": "test-ros-cdk"
}
}
}
},
MatchStyle.EXACT,
),
);
});
- 执行以下命令,进行单元测试。
npm test
执行命令后,输出以下内容:
> demo@0.1.0 test /root/demo
> jest
PASS test/demo.test.ts
✓ Stack with version. (136ms)
Test Suites: 1 passed, 1 total
Tests: 1 passed, 1 total
Snapshots: 0 total
Time: 2.988s, estimated 3s
Ran all test suites.
步骤七:管理资源栈
您可以使用ROS CDK命令,创建、查询或删除资源栈。
- 创建资源栈
执行以下命令,创建资源栈。
ros-cdk deploy
执行命令后,输出以下内容:
✅ The deployment(create stack) has completed!
RequestedId: BC963C80-054D-41A0-87E7-001E0AB7B1BA
StackId: 0714be3a-0713-4b7d-b7aa-1564adef****
- 查询资源栈
执行以下命令,查询资源栈。
ros-cdk list-stacks
执行命令后,输出以下内容:
✅ The Stacks list is:
[
{
"Status": "CREATE_COMPLETE",
"StackType": "ROS",
"StatusReason": "Stack CREATE completed successfully",
"CreateTime": "2021-01-26T12:58:05",
"RegionId": "cn-beijing",
"DisableRollback": false,
"StackName": "DemoStack",
"Tags": [],
"StackId": "218f0db0-7992-4e70-a586-15d****",
"TimeoutInMinutes": 20
}
]
- 删除资源栈
- 执行以下命令,删除资源栈。
ros-cdk destroy
- 根据界面提示,确认删除。
The following stack(s) will be destroyed(Only deployed stacks will be displayed).
DemoStack
Please confirm.(Y/N)
Y
执行命令后,输出以下内容:
✅ Deleted
RequestedId: 1BF864E1-7965-4148-A302-E6ABFF806641