-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(kafka_quota): added support for kafka quota
- Loading branch information
Showing
15 changed files
with
1,498 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "aiven_kafka_quota Resource - terraform-provider-aiven" | ||
| subcategory: "" | ||
| description: |- | ||
| Creates and manages quotas for an Aiven for Apache Kafka® service user. | ||
| --- | ||
|
|
||
| # aiven_kafka_quota (Resource) | ||
|
|
||
| Creates and manages quotas for an Aiven for Apache Kafka® service user. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| resource "aiven_kafka_quota" "example_quota" { | ||
| project = data.aiven_project.foo.project | ||
| service_name = aiven_kafka.example_kafka.service_name | ||
| user = "example-kafka-user" | ||
| client_id = "example_client" | ||
| consumer_byte_rate = 1000 | ||
| producer_byte_rate = 1000 | ||
| request_percentage = 50 | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `project` (String) The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. | ||
| - `service_name` (String) The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. | ||
|
|
||
| ### Optional | ||
|
|
||
| - `client_id` (String) Represents a logical group of clients, assigned a unique name by the client application. | ||
| Quotas can be applied based on user, client-id, or both. | ||
| The most relevant quota is chosen for each connection. | ||
| All connections within a quota group share the same quota. | ||
| It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default' | ||
| - `consumer_byte_rate` (Number) Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. | ||
| Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. | ||
| Exceeding this limit results in client throttling. | ||
| - `producer_byte_rate` (Number) Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. | ||
| Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. | ||
| Exceeding this limit results in client throttling. | ||
| - `request_percentage` (Number) Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. | ||
| Exceeding this limit triggers throttling. | ||
| The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota. | ||
| - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) | ||
| - `user` (String) Represents a logical group of clients, assigned a unique name by the client application. | ||
| Quotas can be applied based on user, client-id, or both. | ||
| The most relevant quota is chosen for each connection. | ||
| All connections within a quota group share the same quota. | ||
| It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default' | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) The ID of this resource. | ||
|
|
||
| <a id="nestedblock--timeouts"></a> | ||
| ### Nested Schema for `timeouts` | ||
|
|
||
| Optional: | ||
|
|
||
| - `create` (String) | ||
| - `default` (String) | ||
| - `delete` (String) | ||
| - `read` (String) | ||
| - `update` (String) | ||
|
|
||
| ## Import | ||
|
|
||
| Import is supported using the following syntax: | ||
|
|
||
| ```shell | ||
| # When both USER and CLIENT_ID are specified | ||
| terraform import aiven_kafka_quota.example_quota PROJECT/SERVICE_NAME/CLIENT_ID/USER | ||
| # When only USER is specified | ||
| terraform import aiven_kafka_quota.example_quota PROJECT/SERVICE_NAME//USER | ||
| # When only CLIENT_ID is specified | ||
| terraform import aiven_kafka_quota.example_quota PROJECT/SERVICE_NAME/CLIENT_ID/ | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # When both USER and CLIENT_ID are specified | ||
| terraform import aiven_kafka_quota.example_quota PROJECT/SERVICE_NAME/CLIENT_ID/USER | ||
| # When only USER is specified | ||
| terraform import aiven_kafka_quota.example_quota PROJECT/SERVICE_NAME//USER | ||
| # When only CLIENT_ID is specified | ||
| terraform import aiven_kafka_quota.example_quota PROJECT/SERVICE_NAME/CLIENT_ID/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| resource "aiven_kafka_quota" "example_quota" { | ||
| project = data.aiven_project.foo.project | ||
| service_name = aiven_kafka.example_kafka.service_name | ||
| user = "example-kafka-user" | ||
| client_id = "example_client" | ||
| consumer_byte_rate = 1000 | ||
| producer_byte_rate = 1000 | ||
| request_percentage = 50 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| package acctest | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| tfjson "github.com/hashicorp/terraform-json" | ||
| "github.com/hashicorp/terraform-plugin-testing/plancheck" | ||
| ) | ||
|
|
||
| type attributeChangeCheck struct { | ||
| resourceAddr string | ||
| attrs []string | ||
| } | ||
|
|
||
| func ExpectOnlyAttributesChanged(resourceAddr string, attrs ...string) plancheck.PlanCheck { | ||
| return &attributeChangeCheck{ | ||
| resourceAddr: resourceAddr, | ||
| attrs: attrs, | ||
| } | ||
| } | ||
|
|
||
| func (c *attributeChangeCheck) CheckPlan(_ context.Context, req plancheck.CheckPlanRequest, resp *plancheck.CheckPlanResponse) { | ||
| var targetResource *tfjson.ResourceChange | ||
|
|
||
| // Find our resource in the changes | ||
| for _, rc := range req.Plan.ResourceChanges { | ||
| if rc.Address == c.resourceAddr { | ||
| targetResource = rc | ||
| break | ||
| } | ||
| } | ||
|
|
||
| if targetResource == nil { | ||
| resp.Error = fmt.Errorf("resource %s not found in plan", c.resourceAddr) | ||
| return | ||
| } | ||
|
|
||
| if targetResource.Change == nil { | ||
| resp.Error = fmt.Errorf("no changes found for resource %s", c.resourceAddr) | ||
| return | ||
| } | ||
|
|
||
| // Convert Before and After to maps | ||
| before, ok := targetResource.Change.Before.(map[string]interface{}) | ||
| if !ok { | ||
| resp.Error = fmt.Errorf("before state for resource %s is not a map", c.resourceAddr) | ||
| return | ||
| } | ||
|
|
||
| after, ok := targetResource.Change.After.(map[string]interface{}) | ||
| if !ok { | ||
| resp.Error = fmt.Errorf("after state for resource %s is not a map", c.resourceAddr) | ||
|
|
||
| return | ||
| } | ||
|
|
||
| // Create a set of expected changes | ||
| expectedChanges := make(map[string]struct{}) | ||
| for _, attr := range c.attrs { | ||
| expectedChanges[attr] = struct{}{} | ||
| } | ||
|
|
||
| // Check all attributes in the after state | ||
| for key, afterValue := range after { | ||
| beforeValue, existsInBefore := before[key] | ||
|
|
||
| // If value changed | ||
| if !existsInBefore || beforeValue != afterValue { | ||
| // Check if this change was expected | ||
| if _, expected := expectedChanges[key]; !expected { | ||
| resp.Error = fmt.Errorf( | ||
| "unexpected change in attribute %q for resource %s: before=%v, after=%v", | ||
| key, | ||
| c.resourceAddr, | ||
| beforeValue, | ||
| afterValue, | ||
| ) | ||
| return | ||
| } | ||
| // Remove from expected changes as we found it | ||
| delete(expectedChanges, key) | ||
| } | ||
| } | ||
|
|
||
| // Check if all expected changes were found | ||
| if len(expectedChanges) > 0 { | ||
| remaining := make([]string, 0, len(expectedChanges)) | ||
| for attr := range expectedChanges { | ||
| remaining = append(remaining, attr) | ||
| } | ||
| resp.Error = fmt.Errorf( | ||
| "expected changes in attributes %v for resource %s were not found in plan", | ||
| remaining, | ||
| c.resourceAddr, | ||
| ) | ||
| } | ||
| } |
Oops, something went wrong.