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): support AccessConfig for the Cluster construct #30016

Open
wants to merge 47 commits into
base: main
Choose a base branch
from

Conversation

pahud
Copy link
Contributor

@pahud pahud commented Apr 30, 2024

Background

Amazon EKS originally uses ConfigMap as its access management and in aws-eks we use AwsAuth to leverage the kubectl from kubectl-lambda-layer to create the AwsAuth configmap for that. The ConfigMap has been very difficult to maintain due to its lack support of EKS API but thanks to the AwsAuth class, it's been very smooth in CDK.

In AWS reInvent 2023 we announced the access API support that simplifies the management as a replacement of the traditional ConfigMap. In CloudFormation we have the AccessConfig with AuthenticationMode and BootstrapClusterCreatorAdminPermissions now.

The AuthenticationMode supports API_AND_CONFIG_MAP, which is the default, API and CONFIG_MAP. It allows users to switch the mode on cluster creation or update. When the mode has API support, users have to define the AccessEntry to map the access policies and the IAM principals. This PR introduces the AccessEntry and AccessPolicy classes for that to simplify it with similar experience just as the iam.ManagedPolicy class. This PR also introduces the grantAccess() method that allows a cluster to grant its access to a specific principal and abstracts away the complexity.

Overview of the API experience from this PR:

const cluster = new eks.Cluster(this, 'Cluster', {
  vpc,
  mastersRole: clusterAdminRole,
  version: eks.KubernetesVersion.V1_29,
  kubectlLayer: new KubectlV29Layer(this, 'KubectlLayer'),
  authenticationMode: eks.AuthenticationMode.API_AND_CONFIG_MAP,
});

// Cluster Admin role for this cluster
cluster.grantAccess('clusterAdminAccess', clusterAdminRole.roleArn, [
  eks.AccessPolicy.fromAccessPolicyName('AmazonEKSClusterAdminPolicy', {
    accessScopeType: eks.AccessScopeType.CLUSTER,
  }),
]);

// EKS Admin role for specified namespaces of thie cluster
cluster.grantAccess('eksAdminRoleAccess', eksAdminRole.roleArn, [
  eks.AccessPolicy.fromAccessPolicyName('AmazonEKSAdminPolicy', {
    accessScopeType: eks.AccessScopeType.NAMESPACE,
    namespaces: ['foo', 'bar'],
  }),
]);

// EKS Admin Viewer role for specified namespaces of thie cluster
cluster.grantAccess('eksAdminViewRoleAccess', eksAdminViewRole.roleArn, [
  eks.AccessPolicy.fromAccessPolicyName('AmazonEKSAdminViewPolicy', {
    accessScopeType: eks.AccessScopeType.NAMESPACE,
    namespaces: ['foo', 'bar'],
  }),
]);

Issue # (if applicable)

Closes #28588

This PR introduces the authenticationMode, AccessEntry and AccessPolicy for both Cluster and FargateCluster construct.

  • bump @aws-sdk/client-eks to v3.476.0(the minimal version with EKS Cluster Access Management support)
  • make sure it deploys with the new AccessConfig support for a new cluster
  • make sure an existing cluster can update by adding this new prop
  • make sure it deploys with a new FargateCluster
  • make sure an existing FargateCluster can update by adding this new prop
  • make sure it works with CfnAccessEntry L1 resources
  • AccessEntry L2 construct support
  • AccessPolicy class
  • bootstrapClusterCreatorAdminPermissions
  • unit tests
  • integ tests
  • update README
  • add PR notes

Notes

  1. Switching authentication modes on an existing cluster is a one-way operation like:

undefined(CONFIG_MAP) -> API_AND_CONFIG_MAP -> API

You can switch from undefined or CONFIG_MAP to API_AND_CONFIG_MAP. You can then switch from API_AND_CONFIG_MAP to API. You cannot revert these operations in the opposite direction. Meaning you cannot switch back to CONFIG_MAP or API_AND_CONFIG_MAP from API. And you cannot switch back to CONFIG_MAP from API_AND_CONFIG_MAP. (see here) This PR adds relevant checks in the custom resource and add docstring in the authenticationMode prop.

  1. Switching bootstrapClusterCreatorAdminPermissions would cause cluster replacement, we callout in the README and construct prop docstring as a headsup. This option is available in CFN which triggers replacement on resource update as well. I have created eks: ack prop for potential cluster replacement #30107 for further improvement.

Reason for this change

Description of changes

Description of how you validated changes

Checklist


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

@github-actions github-actions bot added the p2 label Apr 30, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team April 30, 2024 20:50
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Apr 30, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@pahud pahud added p1 @aws-cdk/aws-eks Related to Amazon Elastic Kubernetes Service and removed p2 labels Apr 30, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review May 6, 2024 16:18

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

Co-authored-by: GZ <hz351086153@gmail.com>
@richardgroves
Copy link

@pahud is there anything that can be done to encourage getting this merged in? We really need it in our project to be able to setup eks clusters properly in one phase.

@pahud
Copy link
Contributor Author

pahud commented Jun 5, 2024

@pahud is there anything that can be done to encourage getting this merged in? We really need it in our project to be able to setup eks clusters properly in one phase.

Thank you @richardgroves I appreciate your concern. I will make another iteration this week and get the CDK team and EKS team review again. Hopefully to clarify some details and move it forward.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 480bf4a
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-eks Related to Amazon Elastic Kubernetes Service contribution/core This is a PR that came from AWS. p1 pr/needs-maintainer-review This PR needs a review from a Core Team Member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws_eks: Support AccessConfig on aws_eks.Cluster
7 participants