AWSCDK基础结构作为抽象数据类型,第一部分
扫描二维码
随时随地手机看文章
基础设施作为代码(IaC),是一种用代码定义基础设施元素的实践。这与通过GUI(图形用户界面)来实现它相反,例如,AWS控制台。其思想是,为了具有确定性和可重复性,云基础设施必须在一个基于用编程语言表达的模型的抽象描述中被捕获,以便允许操作的自动化,否则应该手动执行。
AWS提供了几种IaC工具,如下所示:
· 云形成:一种能够基于JSON或YAML表示法表示的模板创建和管理云资源的配置工具
· AWS扩展Amplify:一个开源框架,为开发人员提供任何他们需要交付连接AWS基础设施元素以及web和移动组件的应用程序
· AWSSAM(无服务器应用程序模型):一种促进AWS Lambda功能与API网关、REST API、AWS SNS/SMQ、DynamoDB等服务集成的工具。
· AWSSDK(软件开发工具包):一个API,使用Java、Python、TypeScript等编程语言为所有AWS服务提供管理支持
·
AWS CDK(云开发工具包):这是另一个类似于SDK的API,但功能更丰富,不仅允许管理AWS服务,还允许以编程方式创建、修改和删除云形成堆栈,其中包含基础设施元素。它支持许多编程语言,包括但不限于Java、Python、类型的Script等。
其他非亚马逊的IaC工具也存在,如Pulumi和地形,它们提供了非常有趣的多云支持,包括但不限于AWS。例如,与AWS CDK一样,Pulumi允许您使用通用编程语言定义云基础设施,并且与云形成一样,三元组使用专用的声明式符号,称为HCL(HashiCorp配置语言)。
本文是一个系列文章的第一部分,它旨在深入研究CDK作为一种面向对象的高级抽象,通过利用编程语言的力量来定义云基础设施。
AWS CDK简介
在AWS自己的定义中,CDK是一个开源软件开发框架,它使用通用的编程语言来定义了AWS云资源。在这里,我们将使用Java。
有趣的是,从一开始就观察到,与其他IaC工具如云形成或地形形成不同,CDK并不仅仅被定义为一个基础设施供应框架。事实上,在AWS术语的意义,CDK不止是:一个非常多才多艺的IaC框架,释放编程语言和编译器管理高度复杂的AWS云基础设施与代码,相比HCL或其他基于JSON/YAML符号,更具可读性和可扩展性。与这些其他IaC工具不同,使用CDK可以循环、映射、引用、编写条件、使用辅助函数,总之,充分利用编程语言的能力。
但是,也许CDK最重要的优势是它的领域特定语言(DSL)类似的风格,这多亏了构建器设计模式的广泛实现,它允许开发人员轻松地与AWS服务交互,而无需学习复杂的api和其他云供应语法。此外,它还使对可重用组件、安全组、证书、负载平衡器、vpc(虚拟私有云)等组件的强大管理和定制成为可能。
CDK是基于将构造作为其基本构建块的概念。这是一个强大的概念,它允许我们抽象出公共云基础设施模式的细节。构造对应于一个或多个合成资源,它可以是一个只包含S3桶的小云形成堆栈,也可以是一个包含一组具有相关的AWS机器管理器参数存储配置、安全组、证书和负载平衡器。它可以根据需要进行初始化和重用,次数尽可能多次。
堆栈是构造对象的逻辑组。它可以被看作是要部署的组件的图表。它生成声明性云形成模板、梯形配置或Kubernetes清单文件。
最后但并非最不重要的是,该应用程序是一个CDK的概念,它对应于一个构造对象的树。有一个根应用程序,它可能包含一个或多个堆栈对象,依次包含一个或多个构造对象,它可能包含其他构造对象,等等。下图描述了这种结构。
这里有几个例子并说明了它。它们从最简单的,创建一个基本的基础设施,到最复杂的,处理多区域的数据库集群和堡垒主机。让我们来其中一些。
CDK启动器
让我们从一个启动项目开始,构建一个CDK应用程序,该应用程序创建一个只包含S3桶的简单堆栈。安装CDK很简单,如这里所述。一旦根据上述文档安装并启动了CDK,您就可以使用其脚手架功能来快速创建项目骨架。运行以下命令:
Shell
$ cdk init app --language java
当CDK脚手架生成Maven项目时,将显示一堆文本,一旦完成,您可以检查它的结构,如下所示:
$ tree -I target
.
├── cdk.json
├── pom.xml
├── README.md
└── src
├── main
│ └── java
│ └── com
│ └── myorg
│ ├── TestApp.java
│ └── TestStack.java
└── test
└── java
└── com
└── myorg
└── TestTest.java
9 directories, 6 files
这是由CDK脚手架创建的项目骨架。如您所见,有几个Java类,以及一个测试类。它们不是很有趣,你已经可以删除它们,连同软件包com.myorg一起,它可能不符合你的命名约定。但是使用CDK支架函数的真正优点是生成了pom.xml和cdk.json文件。
第一个是驱动应用程序构建过程,并定义所需的依赖项和插件。打开它,你就会看到:
XML
...
software.amazon.awscdk
aws-cdk-lib
...
org.codehaus.mojo
exec-maven-plugin
fr.simplex_software.aws.iac.cdk.starter.CdkStarterApp
...
为了开发CDK应用程序,您需要aws-cdk-lib Maven工件。这是包含所有所需资源的CDK库。一旦构建和部署,要运行应用程序,还需要exec-maven插件。
如果您查看cdk init命令为您生成的cdk.json文件,您会看到:
JSON
...
"app": "mvn -e -q compile exec:java"
3
...
这是CDK在构建应用程序时要使用的命令。当然,如果您不想使用支架功能,而且,如果您喜欢从头开始,您可以提供自己的pom.xml,因为毕竟,作为一个开发人员,您必须习惯它。但是,当涉及到cdk.jsonfile时,您最好是生成它。
所以,很好:你刚刚得到了你的项目骨架,现在你需要定制它以适应你的需求。来看看代码存储库中的cdk启动程序项目。正如您所看到的,有两个Java类,Cdk星tapp和Cdk星栈。第一个方法是通过实例化software.amazon.awscdk来创建一个CDK应用程序。抽象了最基本的CDK概念的应用程序类:应用程序。建议一旦实例化,就可以标记应用程序,这样不同的自动工具就能够根据不同的目的来操作它。例如,我们可以想象有一个自动工具,它可以删除所有的测试应用程序,然后扫描它们,寻找标签环境:开发。
应用程序的目标是定义至少一个堆栈,这是我们的应用程序通过实例化CdkStarterStack类所做的事情。这个类是一个堆栈,因为它扩展了software.amazon.awscdk。堆叠一个。在它的构造函数中,我们将创建一个S3桶,如下面的代码片段所示:
Java
Bucket bucket = Bucket.Builder.create(this, "my-bucket-id")
.bucketName("my-bucket-" + System.getenv("CDK_DEFAULT_ACCOUNT"))
.autoDeleteObjects(true).removalPolicy(RemovalPolicy.DESTROY).build();
在这里,我们创建了一个S3桶,具有我的-bbkem的ID和我的-bbkew的名称,我们已经添加了当前用户的默认帐户ID。其原因是S3的桶名在全球范围内必须是唯一的。
正如您所看到的,这里用于抽象Amazon简单存储服务的类software.amazon.awscdk.services.s3.Bucket实现了设计模式构建器,它允许以类似dsl的方式定义诸如桶名、自动删除和删除策略等属性。
所以这是我们的第一个简单的CDK应用程序。CdkStarterApp类中的以下几行:
Java
app.synth();
…是绝对必要的,因为它产生(“合成”,在CDK的术语中)相关的AWS云形成堆栈模板。一旦“合成”了,它就可以被部署和使用了。这是如何做到的:
Shell
$ git clone https://github.com/nicolasduminil/cdk.git
$ cd cdk/cdk-starter
$ mvn package
$ cdk deploy --requireApproval=never
一堆文本将再次显示,一段时间后,如果一切都好,您应该看到堆栈成功部署的确认。现在,为了检查一切是否正常工作,您可以将已部署的堆栈列表如下:
Shell
$ aws cloudformation list-stacks --stack-status-filter CREATE_COMPLETE
关键是根据存在堆栈的当前状态(在本例中是CREATE_COMPLETE)来过滤其输出列表,以避免检索几十个不相关的信息。所以,你应该看到类似的东西:
JSON
{
"StackSummaries": [
...
{
"StackId": "arn:aws:cloudformation:eu-west-3:...:stack/CdkStarterStack/83ceb390-3232-11ef-960b-0aa19373e2a7",
"StackName": "CdkStarterStack",
"CreationTime": "2024-06-24T14:03:21.519000+00:00",
"LastUpdatedTime": "2024-06-24T14:03:27.020000+00:00",
"StackStatus": "CREATE_COMPLETE",
"DriftInformation": {
"StackDriftStatus": "NOT_CHECKED"
}
}
...
]
}
现在,您可以获得关于您的特定堆栈的更详细信息:
Shell
$ aws cloudformation describe-stacks --stack-name CdkStarterStack
输出将非常冗长,我们不会在这里复制它,但您应该看到有趣的信息,如:
JSON
...
"RoleARN": "arn:aws:iam::...:role/cdk-hnb659fds-cfn-exec-role-...-eu-west-3",
"Tags": [
{
"Key": "environment",
"Value": "development"
},
{
"Key": "application",
"Value": "CdkApiGatewayApp"
},
{
"Key": "project",
"Value": "API Gateway with Quarkus"
}
],
...
当然,您也可以检查您的S3桶是否已经成功创建:
Shell
$ aws s3api list-buckets --query "Buckets[].Name"
在这里,使用查询“桶”的选项。名称,您过滤输出,以便只显示桶名称,您将看到:
JSON
[
...
"my-bucket-...",
...
]
如果您想查看一些属性(例如,关联的标记):
Shell
$ aws s3api get-bucket-tagging --bucket my-bucket-...
{
"TagSet": [
{
"Key": "aws:cloudformation:stack-name",
"Value": "CdkStarterStack"
},
{
"Key": "environment",
"Value": "development"
},
{
"Key": "application",
"Value": "CdkStarterApp"
},
{
"Key": "project",
"Value": "The CDK Starter projet"
},
{
"Key": "aws-cdk:auto-delete-objects",
"Value": "true"
}
]
}
一切似乎都很好,你可能会得出结论,你使用CDK的第一次测试是成功的。因为您现在已经部署了一个带有S3桶的堆栈,所以您应该能够使用这个桶,例如,上传文件,下载它们,等等。您可以通过使用这里所示的AWS CLI来实现这一点。但如果你想用CDK来做,你需要等待下一集。
在等待的同时,不要忘记清理你的AWS工作空间,以避免被开具发票!
Shell
$ cdk destroy --all
aws s3 rm s3://my-bucket-... --recursive
aws s3 rb s3://my-bucket-...