Deuxfleurs/garage
33
58
Fork 80
Code Issues 101 Pull requests 18 Releases 30 Wiki Activity

support redirection on s3 endpoint #910

Open
trinity-1686a wants to merge 9 commits from trinity-1686a/garage:1686a/s3-redirects into next-v2
pull from: trinity-1686a/garage:1686a/s3-redirects
merge into: Deuxfleurs:next-v2
Conversation 1 Commits 9 Files changed 8 +1048 -128
trinity-1686a commented 2024-12-14 16:58:15 +00:00
Owner
Copy link

fix #665
doesn't fix #547 directly, but allows for request routing with no condition, which in practice is the same, formulated differently in xml config

implement support for aws s3 routing rules which allow to redirect requests.
Also support server side redirect (not shown to user agent). This is inspired by netlify, and could be useful in some scenarios such as:

  • for 200, a single page application that interpret url path from the client side: otherwise it could change the url without reloading the page in a way that reloading the page would result in a 404
  • for 404 (in conjonction with a prefix, and a condition on return code), having different 404 pages for different situations, for instance a french 404 page for urls starting in /fr/, but a german page on urls starting in /de/
fix #665 doesn't fix #547 directly, but allows for request routing with no condition, which in practice is the same, formulated differently in xml config implement support for aws s3 routing rules which allow to redirect requests. Also support server side redirect (not shown to user agent). This is inspired by netlify, and could be useful in some scenarios such as: - for 200, a single page application that interpret url path from the client side: otherwise it could change the url without reloading the page in a way that reloading the page would result in a 404 - for 404 (in conjonction with a prefix, and a condition on return code), having different 404 pages for different situations, for instance a french 404 page for urls starting in /fr/, but a german page on urls starting in /de/
🎉 1
trinity-1686a added the
kind
improvement
 label 2024-12-14 16:58:15 +00:00
trinity-1686a added 1 commit 2024-12-14 16:58:15 +00:00
support redirection on s3 endpoint
Some checks failed
ci/woodpecker/pr/debug Pipeline failed
Details
c9b733a4a6
trinity-1686a added 2 commits 2024-12-22 14:26:10 +00:00
clippy
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Details
c939d2a936
lx added 1 commit 2025-01-04 16:06:02 +00:00
remove obsolete RedirectAll struct
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Details
6ccfbb2986
lx added 1 commit 2025-01-04 17:22:59 +00:00
move Redirect::compute_target to standalone function in web_server.rs
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Details
22487ceddf
lx added 1 commit 2025-01-04 17:51:05 +00:00
properly implement new bucket model using a migration
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Details
44ce6ae5b4
lx added 1 commit 2025-01-04 18:16:43 +00:00
put bucket website: improve error message for redirectallrequests
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Details
9b7fea4cb0
lx added 1 commit 2025-01-04 18:51:16 +00:00
avoid handling status_code-related logic in api/s3/get.rs
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Details
dde02b9678
lx force-pushed 1686a/s3-redirects from dde02b9678 to cd62450aeb 2025-01-04 18:52:05 +00:00 Compare
lx force-pushed 1686a/s3-redirects from cd62450aeb to 47467df83e 2025-01-04 18:52:20 +00:00 Compare
lx added 1 commit 2025-01-04 19:12:05 +00:00
refactor web_server.rs
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Details
2aaba39ddc
lx commented 2025-01-04 19:18:10 +00:00
Owner
Copy link

@trinity-1686a I pushed a few changes, could you review them ?

  • Revert changes in api/s3/get.rs and instead implement the status-code-specific logic in a new function handle_inner in web_server.rs. This makes the change less invasive and condenses the logic in a single place which IMO makes it easier to debug

  • Make the changes to the bucket table a migration to a v2 of the model. This means that this change will be released with Garage v2, and not earlier, because we expect all v1.x garage damons to be seamlessly compatible within a same cluster but with this change it cannot be the case.

