Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/fix broken links #259

Merged
merged 3 commits into from
Feb 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/add-ons/aws-node-termination-handler.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AWS Node Termination Handler

This project ensures that the Kubernetes control plane responds appropriately to events that can cause your EC2 instance to become unavailable, such as EC2 maintenance events, EC2 Spot interruptions, ASG Scale-In, ASG AZ Rebalance, and EC2 Instance Termination via the API or Console. If not handled, your application code may not stop gracefully, take longer to recover full availability, or accidentally schedule work to nodes that are going down. For more information see [README.md][https://github.com/aws/aws-node-termination-handler#readme].
This project ensures that the Kubernetes control plane responds appropriately to events that can cause your EC2 instance to become unavailable, such as EC2 maintenance events, EC2 Spot interruptions, ASG Scale-In, ASG AZ Rebalance, and EC2 Instance Termination via the API or Console. If not handled, your application code may not stop gracefully, take longer to recover full availability, or accidentally schedule work to nodes that are going down. For more information see [README.md](https://github.com/aws/aws-node-termination-handler#readme).

The aws-node-termination-handler (NTH) can operate in two different modes: Instance Metadata Service (IMDS) or the Queue Processor. In the SSP, we provision the NTH in Queue Processor mode. This means that NTH will monitor an SQS queue of events from Amazon EventBridge for ASG lifecycle events, EC2 status change events, Spot Interruption Termination Notice events, and Spot Rebalance Recommendation events. When NTH detects an instance is going down, NTH uses the Kubernetes API to cordon the node to ensure no new work is scheduled there, then drain it, removing any existing work.

Expand Down
2 changes: 1 addition & 1 deletion docs/add-ons/crossplane.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For complete project documentation, please visit the [Crossplane](https://crossp

### Crossplane Deployment

Crossplane can be deployed by enabling the add-on via the following. Check out the full [example](modules/kubernetes-addons/crossplane/locals.tf) to deploy the EKS Cluster with Crossplane.
Crossplane can be deployed by enabling the add-on via the following. Check out the full [example](../../modules/kubernetes-addons/crossplane/locals.tf) to deploy the EKS Cluster with Crossplane.

```hcl
enable_crossplane = true
Expand Down
38 changes: 19 additions & 19 deletions docs/add-ons/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ The framework currently provides support for the following add-ons:

| Add-on | Description |
|-----------|-----------------
| [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. |
| [Agones](../add-ons/agones.md) | Deploys Agones into an EKS cluster. |
| [Amazon EKS Add-ons](../add-ons/managed-add-ons.md) | Enables Amazon EKS add-ons. |
| [ArgoCD](../add-ons/argocd.md) | Deploys ArgoCD into an EKS cluster. |
| [AWS for Fluent Bit](../add-ons/aws-for-fluent-bit.md) | Deploys Fluent Bit into an EKS cluster. |
| [AWS Load Balancer Controller](../add-ons/aws-load-balancer-controller.md) | Deploys the AWS Load Balancer Controller into an EKS cluster. |
| [AWS Distro for Open Telemetry](../add-ons/aws-open-telemetry.md) | Deploys the AWS Open Telemetry Collector into an EKS cluster. |
| [AWS Node Termination Handler](../add-ons/aws-node-termination-handler.md) | Deploys the AWS Node Termination Handler into an EKS cluster. |
| [cert-manager](../add-ons/cert-manager.md) | Deploys cert-manager into an EKS cluster. |
| [Cluster Autoscaler](../add-ons/cluster-autoscaler.md) | Deploys the standard cluster autoscaler into an EKS cluster. |
| [Fargate Fluent Bit](../add-ons/fargate-fluent-bit.md) | Adds Fluent Bit support for EKS Fargate |
| [Karpenter](../add-ons/karpenter.md) | Deploys Karpenter into an EKS cluster. |
| [Keda](../add-ons/keda.md) | Deploys Keda into an EKS cluster. |
| [Metrics Server](../add-ons/metrics-server.md) | Deploys the Kubernetes Metrics Server into an EKS cluster. |
| [Nginx](../add-ons/nginx.md) | Deploys the NGINX Ingress Controller into an EKS cluster. |
| [Prometheus](../add-ons/prometheus.md) | Deploys Prometheus into an EKS cluster. |
| [Spark K8S Operator](../add-ons/spark-on-k8s-operator.md) | Deploys the Kubernetes Operator for Apache Spark into an EKS cluster. |
| [Traefik](../add-ons/traefik.md) | Deploys Traefik Proxy into an EKS cluster.
| [VPA](../add-ons/vpa.md) | Deploys the Vertical Pod Autoscaler into an EKS cluster. |
| [YuniKorn](../add-ons/yunikorn.md) | Deploys Apache YuniKorn into an EKS cluster. |

## Add-on Management

Expand Down
2 changes: 1 addition & 1 deletion docs/add-ons/karpenter.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ For complete project documentation, please visit the [Karpenter](https://karpent

## Usage

Karpenter can be deployed by enabling the add-on via the following. Check out the full [example](examples/karpenter/main.tf) to deploy the EKS Cluster with Karpenter.
Karpenter can be deployed by enabling the add-on via the following. Check out the full [example](../../modules/kubernetes-addons/karpenter/locals.tf) to deploy the EKS Cluster with Karpenter.

```hcl
enable_karpenter = true
Expand Down
2 changes: 1 addition & 1 deletion docs/add-ons/keda.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ KEDA is a Kubernetes-based Event Driven Autoscaler. With KEDA, you can drive the

KEDA is a single-purpose and lightweight component that can be added into any Kubernetes cluster. KEDA works alongside standard Kubernetes components like the Horizontal Pod Autoscaler and can extend functionality without overwriting or duplication. With KEDA you can explicitly map the apps you want to use event-driven scale, with other apps continuing to function. This makes KEDA a flexible and safe option to run alongside any number of any other Kubernetes applications or frameworks..

[KEDA](https://github.com/kedacore/charts/tree/master/keda) chart bootstraps KEDA infrastructure on a Kubernetes cluster using the Helm package manager.
[KEDA](https://github.com/kedacore/charts/tree/main/keda) chart bootstraps KEDA infrastructure on a Kubernetes cluster using the Helm package manager.

For complete project documentation, please visit the [KEDA documentation site](https://keda.sh/).

Expand Down