Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 58 additions & 18 deletions integrations/iac/terraform/checks-groups.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -228,29 +228,35 @@ resource "checkly_tcp_monitor" "example-tcp-monitor-2" {

## Groups

Once you start having more than just a handful of checks, it makes sense to start looking into [groups](/platform/groups) to keep things tidy:
Once you start having more than just a handful of checks, it makes sense to start looking into [groups](/platform/groups) to keep things tidy. Use the `checkly_check_group_v2` resource. A v2 group doesn't override any settings of its checks unless you ask it to, so it can be as simple as a name:

```terraform
resource "checkly_check_group" "key-shop-flows" {
name = "Key Shop Flows" // The name of the group
activated = true // Whether the group will start as active on creation
muted = false // Whether the group will start as muted on creation

locations = [ // Which locations the check should run from (if not in a group)
"eu-west-1",
"eu-central-1"
]
resource "checkly_check_group_v2" "key-shop-flows" {
name = "Key Shop Flows"
}
```

concurrency = 3 // How many checks to run at once when triggering the group using CI/CD triggers
use_global_alert_settings = false // Whether to use global alert settings or group-specific ones
run_parallel = true // Whether the check would run in a single location at time (round-robin) or all locations on each run
To have the group override a setting for all of its checks, add the matching `enforce_*` block and set `enabled = true`. The available blocks are `enforce_locations`, `enforce_retry_strategy`, `enforce_scheduling_strategy` and `enforce_alert_settings`:

retry_strategy { // The retry strategy used for failed runs
type = "LINEAR"
```terraform
resource "checkly_check_group_v2" "key-shop-flows" {
name = "Key Shop Flows"
activated = true
muted = false
concurrency = 3 // How many checks to run at once when triggering the group using CI/CD triggers

// All checks in this group run from these locations, regardless of their own settings
enforce_locations {
enabled = true
locations = ["eu-west-1", "eu-central-1"]
}
}
```

The older `checkly_check_group` resource still works, but it always applies group-level defaults to its checks. See [migrating to `checkly_check_group_v2`](#migrating-to-checkly_check_group_v2) below.

You can see all the configuration options for groups, as well as more examples, on the Terraform registry documentation pages for [`checkly_check_group_v2`](https://registry.terraform.io/providers/checkly/checkly/latest/docs/resources/check_group_v2) and [`checkly_check_group`](https://registry.terraform.io/providers/checkly/checkly/latest/docs/resources/check_group).

### Adding checks to groups

To add a check to a group, link it to that group by setting the `group_id` argument to the group's resource ID. For example, to link the API check and the group from this article:
Expand All @@ -270,7 +276,7 @@ resource "checkly_check" "get-books" {
]

// This makes the check part of the group
group_id = checkly_check_group.key-shop-flows.id
group_id = checkly_check_group_v2.key-shop-flows.id

retry_strategy {
type = "LINEAR"
Expand All @@ -289,6 +295,40 @@ resource "checkly_check" "get-books" {
}
```

> Locations and alert channel subscriptions defined at group level always trump the ones defined at check level. Double-check your config to make sure all checks are running from the intended regions and are set to alert on the correct channels.
> With a `checkly_check_group_v2` group, a check keeps its own settings unless the group enables the matching `enforce_*` block. With the older `checkly_check_group`, locations and alert channel subscriptions defined at group level always override the ones defined at check level.

### Migrating to `checkly_check_group_v2`

<Warning>
Don't migrate by only changing the resource type from `checkly_check_group` to `checkly_check_group_v2`. Terraform then deletes the old group and creates a new one, and **deleting a group deletes every check in it**. Terraform recreates the checks afterwards, but with new IDs and without their result history.
</Warning>

Move the existing group to the new resource type instead, so the group and its checks stay in place:

1. Note the group's ID:

```bash
terraform state show checkly_check_group.key-shop-flows
```

2. In your configuration, replace the `checkly_check_group` resource with a `checkly_check_group_v2` resource with the same resource name (`key-shop-flows` here). To keep the old behavior, add `enforce_*` blocks for the settings the old group set, such as locations, retry strategy, scheduling strategy and alert settings. Update every reference, for example `group_id = checkly_check_group_v2.key-shop-flows.id`.

3. Remove the old resource from the Terraform state. This doesn't change anything in Checkly:

```bash
terraform state rm checkly_check_group.key-shop-flows
```

4. Import the existing group as the new resource, using the ID from step 1:

```bash
terraform import checkly_check_group_v2.key-shop-flows <group-id>
```

5. Run `terraform plan`. It must not destroy or replace any resource. An in-place update of the group is expected; check that it only turns off `enforce_*` settings you meant to drop. Then run `terraform apply`.

### Deleting a group

You can see all the configuration options for groups, as well as more examples, on the official Terraform registry [documentation page](https://registry.terraform.io/providers/checkly/checkly/latest/docs/resources/check_group).
<Warning>
Deleting a group also deletes all checks in it. To keep the checks, first remove `group_id` from them and apply that change. Then remove the group from your configuration and apply again.
</Warning>
2 changes: 2 additions & 0 deletions platform/groups.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ Groups let you apply shared configuration to standardize how checks behave. Depe
To prevent issues (e.g. broken references to group variables), the check will be automatically deactivated after being added to or removed from a group. Make sure to review its settings before reactivating.
</Warning>

**Deleting a group:** Deleting a group also deletes every check in it. To keep the checks, move them out of the group before you delete it.


Using a set of shared defaults for API checks helps you manage checks that go to the same basic
endpoint, share headers and other settings.
Expand Down
Loading