README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#


# Name of this project
name: Terraform AWS karpenter

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-karpenter

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-karpenter.svg"
    url: "https://github.com/clouddrove/terraform-aws-karpenter/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-karpenter/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-karpenter/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"
  - name: "Changelog"
    image: "https://img.shields.io/badge/Changelog-blue"
    url: "CHANGELOG.md"

prerequesties:
  - name: Terraform
    url: https://learn.hashicorp.com/terraform/getting-started/install.html
    version: ">= 1.6.1"

providers:
  - name: aws
    url: https://aws.amazon.com/
    version: ">= 5.21.0"

module_dependencies:
  - name: Labels Module
    url: https://github.com/clouddrove/terraform-aws-labels
    description: Provides resource tagging.

#  description of this project
description: |-
  Terraform module to create karpenter resource on AWS.



# How to use this project
# yamllint disable rule:line-length
usage: |-
  ### Simple Example
  Here is an example of how you can use this module in your inventory structure:
    ```hcl
      module "karpenter" {

          source      = "clouddrove/karpenter/aws"
          version     = "1.3.0"
          name        = "karpenter"
          environment = "test"
          label_order = ["environment", "name"]

          namespace         = "test"
          create_namespace  = true
          karpenter_version = "0.31.1"

          cluster_name             = module.eks.eks_cluster_id
          eks_cluster_endpoint     = module.eks.eks_cluster_endpoint
          eks_worker_iam_role_name = module.eks.iam_role_name
          provider_url             = module.eks.oidc_issuer_url
          depends_on               = [module.eks]
        }
    ```