Document migrating aws.s3.Bucket to aws.s3.BucketV2 #5444

t0yv0 · 2024-09-17T16:46:49Z

Description

Add a migration guide for moving from aws.s3.Bucket to aws.s3.BucketV2.

Fixes https://github.com/pulumi/home/issues/3630

Adding a new package?

If this pull request adds a new package:

The package's schema URL in this PR is correct.
The package metadata file, if present, contains:
- a supported category (one of Cloud, Infrastructure, Network, Database, Monitoring, or Utility).
- a valid plugin download URL. See Publish Your Package.
- a description that explains what the package does.
- a valid logo URL that points to a PNG whose dimensions conform to the others in this repo (e.g., 100x100).
The package repo contains an Overview doc (/docs/_index.md) that includes:
- a brief explanation of what the package is and what it does.
- at least one representative example in all supported languages.
- a front-matter property for the layout set to package.
The package repo contains an Installation and Configuration doc (/docs/installation-configuration.md) that includes:
- links to SDKs in all supported languages.
- a copyable command for installing the resource plugin if necessary.
- an example of configuring the provider with pulumi config set.
- an example of configuring the provider with environment variables.
The repository has:
- a version tag prefixed with v that corresponds with a valid GitHub release and published package SDKs
A CODEOWNER has reviewed the PR.
A member of the @pulumi/docs team has reviewed all documentation.

t0yv0 · 2024-09-17T18:42:27Z

@interurban opening for early review, thanks a lot!

As an aside, I'm working to get examples formatted with the right <chooser> magic and I'm putting together a little script that updates the non-yaml sections automatically via pulumi convert. Would you all be interested in something like this or is there existing machinery to do this? Much appreciated.

github-actions · 2024-09-17T18:46:57Z

Your site preview for commit 6812b5d is ready! 🎉

http://registry--origin-pr-5444-6812b5d7.s3-website.us-west-2.amazonaws.com/registry.

github-actions · 2024-09-17T19:36:39Z

Your site preview for commit 95a25b7 is ready! 🎉

http://registry--origin-pr-5444-95a25b7f.s3-website.us-west-2.amazonaws.com/registry.

github-actions · 2024-09-17T19:46:51Z

Your site preview for commit f7e5595 is ready! 🎉

http://registry--origin-pr-5444-f7e5595e.s3-website.us-west-2.amazonaws.com/registry.

github-actions · 2024-09-17T20:11:27Z

Your site preview for commit 50358fc is ready! 🎉

http://registry--origin-pr-5444-50358fc1.s3-website.us-west-2.amazonaws.com/registry.

t0yv0 · 2024-09-17T21:15:00Z

Looks like something with choosers inside lists is not happy:

/home/runner/work/registry/registry/themes/default/content/registry/packages/aws/how-to-guides/bucketv2-migration.md:
Line 2417: Ordered list item prefix [Expected: 1; Actual: 6; Style: 1/2/3].
Line 2420: Ordered list item prefix [Expected: 2; Actual: 7; Style: 1/2/3].
Line 2422: Ordered list item prefix [Expected: 3; Actual: 8; Style: 1/2/3].

github-actions · 2024-09-18T02:52:43Z

Your site preview for commit f9a1f60 is ready! 🎉

http://registry--origin-pr-5444-f9a1f600.s3-website.us-west-2.amazonaws.com/registry.

themes/default/content/registry/packages/aws/how-to-guides/bucketv2-migration.md

flostadler · 2024-09-18T07:17:28Z

themes/default/content/registry/packages/aws/how-to-guides/bucketv2-migration.md

+2. Perform `pulumi up` to replace (delete and re-create) the buckets in AWS.
+
+If replacement is not acceptable, it is possible to perform a manual migration with `pulumi import` (see Avoiding
+replacement).


We should be able to link to the section like this: [Avoiding Replacement](#avoiding-replacement). Not 100% sure though whether Hugo supports that syntax

It's been failing builds. Looks like this only works in GitHub markdown. @interurban might have some pointers here.

themes/default/content/registry/packages/aws/how-to-guides/bucketv2-migration.md

flostadler · 2024-09-18T07:28:40Z

themes/default/content/registry/packages/aws/how-to-guides/bucketv2-migration.md

+against the actual cloud account. While the details will vary depending on your use case, this procedure generally
+involves the following steps:
+
+- Find URNs for legacy Bucket Pulumi resources using `pulumi stack export`


We should be able to extract those with jq, right? Could be a nice addition to add that here

github-actions · 2024-09-18T18:30:16Z

Your site preview for commit a26fefd is ready! 🎉

http://registry--origin-pr-5444-a26fefd1.s3-website.us-west-2.amazonaws.com/registry.

github-actions · 2024-09-18T18:43:06Z

Your site preview for commit f172554 is ready! 🎉

http://registry--origin-pr-5444-f1725541.s3-website.us-west-2.amazonaws.com/registry.

t0yv0 · 2024-09-18T20:09:56Z

@flostadler I went ahead and took a larger bucket example for a spin through the import-based migration procedure. It worked but highlighted a few extra steps, this was useful.

For alternative upgrade procedures.

I have filed pulumi/pulumi-aws#4471 as this seems to have regressed.

I've also had a slack conversation with a user trying this today and filed pulumi/pulumi-aws#4470 - sounds like we could do a bit more possibly, depending on interest here.

github-actions · 2024-09-18T20:30:12Z

Your site preview for commit e7f99a0 is ready! 🎉

http://registry--origin-pr-5444-e7f99a0d.s3-website.us-west-2.amazonaws.com/registry.

themes/default/content/registry/packages/aws/how-to-guides/bucketv2-migration.md

t0yv0 · 2024-09-30T21:08:17Z

@cnunciato we have considered some possibilities here but they remain much more complicated that appears on the surface. I'm tracking some relevant issues here in pulumi-aws:

For the moment I think our recommendation is to proceed with the documentation updates, incorporating Matt's latest comment the stance is:

encourage new users to use BucketV2 vs Bucket
offer instructions for users opting to migrate existing Bucket code to BucketV2 code on how to do this

At the time of pulumi-aws v7 major at some point in the future mostly driven by upstream decisions on breaking changes we'll reconsider the above tooling ideas. Possibly we'll also have a little bit more user signal on importance of this by that time.

github-actions · 2024-09-30T21:29:11Z

Your site preview for commit 27c92fc is ready! 🎉

http://registry--origin-pr-5444-27c92fc3.s3-website.us-west-2.amazonaws.com/registry.

github-actions · 2024-10-07T17:22:07Z

Site previews for this pull request have been removed. ✨

t0yv0 had a problem deploying to testing September 17, 2024 16:46 — with GitHub Actions Failure

t0yv0 had a problem deploying to testing September 17, 2024 17:11 — with GitHub Actions Failure

t0yv0 temporarily deployed to testing September 17, 2024 18:13 — with GitHub Actions Inactive

t0yv0 requested review from cnunciato and interurban September 17, 2024 18:40

t0yv0 requested review from corymhall and flostadler September 17, 2024 18:42

t0yv0 temporarily deployed to testing September 17, 2024 19:05 — with GitHub Actions Inactive

t0yv0 temporarily deployed to testing September 17, 2024 19:14 — with GitHub Actions Inactive

t0yv0 temporarily deployed to testing September 17, 2024 19:40 — with GitHub Actions Inactive

t0yv0 had a problem deploying to testing September 17, 2024 19:59 — with GitHub Actions Failure

t0yv0 had a problem deploying to testing September 17, 2024 20:03 — with GitHub Actions Failure

t0yv0 temporarily deployed to testing September 18, 2024 02:22 — with GitHub Actions Inactive

flostadler reviewed Sep 18, 2024

View reviewed changes

t0yv0 mentioned this pull request Sep 18, 2024

Consider building tooling to simplify migrating from Bucket to BucketV2 pulumi/pulumi-aws#4470

Open

t0yv0 temporarily deployed to testing September 18, 2024 17:56 — with GitHub Actions Inactive

t0yv0 temporarily deployed to testing September 18, 2024 18:10 — with GitHub Actions Inactive

t0yv0 temporarily deployed to testing September 18, 2024 20:05 — with GitHub Actions Inactive

t0yv0 requested a review from flostadler September 18, 2024 20:07

mjeffryes reviewed Sep 25, 2024

View reviewed changes

themes/default/content/registry/packages/aws/how-to-guides/bucketv2-migration.md Outdated Show resolved Hide resolved

t0yv0 added 20 commits September 30, 2024 16:58

Document migrating aws.s3.Bucket to aws.s3.BucketV2

1d4c647

Fix <Link fragments should be valid>

5ea6ef8

Work around another x-ref build issue

7f998e0

Translate example 1 to yaml

3dfe7ab

Render the first example

5623397

Add chooser for example #2

839b9f1

More choosers

ce8e8d5

Choosers for more examples

5e01712

The rest of the choosers

26f1824

Final chooser

3c7388d

Remove redundant heading

701fead

Use un-numbered lists

eaddc32

PR feedback; add a context session

7eda261

Simplify the grammar

a455da6

Exampe corrections

6ea5ab7

Update migration notes on latest

82e215b

Regenerate choosers

b000b8e

Flip the sections to recommend the data-loss-free option by default

952e353

Grammar and spelling in the intro paragraph

cdb1916

Edited away recommendation to migrate

27c92fc

t0yv0 force-pushed the t0yv0/bucketv2-migration branch from 92056f2 to 27c92fc Compare September 30, 2024 21:04

t0yv0 temporarily deployed to testing September 30, 2024 21:04 — with GitHub Actions Inactive

t0yv0 requested a review from mjeffryes September 30, 2024 21:08

interurban approved these changes Oct 4, 2024

View reviewed changes

t0yv0 merged commit 2c5ca12 into master Oct 7, 2024
3 checks passed

t0yv0 deleted the t0yv0/bucketv2-migration branch October 7, 2024 17:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document migrating aws.s3.Bucket to aws.s3.BucketV2 #5444

Document migrating aws.s3.Bucket to aws.s3.BucketV2 #5444

t0yv0 commented Sep 17, 2024

t0yv0 commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

t0yv0 commented Sep 17, 2024

github-actions bot commented Sep 18, 2024

flostadler Sep 18, 2024

t0yv0 Sep 18, 2024

flostadler Sep 18, 2024

github-actions bot commented Sep 18, 2024

github-actions bot commented Sep 18, 2024

t0yv0 commented Sep 18, 2024

github-actions bot commented Sep 18, 2024

t0yv0 commented Sep 30, 2024

github-actions bot commented Sep 30, 2024

github-actions bot commented Oct 7, 2024

Document migrating aws.s3.Bucket to aws.s3.BucketV2 #5444

Document migrating aws.s3.Bucket to aws.s3.BucketV2 #5444

Conversation

t0yv0 commented Sep 17, 2024

Description

Adding a new package?

t0yv0 commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

t0yv0 commented Sep 17, 2024

github-actions bot commented Sep 18, 2024

flostadler Sep 18, 2024

Choose a reason for hiding this comment

t0yv0 Sep 18, 2024

Choose a reason for hiding this comment

flostadler Sep 18, 2024

Choose a reason for hiding this comment

github-actions bot commented Sep 18, 2024

github-actions bot commented Sep 18, 2024

t0yv0 commented Sep 18, 2024

github-actions bot commented Sep 18, 2024

t0yv0 commented Sep 30, 2024

github-actions bot commented Sep 30, 2024

github-actions bot commented Oct 7, 2024