From 398866e77386259f698664a29e6bac3a40ba3603 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gon=C3=A7alo=20Montalv=C3=A3o=20Marques?= <9379664+gonmmarques@users.noreply.github.com> Date: Sat, 21 Oct 2023 12:47:22 +0100 Subject: [PATCH] docs: Fix some typos and broken links --- CONTRIBUTING.md | 10 +++++----- content/cluster-autoscaling/index.md | 6 +++--- content/reliability/docs/dataplane.md | 2 +- content/security/docs/network.md | 4 ++-- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a0065ab6f..5bbb9110c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,14 +33,14 @@ To contribute, send us a pull request. For small changes, such as fixing a typo Before you send us a pull request, please be sure that: 1. You're working from the latest source on the **master** branch. -2. You check [existing open](https://github.com/awsdocs/aws-eks-best-practices/pulls), and [recently closed](https://github.com/awsdocs/aws-eks-best-practices/pulls?q=is%3Apr+is%3Aclosed), pull requests to be sure that someone else hasn't already addressed the problem. -3. You [create an issue](https://github.com/awsdocs/aws-eks-best-practices/issues/new) before working on a contribution that will take a significant amount of your time. +2. You check [existing open](https://github.com/aws/aws-eks-best-practices/pulls), and [recently closed](https://github.com/aws/aws-eks-best-practices/pulls?q=is%3Apr+is%3Aclosed), pull requests to be sure that someone else hasn't already addressed the problem. +3. You [create an issue](https://github.com/aws/aws-eks-best-practices/issues/new) before working on a contribution that will take a significant amount of your time. -For contributions that will take a significant amount of time, [open a new issue](https://github.com/awsdocs/aws-eks-best-practices/issues/new) to pitch your idea before you get started. Explain the problem and describe the content you want to see added to the documentation. Let us know if you'll write it yourself or if you'd like us to help. We'll discuss your proposal with you and let you know whether we're likely to accept it. We don't want you to spend a lot of time on a contribution that might be outside the scope of the documentation or that's already in the works. +For contributions that will take a significant amount of time, [open a new issue](https://github.com/aws/aws-eks-best-practices/issues/new) to pitch your idea before you get started. Explain the problem and describe the content you want to see added to the documentation. Let us know if you'll write it yourself or if you'd like us to help. We'll discuss your proposal with you and let you know whether we're likely to accept it. We don't want you to spend a lot of time on a contribution that might be outside the scope of the documentation or that's already in the works. ## Finding contributions to work on -If you'd like to contribute, but don't have a project in mind, look at the [open issues](https://github.com/awsdocs/aws-eks-best-practices/issues) in this repository for some ideas. Any issues with the [help wanted](https://github.com/awsdocs/aws-eks-best-practices/labels/help%20wanted) or [enhancement](https://github.com/awsdocs/aws-eks-best-practices/labels/enhancement) labels are a great place to start. +If you'd like to contribute, but don't have a project in mind, look at the [open issues](https://github.com/aws/aws-eks-best-practices/issues) in this repository for some ideas. Any issues with the [help wanted](https://github.com/aws/aws-eks-best-practices/labels/help%20wanted) or [enhancement](https://github.com/aws/aws-eks-best-practices/labels/enhancement) labels are a great place to start. In addition to written content, we really appreciate new examples and code samples for our documentation, such as examples for different platforms or environments, and code samples in additional languages. @@ -54,4 +54,4 @@ If you discover a potential security issue, please notify AWS Security via our [ ## Licensing -See the [LICENSE](https://github.com/awsdocs/aws-eks-best-practices/blob/master/LICENSE) file for this project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. +See the [LICENSE](https://github.com/aws/aws-eks-best-practices/blob/master/LICENSE) file for this project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. diff --git a/content/cluster-autoscaling/index.md b/content/cluster-autoscaling/index.md index 23fa7c142..fa94064a0 100644 --- a/content/cluster-autoscaling/index.md +++ b/content/cluster-autoscaling/index.md @@ -39,9 +39,9 @@ Ensure that: ### Employ least privileged access to the IAM role -When the [Auto Discovery](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/aws/README.md#Auto-discovery-setup) is used, we strongly recommend that you employ least privelege access by limiting Actions `autoscaling:SetDesiredCapacity` and `autoscaling:TerminateInstanceInAutoScalingGroup` to the Auto Scaling groups that are scoped to the current cluster. +When the [Auto Discovery](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/aws/README.md#Auto-discovery-setup) is used, we strongly recommend that you employ least privilege access by limiting Actions `autoscaling:SetDesiredCapacity` and `autoscaling:TerminateInstanceInAutoScalingGroup` to the Auto Scaling groups that are scoped to the current cluster. -This will prevents a Cluster Autoscaler running in one cluster from modifying nodegroups in a different cluster even if the `--node-group-auto-discovery` argument wasnt scoped down to the nodegroups of the cluster using tags (for example `k8s.io/cluster-autoscaler/`). +This will prevents a Cluster Autoscaler running in one cluster from modifying nodegroups in a different cluster even if the `--node-group-auto-discovery` argument wasn't scoped down to the nodegroups of the cluster using tags (for example `k8s.io/cluster-autoscaler/`). ```json { @@ -265,7 +265,7 @@ Value: NoSchedule ## Additional Parameters There are many configuration options that can be used to tune the behavior and performance of the Cluster Autoscaler. -A complete list of parameters is available on [Github](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-the-parameters-to-ca). +A complete list of parameters is available on [GitHub](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-the-parameters-to-ca). | | | | |-|-|-| diff --git a/content/reliability/docs/dataplane.md b/content/reliability/docs/dataplane.md index 32ee8cb28..763764e59 100644 --- a/content/reliability/docs/dataplane.md +++ b/content/reliability/docs/dataplane.md @@ -6,7 +6,7 @@ You have two choices for worker nodes with EKS: [EC2 instances](https://docs.aws EKS on Fargate offers the easiest path to a resilient data plane. Fargate runs each Pod in an isolated compute environment. Each Pod running on Fargate gets its own worker node. Fargate automatically scales the data plane as Kubernetes scales pods. You can scale both the data plane and your workload by using the [horizontal pod autoscaler](https://docs.aws.amazon.com/eks/latest/userguide/horizontal-pod-autoscaler.html). -The preferred way to scale EC2 worker nodes is by using [Kubernetes Cluster Autoscaler](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/aws/README.md), [EC2 Auto Scaling groups](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html) or community projects like [Atlassian’s Esclator](https://github.com/atlassian/escalator). +The preferred way to scale EC2 worker nodes is by using [Kubernetes Cluster Autoscaler](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/aws/README.md), [EC2 Auto Scaling groups](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html) or community projects like [Atlassian’s Escalator](https://github.com/atlassian/escalator). ## Recommendations diff --git a/content/security/docs/network.md b/content/security/docs/network.md index 2c3811bf3..09ebe8a91 100644 --- a/content/security/docs/network.md +++ b/content/security/docs/network.md @@ -261,7 +261,7 @@ To assist in your migration process, we have developed a tool called [K8s Networ !!! Important Migration tool will only convert 3P policies that are compatible with native kubernetes network policy api. If you are using advanced network policy features offered by 3P plugins, Migration tool will skip and report them. -Please note that migration tool is currently not supported by AWS VPC CNI Network policy engineering team, it is made available to customers on a best-effort basis. We encourage you to utilize this tool to facilitate your migration process. In the event that you encounter any issues or bugs with the tool, we kindly ask you create a [Github issue](https://github.com/awslabs/k8s-network-policy-migrator/issues). Your feedback is invaluable to us and will assist in the continuous improvement of our services. +Please note that migration tool is currently not supported by AWS VPC CNI Network policy engineering team, it is made available to customers on a best-effort basis. We encourage you to utilize this tool to facilitate your migration process. In the event that you encounter any issues or bugs with the tool, we kindly ask you create a [GitHub issue](https://github.com/awslabs/k8s-network-policy-migrator/issues). Your feedback is invaluable to us and will assist in the continuous improvement of our services. ### Additional Resources + [Kubernetes & Tigera: Network Policies, Security, and Audit](https://youtu.be/lEY2WnRHYpg) @@ -523,7 +523,7 @@ kubectl apply -f istio-custom-config.yaml #### Additional Resources + [How to implement cert-manager and the ACM Private CA plugin to enable TLS in EKS](https://aws.amazon.com/blogs/security/tls-enabled-kubernetes-clusters-with-acm-private-ca-and-amazon-eks-2/). + [Setting up end-to-end TLS encryption on Amazon EKS with the new AWS Load Balancer Controller and ACM Private CA](https://aws.amazon.com/blogs/containers/setting-up-end-to-end-tls-encryption-on-amazon-eks-with-the-new-aws-load-balancer-controller/). -+ [Private CA Kubernetes cert-manager plugin on Github](https://github.com/cert-manager/aws-privateca-issuer). ++ [Private CA Kubernetes cert-manager plugin on GitHub](https://github.com/cert-manager/aws-privateca-issuer). + [Private CA Kubernetes cert-manager plugin user guide](https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaKubernetes.html). + [How to use AWS Private Certificate Authority short-lived certificate mode](https://aws.amazon.com/blogs/security/how-to-use-aws-private-certificate-authority-short-lived-certificate-mode)