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

feat: adds OriginRequest field to UnvalidatedIngressRule struct. #1138

Merged
merged 3 commits into from May 23, 2023

Conversation

keitap
Copy link
Contributor

@keitap keitap commented Dec 3, 2022

Description

Add OriginRequest field to UnvalidatedIngressRule struct documented here.
Fixes: #1098

I'm aware #1099 but it seems like not active so I created this.

Has your change been tested?

Yes

Types of changes

What sort of change does your code introduce/modify?

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • This change is using publicly documented (api.cloudflare.com or developers.cloudflare.com) and stable APIs.

Signed-off-by: keita <keitap@gmail.com>
Signed-off-by: keita <keitap@gmail.com>
@github-actions
Copy link
Contributor

github-actions bot commented Dec 3, 2022

changelog detected ✅

Hostname string `json:"hostname,omitempty"`
Path string `json:"path,omitempty"`
Service string `json:"service,omitempty"`
OriginRequest *OriginRequestConfig `json:"originRequest,omitempty"`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jacobbednarz Should I make a new struct like IngressOriginRequestConfig since I believe ingress.originRequest is not identical to top-level originRequest?

https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/local/local-management/ingress/#origin-configuration

@keitap
Copy link
Contributor Author

keitap commented Dec 12, 2022

@jacobbednarz If not satisfied any requirements, let me know.

@hatemosphere
Copy link

@jacobbednarz any chances to get this one rolling? i think a lot of people were waiting for this issue cloudflare/terraform-provider-cloudflare#1756 to be resolved, but apparently, the solution to this feature in Terraform provider is still not usable because of the inability to configure the origin requests for ingress rules...

@keitap
Copy link
Contributor Author

keitap commented Dec 22, 2022

@jacobbednarz I thought it is publicly documented here. Is it not sufficient or beta feature?
https://api.cloudflare.com/#cloudflare-tunnel-configuration-put-configuration

It would be helpful if you could tell me what exactly is needed so that next time I don't send a pull request that doesn't meet your requirements :)

@jacobbednarz
Copy link
Member

I thought it is publicly documented here. Is it not sufficient or beta feature?
https://api.cloudflare.com/#cloudflare-tunnel-configuration-put-configuration

The example is not public documentation that implies a stable API contract. The attributes, their types and what their description are missing.

It would be helpful if you could tell me what exactly is needed so that next time I don't send a pull request that doesn't meet your requirements :)

This is the same issue that has was mentioned in #1099 and why it hasn't been merged or picked up again. We don't yet have public documentation so it won't land in our SDKs that rely on a stable interface.

@keitap
Copy link
Contributor Author

keitap commented Dec 22, 2022

@jacobbednarz config parameter is JSON in JSON and its schema is documented here.
I understood it might be changed to attributes and strict types when it is stable though.

Do you know when it will be stable, by the way?

@hatemosphere
Copy link

@jacobbednarz sorry, but who is responsible for the documentation and how to push them while being an enterprise CF customer? the amount of bureaucracy is just ridiculous, the feature is there, it's blocking other long awaited tunnel config feature in Terraform provider, but since for some reason some other party who is not even here and not in context can't update the docs for X months, we can't get it implemented to finally be able to properly/fully cover CF ZT tunnels with IaC

@jacobbednarz
Copy link
Member

@hatemosphere you can speak with your account team who can track the priority of the documentation changes against the teams' backlog.

@asychev
Copy link

asychev commented Feb 23, 2023

This is really important, how we can move this forward?

@stefanhenseler
Copy link

@jacobbednarz I'm also an enterprise customer, and this is also blocking us. Do you have any news on when this can be merged and used?

@codecov-commenter
Copy link

Codecov Report

Merging #1138 (b58dc47) into master (a5dc232) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1138   +/-   ##
=======================================
  Coverage   49.07%   49.07%           
=======================================
  Files         134      134           
  Lines       13091    13091           
=======================================
  Hits         6425     6425           
  Misses       5162     5162           
  Partials     1504     1504           
Impacted Files Coverage Δ
dns.go 45.05% <ø> (ø)
tunnel.go 41.39% <ø> (ø)

@jacobbednarz jacobbednarz mentioned this pull request May 23, 2023
9 tasks
@jacobbednarz jacobbednarz merged commit f24f822 into cloudflare:master May 23, 2023
11 checks passed
@github-actions github-actions bot added this to the v0.68.0 milestone May 23, 2023
github-actions bot pushed a commit that referenced this pull request May 23, 2023
@github-actions
Copy link
Contributor

This functionality has been released in v0.68.0.

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

@keitap keitap deleted the update_tunnel_config branch May 24, 2023 14:13
@cloudflare cloudflare deleted a comment from keitap May 25, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update TunnelConfig Responses in documentation as well as in SDK
6 participants