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.

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

bid_percentage docs don't match console UI instructions #21691

Closed
carlowahlstedt opened this issue Nov 9, 2021 · 3 comments · Fixed by #21695
Closed

bid_percentage docs don't match console UI instructions #21691

carlowahlstedt opened this issue Nov 9, 2021 · 3 comments · Fixed by #21695
Labels
documentation Introduces or discusses updates to documentation. service/batch Issues and PRs that pertain to the batch service.
Milestone

Comments

@carlowahlstedt
Copy link

carlowahlstedt commented Nov 9, 2021

The docs for bid_percentage say:

bid_percentage - (Optional) Integer of minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20% (20), then the Spot price must be below 20% of the current On-Demand price for that EC2 instance. This parameter is required for SPOT compute environments. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

However the console UI says:

The maximum percentage of On-Demand pricing you want to pay for Spot resources. You will always pay the lowest Spot market price and never more than your maximum percentage. AWS Batch will use 100% as the default maximum price if you leave this field empty.
image

These seem to be opposite of one another and since the console behavior is the source of truth, the tf docs here should be updated to be in line with the console.

@github-actions github-actions bot added the needs-triage Waiting for first response or review from a maintainer. label Nov 9, 2021
@justinretzolk justinretzolk added documentation Introduces or discusses updates to documentation. service/batch Issues and PRs that pertain to the batch service. and removed needs-triage Waiting for first response or review from a maintainer. labels Nov 9, 2021
@justinretzolk
Copy link
Member

justinretzolk commented Nov 9, 2021

Hey @carlowahlstedt 👋 Thank you for taking the time to open this issue and for bringing this to our attention! Looking over the Go SDK documentation, it looks like you're completely right:

// The maximum percentage that a Spot Instance price can be when compared with
// the On-Demand price for that instance type before instances are launched.
// For example, if your maximum percentage is 20%, then the Spot price must
// be less than 20% of the current On-Demand price for that Amazon EC2 instance.
// You always pay the lowest (market) price and never more than your maximum
// percentage. If you leave this field empty, the default value is 100% of the
// On-Demand price.
//
// This parameter isn't applicable to jobs that are running on Fargate resources,
// and shouldn't be specified.

I'll work on a pull request to get this updated (edit: I submitted the PR before this comment, but you get the picture 😛)

@github-actions github-actions bot added this to the v3.65.0 milestone Nov 9, 2021
@github-actions
Copy link

This functionality has been released in v3.65.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

@github-actions
Copy link

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Introduces or discusses updates to documentation. service/batch Issues and PRs that pertain to the batch service.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants