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 migration guide for EKS v3 #1400

Merged
merged 5 commits into from
Sep 30, 2024
Merged

Conversation

flostadler
Copy link
Contributor

This change adds the migration guide for EKS v3. We'll also publish this to the docs as part of Relates to https://github.com/pulumi/home/issues/3626, but by having it in the repo we can already send it to alpha users.

Relates to https://github.com/pulumi/home/issues/3626

@flostadler flostadler self-assigned this Sep 26, 2024
Copy link

Does the PR have any schema changes?

Looking good! No breaking changes found.
No new resources/functions.

@flostadler
Copy link
Contributor Author

flostadler commented Sep 26, 2024

@t0yv0 @corymhall @mjeffryes I created this first version of the migration guide: #1400. So we can start sending it out to potential alpha testers. Please have a look and let me know if there's anything missing/needs changing.

docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
Copy link
Member

@t0yv0 t0yv0 left a comment

Choose a reason for hiding this comment

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

LGTM

@t0yv0
Copy link
Member

t0yv0 commented Sep 27, 2024

@blampe @jkodroff @rquitales @EronWright if you have a moment, appreciate taking a quick look.

Copy link
Member

@rquitales rquitales left a comment

Choose a reason for hiding this comment

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

Some minor feedback on wording etc, but overall looks great!

docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
docs/eks-v3-migration.md Outdated Show resolved Hide resolved
@t0yv0
Copy link
Member

t0yv0 commented Sep 27, 2024

https://github.com/pulumi/pulumi-eks/actions/runs/11061627119 we might just have succeeded in publishing the alpha for all languages. I'll test lightly tomorrow.

@flostadler
Copy link
Contributor Author

@t0yv0 @rquitales thanks a lot for your feedback! I've addressed your comments, please have another look

@t0yv0
Copy link
Member

t0yv0 commented Sep 27, 2024

Looking good, thank you!


## Nodejs SDK breaking changes

The Node SDK is updated to use state of the art Pulumi tooling, improving stability, documentation and security. The update requires the following changes to programs:
Copy link
Member

Choose a reason for hiding this comment

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

nit: consistency

Suggested change
The Node SDK is updated to use state of the art Pulumi tooling, improving stability, documentation and security. The update requires the following changes to programs:
The Nodejs SDK is updated to use state of the art Pulumi tooling, improving stability, documentation and security. The update requires the following changes to programs:

- **`RECOMMENDED` Default Setting**: By default, the `RECOMMENDED` option will be used, which ensures your nodes are always running the OS recommended by AWS for optimal security and performance. This default setting will be kept in sync with AWS’s updates.


- **EKS Cluster Addon Management: `vpc-cni` and `coredns`**
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we also mention kube-proxy?

Also, I think we need to add something about cases where users are already managing these with addons. They will have to explicitly disable the creation of these in the cluster.

We currently recommend users create all new clusters with the `API` authentication mode.
More details about this can be found [here](https://docs.aws.amazon.com/eks/latest/userguide/grant-k8s-access.html).

## Nodejs SDK breaking changes
Copy link
Contributor

Choose a reason for hiding this comment

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

Another one is that if you use the createManagedNodeGroup overlay you will see a couple of additional component resource wrappers created

 + eks:index:ManagedNodeGroup: (create)
        [urn=urn:pulumi:dev::example-managed-nodegroups::eks:index:ManagedNodeGroup::example-managed-ng4]
    + eks:index:ManagedNodeGroup: (create)
        [urn=urn:pulumi:dev::example-managed-nodegroups::eks:index:ManagedNodeGroup::example-managed-ng1]
    + eks:index:ManagedNodeGroup: (create)
        [urn=urn:pulumi:dev::example-managed-nodegroups::eks:index:ManagedNodeGroup::example-managed-ng3]
    + eks:index:ManagedNodeGroup: (create)
        [urn=urn:pulumi:dev::example-managed-nodegroups::eks:index:ManagedNodeGroup::example-managed-ng0]
    + eks:index:ManagedNodeGroup: (create)
        [urn=urn:pulumi:dev::example-managed-nodegroups::eks:index:ManagedNodeGroup::example-managed-ng2]

@flostadler flostadler merged commit 3fa365a into release-3.x.x Sep 30, 2024
10 of 11 checks passed
@flostadler flostadler deleted the flostadler/v3-migration-guide branch September 30, 2024 16:06

## VPC CNI Component changes

The VPC CNI cluster component is now configured as an EKS addon as mentioned in the “New Features” section above. This brings the following changes:
Copy link
Member

Choose a reason for hiding this comment

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

Should it also mention this diff?

+      ├─ eks:index:VpcCniAddon        cluster-vpc-cni                  create     
+      │  └─ aws:eks:Addon             cluster-vpc-cni                  create     
-      ├─ eks:index:VpcCni             cluster-vpc-cni                  delete

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I can add a sentence about this!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

- Removed `enableIpv6` input property. The component automatically configures the IP version now depending on whether the cluster is running in IPv4 or IPv6 mode.
- Removed `image`, `initImage`, `nodeAgentImage` input properties. The component now automatically selects an image registry in the cluster’s region to pull the images from.

## Node Group Updates
Copy link
Member

Choose a reason for hiding this comment

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

Should we mention this change somewhere

-      ├─ aws:cloudformation:Stack     cluster-nodes                    delete

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The effect this will have is described in the NodeGroup component deprecation section. (i.e. Updates to the default node group will be done by first creating the new replacement nodes and then shutting down the old ones which will move pods to the new nodes.)

flostadler added a commit that referenced this pull request Oct 17, 2024
This change adds the migration guide for EKS v3. We'll also publish this
to the docs as part of Relates to
pulumi/home#3626, but by having it in the repo
we can already send it to alpha users.

Relates to pulumi/home#3626
flostadler added a commit that referenced this pull request Oct 17, 2024
This change adds the migration guide for EKS v3. We'll also publish this
to the docs as part of Relates to
pulumi/home#3626, but by having it in the repo
we can already send it to alpha users.

Relates to pulumi/home#3626
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