From 021968aeb21b682696502da769e97fa27591de1a Mon Sep 17 00:00:00 2001 From: aidanmelen Date: Mon, 1 Aug 2022 21:38:33 +0000 Subject: [PATCH] revved minimum version in doc examples. --- Makefile | 10 +++++++++- README.md | 2 +- bin/render-docs.sh | 10 +++++----- examples/complete/.main.tf.docs | 2 +- examples/complete/README.md | 2 +- examples/confluent_operator/.main.tf.docs | 2 +- examples/confluent_operator/README.md | 2 +- examples/confluent_platform/.main.tf.docs | 2 +- examples/confluent_platform/README.md | 2 +- .../confluent_platform_singlenode/.main.tf.docs | 16 ++++++++-------- examples/confluent_platform_singlenode/README.md | 16 ++++++++-------- examples/kafka_topics/.main.tf.docs | 4 ++-- examples/kafka_topics/README.md | 4 ++-- modules/kafka_topic/.terraform-docs.yml | 1 + modules/kafka_topic/README.md | 5 +++++ 15 files changed, 47 insertions(+), 33 deletions(-) diff --git a/Makefile b/Makefile index ef4d52b..9c5575d 100644 --- a/Makefile +++ b/Makefile @@ -22,6 +22,9 @@ apply-cfk-crds: setup: apply-cfk-crds ## Setup project # terraform terraform init + + cd modules/confluent_operator && terraform init + cd modules/kafka_topics && terraform init cd examples/confluent_operator && terraform init cd examples/confluent_platform && terraform init cd examples/confluent_platform_singlenode && terraform init @@ -85,15 +88,20 @@ delete-cfk-crds: clean: delete-cfk-crds ## Clean project @rm -f .terraform.lock.hcl + + @rm -f modules/confluent_operator/.terraform.lock.hcl + @rm -f modules/kafka_topics/.terraform.lock.hcl @rm -f examples/confluent_operator/.terraform.lock.hcl @rm -f examples/confluent_platform/.terraform.lock.hcl @rm -f examples/confluent_platform_singlenode/.terraform.lock.hcl @rm -f examples/complete/.terraform.lock.hcl + @rm -rf modules/confluent_operator/.terraform + @rm -rf modules/kafka_topics/.terraform @rm -rf examples/confluent_operator/.terraform @rm -rf examples/confluent_platform/.terraform @rm -rf examples/confluent_platform_singlenode/.terraform - @rm -f examples/complete/.terraform.terraform + @rm -rf examples/complete/.terraform @rm -f go.mod @rm -f go.sum diff --git a/README.md b/README.md index ca00547..9fad46a 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ A Terraform module for running [Confluent for Kubernetes (CFK)](https://docs.con ```hcl module "confluent_platform" { source = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" namespace = var.namespace diff --git a/bin/render-docs.sh b/bin/render-docs.sh index fb01b3d..10f51db 100755 --- a/bin/render-docs.sh +++ b/bin/render-docs.sh @@ -1,11 +1,11 @@ #!/bin/bash # render terraform-docs code examples -sed -z 's/source[^\r\n]*/source = "aidanmelen\/confluent-platform\/kubernetes\/\/modules\/confluent_operator"\n version = ">= 0.4.0"\n/g' examples/confluent_operator/main.tf > examples/confluent_operator/.main.tf.docs -sed -z 's/source[^\r\n]*/source = "aidanmelen\/confluent-platform\/kubernetes"\n version = ">= 0.4.0"\n/g' examples/confluent_platform/main.tf > examples/confluent_platform/.main.tf.docs -sed -z 's/source[^\r\n]*/source = "aidanmelen\/confluent-platform\/kubernetes"\n version = ">= 0.4.0"\n/g' examples/confluent_platform_singlenode/main.tf > examples/confluent_platform_singlenode/.main.tf.docs -sed -z 's/source[^\r\n]*/source = "aidanmelen\/confluent-platform\/kubernetes"\n version = ">= 0.4.0"/g' examples/complete/main.tf > examples/complete/.main.tf.docs -sed -z 's/source[^\r\n]*/source = "aidanmelen\/confluent-platform\/kubernetes"\n version = ">= 0.4.0"/g' examples/kafka_topics/main.tf > examples/kafka_topics/.main.tf.docs +sed -z 's/source[^\r\n]*/source = "aidanmelen\/confluent-platform\/kubernetes\/\/modules\/confluent_operator"\n version = ">= 0.6.0"\n/g' examples/confluent_operator/main.tf > examples/confluent_operator/.main.tf.docs +sed -z 's/source[^\r\n]*/source = "aidanmelen\/confluent-platform\/kubernetes"\n version = ">= 0.6.0"\n/g' examples/confluent_platform/main.tf > examples/confluent_platform/.main.tf.docs +sed -z 's/source[^\r\n]*/source = "aidanmelen\/confluent-platform\/kubernetes"\n version = ">= 0.6.0"\n/g' examples/confluent_platform_singlenode/main.tf > examples/confluent_platform_singlenode/.main.tf.docs +sed -z 's/source[^\r\n]*/source = "aidanmelen\/confluent-platform\/kubernetes"\n version = ">= 0.6.0"/g' examples/complete/main.tf > examples/complete/.main.tf.docs +sed -z 's/source[^\r\n]*/source = "aidanmelen\/confluent-platform\/kubernetes"\n version = ">= 0.6.0"/g' examples/kafka_topics/main.tf > examples/kafka_topics/.main.tf.docs # render Makefile targets examples make > .make.docs diff --git a/examples/complete/.main.tf.docs b/examples/complete/.main.tf.docs index e6ae8ed..5537d05 100644 --- a/examples/complete/.main.tf.docs +++ b/examples/complete/.main.tf.docs @@ -1,6 +1,6 @@ module "confluent_platform" { source = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" namespace = var.namespace diff --git a/examples/complete/README.md b/examples/complete/README.md index b3d5786..4d54e50 100644 --- a/examples/complete/README.md +++ b/examples/complete/README.md @@ -24,7 +24,7 @@ Please see the [Makefile](https://github.com/aidanmelen/terraform-kubernetes-con ```hcl module "confluent_platform" { source = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" namespace = var.namespace diff --git a/examples/confluent_operator/.main.tf.docs b/examples/confluent_operator/.main.tf.docs index 1a5cae5..3709fe8 100644 --- a/examples/confluent_operator/.main.tf.docs +++ b/examples/confluent_operator/.main.tf.docs @@ -1,6 +1,6 @@ module "confluent_operator" { source = "aidanmelen/confluent-platform/kubernetes//modules/confluent_operator" - version = ">= 0.4.0" + version = ">= 0.6.0" create_namespace = true namespace = "confluent" diff --git a/examples/confluent_operator/README.md b/examples/confluent_operator/README.md index 032dedc..aa65740 100644 --- a/examples/confluent_operator/README.md +++ b/examples/confluent_operator/README.md @@ -13,7 +13,7 @@ This example assumes you have a Kubernetes cluster running locally on Docker Des ```hcl module "confluent_operator" { source = "aidanmelen/confluent-platform/kubernetes//modules/confluent_operator" - version = ">= 0.4.0" + version = ">= 0.6.0" create_namespace = true namespace = "confluent" diff --git a/examples/confluent_platform/.main.tf.docs b/examples/confluent_platform/.main.tf.docs index cb83da3..edf7154 100644 --- a/examples/confluent_platform/.main.tf.docs +++ b/examples/confluent_platform/.main.tf.docs @@ -1,6 +1,6 @@ module "confluent_platform" { source = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" namespace = "confluent" diff --git a/examples/confluent_platform/README.md b/examples/confluent_platform/README.md index 2c5c452..60fef4c 100644 --- a/examples/confluent_platform/README.md +++ b/examples/confluent_platform/README.md @@ -17,7 +17,7 @@ Release the [Confluent Operator example](https://github.com/aidanmelen/terraform ```hcl module "confluent_platform" { source = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" namespace = "confluent" diff --git a/examples/confluent_platform_singlenode/.main.tf.docs b/examples/confluent_platform_singlenode/.main.tf.docs index 3609508..911a5c6 100644 --- a/examples/confluent_platform_singlenode/.main.tf.docs +++ b/examples/confluent_platform_singlenode/.main.tf.docs @@ -1,6 +1,6 @@ module "confluent_platform_singlenode" { source = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" namespace = "confluent" @@ -9,7 +9,7 @@ spec: replicas: 1 podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 100m @@ -38,7 +38,7 @@ spec: - "password.encoder.secret=secret" podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 200m @@ -62,7 +62,7 @@ spec: - "status.storage.replication.factor=1" podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 100m @@ -88,7 +88,7 @@ spec: url: http://schemaregistry.confluent.svc.cluster.local:8081 podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 100m @@ -122,7 +122,7 @@ spec: domain: minikube.domain podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 500m @@ -153,7 +153,7 @@ spec: replicas: 1 podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 100m @@ -173,7 +173,7 @@ spec: url: http://schemaregistry.confluent.svc.cluster.local:8081 podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 100m diff --git a/examples/confluent_platform_singlenode/README.md b/examples/confluent_platform_singlenode/README.md index 2fd4eff..f5cee0c 100644 --- a/examples/confluent_platform_singlenode/README.md +++ b/examples/confluent_platform_singlenode/README.md @@ -18,7 +18,7 @@ Release the [Confluent Operator example](https://github.com/aidanmelen/terraform ```hcl module "confluent_platform_singlenode" { source = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" namespace = "confluent" @@ -27,7 +27,7 @@ spec: replicas: 1 podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 100m @@ -56,7 +56,7 @@ spec: - "password.encoder.secret=secret" podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 200m @@ -80,7 +80,7 @@ spec: - "status.storage.replication.factor=1" podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 100m @@ -106,7 +106,7 @@ spec: url: http://schemaregistry.confluent.svc.cluster.local:8081 podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 100m @@ -140,7 +140,7 @@ spec: domain: minikube.domain podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 500m @@ -171,7 +171,7 @@ spec: replicas: 1 podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 100m @@ -191,7 +191,7 @@ spec: url: http://schemaregistry.confluent.svc.cluster.local:8081 podTemplate: resource = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" requests: cpu: 100m diff --git a/examples/kafka_topics/.main.tf.docs b/examples/kafka_topics/.main.tf.docs index e136f52..6bcccaa 100644 --- a/examples/kafka_topics/.main.tf.docs +++ b/examples/kafka_topics/.main.tf.docs @@ -1,6 +1,6 @@ module "kafka_topic" { source = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" name = "my-topic" namespace = "confluent" @@ -8,7 +8,7 @@ module "kafka_topic" { module "other_kafka_topic" { source = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" name = "my-other-topic" namespace = "confluent" diff --git a/examples/kafka_topics/README.md b/examples/kafka_topics/README.md index f2969a2..50ebc23 100644 --- a/examples/kafka_topics/README.md +++ b/examples/kafka_topics/README.md @@ -17,7 +17,7 @@ Release the [Complete example](https://github.com/aidanmelen/terraform-kubernete ```hcl module "kafka_topic" { source = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" name = "my-topic" namespace = "confluent" @@ -25,7 +25,7 @@ module "kafka_topic" { module "other_kafka_topic" { source = "aidanmelen/confluent-platform/kubernetes" - version = ">= 0.4.0" + version = ">= 0.6.0" name = "my-other-topic" namespace = "confluent" diff --git a/modules/kafka_topic/.terraform-docs.yml b/modules/kafka_topic/.terraform-docs.yml index e411edd..3cf1788 100644 --- a/modules/kafka_topic/.terraform-docs.yml +++ b/modules/kafka_topic/.terraform-docs.yml @@ -8,6 +8,7 @@ content: |- {{ .Requirements }} {{ .Providers }} + {{ .Modules }} {{ .Resources }} {{ .Inputs }} {{ .Outputs }} diff --git a/modules/kafka_topic/README.md b/modules/kafka_topic/README.md index a38587e..af628b6 100644 --- a/modules/kafka_topic/README.md +++ b/modules/kafka_topic/README.md @@ -44,6 +44,11 @@ spec: | Name | Version | |------|---------| | [kubernetes](#provider\_kubernetes) | >= 2.12.1 | +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [kafka\_topic\_override\_values](#module\_kafka\_topic\_override\_values) | Invicton-Labs/deepmerge/null | 0.1.5 | ## Resources | Name | Type |