Skip to content

Commit

Permalink
fix: Add terradocs to deployable module dir (#764)
Browse files Browse the repository at this point in the history
  • Loading branch information
ocofaigh committed Apr 12, 2024
1 parent 54e0791 commit 164783c
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
31 changes: 31 additions & 0 deletions deployable_modules/module-template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,34 @@

A thin wrapper around the [terraform-ibm-module-template](../../) module which includes a provider configuration meaning it can be deployed as is.
This is not intended to be called by one or more other modules since it contains a provider configuration, meaning it is not compatible with the `for_each`, `count`, and `depends_on` arguments. For more information see [Providers Within Modules](https://developer.hashicorp.com/terraform/language/modules/develop/providers).

<!-- The following content is automatically populated by the pre-commit hook -->
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
### Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0, <1.7.0 |
| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | 1.64.0 |

### Modules

| Name | Source | Version |
|------|--------|---------|
| <a name="module_module_template"></a> [module\_template](#module\_module\_template) | ../.. | n/a |

### Resources

No resources.

### Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_ibmcloud_api_key"></a> [ibmcloud\_api\_key](#input\_ibmcloud\_api\_key) | The IBM Cloud API Key | `string` | n/a | yes |
| <a name="input_region"></a> [region](#input\_region) | The IBM Cloud region | `string` | n/a | yes |

### Outputs

No outputs.
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 comments on commit 164783c

Please sign in to comment.