From 8e28d16eb81bbd9826ea0ec3a8015afbad6b027e Mon Sep 17 00:00:00 2001 From: Naris Silpakit Date: Thu, 13 Jan 2022 18:09:57 -0800 Subject: [PATCH] fix broken links in documentation; update supported k8s addons list in add-ons/index.md --- docs/add-ons/aws-for-fluent-bit.md | 2 +- docs/add-ons/index.md | 35 +++++++++++++++++------------- docs/node-groups.md | 2 +- mkdocs.yml | 2 +- 4 files changed, 23 insertions(+), 18 deletions(-) diff --git a/docs/add-ons/aws-for-fluent-bit.md b/docs/add-ons/aws-for-fluent-bit.md index 570e5dbc2f..1d7c763aa5 100644 --- a/docs/add-ons/aws-for-fluent-bit.md +++ b/docs/add-ons/aws-for-fluent-bit.md @@ -8,7 +8,7 @@ AWS provides a Fluent Bit image with plugins for both CloudWatch Logs and Kinesi ### Usage -[aws-for-fluent-bit](https://github.com/aws-samples/aws-eks-accelerator-for-terraform/modules/kubernetes-addons/aws-for-fluent-bit/README.md) can be deployed by enabling the add-on via the following. +[aws-for-fluent-bit](https://github.com/aws-samples/aws-eks-accelerator-for-terraform/tree/main/modules/kubernetes-addons/aws-for-fluentbit) can be deployed by enabling the add-on via the following. ```hcl enable_aws_for_fluentbit = true diff --git a/docs/add-ons/index.md b/docs/add-ons/index.md index a7ab979e9a..587897f98c 100644 --- a/docs/add-ons/index.md +++ b/docs/add-ons/index.md @@ -1,25 +1,30 @@ # Kubernetes Addons Module -The [`kubernetes-addons`](../../modules/kubernetes-addons) module within this framework allows you to configure the add-ons you would like deployed into you EKS cluster with simple **true/false** flags. +The [`kubernetes-addons`](https://github.com/aws-samples/aws-eks-accelerator-for-terraform/tree/main/modules/kubernetes-addons) module within this framework allows you to configure the add-ons you would like deployed into you EKS cluster with simple **true/false** flags. The framework currently provides support for the following add-ons: | Add-on | Description | |-----------|----------------- -| [Agones](./agones) | Deploys Agones into an EKS cluster. | -| [ArgoCD](./argocd) | Deploys ArgoCD into an EKS cluster. | -| [AWS for Fluent Bit](./aws-for-fluent-bit) | Deploys Fluent Bit into an EKS cluster. | -| [AWS Load Balancer Controller](./fargate-fluent-bit) | Deploys the AWS Load Balancer Controller into an EKS cluster. | -| [AWS Distro for Open Telemetry](./aws-open-telemetry) | Deploys the AWS Open Telemetry Collector into an EKS cluster. | -| [cert-manager](./cert-manager) | Deploys cert-manager into an EKS cluster. | -| [Cluster Autoscaler](./cluster-autoscaler) | Deploys the standard cluster autoscaler into an EKS cluster. | -| [Fargate Fluent Bit](./fargate-fluent-bit) | Adds Fluent Bit support for EKS Fargate | -| [EKS Managed Add-ons](./managed-add-ons) | Enables EKS managed add-ons. | -| [Keda](./keda) | Deploys Keda into an EKS cluster. | -| [Metrics Server](./metrics-server) | Deploys the Kubernetes Metrics Server into an EKS cluster. | -| [Nginx](./ingress-nginx) | Deploys the NGINX Ingress Controller into an EKS cluster. | -| [Prometheus](./prometheus) | Deploys Prometheus into an EKS cluster. | -| [Traefik](./traefik) | Deploys Traefik Proxy into an EKS cluster. +| [Agones](../add-ons/agones) | Deploys Agones into an EKS cluster. | +| [Amazon EKS Add-ons](../add-ons/managed-add-ons) | Enables Amazon EKS add-ons. | +| [ArgoCD](../add-ons/argocd) | Deploys ArgoCD into an EKS cluster. | +| [AWS for Fluent Bit](../add-ons/aws-for-fluent-bit) | Deploys Fluent Bit into an EKS cluster. | +| [AWS Load Balancer Controller](../add-ons/aws-load-balancer-controller) | Deploys the AWS Load Balancer Controller into an EKS cluster. | +| [AWS Distro for Open Telemetry](../add-ons/aws-open-telemetry) | Deploys the AWS Open Telemetry Collector into an EKS cluster. | +| [AWS Node Termination Handler](../add-ons/aws-node-termination-handler) | Deploys the AWS Node Termination Handler into an EKS cluster. | +| [cert-manager](../add-ons/cert-manager) | Deploys cert-manager into an EKS cluster. | +| [Cluster Autoscaler](../add-ons/cluster-autoscaler) | Deploys the standard cluster autoscaler into an EKS cluster. | +| [Fargate Fluent Bit](../add-ons/fargate-fluent-bit) | Adds Fluent Bit support for EKS Fargate | +| [Karpenter](../add-ons/karpenter) | Deploys Karpenter into an EKS cluster. | +| [Keda](../add-ons/keda) | Deploys Keda into an EKS cluster. | +| [Metrics Server](../add-ons/metrics-server) | Deploys the Kubernetes Metrics Server into an EKS cluster. | +| [Nginx](../add-ons/nginx) | Deploys the NGINX Ingress Controller into an EKS cluster. | +| [Prometheus](../add-ons/prometheus) | Deploys Prometheus into an EKS cluster. | +| [Spark K8S Operator](../add-ons/spark-on-k8s-operator) | Deploys the Kubernetes Operator for Apache Spark into an EKS cluster. | +| [Traefik](../add-ons/traefik) | Deploys Traefik Proxy into an EKS cluster. +| [VPA](../add-ons/vpa) | Deploys the Vertical Pod Autoscaler into an EKS cluster. | +| [YuniKorn](../add-ons/yunikorn) | Deploys Apache YuniKorn into an EKS cluster. | ## Add-on Management diff --git a/docs/node-groups.md b/docs/node-groups.md index 9ebd9278c1..1aca722274 100644 --- a/docs/node-groups.md +++ b/docs/node-groups.md @@ -1,6 +1,6 @@ # Node Groups -The framework uses dedicated sub modules for creating [AWS Managed Node Groups](modules/aws-eks-managed-node-groups), [Self-managed Node groups](modules/aws-eks-self-managed-node-groups) and [Fargate profiles](modules/aws-eks-fargate-profiles). These modules provide flexibility to add or remove managed/self-managed node groups/fargate profiles by simply adding/removing map of values to input config. See [example](https://github.com/aws-samples/aws-eks-accelerator-for-terraform/tree/main/examples/1-eks-cluster-with-new-vpc). +The framework uses dedicated sub modules for creating [AWS Managed Node Groups](https://github.com/aws-samples/aws-eks-accelerator-for-terraform/tree/main/modules/aws-eks-managed-node-groups), [Self-managed Node groups](https://github.com/aws-samples/aws-eks-accelerator-for-terraform/tree/main/modules/aws-eks-self-managed-node-groups) and [Fargate profiles](https://github.com/aws-samples/aws-eks-accelerator-for-terraform/tree/main/modules/aws-eks-fargate-profiles). These modules provide flexibility to add or remove managed/self-managed node groups/fargate profiles by simply adding/removing map of values to input config. See [example](https://github.com/aws-samples/aws-eks-accelerator-for-terraform/tree/main/examples/1-eks-cluster-with-new-vpc). The `aws-auth` ConfigMap handled by this module allow your nodes to join your cluster, and you also use this ConfigMap to add RBAC access to IAM users and roles. Each Node Group can have dedicated IAM role, Launch template and Security Group to improve the security. diff --git a/mkdocs.yml b/mkdocs.yml index 431e96b968..8ac4940eb0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,6 +17,7 @@ nav: - Add-ons: - Overview: "add-ons/index.md" - Agones: "add-ons/agones.md" + - Amazon EKS Add-ons: "add-ons/managed-add-ons.md" - Argo CD: "add-ons/argocd.md" - AWS for Fluent Bit: "add-ons/aws-for-fluent-bit.md" - AWS Load Balancer Controller: "add-ons/aws-load-balancer-controller.md" @@ -27,7 +28,6 @@ nav: - Fargate Fluent Bit: "add-ons/fargate-fluent-bit.md" - Karpenter: "add-ons/karpenter.md" - KEDA: "add-ons/keda.md" - - Managed EKS Add-ons: "add-ons/managed-add-ons.md" - Metrics Server: "add-ons/metrics-server.md" - Nginx: "add-ons/nginx.md" - Prometheus: "add-ons/prometheus.md"