@genie-solutions/gdk

中文文档
1.0.1发布于 2022/05/10ISCTypeScriptCommonJS近 30 天下载 4718

Genie 常见 AWS CDK 构造

中文使用文档
文档目录12 节
  1. 安装
  2. 依赖关系
  3. 结构
  4. 模块
  5. 模块内容
  6. 模块测试
  7. 如何发布新版本
  8. 有用命令
  9. 实例
  10. 先决条件
  11. 实例1
  12. 实例2

GDK - AWS CDK 的 Genie 构造库

用于将 AWS 资源部署到 Gentu 和 平台 的一组可重复使用的构造 .

安装

将此库安装到您的工程中

$ npm i @genie-solutions/gdk

依赖关系

关键是:

主要版本 1.0.0 使用 AWS CDK 2.0.0 版本构建. 如果您正在使用此库新鲜度, 请使用库的 1. 0.0 版本和 AWS CDK 的 2. 0.0+ 版本 。 支持版本0.40.0的遗产指示仍保留在下.

只有立法支持

这个库使用AWS CDK的1.151.0版本来构建. 为了保证您能够使用 Cdk 和这个库, 请将您的 cdk 版本固定 .

$ npm i -g [email protected]

如果您在工程中使用本地的 CDK 软件包, 请确保您使用同一版本 。 示例: S3 软件包...

$ npm install @aws-cdk/[email protected]

结构

模块

GDK库被组织成几个模块,但被包装成单一资产. 项目结构如下:

  • src/xxx:xxxx代表AWS CDK包名称的服务组件. 示例:src/ec将包含作为aws-ec构造扩展的构造.
  • src/base-infra:其中包含基础基础设施构造,是进口本土的"云形"模板.

模块内容

模块包含以下类型:

  • 构造 - 本库中的所有更高层次的构造 .
  • 其他类型 - 所有支持构造而存在的非构造类,界面,构造和enum.

模块测试

对库的测试应当遵循与src文件夹相同的结构.

如何发布新版本

在您的分支合并为主后 :

  1. 把您的特性推到主机上
  2. 标记你的承诺,像这样: git tag -a v<major>.<minor>.<patch> -m "<major>.<minor>.<patch>" - 举起手来. git tag -a v0.31.14 -m "0.31.14" (这里的评论非常重要)
  3. 将标签推向主机 git push --tags origin master

Gitlab管道将发布新版本.

有用命令

  • npm run build 将打字符编译为 js
  • npm run watch 监视更改并编译
  • npm run test 进行滑稽单元测试

实例

先决条件

这些变量被用来命名所有资源,生成堆栈名,标记,并确保正确的基建被锁定. 它们组成了GenieStack类型的基础.

❗ 所需变量包括:

  1. 环境
  2. 特性环境
  3. 应用程序
  4. 服务
  5. 版本

你可以读更多关于 维基百科的环境策略。 。 。 .

实例1

此示例创建了可依存的空堆栈 .

// The GDK includes a util module that allows developers to map environment variables to variables
export const configFromEnv =
  fromEnv({
    executionEnvironment: "EXECUTION_ENVIRONMENT",
    featureEnvironment: "FEATURE_ENVIRONMENT",
    application: "APPLICATION",
    service: "SERVICE",
    version: "VERSION",
    containerImage: "CONTAINER_IMAGE"
  });

// The service stack where everything is created
export class MyWebServiceStack extends GenieStack {
  constructor(scope: Construct, id: string, props: BaseServiceStackProps) {
    super(props, scope, id);

  }
}

const app = new App();

// Service stack is instantiated with the properties pulled from environment variables
new MyWebServiceStack(app, "MyWebServiceStack", {
  ...configFromEnv
});

app.synth();

实例2

基于例1,本代码包含一些正在使用的构造,GenieFargateTaskDefinition和GenieFargateService. 你会注意到道具被传递到每个构造中 此变量包含Prerequists中提及的最小要求变量,这再次帮助命名空间,标记和瞄准正确的基础设施.


export class MyWebServiceStack extends GenieStack {
  constructor(scope: Construct, id: string, props: BaseServiceStackProps) {
    super(props, scope, id);

    const myWebServiceTaskDef = new GenieFargateTaskDefinition(this, "EcsTaskDefinition", {
      ...props,
      memoryLimitMiB: 1024,
      cpu: 512,
    });

    myWebServiceTaskDef.addGenieContainer("MyWebContainer", {
      imageName: configFromEnv.containerImage,
      port: 8086,
      cpu: 512,
      memoryLimitMiB: 1024,
      environment: {
        "THIRD_PARTY_API_URL": "http://www.somethirdparty.com/api/v2"
      },
      ...props
    });

    new GenieFargateService(this, "EcsService", {
      ...props,
      taskDefinition: myWebServiceTaskDef,
      desiredCount: 2,
      isPublic: true,
      healthCheck: {
        path: "/health",
        port: "8086"
      }
    });
  }
}

版本与发布记录

@genie-solutions/gdk 共发布 89 个版本,首次发布于 2020/04/22;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.1latest2022/05/104 年前
0.40.32022/04/074 年前
0.40.22022/04/074 年前
0.40.12021/06/305 年前
0.35.02020/09/306 年前
0.34.42020/09/236 年前

关于 @genie-solutions/gdk 的常见问题

@genie-solutions/gdk 是什么?

Genie 常见 AWS CDK 构造

如何安装 @genie-solutions/gdk?

在项目目录运行 npm install @genie-solutions/gdk,或使用 pnpm add / yarn add / bun add。

@genie-solutions/gdk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@genie-solutions/gdk 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@genie-solutions/gdk 可以商用吗?

@genie-solutions/gdk 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@genie-solutions/gdk 的下载量有多少?

根据 npm 官方下载统计,@genie-solutions/gdk 在 2026/10/16 – 2026/11/14 这 30 天内被下载 4,718 次,日均约 157 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@genie-solutions/gdk 还在维护吗?

最新版本 1.0.1 发布于 2022/05/10(4 年前);至今共发布 89 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/04/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。