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.

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

Add docs on migrating AWS CDK applications #13685

Merged
merged 7 commits into from
Jan 3, 2025

Conversation

corymhall
Copy link
Contributor

@corymhall corymhall commented Dec 20, 2024

Proposed changes

This PR adds migration docs detailing how users can migrate their AWS
CDK applications to use Pulumi CDK. It also includes docs on the new
experimental tool for importing the state of the AWS resources.

For reviewers, you can add docs/iac/adopting-pulumi/migrating-to-pulumi/from-cdk/ to the preview link to view the doc.

Unreleased product version (optional)

Related issues (optional)

re pulumi/pulumi-cdk#250

@pulumi-bot
Copy link
Collaborator

* [**Coexist**](#referencing-stack-outputs) with resources provisioned by CDK by referencing stack outputs.
* [**Convert**](#converting-cdk-applications) your CDK application to use [Pulumi CDK](https://github.com/pulumi/pulumi-cdk)

## Referencing Stack Outputs
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This section I copied over from the From CloudFormation page since it also applies to CDK. I could instead just have a reference to that page instead of copying over the content. Let me know what you think

@pulumi-bot
Copy link
Collaborator

This PR adds migration docs detailing how users can migrate their AWS
CDK applications to use Pulumi CDK. It also includes docs on the new
experimental tool for importing the state of the AWS resources.

re pulumi/pulumi-cdk#250
@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

* [@pulumi/pulumi](https://www.npmjs.com/package/@pulumi/pulumi)

```console
npm install @pulumi/aws @pulumi/aws-native @pulumi/docker-build @pulumi/pulumi
Copy link
Member

Choose a reason for hiding this comment

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

Is there not a way to install @pulumi/cdk and get them pulled in transitively?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

npm should automatically install peerDependencies, but sometimes there can be issues and I don't think yarn does. I think it's safer to just have the full list of dependencies the user can install.

Copy link
Contributor

@flostadler flostadler left a comment

Choose a reason for hiding this comment

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

LGTM

}

const app = new pulumicdk.App('app', (scope: pulumicdk.App) => {
new AppStack(app, 'app-stack', {
Copy link
Contributor

Choose a reason for hiding this comment

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

This is missing the StatefulStack from the CDK example from above. Is that intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, we combine the stacks into one.

@pulumi-bot
Copy link
Collaborator

@corymhall corymhall self-assigned this Jan 2, 2025
@corymhall corymhall merged commit e082623 into master Jan 3, 2025
8 checks passed
@corymhall corymhall deleted the corymhall/cdk-migration-guide branch January 3, 2025 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants