feat: initial module release (#2)

Author: MatthewLemmond

.github/settings.yml

@@ -15,14 +15,14 @@ repository:
   # By changing this field, you rename the repository.
 
   # Uncomment this name property and set the name to the current repo name.
-  # name: ""
+  name: "terraform-ibm-app-configuration"
 
   # The description is displayed under the repository name on the
   # organization page and in the 'About' section of the repository.
 
   # Uncomment this description property
   # and update the description to the current repo description.
-  # description: ""
+  description: "Create an App Configuration instance and optionally allows for multiple App Configuration Collections to be created."
 
   # Use a comma-separated list of topics to set on the repo.
   topics: terraform, ibm-cloud, terraform-module

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "go.sum|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2023-06-03T04:42:19Z",
+  "generated_at": "2023-10-07T00:05:00Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"

README.md

@@ -1,19 +1,12 @@
-<!-- Update the title -->
-# Terraform Modules Template Project
+# Terraform IBM App Configuration
 
-<!--
-Update status and "latest release" badges:
-  1. For the status options, see https://github.ibm.com/GoldenEye/documentation/blob/master/status.md
-  2. Update the "latest release" badge to point to the correct module's repo. Replace "module-template" in two places.
--->
-[![Incubating (Not yet consumable)](https://img.shields.io/badge/status-Incubating%20(Not%20yet%20consumable)-red)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
-[![latest release](https://img.shields.io/github/v/release/terraform-ibm-modules/terraform-ibm-module-template?logo=GitHub&sort=semver)](https://github.com/terraform-ibm-modules/terraform-ibm-module-template/releases/latest)
+[![Stable (Adopted)](https://img.shields.io/badge/Status-Stable%20(Adopted)-yellowgreen?style=plastic)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
+[![latest release](https://img.shields.io/github/v/release/terraform-ibm-modules/terraform-ibm-app-configuration?logo=GitHub&sort=semver)](https://github.com/terraform-ibm-modules/terraform-ibm-app-configuration/releases/latest)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-<!-- Add a description of module(s) in this repo -->
-
+Create an App Configuration instance and optionally allows for multiple App Configuration Collections to be created.
 
 <!--
 If this repo contains any reference architectures, uncomment the heading below and links to them.
@@ -23,7 +16,6 @@ https://terraform-ibm-modules.github.io/documentation/#/implementation-guideline
 -->
 <!-- ## Reference architectures -->
 
-
 <!-- Below content is automatically populated via pre-commit hook -->
 <!-- BEGIN OVERVIEW HOOK -->
 ## Overview
@@ -34,48 +26,51 @@ https://terraform-ibm-modules.github.io/documentation/#/implementation-guideline
 * [Contributing](#contributing)
 <!-- END OVERVIEW HOOK -->
 
-### Usage
+## terraform-ibm-app-configuration
 
-<!--
-Add an example of the use of the module in the following code block.
-
-Use real values instead of "var.<var_name>" or other placeholder values
-unless real values don't help users know what to change.
--->
+### Usage
 
 ```hcl
-
+module "app_config" {
+  source                       = "terraform-ibm-modules/app-configuration/ibm"
+  version                      = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release
+  resource_group_id            = "65xxxxxxxxxxxxxxxa3fd"
+  region                       = "us-south"
+  app_config_name              = "my-app-config-name"
+  app_config_plan              = "lite"
+  app_config_service_endpoints = "public"
+  app_config_tags              = ["list", "of", "tags"]
+
+  app_config_collections = [
+    {
+      name          = "my-app-config-collection-name",
+      collection_id = "my-app-config-collection-id",
+      description   = "Collection for app config instance",
+      tags          = "tag for collection"
+    },
+    {
+      name          = "second-collection-name",
+      collection_id = "second-collection-id",
+      description   = "Another Collection for app config instance",
+      tags          = "another tag"
+    }
+  ]
+}
 ```
 
 ### Required IAM access policies
 
-<!-- PERMISSIONS REQUIRED TO RUN MODULE
-If this module requires permissions, uncomment the following block and update
-the sample permissions, following the format.
-Replace the sample Account and IBM Cloud service names and roles with the
-information in the console at
-Manage > Access (IAM) > Access groups > Access policies.
--->
-
-<!--
 You need the following permissions to run this module.
 
-- Account Management
-    - **Sample Account Service** service
-        - `Editor` platform access
-        - `Manager` service access
-    - IAM Services
-        - **Sample Cloud Service** service
-            - `Administrator` platform access
--->
-
-<!-- NO PERMISSIONS FOR MODULE
-If no permissions are required for the module, uncomment the following
-statement instead the previous block.
--->
-
-<!-- No permissions are needed to run this module.-->
+* Account Management
+  * **All Resource Groups** service
+    * `Viewer` platform access
+  * IAM Services
+    * **App Configuration** service
+      * `Administrator` platform access
+      * `Manager` service access
 
+For more information on access and permissions, see <https://cloud.ibm.com/docs/account?topic=account-iam-service-roles-actions#apprapp-roles>
 
 <!-- Below content is automatically populated via pre-commit hook -->
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
@@ -84,22 +79,37 @@ statement instead the previous block.
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0, <1.6.0 |
+| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.49.0, < 2.0.0 |
 
 ### Modules
 
 No modules.
 
 ### Resources
 
-No resources.
+| Name | Type |
+|------|------|
+| [ibm_app_config_collection.collections](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/app_config_collection) | resource |
+| [ibm_resource_instance.app_config](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/resource_instance) | resource |
 
 ### Inputs
 
-No inputs.
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_app_config_collections"></a> [app\_config\_collections](#input\_app\_config\_collections) | A list of collections to be added to the App Configuration instance | <pre>list(object({<br>    name          = string<br>    collection_id = string<br>    description   = optional(string, null)<br>    tags          = optional(string, null)<br>  }))</pre> | `[]` | no |
+| <a name="input_app_config_name"></a> [app\_config\_name](#input\_app\_config\_name) | Name for the App Configuration service instance | `string` | n/a | yes |
+| <a name="input_app_config_plan"></a> [app\_config\_plan](#input\_app\_config\_plan) | Plan for the App Configuration service instance, valid plans are lite, standardv2, and enterprise. | `string` | `"lite"` | no |
+| <a name="input_app_config_service_endpoints"></a> [app\_config\_service\_endpoints](#input\_app\_config\_service\_endpoints) | Service Endpoints for the App Configuration service instance, valid endpoints are public or public-and-private. | `string` | `"public-and-private"` | no |
+| <a name="input_app_config_tags"></a> [app\_config\_tags](#input\_app\_config\_tags) | Optional list of tags to be added to the App Config instance. | `list(string)` | `[]` | no |
+| <a name="input_region"></a> [region](#input\_region) | The region to provision the App Configuration service, valid regions are us-south, us-east, eu-gb, and au-syd. | `string` | `"us-south"` | no |
+| <a name="input_resource_group_id"></a> [resource\_group\_id](#input\_resource\_group\_id) | The resource group ID where resources will be provisioned. | `string` | n/a | yes |
 
 ### Outputs
 
-No outputs.
+| Name | Description |
+|------|-------------|
+| <a name="output_app_config_collection_ids"></a> [app\_config\_collection\_ids](#output\_app\_config\_collection\_ids) | List of IDs for the collections in the App Configuration instance |
+| <a name="output_app_config_guid"></a> [app\_config\_guid](#output\_app\_config\_guid) | GUID of the App Configuration instance |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 <!-- Leave this section as is so that your module has a link to local development environment set up steps for contributors to follow -->

examples/basic/README.md

@@ -7,5 +7,6 @@ The text below should describe exactly what resources are provisioned / configur
 -->
 
 An end-to-end basic example that will provision the following:
+
 - A new resource group if one is not passed in.
-- A new Cloud Object Storage instance.
+- A new App Configuration instance.

examples/basic/main.tf

@@ -11,14 +11,13 @@ module "resource_group" {
 }
 
 ########################################################################################################################
-# COS instance
+# App Config
 ########################################################################################################################
 
-resource "ibm_resource_instance" "cos_instance" {
-  name              = "${var.prefix}-cos"
+module "app_config" {
+  source            = "../.."
   resource_group_id = module.resource_group.resource_group_id
-  service           = "cloud-object-storage"
-  plan              = "standard"
-  location          = "global"
-  tags              = var.resource_tags
+  region            = var.region
+  app_config_name   = "${var.prefix}-app-config"
+  app_config_tags   = var.resource_tags
 }

examples/basic/outputs.tf

@@ -2,11 +2,6 @@
 # Outputs
 ########################################################################################################################
 
-output "cos_instance_id" {
-  description = "COS instance id"
-  value       = ibm_resource_instance.cos_instance.id
-}
-
 output "resource_group_name" {
   description = "Resource group name"
   value       = module.resource_group.resource_group_name
@@ -16,3 +11,8 @@ output "resource_group_id" {
   description = "Resource group ID"
   value       = module.resource_group.resource_group_id
 }
+
+output "app_config_guid" {
+  description = "App Configuration GUID"
+  value       = module.app_config.app_config_guid
+}

examples/complete/README.md

@@ -2,3 +2,9 @@
 
 <!-- There is a pre-commit hook that will take the title of each example add include it in the repos main README.md  -->
 <!-- Add text below should describe exactly what resources are provisioned / configured by the example  -->
+
+An end-to-end basic example that will provision the following:
+
+- A new resource group if one is not passed in.
+- A new App Configuration instance.
+- A new collection within the App Configuration instance.

examples/complete/main.tf

@@ -1,3 +1,35 @@
 ##############################################################################
 # Complete example
 ##############################################################################
+
+########################################################################################################################
+# Resource group
+########################################################################################################################
+
+module "resource_group" {
+  source  = "terraform-ibm-modules/resource-group/ibm"
+  version = "1.1.0"
+  # if an existing resource group is not set (null) create a new one using prefix
+  resource_group_name          = var.resource_group == null ? "${var.prefix}-resource-group" : null
+  existing_resource_group_name = var.resource_group
+}
+
+########################################################################################################################
+# App Config
+########################################################################################################################
+
+module "app_config" {
+  source            = "../.."
+  resource_group_id = module.resource_group.resource_group_id
+  region            = var.region
+  app_config_name   = "${var.prefix}-app-config"
+  app_config_tags   = var.resource_tags
+
+  app_config_collections = [
+    {
+      name          = "${var.prefix}-collection",
+      collection_id = "${var.prefix}-collection"
+      description   = "Collection for ${var.prefix}"
+    }
+  ]
+}

examples/complete/outputs.tf

@@ -17,6 +17,16 @@ output "resource_group_name" {
   value       = var.resource_group
 }
 
+output "app_config_guid" {
+  description = "App Configuration GUID"
+  value       = module.app_config.app_config_guid
+}
+
+output "app_config_collection_ids" {
+  description = "App Configuration Collection IDs"
+  value       = module.app_config.app_config_collection_ids
+}
+
 output "resource_tags" {
   description = "List of resource tags"
   value       = var.resource_tags

main.tf

@@ -1,3 +1,29 @@
-/********************************************************************
-This file is used to implement the ROOT module.
-*********************************************************************/
+##############################################################################
+# App Config module
+##############################################################################
+
+resource "ibm_resource_instance" "app_config" {
+  resource_group_id = var.resource_group_id
+  location          = var.region
+  name              = var.app_config_name
+  service           = "apprapp"
+  plan              = var.app_config_plan
+  service_endpoints = var.app_config_service_endpoints
+  tags              = var.app_config_tags
+}
+
+locals {
+  collections_map = {
+    for obj in var.app_config_collections :
+    (obj.name) => obj
+  }
+}
+
+resource "ibm_app_config_collection" "collections" {
+  for_each      = local.collections_map
+  guid          = ibm_resource_instance.app_config.guid
+  name          = each.value.name
+  collection_id = each.value.collection_id
+  description   = each.value.description
+  tags          = each.value.tags
+}