Skip to content

Commit 7fb091a

Browse files
committed
chore: additional docs on common issues
1 parent aefa549 commit 7fb091a

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

docs/network_connectivity.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# Network Connectivity
22

3-
### Security Groups
3+
## Cluster Endpoint
4+
5+
### Public Endpoint w/ Restricted CIDRs
6+
7+
When restricting the clusters public endpoint to only the CIDRs specified by users, it is recommended that you also enable the private endpoint, or ensure that the CIDR blocks that you specify include the addresses that nodes and Fargate pods (if you use them) access the public endpoint from.
8+
9+
Please refer to the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) for further information
10+
11+
## Security Groups
412

513
- Cluster Security Group
614
- This module by default creates a cluster security group ("additional" security group when viewed from the console) in addition to the default security group created by the AWS EKS service. This "additional" security group allows users to customize inbound and outbound rules via the module as they see fit

docs/user_data.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,25 @@ When using an EKS managed node group, users have 2 primary routes for interactin
4848
| ℹ️ When using bottlerocket as the desired platform, since the user data for bottlerocket is TOML, all configurations are merged in the one file supplied as user data. Therefore, `pre_bootstrap_user_data` and `post_bootstrap_user_data` are not valid since the bottlerocket OS handles when various settings are applied. If you wish to supply additional configuration settings when using bottlerocket, supply them via the `bootstrap_extra_args` variable. For the linux platform, `bootstrap_extra_args` are settings that will be supplied to the [AWS EKS Optimized AMI bootstrap script](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh#L14) such as kubelet extra args, etc. See the [bottlerocket GitHub repository documentation](https://github.com/bottlerocket-os/bottlerocket#description-of-settings) for more details on what settings can be supplied via the `bootstrap_extra_args` variable. |
4949
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5050
51+
#### ⚠️ Caveat
52+
53+
Since the EKS Managed Node Group service provides the necessary bootstrap user data to nodes (unless an `ami_id` is provided), users do not have direct access to settings/variables provided by the EKS optimized AMI [`bootstrap.sh` script](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh). Currently, users must employ work-arounds to influence the `bootstrap.sh` script. For example, to enable `containerd` on EKS Managed Node Groups, users can supply the following user data. You can learn more about this issue [here](https://github.com/awslabs/amazon-eks-ami/issues/844):
54+
55+
```hcl
56+
# See issue https://github.com/awslabs/amazon-eks-ami/issues/844
57+
pre_bootstrap_user_data = <<-EOT
58+
#!/bin/bash
59+
set -ex
60+
cat <<-EOF > /etc/profile.d/bootstrap.sh
61+
export CONTAINER_RUNTIME="containerd"
62+
export USE_MAX_PODS=false
63+
export KUBELET_EXTRA_ARGS="--max-pods=110"
64+
EOF
65+
# Source extra environment variables in bootstrap script
66+
sed -i '/^set -o errexit/a\\nsource /etc/profile.d/bootstrap.sh' /etc/eks/bootstrap.sh
67+
EOT
68+
```
69+
5170
### Self Managed Node Group
5271

5372
Self managed node groups require users to provide the necessary bootstrap user data. Users can elect to use the user data template provided by the module for their platform/OS or provide their own user data template for rendering by the module.

0 commit comments

Comments
 (0)