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-kops-vpc-peering

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - kops-kubernetes
  - kops
  - kubernetes
  - vpc
  - ec2
  - peering
  - vpn
  - backing-services

# Categories of this project
categories:
  - terraform-modules/kops-kubernetes

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

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-kops-vpc-peering

# Badges to display
badges:
  - name: "Build Status"
    image: "https://travis-ci.org/cloudposse/terraform-aws-kops-vpc-peering.svg?branch=master"
    url: "https://travis-ci.org/cloudposse/terraform-aws-kops-vpc-peering"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-kops-vpc-peering.svg"
    url: "https://github.com/cloudposse/terraform-aws-kops-vpc-peering/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related:
  - name: "terraform-aws-kops-metadata"
    description: "Terraform module to lookup resources within a Kops cluster for easier integration with Terraform"
    url: "https://github.com/cloudposse/terraform-aws-kops-metadata"
  - name: "terraform-aws-kops-ecr"
    description: "Terraform module to provision an ECR repository and grant users and kubernetes nodes access to it."
    url: "https://github.com/cloudposse/terraform-aws-kops-ecr"
  - name: "terraform-aws-kops-state-backend"
    description: "Easily bootstrap kops clusters (DNS & S3 Bucket)"
    url: "https://github.com/cloudposse/terraform-aws-kops-state-backend"
  - name: "terraform-aws-kops-external-dns"
    description: "Terraform module to provision an IAM role for external-dns running in a Kops cluster, and attach an IAM policy to the role with permissions to modify Route53 record sets"
    url: "https://github.com/cloudposse/terraform-aws-kops-external-dns"
  - name: "terraform-aws-kops-route53"
    description: "Terraform module to lookup the IAM role associated with `kops` masters, and attach an IAM policy to the role with permissions to modify Route53 record sets"
    url: "https://github.com/cloudposse/terraform-aws-kops-route53"
  - name: "terraform-aws-kops-vault-backend"
    description: "Terraform module to provision an S3 bucket for HashiCorp Vault secrets storage, and an IAM role and policy with permissions for Kops nodes to access the bucket"
    url: "https://github.com/cloudposse/terraform-aws-kops-vault-backend"
  - name: "terraform-aws-kops-chart-repo"
    description: "Terraform module to provision an S3 bucket for Helm chart repository, and an IAM role and policy with permissions for Kops nodes to access the bucket"
    url: "https://github.com/cloudposse/terraform-aws-kops-chart-repo"

# Short description of this project
description: |-
  Terraform module to create a peering connection between a backing services VPC and a VPC created by [Kops](https://github.com/kubernetes/kops).

  The module depends on the following [Cloud Posse][website] Terraform modules

  - [terraform-aws-kops-metadata](https://github.com/cloudposse/terraform-aws-kops-metadata) - to lookup resources within a Kops cluster
  - [terraform-aws-vpc-peering](https://github.com/cloudposse/terraform-aws-vpc-peering) - to create a peering connection between two VPCs

# How to use this project
usage: |-
  ```hcl
  module "kops_vpc_peering" {
    source                                           = "git::https://github.com/cloudposse/terraform-aws-kops-vpc-peering.git?ref=master"
    namespace                                        = "cp"
    stage                                            = "dev"
    name                                             = "cluster"
    backing_services_vpc_id                          = "vpc-XXXXXXXX"
    dns_zone                                         = "us-west-2.domain.com"
    bastion_name                                     = "bastion"
    masters_name                                     = "masters"
    nodes_name                                       = "nodes"
    backing_services_allow_remote_vpc_dns_resolution = "true"
  }
  ```

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors:
  - name: "Andriy Knysh"
    github: "aknysh"