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 module gke

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-gcp-gke

badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-gcp-gke.svg"
    url: "https://github.com/clouddrove/terraform-gcp-gke/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-gcp-gke/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-gcp-gke/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.3"
    
providers:
  - name: gcp
    url: https://cloud.google.com/
    version: ">= 5.9.0, < 6"

#  description of this project
description: |-
   Terraform module to create and manage GKE clusters on Google Cloud Platform.

# How to use this project
usage: |-
  Here are some examples of how you can use this module in your inventory structure:
  ### Default gke
  ```hcl
  module "gke-dev-jetic-cluster" {
  source                     = "../../"
  project_id                 = var.gcp_project_id
  name                       = "cluster-1"
  region                     = "us-central1"
  zones                      = ["us-central1-c"]
  network                    = "test-vpc-dev"
  subnetwork                 = "dev-test"
  ip_range_pods              = "pods"
  workload_config_audit_mode = "BASIC"
  security_posture_mode      = "BASIC"
  kubernetes_version         = "1.30.2-gke.1587003"
  regional                   = true

  logging_service                   = "logging.googleapis.com/kubernetes"
  monitoring_service                = "monitoring.googleapis.com/kubernetes"
  enable_private_nodes              = true
  release_channel                   = "STABLE"
  horizontal_pod_autoscaling        = true
  http_load_balancing               = false
  filestore_csi_driver              = true
  istio                             = false
  network_policy                    = true
  ip_range_services                 = "services"
  create_service_account            = false
  cluster_resource_labels           = { env = "test" }
  service_account                   = "example@example.gserviceaccount.com"
  remove_default_node_pool          = true
  disable_legacy_metadata_endpoints = true
  deletion_protection               = false

  node_pools = [
    {
      name                         = "critical"
      master_version               = "1.30.2-gke.1587003"
      machine_type                 = "g1-small"
      node_locations               = "us-central1-c"
      min_count                    = 1
      max_count                    = 1
      local_ssd_count              = 0
      spot                         = true
      disk_size_gb                 = 10
      disk_type                    = "pd-standard"
      image_type                   = "cos_containerd"
      enable_gcfs                  = false
      enable_gvnic                 = false
      logging_variant              = "DEFAULT"
      auto_repair                  = true
      auto_upgrade                 = true
      create_service_account       = false
      service_account              = "example@example.gserviceaccount.com"
      preemptible                  = false
      initial_node_count           = 1
      enable_node_pool_autoscaling = false
      enable_private_nodes         = true
    }
  ```