Update documentation on GCS bundles #6264
Conversation
When an object in GCS contains special characters such as slashes (/) these need to be url-encoded in the configuration. If not, the bundle will not be found. e.g. `bundles/bundle.tar.gz` should be entered as `bundles%2fbundle.tar.gz` This PR adds a small note to help the reader know about this. Signed-off-by: Dennis Geurts <dennisg@dennisg.nl>
dennisg
changed the title
✅ Deploy Preview for openpolicyagent ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Dennis Geurts <dennisg@dennisg.nl>
docs/content/management-bundles.md
Outdated
| @@ -941,6 +941,9 @@ bundles: | |||
| resource: 'bundle.tar.gz?alt=media' | |||
| ``` | |||
|
|
|||
| If the resource (the object in the gcs bucket) contains slashes (/) or other special characters, these need to be url-encoded here, e.g. | |||
| `bundles/bundle.tar.gz?alt=media` should be entered as `bundles%2fbundle.tar.gz?alt=media`. | |||
There was a problem hiding this comment.
A link to https://cloud.google.com/storage/docs/request-endpoints#encoding would be good here.
There was a problem hiding this comment.
thanks, I added the link
| @@ -631,13 +631,15 @@ services: | |||
| bundles: | |||
| authz: | |||
| service: gcs | |||
| resource: 'bundle.tar.gz?alt=media' | |||
| resource: 'bundles%2fhttp%2fexample%2fbundle.tar.gz?alt=media' | |||
There was a problem hiding this comment.
I don't think think the resource name should be changed just for the sake of using encoding. The previous example on line 500 is enough to do that, IMHO.
There was a problem hiding this comment.
Ok, I did that specifically because the Cloud Run example above actually uses the same resource as I mention here; there the encoding is not required. This, to me, drives home better the distinction between both types of GCP resources. But of course, we can change this back to the original.
There was a problem hiding this comment.
No, that's fine. Thanks for helping out with the docs!
Signed-off-by: Dennis Geurts <dennisg@dennisg.nl>
When an object in GCS contains special characters such as slashes (/) these need to be url-encoded in the configuration. If not, the bundle will not be found.
e.g.
bundles/bundle.tar.gzshould be entered asbundles%2fbundle.tar.gzThis PR adds notes to help the reader know about this and corrects some existing (IMHO incorrect) documentation.
Why the changes in this PR are needed?
I tried to add a bundle using GCS (with a bundle in a subfolder) and stumbled upon the fact myself. Took me some time
to figure it out. I hope this helps the next reader of this part of the documentation.
What are the changes in this PR?
Just some notes were added to the documentation regarding GCS bundles, some other parts were corrected.
Notes to assist PR review:
Personally, I think this is enough. If preferred, though, we could elaborate a little more on it and e.g. link to
the GCS documentation page.
Further comments:
relevant GCS docs: https://cloud.google.com/storage/docs/request-endpoints#encoding