Skip to content

Commit

Permalink
Update everything such that runtime groups become control planes
Browse files Browse the repository at this point in the history
  • Loading branch information
scastrianni committed Jan 5, 2024
1 parent 0133367 commit 6fe83a4
Show file tree
Hide file tree
Showing 36 changed files with 240 additions and 226 deletions.
10 changes: 5 additions & 5 deletions docs/data-sources/consumer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ subcategory: "Runtime Configuration"
Represents a consumer
## Example usage
```hcl
data "konnect_runtime_group" "RuntimeGroup" {
name = "TestRuntimeGroup"
data "konnect_control_plane" "ControlPlane" {
name = "TestControlPlane"
}
data "konnect_consumer" "example" {
runtime_group_id = data.konnect_runtime_group.RuntimeGroup.id
control_plane_id = data.konnect_control_plane.ControlPlane.id
search_username = "Bob"
}
```
## Argument Reference
* `runtime_group_id` - **(Required, String)** The id of the runtime group containing consumer
* `control_plane_id` - **(Required, String)** The id of the control plane containing consumer
* `search_username` - **(Optional, String)** The search string to apply to the username of the consumer. Uses contains.
* `username` - **(Optional, String)** The filter string to apply to the username of the consumer. Uses equality.
* `search_custom_id` - **(Optional, String)** The search string to apply to the custom_id of the consumer. Uses contains.
* `custom_id` - **(Optional, String)** The filter string to apply to the custom_id of the consumer. Uses equality.
## Attribute Reference
* `id` - **(String)** Same as `runtime_group_id`:`consumer_id`
* `id` - **(String)** Same as `control_plane_id`:`consumer_id`
* `consumer_id` - **(String)** Id of the consumer alone
16 changes: 8 additions & 8 deletions docs/data-sources/nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@
subcategory: "Runtime Configuration"
---
# Data Source: konnect_nodes
Represents all nodes of a runtime group
Represents all nodes of a control plane
## Example usage
```hcl
data "konnect_runtime_group" "RuntimeGroup" {
name = "TestRuntimeGroup"
data "konnect_control_plane" "ControlPlane" {
name = "TestControlPlane"
}
data "konnect_nodes" "example" {
runtime_group_id = data.konnect_runtime_group.RuntimeGroup.id
control_plane_id = data.konnect_control_plane.ControlPlane.id
}
```
## Argument Reference
* `runtime_group_id` - **(Required, String)** The id of the parent runtime group.
* `control_plane_id` - **(Required, String)** The id of the parent control plane.
## Attribute Reference
* `id` - **(String)** Same as `runtime_group_id`
* `nodes` - **(set{node})** Set of nodes belonging to runtime group
* `id` - **(String)** Same as `control_plane_id`
* `nodes` - **(set{node})** Set of nodes belonging to control plane
### node
* `id` - **(String)** Id of node.
* `version` - **(String)** Version of node.
* `hostname` - **(String)** Hostname of node.
* `last_ping` - **(Integer)** Last time of ping of node.
* `type` - **(String)** Type of node.
* `config_hash` - **(String)** Hash of the current configuration state of node.
* `data_plane_cert_id` - **(String)** Id of certificate used in communication between node and runtime group.
* `data_plane_cert_id` - **(String)** Id of certificate used in communication between node and control plane.
4 changes: 2 additions & 2 deletions docs/data-sources/role.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ Represents a role
## Example usage
```hcl
data "konnect_role" "example" {
entity_type_display_name = "Runtime Groups"
entity_type_display_name = "Control Planes"
display_name = "Admin"
}
```
## Argument Reference
* `entity_type_display_name` - **(Required, String)** The display name of the role entity type. Must be `Runtime Groups` or `Services`
* `entity_type_display_name` - **(Required, String)** The display name of the role entity type. Must be `Control Planes` or `Services`
* `display_name` - **(Required, String)** The display name of the Role. Uses equality.
## Attribute Reference
* `id` - **(String)** Same as `entity_type_name`:`name`
Expand Down
20 changes: 10 additions & 10 deletions docs/data-sources/runtime_group.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
subcategory: "Runtime Configuration"
---
# Data Source: konnect_runtime_group
Represents a runtime group
# Data Source: konnect_control_plane
Represents a control plane
## Example usage
```hcl
data "konnect_runtime_group" "example" {
name = "TestRuntimeGroup"
data "konnect_control_plane" "example" {
name = "TestControlPlane"
}
```
## Argument Reference
* `search_name` - **(Optional, String)** The search string to apply to the name of the runtime group. Uses contains.
* `name` - **(Optional, String)** The filter string to apply to the name of the runtime group. Uses equality.
* `search_name` - **(Optional, String)** The search string to apply to the name of the control plane. Uses contains.
* `name` - **(Optional, String)** The filter string to apply to the name of the control plane. Uses equality.
## Attribute Reference
* `id` - **(String)** Guid
* `description` - **(String)** The description of the runtime group.
* `cluster_type` - **(String)** The cluster type of the runtime group.
* `control_plane_endpoint` - **(String)** The control plane endpoint URL of the runtime group.
* `telemetry_endpoint` - **(String)** The telemetry endpoint URL of the runtime group.
* `description` - **(String)** The description of the control plane.
* `cluster_type` - **(String)** The cluster type of the control plane.
* `control_plane_endpoint` - **(String)** The control plane endpoint URL of the control plane.
* `telemetry_endpoint` - **(String)** The telemetry endpoint URL of the control plane.
6 changes: 3 additions & 3 deletions docs/data-sources/team_role.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ data "konnect_team" "Team" {
}
data "konnect_team_role" "example" {
team_id = data.konnect_team.Team.id
entity_type_display_name = "Runtime Groups"
entity_type_display_name = "Control Planes"
}
```
## Argument Reference
* `team_id` - **(Required, String)** The id of the team assigned the role
* `search_role_display_name` - **(Optional, String)** The search string to apply to the display name of the role. Uses contains.
* `role_display_name` - **(Optional, String)** The filter string to apply to the display name of the role. Uses equality.
* `search_entity_type_display_name` - **(Optional, String)** The search string to apply to the display name of the entity type, like `Runtime Groups` or `Services`. Uses contains.
* `entity_type_display_name` - **(Optional, String)** The filter string to apply to the display name of the entity type. Must be `Runtime Groups` or `Services`. Uses equality.
* `search_entity_type_display_name` - **(Optional, String)** The search string to apply to the display name of the entity type, like `Control Planes` or `Services`. Uses contains.
* `entity_type_display_name` - **(Optional, String)** The filter string to apply to the display name of the entity type. Must be `Control Planes` or `Services`. Uses equality.
## Attribute Reference
* `id` - **(String)** Same as `team_id`:`Guid of role assignment`
* `entity_id` - **(String)** The id of the entity for which the role applies.
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/user_role.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ data "konnect_user" "User" {
}
data "konnect_user_role" "example" {
user_id = data.konnect_user.User.id
entity_type_display_name = "Runtime Groups"
entity_type_display_name = "Control Planes"
}
```
## Argument Reference
* `user_id` - **(Required, String)** The id of the user assigned the role
* `search_role_display_name` - **(Optional, String)** The search string to apply to the display name of the role. Uses contains.
* `role_display_name` - **(Optional, String)** The filter string to apply to the display name of the role. Uses equality.
* `search_entity_type_display_name` - **(Optional, String)** The search string to apply to the display name of the entity type, like `Runtime Groups` or `Services`. Uses contains.
* `entity_type_display_name` - **(Optional, String)** The filter string to apply to the display name of the entity type. Must be `Runtime Groups` or `Services`. Uses equality.
* `search_entity_type_display_name` - **(Optional, String)** The search string to apply to the display name of the entity type, like `Control Planes` or `Services`. Uses contains.
* `entity_type_display_name` - **(Optional, String)** The filter string to apply to the display name of the entity type. Must be `Control Planes` or `Services`. Uses equality.
## Attribute Reference
* `id` - **(String)** Same as `user_id`:`Guid of role assignment`
* `entity_id` - **(String)** The id of the entity for which the role applies.
Expand Down
12 changes: 6 additions & 6 deletions docs/resources/consumer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@
subcategory: "Runtime Configuration"
---
# Resource: konnect_consumer
Represents a consumer within a runtime group
Represents a consumer within a control plane
## Example usage
```hcl
data "konnect_runtime_group" "RuntimeGroup" {
name = "TestRuntimeGroup"
data "konnect_control_plane" "ControlPlane" {
name = "TestControlPlane"
}
resource "konnect_consumer" "example" {
runtime_group_id = data.konnect_runtime_group.RuntimeGroup.id
control_plane_id = data.konnect_control_plane.ControlPlane.id
username = "testuser"
custom_id = "testcustom"
}
```
## Argument Reference
* `runtime_group_id` - **(Required, String)** The id of the runtime group.
* `control_plane_id` - **(Required, String)** The id of the control plane.
* `username` - **(Optional, String)** The unique username of the Consumer.
* `custom_id` - **(Optional, String)** Field for storing an existing unique ID for the Consumer.
## Attribute Reference
* `id` - **(String)** Same as `runtime_group_id`:`consumer_id`
* `id` - **(String)** Same as `control_plane_id`:`consumer_id`
* `consumer_id` - **(String)** Id of the consumer alone
## Import
Consumers can be imported using a proper value of `id` as described above
12 changes: 6 additions & 6 deletions docs/resources/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
subcategory: "Runtime Configuration"
---
# Resource: konnect_plugin
Represents a plugin within a runtime group
Represents a plugin within a control plane
## Example usage
```hcl
data "konnect_runtime_group" "RuntimeGroup" {
name = "TestRuntimeGroup"
data "konnect_control_plane" "ControlPlane" {
name = "TestControlPlane"
}
resource "konnect_plugin" "example" {
runtime_group_id = data.konnect_runtime_group.RuntimeGroup.id
control_plane_id = data.konnect_control_plane.ControlPlane.id
name = "rate-limiting"
config_json = <<EOF
{
Expand All @@ -19,7 +19,7 @@ EOF
}
```
## Argument Reference
* `runtime_group_id` - **(Required, String)** The id of the runtime group.
* `control_plane_id` - **(Required, String)** The id of the control plane.
* `name` - **(Required, String)** The name of the plugin which must match a valid installed plugin.
* `instance_name` - **(Optional, String)** The instance name of the plugin. Default: `-`
* `protocols` - **(Optional, List of String)** A list of the request protocols that will trigger this plugin. Allowed values: `grpc`, `grpcs`, `http`, `https`, `tcp`, `tls`, `tls_passthrough`, `udp`, `ws`, `wss`
Expand All @@ -29,7 +29,7 @@ EOF
* `route_id` - **(Optional, String)** If set, the plugin will only activate when receiving requests via the specified route.
* `consumer_id` - **(Optional, String)** If set, the plugin will activate only for requests where the specified consumer has been authenticated.
## Attribute Reference
* `id` - **(String)** Same as `runtime_group_id`:`plugin_id`
* `id` - **(String)** Same as `control_plane_id`:`plugin_id`
* `plugin_id` - **(String)** Id of the plugin alone
* `config_all_json` - **(JSON)** The full configuration properties for the plugin, including all properties with their default values not specified in `config`.
## Import
Expand Down
14 changes: 7 additions & 7 deletions docs/resources/route.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@
subcategory: "Runtime Configuration"
---
# Resource: konnect_route
Represents a route within a runtime group
Represents a route within a control plane
## Example usage
```hcl
data "konnect_runtime_group" "RuntimeGroup" {
name = "TestRuntimeGroup"
data "konnect_control_plane" "ControlPlane" {
name = "TestControlPlane"
}
resource "konnect_service" "Service" {
runtime_group_id = data.konnect_runtime_group.RuntimeGroup.id
control_plane_id = data.konnect_control_plane.ControlPlane.id
host = "mockbin.org"
name = "Test"
}
resource "konnect_route" "example" {
runtime_group_id = data.konnect_runtime_group.RuntimeGroup.id
control_plane_id = data.konnect_control_plane.ControlPlane.id
service_id = konnect_service.Service.service_id
name = "Test"
protocols = ["http"]
Expand All @@ -26,7 +26,7 @@ resource "konnect_route" "example" {
}
```
## Argument Reference
* `runtime_group_id` - **(Required, String)** The id of the runtime group.
* `control_plane_id` - **(Required, String)** The id of the control plane.
* `service_id` - **(Optional, String)** The id of the service to forward traffic to.
* `name` - **(Optional, String)** The name of the route.
* `protocols` - **(Optional, List of String)** The protocols this route should allow. Allowed values: `http`, `https`
Expand All @@ -45,7 +45,7 @@ resource "konnect_route" "example" {
* `name` - **(Required, String)** Name of header this route should require.
* `values` - **(Required, List of String)** Allowed values this header should equal.
## Attribute Reference
* `id` - **(String)** Same as `runtime_group_id`:`route_id`
* `id` - **(String)** Same as `control_plane_id`:`route_id`
* `route_id` - **(String)** Id of the route alone
## Import
Routes can be imported using a proper value of `id` as described above
22 changes: 11 additions & 11 deletions docs/resources/runtime_group.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
subcategory: "Runtime Configuration"
---
# Resource: konnect_runtime_group
Represents a runtime group
# Resource: konnect_control_plane
Represents a control plane
## Example usage
```hcl
resource "konnect_runtime_group" "example" {
name = "TestRuntimeGroup"
description = "TestRuntimeGroup"
resource "konnect_control_plane" "example" {
name = "TestControlPlane"
description = "TestControlPlane"
}
```
## Argument Reference
* `name` - **(Required, String)** The name of the runtime group.
* `description` - **(Optional, String)** The description of the runtime group.
* `name` - **(Required, String)** The name of the control plane.
* `description` - **(Optional, String)** The description of the control plane.
## Attribute Reference
* `id` - **(String)** Guid
* `cluster_type` - **(String)** The cluster type of the runtime group.
* `control_plane_endpoint` - **(String)** The control plane endpoint URL of the runtime group.
* `telemetry_endpoint` - **(String)** The telemetry endpoint URL of the runtime group.
* `cluster_type` - **(String)** The cluster type of the control plane.
* `control_plane_endpoint` - **(String)** The control plane endpoint URL of the control plane.
* `telemetry_endpoint` - **(String)** The telemetry endpoint URL of the control plane.
## Import
Runtime groups can be imported using a proper value of `id` as described above
Control planes can be imported using a proper value of `id` as described above
12 changes: 6 additions & 6 deletions docs/resources/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@
subcategory: "Runtime Configuration"
---
# Resource: konnect_service
Represents a service within a runtime group
Represents a service within a control plane
## Example usage
```hcl
data "konnect_runtime_group" "RuntimeGroup" {
name = "TestRuntimeGroup"
data "konnect_control_plane" "ControlPlane" {
name = "TestControlPlane"
}
resource "konnect_service" "example" {
runtime_group_id = data.konnect_runtime_group.RuntimeGroup.id
control_plane_id = data.konnect_control_plane.ControlPlane.id
host = "mockbin.org"
name = "Test"
}
```
## Argument Reference
* `runtime_group_id` - **(Required, String)** The id of the runtime group.
* `control_plane_id` - **(Required, String)** The id of the control plane.
* `host` - **(Required, String)** The host of the service.
* `name` - **(Optional, String)** The name of the service.
* `retries` - **(Optional, Integer)** The number of retries to execute upon failure to proxy. Default: `5`
Expand All @@ -27,7 +27,7 @@ resource "konnect_service" "example" {
* `write_timeout` - **(Optional, Integer)** The timeout in milliseconds between two successive write operations for transmitting a request to the host. Default: `60000`
* `enabled` - **(Optional, Boolean)** Whether the service is active. Default: `true`
## Attribute Reference
* `id` - **(String)** Same as `runtime_group_id`:`service_id`
* `id` - **(String)** Same as `control_plane_id`:`service_id`
* `service_id` - **(String)** Id of the service alone
## Import
Services can be imported using a proper value of `id` as described above
10 changes: 5 additions & 5 deletions docs/resources/team_role.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,25 @@ resource "konnect_team" "Team" {
description = "testing"
}
data "konnect_role" "Role" {
group_display_name = "Runtime Groups"
group_display_name = "Control Planes"
display_name = "Admin"
}
resource "konnect_runtime_group" "RuntimeGroup" {
resource "konnect_control_plane" "ControlPlane" {
name = "TestRG"
description = "testing"
}
resource "konnect_team_role" "example" {
team_id = konnect_team.Team.id
entity_id = konnect_runtime_group.RuntimeGroup.id
entity_type_display_name = "Runtime Groups"
entity_id = konnect_control_plane.ControlPlane.id
entity_type_display_name = "Control Planes"
entity_region = "us"
role_display_name = data.konnect_role.Role.display_name
}
```
## Argument Reference
* `team_id` - **(Required, ForceNew, String)** The id of the team assigned the role
* `role_display_name` - **(Required, ForceNew, String)** The display name of the role.
* `entity_type_display_name` - **(Required, ForceNew, String)** The display name of the entity type, like `Runtime Groups` or `Services`.
* `entity_type_display_name` - **(Required, ForceNew, String)** The display name of the entity type, like `Control Planes` or `Services`.
* `entity_id` - **(Required, ForceNew, String)** The id of the entity for which the role applies.
* `entity_region` - **(Required, ForceNew, String)** The region of the entity for which the role applies.
## Attribute Reference
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/user_role.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,25 @@ resource "konnect_user" "User" {
preferred_name = "Joe"
}
data "konnect_role" "Role" {
group_display_name = "Runtime Groups"
group_display_name = "Control Planes"
display_name = "Admin"
}
resource "konnect_runtime_group" "RuntimeGroup" {
resource "konnect_control_plane" "ControlPlane" {
name = "TestRG"
description = "testing"
}
resource "konnect_user_role" "example" {
user_id = konnect_user.User.id
entity_id = konnect_runtime_group.RuntimeGroup.id
entity_type_display_name = "Runtime Groups"
entity_id = konnect_control_plane.ControlPlane.id
entity_type_display_name = "Control Planes"
entity_region = "us"
role_display_name = data.konnect_role.Role.display_name
}
```
## Argument Reference
* `user_id` - **(Required, ForceNew, String)** The id of the user assigned the role
* `role_display_name` - **(Required, ForceNew, String)** The display name of the role.
* `entity_type_display_name` - **(Required, ForceNew, String)** The display name of the entity type, like `Runtime Groups` or `Services`.
* `entity_type_display_name` - **(Required, ForceNew, String)** The display name of the entity type, like `Control Planes` or `Services`.
* `entity_id` - **(Required, ForceNew, String)** The id of the entity for which the role applies.
* `entity_region` - **(Required, ForceNew, String)** The region of the entity for which the role applies.
## Attribute Reference
Expand Down
Loading

0 comments on commit 6fe83a4

Please sign in to comment.