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

Issue with documentation. cloudflare_authenticated_origin_pulls / cloudflare_authenticated_origin_pulls_certificate #2733

Closed
2 tasks done
BenCoughlan15 opened this issue Sep 4, 2023 · 3 comments · Fixed by #2771
Labels
kind/bug Categorizes issue or PR as related to a bug. triage/needs-information Indicates an issue needs more information in order to work on it.
Milestone

Comments

@BenCoughlan15
Copy link

Confirmation

  • My issue isn't already found on the issue tracker.
  • I have replicated my issue using the latest version of the provider and it is still present.

Terraform and Cloudflare provider version

Cloudflare: 4.13.0

Terraform 1.5.0

Affected resource(s)

Hey, the docs at least misleading or incorrect in both of these.

cloudflare_authenticated_origin_pulls
cloudflare_authenticated_origin_pulls_certificate

in both resources, the import refers to cloudflare_authenticated_origin_pulls_certificate

does certificate-type refer to the type field in the resource? i.e.

[type](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/authenticated_origin_pulls_certificate#type) (String) The form of Authenticated Origin Pulls to upload the certificate to. Available values: per-zone, per-hostname. Modifying this attribute will force creation of a new resource.

I think this could do with being cleaned up, or clarified.

Terraform configuration files

# Authenticated Origin Pulls
resource "cloudflare_authenticated_origin_pulls" "my_aop" {
  zone_id = "0da42c8d2132a9ddaf714f9e7c920711"
  enabled = true
}

# Per-Zone Authenticated Origin Pulls
resource "cloudflare_authenticated_origin_pulls_certificate" "my_per_zone_aop_cert" {
  zone_id     = "0da42c8d2132a9ddaf714f9e7c920711"
  certificate = "-----INSERT CERTIFICATE-----"
  private_key = "-----INSERT PRIVATE KEY-----"
  type        = "per-zone"
}

Link to debug output

4.13.0

Panic output

none

Expected output

none, it's just bad docs.

Actual output

none, it's just bad docs.

Steps to reproduce

see: https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/authenticated_origin_pulls

Additional factoids

none, it's just bad docs.

References

https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/authenticated_origin_pulls

@BenCoughlan15 BenCoughlan15 added kind/bug Categorizes issue or PR as related to a bug. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Sep 4, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2023

Community Note

Voting for Prioritization

  • Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

  • If you are interested in working on this issue, please leave a comment.
  • If this would be your first contribution, please review the contribution guide.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2023

Thank you for reporting this issue! For maintainers to dig into issues it is required that all issues include the entirety of TF_LOG=DEBUG output to be provided. The only parts that should be redacted are your user credentials in the X-Auth-Key, X-Auth-Email and Authorization HTTP headers. Details such as zone or account identifiers are not considered sensitive but can be redacted if you are very cautious. This log file provides additional context from Terraform, the provider and the Cloudflare API that helps in debugging issues. Without it, maintainers are very limited in what they can do and may hamper diagnosis efforts.

This issue has been marked with triage/needs-information and is unlikely to receive maintainer attention until the log file is provided making this a complete bug report.

@github-actions github-actions bot added triage/needs-information Indicates an issue needs more information in order to work on it. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Sep 4, 2023
@jacobbednarz jacobbednarz added this to the v4.16.0 milestone Sep 20, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 3, 2023

This functionality has been released in v4.16.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 Oct 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/bug Categorizes issue or PR as related to a bug. triage/needs-information Indicates an issue needs more information in order to work on it.
Projects
None yet
2 participants