Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify usage of min/max throughput and instances #10130

Merged
merged 3 commits into from
Mar 21, 2024
Merged

Clarify usage of min/max throughput and instances #10130

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
64eaf3c
Clarify usage of min/max throughput and instances
jashansudan Mar 6, 2024
5cc20c2
fix lint
jashansudan Mar 6, 2024
b9864cd
fix snake casing
jashansudan Mar 18, 2024
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
15 changes: 11 additions & 4 deletions mmv1/products/vpcaccess/Connector.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,27 +106,34 @@ properties:
- !ruby/object:Api::Type::Integer
name: minThroughput
description: |
Minimum throughput of the connector in Mbps. Default and min is 200.
Minimum throughput of the connector in Mbps. Default and min is 200. Refers to the expected throughput when using an e2-micro machine type.
Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by maxThroughput. If both minThroughput and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: From Terraform's perspective, these fields are snake cased (ie. max_throughput)

minInstances are provided, minInstances takes precedence over minThroughput. The use of minThroughput is discouraged in favor of minInstances.
default_value: 200
validation: !ruby/object:Provider::Terraform::Validation
function: 'validation.IntBetween(200, 1000)'
- !ruby/object:Api::Type::Integer
name: minInstances
description: |
Minimum value of instances in autoscaling group underlying the connector.
Minimum value of instances in autoscaling group underlying the connector. Value must be between 2 and 9, inclusive. Must be
lower than the value specified by maxInstances.
default_from_api: true
- !ruby/object:Api::Type::Integer
name: maxInstances
description: |
Maximum value of instances in autoscaling group underlying the connector.
Maximum value of instances in autoscaling group underlying the connector. Value must be between 3 and 10, inclusive. Must be
higher than the value specified by minInstances.
default_from_api: true
- !ruby/object:Api::Type::Integer
name: maxThroughput
# The API documentation says this will default to 200, but when I tried that I got an error that the minimum
# throughput must be lower than the maximum. The console defaults to 1000, so I changed it to that.
# API returns 300 if it is not sent
description: |
Maximum throughput of the connector in Mbps, must be greater than `min_throughput`. Default is 300.
Maximum throughput of the connector in Mbps, must be greater than `min_throughput`. Default is 300. Refers to the expected throughput
when using an e2-micro machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by
minThroughput. If both maxThroughput and maxInstances are provided, maxInstances takes precedence over maxThroughput. The use of
maxThroughput is discouraged in favor of maxInstances.
default_value: 300
validation: !ruby/object:Provider::Terraform::Validation
function: 'validation.IntBetween(200, 1000)'
Expand Down