BREAKING CHANGE: labels/groups attachment to tests/agents updates (#125)

* BREAKING CHANGE: labels/groups attachment to tests/agents updates Going forward it will no longer be possible to attach a label/group to a test in any test resource. Test resources obtain the labels linked to them via the API automatically (computed fields). Labels are now linked to tests only in the label resource. This diverges from what the ThousandEyes API allows, but is necessary considering how terraform works, as it was previously possible to have a test resource cancel out a label that is being added to it in a label resource, because the test resource wasn't setting it. * docs: fix account name description grammar
thousandeyes · Feb 27, 2023 · 7a3db27 · 7a3db27
1 parent a8bfb96
commit 7a3db27
Show file tree

Hide file tree

Showing 18 changed files with 351 additions and 562 deletions.
diff --git a/docs/resources/agent_to_agent.md b/docs/resources/agent_to_agent.md
@@ -47,7 +47,6 @@ resource "thousandeyes_agent_to_agent" "example_agent_to_agent_test" {
 - `description` (String) A description of the alert rule. Defaults to an empty string.
 - `dscp_id` (Number) The DSCP ID.
 - `enabled` (Boolean) Enables or disables the test.
-- `groups` (Block Set, Deprecated) The array of label objects. (see [below for nested schema](#nestedblock--groups))
 - `mss` (Number) The maximum segment size, in bytes. Value can be from 30 to 1400.
 - `mtu_measurements` (Boolean) Measure MTU sizes on the network from agents to the target.
 - `network_measurements` (Boolean) Set to 'true' to enable network measurements.
@@ -66,6 +65,7 @@ resource "thousandeyes_agent_to_agent" "example_agent_to_agent_test" {
 - `created_by` (String) Created by user.
 - `created_date` (String) The date of creation.
 - `dscp` (String) The Differentiated Services Code Point (DSCP) label.
+- `groups` (Set of Object) The array of label objects. (see [below for nested schema](#nestedatt--groups))
 - `id` (String) The ID of this resource.
 - `live_share` (Boolean) Set to 'true' for a test shared with your account group, or to 'false' for a normal test.
 - `modified_by` (String) Last modified by this user.
@@ -165,59 +165,52 @@ Optional:
 - `network` (String) The name of the autonomous system in which the BGP monitor is found.
 
 
-<a id="nestedblock--groups"></a>
-### Nested Schema for `groups`
+<a id="nestedblock--shared_with_accounts"></a>
+### Nested Schema for `shared_with_accounts`
 
 Required:
 
-- `group_id` (Number) The unique ID of the label.
-
-Optional:
-
-- `agents` (Block List) Define the ThousandEyes agents to use. (see [below for nested schema](#nestedblock--groups--agents))
-- `name` (String) The name of the label.
-- `tests` (Block List) The list of tests. (see [below for nested schema](#nestedblock--groups--tests))
-- `type` (String) [tests, agents, endpoint_tests, or endpoint_agents] The type of label.
+- `aid` (Number) The account group ID.
 
 Read-Only:
 
-- `builtin` (Boolean) Shows whether you are using built-in (true) labels or user-created (false) labels. Built-in labels are read-only.
+- `name` (String) Account name.
 
-<a id="nestedblock--groups--agents"></a>
-### Nested Schema for `groups.agents`
 
-Optional:
-
-- `agent_id` (Number) The unique ThousandEyes agent ID.
-
-
-<a id="nestedblock--groups--tests"></a>
-### Nested Schema for `groups.tests`
+<a id="nestedatt--api_links"></a>
+### Nested Schema for `api_links`
 
-Optional:
+Read-Only:
 
-- `test_id` (Number) The unique ID of the test.
+- `href` (String)
+- `rel` (String)
 
 
+<a id="nestedatt--groups"></a>
+### Nested Schema for `groups`
 
-<a id="nestedblock--shared_with_accounts"></a>
-### Nested Schema for `shared_with_accounts`
+Read-Only:
 
-Required:
+- `agents` (List of Object) (see [below for nested schema](#nestedobjatt--groups--agents))
+- `builtin` (Boolean)
+- `group_id` (Number)
+- `name` (String)
+- `tests` (List of Object) (see [below for nested schema](#nestedobjatt--groups--tests))
+- `type` (String)
 
-- `aid` (Number) The account group ID.
+<a id="nestedobjatt--groups--agents"></a>
+### Nested Schema for `groups.agents`
 
 Read-Only:
 
-- `name` (String) The name of account.
+- `agent_id` (Number)
 
 
-<a id="nestedatt--api_links"></a>
-### Nested Schema for `api_links`
+<a id="nestedobjatt--groups--tests"></a>
+### Nested Schema for `groups.tests`
 
 Read-Only:
 
-- `href` (String)
-- `rel` (String)
+- `test_id` (Number)
 
 
diff --git a/docs/resources/agent_to_server.md b/docs/resources/agent_to_server.md
@@ -45,7 +45,6 @@ resource "thousandeyes_agent_to_server" "example_agent_to_server_test" {
 - `bgp_monitors` (Block List) The array of BGP monitor object IDs. The monitorIDs can be sourced from the /bgp-monitors endpoint. (see [below for nested schema](#nestedblock--bgp_monitors))
 - `description` (String) A description of the alert rule. Defaults to an empty string.
 - `enabled` (Boolean) Enables or disables the test.
-- `groups` (Block Set, Deprecated) The array of label objects. (see [below for nested schema](#nestedblock--groups))
 - `mtu_measurements` (Boolean) Measure MTU sizes on the network from agents to the target.
 - `network_measurements` (Boolean) Set to 'true' to enable network measurements.
 - `num_path_traces` (Number) The number of path traces.
@@ -61,6 +60,7 @@ resource "thousandeyes_agent_to_server" "example_agent_to_server_test" {
 - `api_links` (List of Object) Self links to the endpoint to pull test metadata, and data links to the endpoint for test data. Read-only, and shows rel and href elements. (see [below for nested schema](#nestedatt--api_links))
 - `created_by` (String) Created by user.
 - `created_date` (String) The date of creation.
+- `groups` (Set of Object) The array of label objects. (see [below for nested schema](#nestedatt--groups))
 - `id` (String) The ID of this resource.
 - `live_share` (Boolean) Set to 'true' for a test shared with your account group, or to 'false' for a normal test.
 - `modified_by` (String) Last modified by this user.
@@ -160,59 +160,52 @@ Optional:
 - `network` (String) The name of the autonomous system in which the BGP monitor is found.
 
 
-<a id="nestedblock--groups"></a>
-### Nested Schema for `groups`
+<a id="nestedblock--shared_with_accounts"></a>
+### Nested Schema for `shared_with_accounts`
 
 Required:
 
-- `group_id` (Number) The unique ID of the label.
-
-Optional:
-
-- `agents` (Block List) Define the ThousandEyes agents to use. (see [below for nested schema](#nestedblock--groups--agents))
-- `name` (String) The name of the label.
-- `tests` (Block List) The list of tests. (see [below for nested schema](#nestedblock--groups--tests))
-- `type` (String) [tests, agents, endpoint_tests, or endpoint_agents] The type of label.
+- `aid` (Number) The account group ID.
 
 Read-Only:
 
-- `builtin` (Boolean) Shows whether you are using built-in (true) labels or user-created (false) labels. Built-in labels are read-only.
+- `name` (String) Account name.
 
-<a id="nestedblock--groups--agents"></a>
-### Nested Schema for `groups.agents`
 
-Optional:
-
-- `agent_id` (Number) The unique ThousandEyes agent ID.
-
-
-<a id="nestedblock--groups--tests"></a>
-### Nested Schema for `groups.tests`
+<a id="nestedatt--api_links"></a>
+### Nested Schema for `api_links`
 
-Optional:
+Read-Only:
 
-- `test_id` (Number) The unique ID of the test.
+- `href` (String)
+- `rel` (String)
 
 
+<a id="nestedatt--groups"></a>
+### Nested Schema for `groups`
 
-<a id="nestedblock--shared_with_accounts"></a>
-### Nested Schema for `shared_with_accounts`
+Read-Only:
 
-Required:
+- `agents` (List of Object) (see [below for nested schema](#nestedobjatt--groups--agents))
+- `builtin` (Boolean)
+- `group_id` (Number)
+- `name` (String)
+- `tests` (List of Object) (see [below for nested schema](#nestedobjatt--groups--tests))
+- `type` (String)
 
-- `aid` (Number) The account group ID.
+<a id="nestedobjatt--groups--agents"></a>
+### Nested Schema for `groups.agents`
 
 Read-Only:
 
-- `name` (String) The name of account.
+- `agent_id` (Number)
 
 
-<a id="nestedatt--api_links"></a>
-### Nested Schema for `api_links`
+<a id="nestedobjatt--groups--tests"></a>
+### Nested Schema for `groups.tests`
 
 Read-Only:
 
-- `href` (String)
-- `rel` (String)
+- `test_id` (Number)
 
 
diff --git a/docs/resources/bgp.md b/docs/resources/bgp.md
@@ -35,7 +35,6 @@ resource "thousandeyes_bgp" "example_bgp_test" {
 - `bgp_monitors` (Block List) The array of BGP monitor object IDs. The monitorIDs can be sourced from the /bgp-monitors endpoint. (see [below for nested schema](#nestedblock--bgp_monitors))
 - `description` (String) A description of the alert rule. Defaults to an empty string.
 - `enabled` (Boolean) Enables or disables the test.
-- `groups` (Block Set, Deprecated) The array of label objects. (see [below for nested schema](#nestedblock--groups))
 - `include_covered_prefixes` (Boolean) Include queries for subprefixes detected under this prefix.
 - `shared_with_accounts` (Block List) [“serverName”: “fqdn of server”] The array of DNS Server objects. (see [below for nested schema](#nestedblock--shared_with_accounts))
 - `use_public_bgp` (Boolean) Enable to automatically add all available Public BGP Monitors to the test.
@@ -45,6 +44,7 @@ resource "thousandeyes_bgp" "example_bgp_test" {
 - `api_links` (List of Object) Self links to the endpoint to pull test metadata, and data links to the endpoint for test data. Read-only, and shows rel and href elements. (see [below for nested schema](#nestedatt--api_links))
 - `created_by` (String) Created by user.
 - `created_date` (String) The date of creation.
+- `groups` (Set of Object) The array of label objects. (see [below for nested schema](#nestedatt--groups))
 - `id` (String) The ID of this resource.
 - `live_share` (Boolean) Set to 'true' for a test shared with your account group, or to 'false' for a normal test.
 - `modified_by` (String) Last modified by this user.
@@ -76,59 +76,52 @@ Optional:
 - `network` (String) The name of the autonomous system in which the BGP monitor is found.
 
 
-<a id="nestedblock--groups"></a>
-### Nested Schema for `groups`
+<a id="nestedblock--shared_with_accounts"></a>
+### Nested Schema for `shared_with_accounts`
 
 Required:
 
-- `group_id` (Number) The unique ID of the label.
-
-Optional:
-
-- `agents` (Block List) Define the ThousandEyes agents to use. (see [below for nested schema](#nestedblock--groups--agents))
-- `name` (String) The name of the label.
-- `tests` (Block List) The list of tests. (see [below for nested schema](#nestedblock--groups--tests))
-- `type` (String) [tests, agents, endpoint_tests, or endpoint_agents] The type of label.
+- `aid` (Number) The account group ID.
 
 Read-Only:
 
-- `builtin` (Boolean) Shows whether you are using built-in (true) labels or user-created (false) labels. Built-in labels are read-only.
-
-<a id="nestedblock--groups--agents"></a>
-### Nested Schema for `groups.agents`
-
-Optional:
-
-- `agent_id` (Number) The unique ThousandEyes agent ID.
+- `name` (String) Account name.
 
 
-<a id="nestedblock--groups--tests"></a>
-### Nested Schema for `groups.tests`
+<a id="nestedatt--api_links"></a>
+### Nested Schema for `api_links`
 
-Optional:
+Read-Only:
 
-- `test_id` (Number) The unique ID of the test.
+- `href` (String)
+- `rel` (String)
 
 
+<a id="nestedatt--groups"></a>
+### Nested Schema for `groups`
 
-<a id="nestedblock--shared_with_accounts"></a>
-### Nested Schema for `shared_with_accounts`
+Read-Only:
 
-Required:
+- `agents` (List of Object) (see [below for nested schema](#nestedobjatt--groups--agents))
+- `builtin` (Boolean)
+- `group_id` (Number)
+- `name` (String)
+- `tests` (List of Object) (see [below for nested schema](#nestedobjatt--groups--tests))
+- `type` (String)
 
-- `aid` (Number) The account group ID.
+<a id="nestedobjatt--groups--agents"></a>
+### Nested Schema for `groups.agents`
 
 Read-Only:
 
-- `name` (String) The name of account.
+- `agent_id` (Number)
 
 
-<a id="nestedatt--api_links"></a>
-### Nested Schema for `api_links`
+<a id="nestedobjatt--groups--tests"></a>
+### Nested Schema for `groups.tests`
 
 Read-Only:
 
-- `href` (String)
-- `rel` (String)
+- `test_id` (Number)
 
 
diff --git a/docs/resources/dns_server.md b/docs/resources/dns_server.md
@@ -49,7 +49,6 @@ resource "thousandeyes_dns_server" "example_dns_server_test" {
 - `description` (String) A description of the alert rule. Defaults to an empty string.
 - `dns_transport_protocol` (String) [UDP or TCP] The DNS transport protocol used for DNS requests. Defaults to UDP.
 - `enabled` (Boolean) Enables or disables the test.
-- `groups` (Block Set, Deprecated) The array of label objects. (see [below for nested schema](#nestedblock--groups))
 - `mtu_measurements` (Boolean) Measure MTU sizes on the network from agents to the target.
 - `network_measurements` (Boolean) Set to 'true' to enable network measurements.
 - `num_path_traces` (Number) The number of path traces.
@@ -65,6 +64,7 @@ resource "thousandeyes_dns_server" "example_dns_server_test" {
 - `api_links` (List of Object) Self links to the endpoint to pull test metadata, and data links to the endpoint for test data. Read-only, and shows rel and href elements. (see [below for nested schema](#nestedatt--api_links))
 - `created_by` (String) Created by user.
 - `created_date` (String) The date of creation.
+- `groups` (Set of Object) The array of label objects. (see [below for nested schema](#nestedatt--groups))
 - `id` (String) The ID of this resource.
 - `live_share` (Boolean) Set to 'true' for a test shared with your account group, or to 'false' for a normal test.
 - `modified_by` (String) Last modified by this user.
@@ -173,59 +173,52 @@ Optional:
 - `network` (String) The name of the autonomous system in which the BGP monitor is found.
 
 
-<a id="nestedblock--groups"></a>
-### Nested Schema for `groups`
+<a id="nestedblock--shared_with_accounts"></a>
+### Nested Schema for `shared_with_accounts`
 
 Required:
 
-- `group_id` (Number) The unique ID of the label.
-
-Optional:
-
-- `agents` (Block List) Define the ThousandEyes agents to use. (see [below for nested schema](#nestedblock--groups--agents))
-- `name` (String) The name of the label.
-- `tests` (Block List) The list of tests. (see [below for nested schema](#nestedblock--groups--tests))
-- `type` (String) [tests, agents, endpoint_tests, or endpoint_agents] The type of label.
+- `aid` (Number) The account group ID.
 
 Read-Only:
 
-- `builtin` (Boolean) Shows whether you are using built-in (true) labels or user-created (false) labels. Built-in labels are read-only.
+- `name` (String) Account name.
 
-<a id="nestedblock--groups--agents"></a>
-### Nested Schema for `groups.agents`
 
-Optional:
-
-- `agent_id` (Number) The unique ThousandEyes agent ID.
-
-
-<a id="nestedblock--groups--tests"></a>
-### Nested Schema for `groups.tests`
+<a id="nestedatt--api_links"></a>
+### Nested Schema for `api_links`
 
-Optional:
+Read-Only:
 
-- `test_id` (Number) The unique ID of the test.
+- `href` (String)
+- `rel` (String)
 
 
+<a id="nestedatt--groups"></a>
+### Nested Schema for `groups`
 
-<a id="nestedblock--shared_with_accounts"></a>
-### Nested Schema for `shared_with_accounts`
+Read-Only:
 
-Required:
+- `agents` (List of Object) (see [below for nested schema](#nestedobjatt--groups--agents))
+- `builtin` (Boolean)
+- `group_id` (Number)
+- `name` (String)
+- `tests` (List of Object) (see [below for nested schema](#nestedobjatt--groups--tests))
+- `type` (String)
 
-- `aid` (Number) The account group ID.
+<a id="nestedobjatt--groups--agents"></a>
+### Nested Schema for `groups.agents`
 
 Read-Only:
 
-- `name` (String) The name of account.
+- `agent_id` (Number)
 
 
-<a id="nestedatt--api_links"></a>
-### Nested Schema for `api_links`
+<a id="nestedobjatt--groups--tests"></a>
+### Nested Schema for `groups.tests`
 
 Read-Only:
 
-- `href` (String)
-- `rel` (String)
+- `test_id` (Number)