revved minimum version in doc examples.

aidanmelen · Aug 1, 2022 · 021968a · 021968a
1 parent 848ef08
commit 021968a
Show file tree

Hide file tree

Showing 15 changed files with 47 additions and 33 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,14 +1,14 @@
 module "kafka_topic" {
   source  = "aidanmelen/confluent-platform/kubernetes"
-  version = ">= 0.4.0"
+  version = ">= 0.6.0"
 
   name      = "my-topic"
   namespace = "confluent"
 }
 
 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
@@ -17,15 +17,15 @@ 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"
 }
 
 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
@@ -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
@@ -44,6 +44,11 @@ spec:
 | Name | Version |
 |------|---------|
 | <a name="provider_kubernetes"></a> [kubernetes](#provider\_kubernetes) | >= 2.12.1 |
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_kafka_topic_override_values"></a> [kafka\_topic\_override\_values](#module\_kafka\_topic\_override\_values) | Invicton-Labs/deepmerge/null | 0.1.5 |
 ## Resources
 
 | Name | Type |