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

feat(eks): deprecate "kubectlEnabled: false" #9454

Merged
merged 7 commits into from
Aug 6, 2020

Conversation

eladb
Copy link
Contributor

@eladb eladb commented Aug 5, 2020

When specifying kubectlEnabled: false, it implicitly meant that the underlying resource behind the construct would be the stock AWS::EKS::Cluster resource instead of the custom resource used by default. This means that many new capabilities of EKS would not be supported (e.g. Fargate profiles).

Clusters backed by the custom-resource have all the capabilities (and more) of clusters backed by AWS::EKS::Cluster. Therefore, we decided that going forward we are going to support only the custom-resource backed solution.

To that end, after this change, defining an eks.Cluster with kubectlEnabled: false will throw an error with the following message:

The "eks.Cluster" class no longer allows disabling kubectl support.
As a temporary workaround, you can use the drop-in replacement class `eks.LegacyCluster`
but bear in mind that this class will soon be removed and will no longer receive additional
features or bugfixes. See https://github.com/aws/aws-cdk/issues/9332 for more details

Resolves #9332

BREAKING CHANGE: The experimental eks.Cluster construct no longer supports setting kubectlEnabled: false. A temporary drop-in alternative is eks.LegacyCluster, but we have plans to completely remove support for it in an upcoming release since eks.Cluster has matured and should provide all the needed capabilities. Please comment on #9332 if there are use cases that are not supported by eks.Cluster.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

When specifying `kubectlEnabled: false`, it _implicitly_ meant that the underlying resource behind the construct would be the stock `AWS::EKS::Cluster` resource instead of the custom resource used by default. This means that many new capabilities of EKS would not be supported (e.g. Fargate profiles).

Clusters backed by the custom-resource have all the capabilities (and more) of clusters backed by `AWS::EKS::Cluster`. Therefore, we decided that going forward we are going to support only the custom-resource backed solution.

To that end, after this change, defining an `eks.Cluster` with `kubectlEnabled: false` will throw an error with the following message:

    The "eks.Cluster" class no longer allows disabling kubectl support.
    As a temporary workaround, you can use the drop-in replacement class `eks.LegacyCluster`
    but bear in mind that this class will soon be removed and will no longer receive additional
    features or bugfixes. See #9332 for more details

Resolves #9332

BREAKING CHANGE: The experimental `eks.Cluster` construct no longer supports setting `kubectlEnabled: false`. A temporary drop-in alternative is `eks.LegacyCluster`, but we have plans to completely remove support for it in an upcoming release since `eks.Cluster` has matured and should provide all the needed capabilities. Please comment on #9332 if there are use cases that are not supported by `eks.Cluster`.
@eladb eladb requested a review from iliapolo August 5, 2020 12:24
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Aug 5, 2020
Copy link
Contributor

@iliapolo iliapolo left a comment

Choose a reason for hiding this comment

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

@eladb Not critical, but can we also remove the ClusterResource indirection layer now? Seems redundant.

@eladb
Copy link
Contributor Author

eladb commented Aug 5, 2020

@eladb Not critical, but can we also remove the ClusterResource indirection layer now? Seems redundant.

I think its a pretty useful way to encapsulate the custom resource. I rather keep it.

@eladb eladb requested a review from iliapolo August 5, 2020 14:51
@SomayaB SomayaB added the pr/breaking-change This PR is a breaking change. It needs to be modified to be allowed in the current major version. label Aug 5, 2020
@eladb eladb marked this pull request as ready for review August 6, 2020 05:04
Copy link
Contributor

@iliapolo iliapolo left a comment

Choose a reason for hiding this comment

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

Very cool. Just some minor stuff.

Also, this can be removed as well:

* This feature is only available for kubectl enabled clusters, i.e `kubectlEnabled: true`.

packages/@aws-cdk/aws-eks/lib/managed-nodegroup.ts Outdated Show resolved Hide resolved
packages/@aws-cdk/aws-eks/test/test.cluster.ts Outdated Show resolved Hide resolved
@eladb eladb requested a review from iliapolo August 6, 2020 10:27
Copy link
Contributor

@iliapolo iliapolo left a comment

Choose a reason for hiding this comment

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

@eladb
Copy link
Contributor Author

eladb commented Aug 6, 2020

@eladb What about this? https://github.com/aws/aws-cdk/blob/benisrae/eks-deprecate-kubectl-disabled/packages/@aws-cdk/aws-eks/lib/cluster.ts#L224

Removed the comment - this Options interface is only used for eks.Cluster so it is technically impossible to specify this option for LegacyCluster

@iliapolo
Copy link
Contributor

iliapolo commented Aug 6, 2020

@eladb What about this? https://github.com/aws/aws-cdk/blob/benisrae/eks-deprecate-kubectl-disabled/packages/@aws-cdk/aws-eks/lib/cluster.ts#L224

Removed the comment - this Options interface is only used for eks.Cluster so it is technically impossible to specify this option for LegacyCluster

Yeah i just meant the comment 👍

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: 55bd7b4
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify
Copy link
Contributor

mergify bot commented Aug 6, 2020

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 2791017 into master Aug 6, 2020
@mergify mergify bot deleted the benisrae/eks-deprecate-kubectl-disabled branch August 6, 2020 12:03
eladb pushed a commit that referenced this pull request Aug 10, 2020
When specifying `kubectlEnabled: false`, it _implicitly_ meant that the underlying resource behind the construct would be the stock `AWS::EKS::Cluster` resource instead of the custom resource used by default. This means that many new capabilities of EKS would not be supported (e.g. Fargate profiles).

Clusters backed by the custom-resource have all the capabilities (and more) of clusters backed by `AWS::EKS::Cluster`. Therefore, we decided that going forward we are going to support only the custom-resource backed solution.

To that end, after this change, defining an `eks.Cluster` with `kubectlEnabled: false` will throw an error with the following message:

    The "eks.Cluster" class no longer allows disabling kubectl support.
    As a temporary workaround, you can use the drop-in replacement class `eks.LegacyCluster`
    but bear in mind that this class will soon be removed and will no longer receive additional
    features or bugfixes. See #9332 for more details

Resolves #9332

BREAKING CHANGE: The experimental `eks.Cluster` construct no longer supports setting `kubectlEnabled: false`. A temporary drop-in alternative is `eks.LegacyCluster`, but we have plans to completely remove support for it in an upcoming release since `eks.Cluster` has matured and should provide all the needed capabilities. Please comment on #9332 if there are use cases that are not supported by `eks.Cluster`.


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. pr/breaking-change This PR is a breaking change. It needs to be modified to be allowed in the current major version.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[aws-eks] Remove support for non-kubectlEnabled clusters
4 participants