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-gitlab-kube-cluster

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

# License of this project
license: "MIT"

# Copyrights
copyrights:
  - name: "LazyOrange, LLC"
    url: "https://lazyorange.xyz"
    year: "2020"

# Canonical GitHub repo
github_repo: lazyorangejs/terraform-gitlab-kube-cluster

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/lazyorangejs/terraform-gitlab-kube-cluster.svg"
    url: "https://github.com/lazyorangejs/terraform-gitlab-kube-cluster/releases/latest"

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "root.lazyorange.xyz"
    description: "A terraform configuration to setup the ready-to-go Kubernetes cluster and connect to GitLab"
    url: "https://github.com/lazyorangejs/root.lazyorange.xyz"
  - 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 `random_integer` Resource"
    description: "The resource random_integer generates random values from a given range, described by the min and max attributes of a given resource."
    url: "https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/integer"
  - 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"

# Short description of this project
description: |-
  This is `terraform-gitlab-kube-cluster` to easily connect any existing Kubernetes cluster with Gitlab.

# Introduction to the project
#introduction: |-
#  This is an introduction.

# How to use this module. Should be an easy example to copy and paste.
usage: |-
  Here's how to invoke this example module in your projects

  ```hcl
  data "digitalocean_kubernetes_versions" "default" {
    version_prefix = "1.16"
  }

  data "digitalocean_sizes" "default" {
    filter {
      key    = "memory"
      values = [2048, 3072, 4096]
    }

    filter {
      key    = "regions"
      values = ["fra1"]
    }

    sort {
      key       = "price_monthly"
      direction = "asc"
    }
  }

  resource "digitalocean_kubernetes_cluster" "default" {
    region = "fra1"

    name    = "examples-complete"
    version = data.digitalocean_kubernetes_versions.default.latest_version

    node_pool {
      name       = "main"
      size       = element(data.digitalocean_sizes.default.sizes, 0).slug
      node_count = 1
      min_nodes  = 1
      max_nodes  = 1
    }
  }

  module "example" {
    source = "../.."

    stage        = "dev"
    cluster_name = "terraform-gitlab-kube-cluster"
    dns_zone     = "terraform-gitlab-kube-cluster.example.com"

    # https://gitlab.com/lazyorangejs/lab
    root_gitlab_group = var.root_gitlab_group # should point to your own gitlab group

    kubernetes_endpoint = digitalocean_kubernetes_cluster.default.endpoint
    kubernetes_token    = digitalocean_kubernetes_cluster.default.kube_config[0].token
    kubernetes_ca_cert  = digitalocean_kubernetes_cluster.default.kube_config[0].cluster_ca_certificate
  }
  ```

# Example usage
examples: |-
  Here is an example of using this module:
  - [`examples/complete`](https://github.com/lazyorangejs/terraform-gitlab-kube-cluster/tree/master/examples/complete) - complete example of using this module

# How to get started quickly
#quickstart: |-
#  Here's how to get started...

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

# Contributors to this project
contributors:
  - name: "Vitaly Markov"
    github: "vymarkov"