@trinity-1686a I pushed a few changes, could you review them ? - Revert changes in api/s3/get.rs and instead implement the status-code-specific logic in a new function handle_inner in web_server.rs. This makes the change less invasive and condenses the logic in a single place which IMO makes it easier to debug - Make the changes to the bucket table a migration to a v2 of the model. This means that this change will be released with Garage v2, and not earlier, because we expect all v1.x garage damons to be seamlessly compatible within a same cluster but with this change it cannot be the case.
lx changed target branch from main to next-v2 2025-01-04 19:21:19 +00:00
lx added this to the v2.0 milestone 2025-01-27 12:53:09 +00:00
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Details
This pull request has changes conflicting with the target branch.
  • src/api/admin/bucket.rs
  • src/api/s3/website.rs
  • src/garage/admin/bucket.rs
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 1686a/s3-redirects:trinity-1686a-1686a/s3-redirects
git checkout trinity-1686a-1686a/s3-redirects

Merge

Merge the changes and update on Forgejo.
git checkout next-v2
git merge --no-ff trinity-1686a-1686a/s3-redirects
git checkout trinity-1686a-1686a/s3-redirects
git rebase next-v2
git checkout next-v2
git merge --ff-only trinity-1686a-1686a/s3-redirects
git checkout trinity-1686a-1686a/s3-redirects
git rebase next-v2
git checkout next-v2
git merge --no-ff trinity-1686a-1686a/s3-redirects
git checkout next-v2
git merge --squash trinity-1686a-1686a/s3-redirects
git checkout next-v2
git merge --ff-only trinity-1686a-1686a/s3-redirects
git checkout next-v2
git merge trinity-1686a-1686a/s3-redirects
git push origin next-v2
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
action
check-aws
The behaviour should be checked against AWS S3

  
action
discussion-needed
We need to discuss if the feature is desirable and/or better specify the envisioned behavior or technical implementation

  
action
for-external-contributors
Core team does not plan working on this in the near future however an external contribution will be reviewed & merged

  
action
for-newcomers
An issue that should be newcomer friendly.

  
action
more-info-needed
More information is needed to investigate this issue

  
action
need-funding
This issue represents lots of work, we need to find money to pay our core team work

  
action
triage-required
It's not very clear what we want to do with this issue yet, more thoughts is required

  
kind
correctness
Issues of theoretical correctness that may impact edge-case scenarios

  
kind
ideas
For abstract ideas/proposal to make Garage better, to better communicate our not yet achieved aims

  
kind
improvement
Feature requests that do not fall in other categories

  
kind
performance
Deceptive performance observed OR idea to improve performances

  
kind
testing
Functional tests, integration tests, Jepsen, etc.

  
kind
usability
Propositions to make Garage easier to operate, by improving error reporting, CLI, etc.

  
kind
wrong-behavior
Unintended behavior

  
prio
critical
Could impact integrity or availability of production clusters

  
prio
low
For issues that we don't want to spend time on until made absolutely necessary

  
scope
admin-api
Issues concerning the administration API

  
scope
background-healing
Background healing covers repair tasks, anti-entropy, merkle trees, etc. ; everything related to replicating data appropriately.

  
scope
build
Issues with Nix, Drone, Rust Compiler, etc.

  
scope
documentation

  
scope
k8s
Kubernetes related, including Helm Charts

  
scope
layout
Linked to the cluster layout and storage management

  
scope
metadata
Metadata Engine (LMDB, sqlite, etc.)

  
scope
ops
Operations related to operations/maintenance issue, tooling related (like CLI missing info ; impossible, too dangerous, too complicated migration, etc.)

  
scope
rpc
Linked to RPC

  
scope
s3-api
Related to the S3 API (especially compatibility issues).

  
scope
security
Cryptography-related, auth-related, authorization-related issues

  
scope
telemetry
OpenTelemetry (traces, metrics, etc.)

No labels
action
check-aws
action
discussion-needed
action
for-external-contributors
action
for-newcomers
action
more-info-needed
action
need-funding
action
triage-required
kind
correctness
kind
ideas
kind
improvement
kind
performance
kind
testing
kind
usability
kind
wrong-behavior
prio
critical
prio
low
scope
admin-api
scope
background-healing
scope
build
scope
documentation
scope
k8s
scope
layout
scope
metadata
scope
ops
scope
rpc
scope
s3-api
scope
security
scope
telemetry
Milestone
Clear milestone
No items
No milestone
v2.0
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Deuxfleurs/garage#910
No description provided.
Delete branch "trinity-1686a/garage:1686a/s3-redirects"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?