Copying some notes from the first PR about what we'd like for this:
As part of the setup-related documentation, we think the mention and link should be in QUICKSTART.md rather than README.md. (“QUICKSTART” sometimes means that there’s only a single recommended install path, but for now it’s our only setup guide. We’ll likely have an additional in-depth guide describing all options in the future and reconsider our file naming then.)
We’d like to refer to the support as “preliminary” until more testing has been done and the CDK supports more of Bottlerocket’s features.
We’d like to clarify how to specify additional user data, and any caveats that may apply to the process. Currently, the CDK is including a pre-rendered snippet of user data for the mandatory Kubernetes settings. Since you can’t specify duplicate keys in TOML, we’d like to make clear the limitations around what you can specify and how to do so. Two use case examples are setting Kubernetes labels and taints, and setting non-Kubernetes settings like those regarding host-containers.
I think it could fit as a new section at the end of QUICKSTART while in this preliminary phase.
What I'd like:
AWS CDK v1.33.0 introduces Bottlerocket support for Amazon EKS and dramatically simplifies the setup by just adding one property.
Let's add a link in the README to the AWS CDK document to help people onboard bottlerocket with AWS CDK.
https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/aws-eks#bottlerocket