If you do not want to follow the syntax of JSON or YAML templates to orchestrate resources, you can use Cloud Development Toolkit (CDK) of Resource Orchestration Service (ROS). This topic describes how to use ROS CDK for Java to create and manage an Alibaba Cloud virtual private cloud (VPC).
Prerequisites
Java Development Kit (JDK) and Maven in the following versions are available:
JDK: V8 or later
Maven: V3.6 or later
Step 1: Initialize a project
Each ROS CDK application must be created in a separate project directory. The application uses the dependencies of the modules in the directory. Before you create an application, you must create a project directory and initialize the project.
Run the following commands to create a project directory and initialize the project:
mkdir demo
cd demo
ros-cdk init --language=java --generate-only=true
Step 2: Configure an Alibaba Cloud credential
Run the following command to configure an Alibaba Cloud credential:
ros-cdk config
Follow on-screen instructions to configure the credential parameters.
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!
Parameter description:
endpoint: the endpoint of ROS. Default value: https://ros.aliyuncs.com.
defaultRegionId: the ID of the region where you want to deploy the ROS stack. Default value: cn-hangzhou.
Authenticate mode: the authentication method. In this example, an AccessKey pair is used for authentication. In this case, you must specify the AccessKey ID and the AccessKey secret. For more information about how to obtain an AccessKey pair, see Configure a credential in interactive mode (fast).
Step 3: Preview the project structure
Run the following command to preview the project structure:
tree .
After you run the command, the following output is returned:
.
├── cdk.json
├── pom.xml
├── README.md
└── src
├── main
│ └── java
│ └── com
│ └── myorg
│ ├── DemoApp.java
│ └── DemoStack.java
└── test
└── java
└── com
└── myorg
└── DemoTest.java
9 directories, 6 files
The following section describes the project structure:
DemoApp.java
: the launch file of the project.NoteA project can contain only one application.
In this example, an application of the App type and a stack that is named DemoStack and is of the DemoStack type are created. The stack is added to the application. The
DemoApp.java
file contains the following content:package com.myorg; import com.aliyun.ros.cdk.core.*; import java.util.Arrays; public class DemoApp { public static void main(final String[] args) { App app = new App(); new DemoStack(app, "DemoStack"); app.synth(); } }
DemoStack.java
: the definition file of the stack.You can add resources to the stack to dynamically create the stack. When the stack is created, the generated code contains only the description of the stack. The
DemoStack.java
file contains the following content:package com.myorg; import com.aliyun.ros.cdk.core.*; public class DemoStack extends Stack { public DemoStack(final Construct scope, final String id) { this(scope, id, null); } public DemoStack(final Construct scope, final String id, final StackProps props) { super(scope, id, props); // The code that defines your stack goes here } }
DemoTest.java
: the unit test file.The file is used to check whether the created stack follows the expected logic. The
DemoTest.java
file contains the following content:package com.myorg; import com.aliyun.ros.cdk.core.*; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.SerializationFeature; import com.fasterxml.jackson.databind.node.ObjectNode; import org.junit.Test; import com.fasterxml.jackson.databind.node.ArrayNode; import java.io.IOException; import static org.junit.Assert.assertEquals; public class DemoTest { private final static ObjectMapper JSON = new ObjectMapper().configure(SerializationFeature.INDENT_OUTPUT, true); @Test public void testStack() throws IOException { App app = new App(); DemoStack stack = new DemoStack(app, "test"); // synthesize the stack to a ROS template and compare against // a checked-in JSON file. JsonNode actual = JSON.valueToTree(app.synth().getStackArtifact(stack.getArtifactId()).getTemplate()); ObjectNode expected = new ObjectMapper().createObjectNode(); expected.put("ROSTemplateFormatVersion", "2015-09-01"); ObjectNode metadata = expected.putObject("Metadata"); ObjectNode rosInterface = metadata.putObject("ALIYUN::ROS::Interface"); ArrayNode templateTags = rosInterface.putArray("TemplateTags"); templateTags.add("Create by ROS CDK"); assertEquals(expected, actual); } }
Step 4: Install dependencies
Modify the
pom.xml
file to add the dependency package of Elastic Compute Service (ECS) SDK.<?xml version="1.0" encoding="UTF-8"?> <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <modelVersion>4.0.0</modelVersion> <groupId>com.myorg</groupId> <artifactId>java_demo</artifactId> <version>0.1</version> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <cdk.version>1.0.3</cdk.version> </properties> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.1</version> <configuration> <source>1.8</source> <target>1.8</target> </configuration> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>exec-maven-plugin</artifactId> <version>1.6.0</version> <configuration> <mainClass>com.myorg.DemoApp</mainClass> </configuration> </plugin> </plugins> </build> <dependencies> <!-- AliCloud ROS Cloud Development Kit (ROS CDK) --> <dependency> <groupId>com.aliyun</groupId> <artifactId>ros-cdk-core</artifactId> <version>1.0.0</version> </dependency> <dependency> <groupId>com.aliyun</groupId> <artifactId>ros-cdk-ecs</artifactId> <version>1.0.0</version> </dependency> <!-- https://mvnrepository.com/artifact/junit/junit --> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> <scope>test</scope> </dependency> </dependencies> </project>
Run the following command to install the dependencies:
mvn compile
Step 5: Create a resource
Modify the
DemoStack.java
file to create a VPC. For more information about how to obtain resource parameters, visit the CDK page.package com.myorg; import com.aliyun.ros.cdk.core.*; import com.aliyun.ros.cdk.ecs.*; public class DemoStack extends Stack { public DemoStack(final Construct scope, final String id) { this(scope, id, null); } public DemoStack(final Construct scope, final String id, final StackProps props) { super(scope, id, props); // The code that defines your stack goes here Vpc.Builder.create(this, "VPC").vpcName("TestJavaCDK").description("This is ros java cdk test"). cidrBlock("10.0.0.0/8").build(); } }
Run the following commands to generate a template file:
mvn compile ros-cdk synth --json
After you run the commands, the following output is returned:
{ "Metadata": { "ALIYUN::ROS::Interface": { "TemplateTags": [ "Create by ROS CDK" ] } }, "ROSTemplateFormatVersion": "2015-09-01", "Resources": { "VPC": { "Type": "ALIYUN::ECS::VPC", "Properties": { "CidrBlock": "10.0.0.0/8", "Description": "This is ros java cdk test", "EnableIpv6": false, "VpcName": "TestJavaCDK" } } } }
Step 6: Perform a unit test
Modify the
DemoTest.java
file to check whether a VPC can be created for the stack.package com.myorg; import com.aliyun.ros.cdk.core.*; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.SerializationFeature; import com.fasterxml.jackson.databind.node.ObjectNode; import org.junit.Test; import com.fasterxml.jackson.databind.node.ArrayNode; import java.io.IOException; import static org.junit.Assert.assertEquals; public class DemoTest { private final static ObjectMapper JSON = new ObjectMapper().configure(SerializationFeature.INDENT_OUTPUT, true); @Test public void testStack() throws IOException { App app = new App(); DemoStack stack = new DemoStack(app, "test"); // synthesize the stack to a ROS template and compare against // a checked-in JSON file. JsonNode actual = JSON.valueToTree(app.synth().getStackArtifact(stack.getArtifactId()).getTemplate()); ObjectNode expected = new ObjectMapper().createObjectNode(); expected.put("ROSTemplateFormatVersion", "2015-09-01"); ObjectNode metadata = expected.putObject("Metadata"); ObjectNode rosInterface = metadata.putObject("ALIYUN::ROS::Interface"); ArrayNode templateTags = rosInterface.putArray("TemplateTags"); templateTags.add("Create by ROS CDK"); ObjectNode resources = expected.putObject("Resources"); ObjectNode vpc = resources.putObject("VPC"); vpc.put("Type","ALIYUN::ECS::VPC"); ObjectNode properties = vpc.putObject("Properties"); properties.put("CidrBlock","10.0.0.0/8"); properties.put("Description","This is ros java cdk test"); properties.put("EnableIpv6",false); properties.put("VpcName","TestJavaCDK"); assertEquals(expected, actual); } }
Run the following command to perform a unit test:
mvn test
After you run the command, the following output is returned:
------------------------------------------------------- T E S T S ------------------------------------------------------- Running com.myorg.DemoTest Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.294 sec Results : Tests run: 1, Failures: 0, Errors: 0, Skipped: 0 [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 9.158 s [INFO] Finished at: 2021-01-28T20:00:59+08:00 [INFO] ------------------------------------------------------------------------
Step 7: Manage a stack
You can run ROS CDK commands to create, query, and delete a stack.
Create a stack
Run the following command to create a stack:
ros-cdk deploy
After you run the command, the following output is returned:
✅ The deployment(create stack) has completed! RequestedId: BC963C80-054D-41A0-87E7-001E0AB7B1BA StackId: 218f0db0-7992-4e70-a586-12****
Query a stack
Run the following command to query a stack:
ros-cdk list-stacks
After you run the command, the following output is returned:
✅ 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-15e****", "TimeoutInMinutes": 20 } ]
Delete a stack
Run the following command to delete a stack:
ros-cdk destroy
Follow on-screen instructions to confirm the deletion operation.
The following stack(s) will be destroyed(Only deployed stacks will be displayed). DemoStack Please confirm.(Y/N) Y
After you run the command, the following output is returned:
✅ Deleted RequestedId: 1BF864E1-7965-4148-A302-E6ABFF806641