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

Jump to bottom

Add support for Proxy Read Timeout field in the Rulesets API #2755

Merged
merged 4 commits into from
Sep 15, 2023
Merged

Add support for Proxy Read Timeout field in the Rulesets API #2755

merged 4 commits into from
Sep 15, 2023

Conversation

iveelsm
Copy link

@iveelsm iveelsm commented Sep 11, 2023

No description provided.

@github-actions
Copy link

github-actions bot commented Sep 11, 2023 •
edited
Loading

changelog detected ✅

@iveelsm iveelsm force-pushed the mikey/proxy-read-timeout branch from bd6cf28 to 5de2d26 Compare September 11, 2023 01:01
jacobbednarz
jacobbednarz reviewed Sep 11, 2023
View reviewed changes
internal/framework/service/rulesets/schema.go Outdated
@@ -233,6 +233,10 @@ func (r *RulesetResource) Schema(ctx context.Context, req resource.SchemaRequest
Optional: true,
MarkdownDescription: fmt.Sprintf("Products to target with the actions. %s.", utils.RenderAvailableDocumentationValuesStringSlice(cloudflare.RulesetActionParameterProductValues())),
},
"proxy_read_timeout": schema.Int64Attribute{
Optional: true,
MarkdownDescription: "Specifies a maximum timeout for reading content from an origin server",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
MarkdownDescription: "Specifies a maximum timeout for reading content from an origin server",
MarkdownDescription: "Specifies a maximum timeout for reading content from an origin server.",

jacobbednarz
jacobbednarz reviewed Sep 11, 2023
View reviewed changes
docs/resources/ruleset.md Outdated
@@ -513,6 +513,7 @@ Optional:
- `phases` (Set of String) Point in the request/response lifecycle where the ruleset will be created. Available values: `ddos_l4`, `ddos_l7`, `http_config_settings`, `http_custom_errors`, `http_log_custom_fields`, `http_ratelimit`, `http_request_cache_settings`, `http_request_dynamic_redirect`, `http_request_firewall_custom`, `http_request_firewall_managed`, `http_request_late_transform`, `http_request_origin`, `http_request_redirect`, `http_request_sanitize`, `http_request_sbfm`, `http_request_transform`, `http_response_compression`, `http_response_firewall_managed`, `http_response_headers_transform`, `magic_transit`.
- `polish` (String) Apply options from the Polish feature of the Cloudflare Speed app.
- `products` (Set of String) Products to target with the actions. Available values: `bic`, `hot`, `ratelimit`, `securityLevel`, `uablock`, `waf`, `zonelockdown`.
- `proxy_read_timeout` (Int) Sets the timeout value for reading content from an origin server.
Copy link
Member

Choose a reason for hiding this comment

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

the documentation is generated automatically based on the schema description (see https://github.com/cloudflare/terraform-provider-cloudflare/blob/master/contributing/registry-documentation.md)

@jacobbednarz
Copy link
Member

this PR doesn't seem to introduce handling of the proxy_read_timeout attribute in either the API request or response. did you intend to? right now, this won't have any impact if someone was to provide it as an option.

@jacobbednarz jacobbednarz mentioned this pull request Sep 11, 2023
Closed
@iveelsm iveelsm force-pushed the mikey/proxy-read-timeout branch 3 times, most recently from ece860c to 125e894 Compare September 14, 2023 04:57
@iveelsm iveelsm force-pushed the mikey/proxy-read-timeout branch from 125e894 to 682760c Compare September 14, 2023 04:59
@jacobbednarz
Copy link
Member

acceptance tests all passing

TF_ACC=1 go test ./internal/framework/service/rulesets -v -run "^TestAccCloudflareRuleset_Cache" -count 1 -timeout 120m -parallel 1
=== RUN   TestAccCloudflareRuleset_CacheSettingsAllEnabled
--- PASS: TestAccCloudflareRuleset_CacheSettingsAllEnabled (12.59s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsOptionalsEmpty
--- PASS: TestAccCloudflareRuleset_CacheSettingsOptionalsEmpty (11.53s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsEdgeTTLRespectOrigin
--- PASS: TestAccCloudflareRuleset_CacheSettingsEdgeTTLRespectOrigin (11.88s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsNoCacheForStatus
--- PASS: TestAccCloudflareRuleset_CacheSettingsNoCacheForStatus (10.71s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsStatusRangeGreaterThan
--- PASS: TestAccCloudflareRuleset_CacheSettingsStatusRangeGreaterThan (10.71s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsStatusRangeLessThan
--- PASS: TestAccCloudflareRuleset_CacheSettingsStatusRangeLessThan (11.06s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsFalse
--- PASS: TestAccCloudflareRuleset_CacheSettingsFalse (10.77s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsMissingEdgeTTLWithOverrideOrigin
--- PASS: TestAccCloudflareRuleset_CacheSettingsMissingEdgeTTLWithOverrideOrigin (8.21s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsMissingBrowserTTLWithOverrideOrigin
--- PASS: TestAccCloudflareRuleset_CacheSettingsMissingBrowserTTLWithOverrideOrigin (7.49s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsInvalidEdgeTTLWithOverrideOrigin
--- PASS: TestAccCloudflareRuleset_CacheSettingsInvalidEdgeTTLWithOverrideOrigin (6.26s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsBrowserTTLWithBypass
--- PASS: TestAccCloudflareRuleset_CacheSettingsBrowserTTLWithBypass (10.74s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsInvalidBrowserTTLWithBypass
--- PASS: TestAccCloudflareRuleset_CacheSettingsInvalidBrowserTTLWithBypass (6.48s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsInvalidBrowserTTLWithOverrideOrigin
--- PASS: TestAccCloudflareRuleset_CacheSettingsInvalidBrowserTTLWithOverrideOrigin (7.38s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsDefinedQueryStringExcludeKeys
--- PASS: TestAccCloudflareRuleset_CacheSettingsDefinedQueryStringExcludeKeys (10.78s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsDefinedQueryStringIncludeKeys
--- PASS: TestAccCloudflareRuleset_CacheSettingsDefinedQueryStringIncludeKeys (10.98s)
=== RUN   TestAccCloudflareRuleset_CacheSettingsHandleDefaultHeaderExcludeOrigin
--- PASS: TestAccCloudflareRuleset_CacheSettingsHandleDefaultHeaderExcludeOrigin (16.83s)
PASS
ok  	github.com/cloudflare/terraform-provider-cloudflare/internal/framework/service/rulesets	165.091s

@jacobbednarz jacobbednarz merged commit a2fe8a2 into cloudflare:master Sep 15, 2023
@github-actions github-actions bot added this to the v4.15.0 milestone Sep 15, 2023
github-actions bot pushed a commit that referenced this pull request Sep 15, 2023
Update CHANGELOG.md for #2755
ce286ed
jacobbednarz added a commit that referenced this pull request Sep 15, 2023
@jacobbednarz
revert changes from #2755 for zone settings override
e41a876
@github-actions
Copy link

This functionality has been released in v4.15.0 of the Terraform Cloudflare 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 github-actions bot locked as resolved and limited conversation to collaborators Sep 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jacobbednarz jacobbednarz jacobbednarz left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v4.15.0
Development

Successfully merging this pull request may close these issues.
2 participants
@iveelsm @jacobbednarz