Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(app-staging-synthesizer-alpha): app staging stack description #28817

Merged
merged 6 commits into from
Jan 23, 2024
Merged

chore(app-staging-synthesizer-alpha): app staging stack description #28817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1693a75
feat(app-staging-synthesizer-alpha): add support stack description
blimmer Jan 22, 2024
787a7f1
fix: integration test
blimmer Jan 22, 2024
8ddfe11
Merge branch 'main' into add-description-to-appstagingsynth
paulhcsun Jan 22, 2024
798bcc8
fix: more snapshots
blimmer Jan 23, 2024
ed8661b
Merge branch 'add-description-to-appstagingsynth' of github.com:blimm…
blimmer Jan 23, 2024
ef73f8c
Merge branch 'main' into add-description-to-appstagingsynth
mergify[bot] Jan 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/@aws-cdk/app-staging-synthesizer-alpha/lib/default-staging-stack.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,7 @@ export class DefaultStagingStack extends Stack implements IStagingResources {
super(scope, id, {
...props,
synthesizer: new BootstraplessSynthesizer(),
description: `This stack includes resources needed to deploy the AWS CDK app ${props.appId} into this environment`,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feedback on this description is welcome.

I based this on the default CDKToolkit stack description:

This stack includes resources needed to deploy AWS CDK apps into this environment

Do we want to include the term AppStagingSynthesizer?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the current description is probably fine as is. Users will be able to easily check that resources are being created by checking the Resources tab anyway.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One thing that we're not considering. The support stack (since it cannot be bootstrapped) must be uploaded to CFN directly, and CFN supports a max size of 51,200 bytes. The app support stack is dynamic because it entirely depends on how many ECR/S3 resources you want. So the description cuts into that.

Somewhere we are promising a number of ECR resources allowed per staging stack. That number could go down as a result of this.

That being said, we probably are ok with this.

analyticsReporting: false, // removing AWS::CDK::Metadata construct saves ~3KB
});
// removing path metadata saves ~2KB
Expand Down
1 change: 1 addition & 0 deletions ...ault-resources.js.snapshot/StagingStack-default-resourcesmax-ACCOUNT-REGION.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"Description": "This stack includes resources needed to deploy the AWS CDK app default-resourcesmax into this environment",
"Resources": {
"CdkFileRoleE26CEABA": {
"Type": "AWS::IAM::Role",
Expand Down
1 change: 1 addition & 0 deletions ...ault-resources.ts.snapshot/StagingStack-default-resourcesmax-ACCOUNT-REGION.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"Description": "This stack includes resources needed to deploy the AWS CDK app default-resourcesmax into this environment",
"Resources": {
"CdkFileRoleE26CEABA": {
"Type": "AWS::IAM::Role",
Expand Down