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-kubernetes-tfc-cloud-agent

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Copyrights
copyrights:
  - name: "Cloud Posse, LLC"
    url: "https://cloudposse.com"
    year: "2020"

# Canonical GitHub repo
github_repo: cloudposse/terraform-kubernetes-tfc-cloud-agent

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-kubernetes-tfc-cloud-agent.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-kubernetes-tfc-cloud-agent/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-kubernetes-tfc-cloud-agent.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-kubernetes-tfc-cloud-agent/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-null-label"
    description: "Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention."
    url: "https://github.com/cloudposse/terraform-null-label"

# List any resources helpful for someone to get started. For example, link to the hashicorp documentation or AWS documentation.
references:
  - name: "Terraform Standard Module Structure"
    description: "HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories."
    url: "https://www.terraform.io/docs/modules/index.html#standard-module-structure"
  - name: "Terraform Module Requirements"
    description: "HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy."
    url: "https://www.terraform.io/docs/registry/modules/publish.html#requirements"
  - name: "Terraform Version Pinning"
    description: "The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration"
    url: "https://www.terraform.io/docs/configuration/terraform.html#specifying-a-required-terraform-version"
  - name: "Terraform Cloud Agents"
    description: "Terraform Cloud Agents are a solution to allow Terraform Cloud to communicate with isolated, private, or on-premises infrastructure."
    url: "https://www.terraform.io/docs/cloud/workspaces/agent.html"
  - name: "Announcing HashiCorp Terraform Cloud Business Tier"
    description: "This new tier includes enterprise features for advanced security, compliance and governance, the ability to execute multiple runs concurrently, and flexible support options."
    url: "https://www.hashicorp.com/blog/announcing-hashicorp-terraform-cloud-business"
  - name: "Announcing Terraform Cloud Business Tier with Armon Dadgar"
    description: "Watch HashiCorp co-founder and CTO Armon Dadgar announce the latest addition to Terraform Cloud: the new Business tier."
    url: "https://www.hashicorp.com/resources/announcing-terraform-cloud-business-tier-with-armon-dadgar"

# Short description of this project
description: |-
  This project installs the Terraform Cloud Agent on an existing Kubernetes cluster. You must provide your own Kubernetes provider configuration in your project!

  NOTE: Requires [Terraform Cloud Business or Terraform Enterprise](https://www.hashicorp.com/products/terraform/pricing) subscription.

# How to use this module. Should be an easy example to copy and paste.
usage: |2-

  ```hcl
  provider "kubernetes" {
    # Context to choose from the config file, if needed.
    config_context = "example-context"
    version        = "~> 1.12"
  }

  module "tfc_agent" {
    source = "https://github.com/cloudposse/terraform-kubernetes-tfc-cloud-agent.git?ref=master"

    # Your agent token generated in Terraform Cloud
    token       = var.tfc_agent_token
    namespace   = var.namespace
    stage       = var.stage
    environment = var.environment
    name        = var.name

    # You can specify a namespace other than "default"
    kubernetes_namespace = "tfc-agent"
  }
  ```

# Example usage
examples: |-
  Here is an example of using this module:
  - [`examples/complete`](https://github.com/cloudposse/terraform-kubernetes-tfc-cloud-agent/) - complete example of using this module

# Other files to include in this README from the project folder
include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors: []