将现有的 CDK 应用程序转换为 CDK 管道

Question

是否可以将现有的 CDK 应用程序包装到管道中，选择为应用程序创建管道，但如果只想在本地部署应用程序，也可以执行常规的 cdk deploy -all？

我们当前的主应用程序看起来像这样（过于简化，但只是为了给出想法）：

const app = describeApp()
const coreStack = new CoreStack(app, 'CoreStack')
const domainConfig = new DomainConfig(app, 'DomainConfig')
...

然后我想做的是在底部添加一些内容：

if (process.env.CREATE_PIPELINE) {
    const pipelineApp = new App();
    new PipelineStack(pipelineApp, 'PipelineStack', app);
}

使用 PipelineStack 类可以有效地将主应用程序作为阶段添加到管道中，例如：

export class PipelineStack extends Stack {
    constructor(scope: Construct, id: string, app: App, props?: StackProps) {

        super(scope, id, props);

        const repo = codeCommit.Repository.fromRepositoryName(this, 'Repo', 'XXX')

        const pipeline = new CodePipeline(this, 'Pipeline', {
            pipelineName: 'Pipeline',
            synth: new CodeBuildStep('SynthStep', {
                    input: CodePipelineSource.codeCommit(repo, 'YYY'),
                    installCommands: [
                        'npm install -g yarn',
                        'cd app',
                        'yarn install',
                        'yarn global add aws-cdk'
                    ],
                    commands: [
                        'yarn build',
                        'cdk synth'
                    ]
                }
            )
        });

        pipeline.addStage(app) 
    }
}

这目前抱怨我的舞台没有舞台名称，但如果我添加黑客：

        // @ts-ignore
        app.stageName = 'DeployApp'

然后我在Error: Pipeline stack which uses cross-environment actions must have an explicitly set region 周围出现错误。

我觉得必须有一种更直接的方法来执行此操作，但无需重写我的主应用程序类以仅允许我通过这个新管道进行部署？

Answer 1

是的。这里的重点是“本地”和“管道”部署具有不同的构造层次结构：

• 本地：App > (CoreStack, DomainConfig)
• 管道：App > PipelineStack > Stage > (CoreStack, DomainConfig)

因为堆栈的父级在每种情况下都不同，所以将应用程序的堆栈包装在可重用的构造中很有用。 MyService example in the docs 也使用这种模式。

// AppStacks.ts
export class AppStacks extends Construct {
  constructor(scope: cdk.App | cdk.Stage, id: string, props: AppStacksProps) {
    super(scope, id);
    const coreStack = new CoreStack(this, 'CoreStack', props)
    const domainConfig = new DomainConfig(this, 'DomainConfig', props)
  }
}

对于 *local* (cdk deploy) 部署，包裹在 AppStacks 中的堆栈是应用程序的子级：

// app.ts
const app = new App();
new AppStacks(app, 'Stacks', props);

对于 *pipeline* 部署，您的堆栈是 Stage 的子级，并且 Stage 被添加到 Pipeline。

// DeployStage.ts
export class DeployStage extends cdk.Stage {
  constructor(scope: Construct, id: string, props: DeployStageProps) {
    super(scope, id, { ...props, env: props.config.env });

    new AppStacks(this, 'Stacks', props);
  }
}

// app-pipeline.ts
const app = new App();
new PipelineStack(app, 'Pipeline', props); // add the stage: pipeline.addStage(new DeployStage...)

我更喜欢将我的管道应用程序设置放在一个单独的文件中。但是您也可以拥有一个带有条件逻辑的“应用程序”文件，就像在 OP 中一样。