https://github.com/terraform-ibm-modules/terraform-ibm-resource-group

Looks up or creates an IBM Cloud resource group by name
https://github.com/terraform-ibm-modules/terraform-ibm-resource-group

core-team graduated ibm-cloud resource-group supported terraform terraform-module

Last synced: 3 months ago
JSON representation

Looks up or creates an IBM Cloud resource group by name

• Host: GitHub
• URL: https://github.com/terraform-ibm-modules/terraform-ibm-resource-group
• Owner: terraform-ibm-modules
• License: apache-2.0
• Created: 2022-08-11T10:43:19.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-21T19:07:34.000Z (8 months ago)
• Last Synced: 2024-09-27T19:21:31.453Z (8 months ago)
• Topics: core-team, graduated, ibm-cloud, resource-group, supported, terraform, terraform-module
• Language: Go
• Size: 772 KB
• Stars: 2
• Watchers: 16
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Resource group module

[![Stable (With quality checks)](https://img.shields.io/badge/Status-Stable%20(With%20quality%20checks)-green)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

[![latest release](https://img.shields.io/github/v/release/terraform-ibm-modules/terraform-ibm-resource-group?logo=GitHub&sort=semver)](https://github.com/terraform-ibm-modules/terraform-ibm-resource-group/releases/latest)

[![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)

[![Catalog release](https://img.shields.io/badge/release-IBM%20Cloud%20Catalog-3662FF?logo=ibm)](https://cloud.ibm.com/catalog/modules/terraform-ibm-resource-group-de458c9b-835d-4014-b11f-d61ea081e986-global)

This module returns the ID for the name of a resource group. It can also create a group from a name and return the ID.

## Overview

* [terraform-ibm-resource-group](#terraform-ibm-resource-group)

* [Examples](./examples)

    * [Existing resource group example](./examples/existing-resource-group)

    * [New resource group example](./examples/new-resource-group)

* [Contributing](#contributing)

## terraform-ibm-resource-group

### Usage

Create new Resource group:

```hcl

module "resource_group" {

  source              = "terraform-ibm-modules/resource-group/ibm"

  version             = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release

  resource_group_name = "new-resource-group"

}

```

Return ID of an existing Resource group:

```hcl

module "resource_group" {

  source                       = "terraform-ibm-modules/resource-group/ibm"

  version                      = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release

  existing_resource_group_name = "existing-resource-group"

}

```

### Required IAM access policies

You need the following permissions to run this module.

- Account Management

  - **All Account Management Services** service

      - `Administrator` platform access

### Requirements

| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | >= 1.0.0 |

|  [ibm](#requirement\_ibm) | >= 1.49.0, < 2.0.0 |

### Modules

No modules.

### Resources

| Name | Type |

|------|------|

| [ibm_resource_group.resource_group](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/resource_group) | resource |

| [ibm_resource_group.existing_resource_group](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/data-sources/resource_group) | data source |

### Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [existing\_resource\_group\_name](#input\_existing\_resource\_group\_name) | Name of the existing resource group.  Required if not creating new resource group | `string` | `null` | no |

|  [resource\_group\_name](#input\_resource\_group\_name) | Name of the resource group to create. Required if not using existing resource group | `string` | `null` | no |

### Outputs

| Name | Description |

|------|-------------|

|  [resource\_group\_id](#output\_resource\_group\_id) | Resource group ID |

|  [resource\_group\_name](#output\_resource\_group\_name) | Resource group name |

## Contributing

You can report issues and request features for this module in GitHub issues in the module repo. See [Report an issue or request a feature](https://github.com/terraform-ibm-modules/.github/blob/main/.github/SUPPORT.md).

To set up your local development environment, see [Local development setup](https://terraform-ibm-modules.github.io/documentation/#/local-dev-setup) in the project documentation.