AWS eks documentation change
Summary
Updated documentation with placeholder syntax changes (angle brackets), modified CoreDNS deployment command from annotation removal to rollout restart, and standardized variable substitution formatting
Security assessment
Changes involve documentation formatting and command syntax updates without any explicit security context. The CoreDNS command change improves operational practices but doesn't address vulnerabilities.
Diff
diff --git a/eks/latest/userguide/fargate-getting-started.md b/eks/latest/userguide/fargate-getting-started.md index 7bdc7752a..d04c35f9f 100644 --- a//eks/latest/userguide/fargate-getting-started.md +++ b//eks/latest/userguide/fargate-getting-started.md @@ -29 +29 @@ For existing node groups that were created with `eksctl` or the Amazon EKS manag -You can check for a security group for your cluster in the AWS Management Console under the **Networking** section for the cluster. Or, you can do this using the following AWS CLI command. When using this command, replace `my-cluster` with the name of your cluster. +You can check for a security group for your cluster in the AWS Management Console under the **Networking** section for the cluster. Or, you can do this using the following AWS CLI command. When using this command, replace `<my-cluster>` with the name of your cluster. @@ -32 +32 @@ You can check for a security group for your cluster in the AWS Management Consol - aws eks describe-cluster --name my-cluster --query cluster.resourcesVpcConfig.clusterSecurityGroupId + aws eks describe-cluster --name <my-cluster> --query cluster.resourcesVpcConfig.clusterSecurityGroupId @@ -70 +70 @@ For instructions on how to install or upgrade `eksctl`, see [Installation](https -Create your Fargate profile with the following `eksctl` command, replacing every `example value` with your own values. You’re required to specify a namespace. However, the `--labels` option isn’t required. +Create your Fargate profile with the following `eksctl` command, replacing every `<example value>` with your own values. You’re required to specify a namespace. However, the `--labels` option isn’t required. @@ -74,4 +74,4 @@ Create your Fargate profile with the following `eksctl` command, replacing every - --cluster my-cluster \ - --name my-fargate-profile \ - --namespace my-kubernetes-namespace \ - --labels key=value + --cluster <my-cluster> \ + --name <my-fargate-profile> \ + --namespace <my-kubernetes-namespace> \ + --labels <key=value> @@ -79 +79 @@ Create your Fargate profile with the following `eksctl` command, replacing every -You can use certain wildcards for `my-kubernetes-namespace` and `key=value` labels. For more information, see [Fargate profile wildcards](./fargate-profile.html#fargate-profile-wildcards). +You can use certain wildcards for `<my-kubernetes-namespace>` and `<key=value>` labels. For more information, see [Fargate profile wildcards](./fargate-profile.html#fargate-profile-wildcards). @@ -138 +138 @@ If you created your cluster with `eksctl` using the `--fargate` option, then you - 1. Create a Fargate profile for CoreDNS with the following command. Replace `my-cluster` with your cluster name, `111122223333` with your account ID, `AmazonEKSFargatePodExecutionRole` with the name of your Pod execution role, and `0000000000000001`, `0000000000000002`, and `0000000000000003` with the IDs of your private subnets. If you don’t have a Pod execution role, you must create one first (see Step 2: Create a Fargate Pod execution role). + 1. Create a Fargate profile for CoreDNS with the following command. Replace `<my-cluster>` with your cluster name, `<111122223333>` with your account ID, `<AmazonEKSFargatePodExecutionRole>` with the name of your Pod execution role, and `<000000000000000a>`, `<000000000000000b>`, and `<000000000000000c>` with the IDs of your private subnets. If you don’t have a Pod execution role, you must create one first (see Step 2: Create a Fargate Pod execution role). @@ -142 +142 @@ If you created your cluster with `eksctl` using the `--fargate` option, then you -The role ARN can’t include a [path](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) other than `/`. For example, if the name of your role is `development/apps/my-role`, you need to change it to `my-role` when specifying the ARN for the role. The format of the role ARN must be ` arn:aws:iam::111122223333:role/role-name`. +The role ARN can’t include a [path](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) other than `/`. For example, if the name of your role is `development/apps/AmazonEKSFargatePodExecutionRole`, you need to change it to `AmazonEKSFargatePodExecutionRole` when specifying the ARN for the role. The format of the role ARN must be ` arn:aws:iam::<111122223333>:role/<AmazonEKSFargatePodExecutionRole>`. @@ -146,2 +146,2 @@ The role ARN can’t include a [path](https://docs.aws.amazon.com/IAM/latest/Use - --cluster-name my-cluster \ - --pod-execution-role-arn arn:aws:iam::111122223333:role/AmazonEKSFargatePodExecutionRole \ + --cluster-name <my-cluster> \ + --pod-execution-role-arn arn:aws:iam::<111122223333>:role/<AmazonEKSFargatePodExecutionRole> \ @@ -149 +149 @@ The role ARN can’t include a [path](https://docs.aws.amazon.com/IAM/latest/Use - --subnets subnet-0000000000000001 subnet-0000000000000002 subnet-0000000000000003 + --subnets subnet-<000000000000000a> subnet-<000000000000000b> subnet-<000000000000000c> @@ -151 +151 @@ The role ARN can’t include a [path](https://docs.aws.amazon.com/IAM/latest/Use - 2. Run the following command to remove the `eks.amazonaws.com/compute-type : ec2` annotation from the CoreDNS Pods. + 2. Trigger a rollout of the `coredns` deployment. @@ -153,4 +153 @@ The role ARN can’t include a [path](https://docs.aws.amazon.com/IAM/latest/Use - kubectl patch deployment coredns \ - -n kube-system \ - --type json \ - -p='[{"op": "remove", "path": "/spec/template/metadata/annotations/eks.amazonaws.com~1compute-type"}]' + kubectl rollout restart -n kube-system deployment coredns @@ -167 +164 @@ The role ARN can’t include a [path](https://docs.aws.amazon.com/IAM/latest/Use - 2. Delete and re-create any existing Pods so that they’re scheduled on Fargate. For example, the following command triggers a rollout of the `coredns` deployment. You can modify the namespace and deployment type to update your specific Pods. + 2. Delete and re-create any existing Pods so that they’re scheduled on Fargate. Modify the `<namespace>` and `<deployment-type>` to update your specific Pods. @@ -169 +166 @@ The role ARN can’t include a [path](https://docs.aws.amazon.com/IAM/latest/Use - kubectl rollout restart -n kube-system deployment coredns + kubectl rollout restart -n <namespace> deployment <deployment-type>