feat: updated the required terraform version range to `>= 1.0.0, < 1.…

…6.0` (#368)
terraform-ibm-modules · Oct 6, 2023 · 0e33928 · 0e33928
1 parent b8886c2
commit 0e33928
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -30,9 +30,9 @@ This module supports provisioning the following observability instances:
     * [Provision IBM Cloud Monitoring and Log Analysis + Activity Tracker with archiving enabled using encrypted COS bucket](./examples/observability_archive)
     * [Provision basic observability instances (Log Analysis, Cloud Monitoring, Activity Tracker)](./examples/observability_basic)
 * [Contributing](#contributing)
+<!-- END OVERVIEW HOOK -->
 
 ## terraform-ibm-observability-instances
-<!-- END OVERVIEW HOOK -->
 
 ### Usage
 
@@ -63,7 +63,7 @@ provider "logdna" {
 
 module "observability_instances" {
   source  = "terraform-ibm-modules/observability-instances/ibm"
-  version = "latest" # Replace "latest" with a release version to lock into a specific release
+  version = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release
   providers = {
     logdna.at  = logdna.at
     logdna.ld  = logdna.ld
@@ -93,8 +93,8 @@ provider "logdna" {
 }
 
 module "log_analysis" {
-  # Replace "main" with a GIT release version to lock into a specific release
-  source = "git::https://github.com/terraform-ibm-modules/terraform-ibm-observability-instances//modules/log_analysis?ref=main"
+  source  = "terraform-ibm-modules/observability-instances/ibm//modules/log_analysis"
+  version = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release
   providers = {
     logdna.ld = logdna.ld
   }
@@ -124,7 +124,7 @@ provider "logdna" {
 
 module "activity_tracker" {
   source  = "terraform-ibm-modules/observability/ibm"
-  version = "latest" # Replace "latest" with a release version to lock into a specific release
+  version = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release
   providers = {
     logdna.at = logdna.at
   }
@@ -137,8 +137,8 @@ To provision IBM Cloud Monitoring only
 
 ```hcl
 module "cloud_monitoring" {
-  # Replace "main" with a GIT release version to lock into a specific release
-  source = "git::https://github.com/terraform-ibm-modules/terraform-ibm-observability-instances//modules/cloud_monitoring?ref=main"
+  source  = "terraform-ibm-modules/observability/ibm//modules/cloud_monitoring"
+  version = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release
   resource_group_id = module.resource_group.resource_group_id
   region = var.region
 }
@@ -174,9 +174,9 @@ To attach access management tags to resources in this module, you need the follo
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
-| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.56.1 |
-| <a name="requirement_logdna"></a> [logdna](#requirement\_logdna) | >= 1.14.2 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0, < 1.6.0 |
+| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.56.1, < 2.0.0 |
+| <a name="requirement_logdna"></a> [logdna](#requirement\_logdna) | >= 1.14.2, < 2.0.0 |
 
 ### Modules
 

diff --git a/common-dev-assets b/common-dev-assets
diff --git a/examples/observability_archive/version.tf b/examples/observability_archive/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.0.0"
+  required_version = ">= 1.0.0, < 1.6.0"
   required_providers {
     ibm = {
       source  = "ibm-cloud/ibm"

diff --git a/examples/observability_at_event_routing/version.tf b/examples/observability_at_event_routing/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.0.0"
+  required_version = ">= 1.0.0, < 1.6.0"
   required_providers {
     ibm = {
       source  = "ibm-cloud/ibm"

diff --git a/examples/observability_basic/version.tf b/examples/observability_basic/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.0.0"
+  required_version = ">= 1.0.0, < 1.6.0"
   required_providers {
     # Pin to the lowest provider version of the range defined in the main module to ensure lowest version still works
     ibm = {

diff --git a/module-metadata.json b/module-metadata.json
@@ -837,19 +837,19 @@
     }
   },
   "required_core": [
-    "\u003e= 1.0.0"
+    "\u003e= 1.0.0, \u003c 1.6.0"
   ],
   "required_providers": {
     "ibm": {
       "source": "ibm-cloud/ibm",
       "version_constraints": [
-        "\u003e= 1.56.1"
+        "\u003e= 1.56.1, \u003c 2.0.0"
       ]
     },
     "logdna": {
       "source": "logdna/logdna",
       "version_constraints": [
-        "\u003e= 1.14.2"
+        "\u003e= 1.14.2, \u003c 2.0.0"
       ],
       "aliases": [
         {

diff --git a/modules/activity_tracker/README.md b/modules/activity_tracker/README.md
@@ -44,9 +44,9 @@ module "activity_tracker" {
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
-| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.56.1 |
-| <a name="requirement_logdna"></a> [logdna](#requirement\_logdna) | >= 1.14.2 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0, < 1.6.0 |
+| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.56.1, < 2.0.0 |
+| <a name="requirement_logdna"></a> [logdna](#requirement\_logdna) | >= 1.14.2, < 2.0.0 |
 
 ### Modules
 

diff --git a/modules/activity_tracker/version.tf b/modules/activity_tracker/version.tf
@@ -1,14 +1,14 @@
 terraform {
-  required_version = ">= 1.0.0"
+  required_version = ">= 1.0.0, < 1.6.0"
   required_providers {
     # Use "greater than or equal to" range in modules
     ibm = {
       source  = "ibm-cloud/ibm"
-      version = ">= 1.56.1"
+      version = ">= 1.56.1, < 2.0.0"
     }
     logdna = {
       source                = "logdna/logdna"
-      version               = ">= 1.14.2"
+      version               = ">= 1.14.2, < 2.0.0"
       configuration_aliases = [logdna.at]
     }
   }

diff --git a/modules/cloud_monitoring/README.md b/modules/cloud_monitoring/README.md
@@ -25,8 +25,8 @@ module "cloud_monitoring" {
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
-| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.56.1 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0, < 1.6.0 |
+| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.56.1, < 2.0.0 |
 
 ### Modules
 

diff --git a/modules/cloud_monitoring/version.tf b/modules/cloud_monitoring/version.tf
@@ -1,10 +1,10 @@
 terraform {
-  required_version = ">= 1.0.0"
+  required_version = ">= 1.0.0, < 1.6.0"
   required_providers {
     # Use "greater than or equal to" range in modules
     ibm = {
       source  = "ibm-cloud/ibm"
-      version = ">= 1.56.1"
+      version = ">= 1.56.1, < 2.0.0"
     }
   }
 }
diff --git a/modules/log_analysis/README.md b/modules/log_analysis/README.md
@@ -44,9 +44,9 @@ module "log_analysis" {
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
-| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.56.1 |
-| <a name="requirement_logdna"></a> [logdna](#requirement\_logdna) | >= 1.14.2 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0, < 1.6.0 |
+| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.56.1, < 2.0.0 |
+| <a name="requirement_logdna"></a> [logdna](#requirement\_logdna) | >= 1.14.2, < 2.0.0 |
 
 ### Modules
 

diff --git a/modules/log_analysis/version.tf b/modules/log_analysis/version.tf
@@ -1,14 +1,14 @@
 terraform {
-  required_version = ">= 1.0.0"
+  required_version = ">= 1.0.0, < 1.6.0"
   required_providers {
     # Use "greater than or equal to" range in modules
     ibm = {
       source  = "ibm-cloud/ibm"
-      version = ">= 1.56.1"
+      version = ">= 1.56.1, < 2.0.0"
     }
     logdna = {
       source                = "logdna/logdna"
-      version               = ">= 1.14.2"
+      version               = ">= 1.14.2, < 2.0.0"
       configuration_aliases = [logdna.ld]
     }
   }

diff --git a/version.tf b/version.tf
@@ -1,15 +1,15 @@
 terraform {
-  required_version = ">= 1.0.0"
+  required_version = ">= 1.0.0, < 1.6.0"
   required_providers {
     # Use "greater than or equal to" range in modules
     # tflint-ignore: terraform_unused_required_providers
     ibm = {
       source  = "ibm-cloud/ibm"
-      version = ">= 1.56.1"
+      version = ">= 1.56.1, < 2.0.0"
     }
     logdna = {
       source                = "logdna/logdna"
-      version               = ">= 1.14.2"
+      version               = ">= 1.14.2, < 2.0.0"
       configuration_aliases = [logdna.at, logdna.ld]
     }
   }