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: add a field to disable the auto mutation of endpoints to S3 com… #733

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

arkbriar
Copy link
Collaborator

…patible services

What's changed and what's your intention?

PLEASE DO NOT LEAVE THIS EMPTY !!!

Please explain IN DETAIL what the changes are in this PR and why they are needed:

At the time of writing, RisingWave will automatically mutate the endpoint to a virtual hosted style. It's a bit confusing and will cause problems when a user is using a S3 compatible service that doesn't support accessing with virtual hosted style endpoints.

The PR adds a field disableAutomaticVirtualHostStyle under the spec.stateStore.s3 to let the user decide when to disable the automatic change of style. Recommended ways to explicitly set the styles are as follows.

# path style
spec:
  stateStore:
    s3:
      endpoint: https://xxxx
      disableAutomaticVirtualHostStyle: true

# virtual hosted style, replace ${BUCKET} manually or leave it there. 
# In the latter one, it will be automatically replaced by the operator.
spec:
  stateStore:
    s3:
      endpoint: https://${BUCKET}.xxxx
      disableAutomaticVirtualHostStyle: true

The field takes effect by setting environment variable RW_IS_FORCE_PATH_STYLE=true in containers.

Checklist

  • I have written the necessary docs and comments
  • I have added necessary unit tests and integration tests

Refer to a related PR or issue link (optional)

@arkbriar arkbriar requested a review from a team as a code owner October 11, 2024 09:26
Copy link

codecov bot commented Oct 11, 2024

Codecov Report

Attention: Patch coverage is 33.33333% with 12 lines in your changes missing coverage. Please review.

Project coverage is 55.36%. Comparing base (4cda32b) to head (7fcbd20).

Files with missing lines Patch % Lines
pkg/factory/risingwave_object_factory.go 46.15% 6 Missing and 1 partial ⚠️
apis/risingwave/v1alpha1/zz_generated.deepcopy.go 0.00% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #733      +/-   ##
==========================================
- Coverage   55.43%   55.36%   -0.08%     
==========================================
  Files          40       40              
  Lines        6757     6772      +15     
==========================================
+ Hits         3746     3749       +3     
- Misses       2884     2895      +11     
- Partials      127      128       +1     
Flag Coverage Δ
unittests 55.36% <33.33%> (-0.08%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant