docs(flyte-binary): clarify s3 endpoint for compatible stores - #7735
Conversation
Signed-off-by: Gonzalo Peña-Castellanos <goanpeca@gmail.com>
There was a problem hiding this comment.
Pull request overview
Clarifies how to set configuration.storage.providerConfig.s3.endpoint in the flyte-binary Helm chart so users correctly configure S3-compatible object stores while leaving the value empty for Amazon S3.
Changes:
- Expanded the inline comment above
configuration.storage.providerConfig.s3.endpointto specify it should be empty for Amazon S3. - Added examples of S3-compatible providers and an example endpoint URL shape.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
pingsutw
left a comment
There was a problem hiding this comment.
Thanks for updating it. Is it ready to review?
|
Yes, ready for review, thanks for the ping @pingsutw. Marked it out of draft. For context on the change: |
Why are the changes needed?
configuration.storage.providerConfig.s3.endpointalready drives the stow S3endpointconfig key (seecharts/flyte-binary/templates/configmap.yaml), which is what lets a deployment point its metadata and user-data buckets at an S3-compatible object store instead of Amazon S3. The current one-line comment, "URL of S3-compatible service", does not say that the value stays empty for Amazon S3, and does not show what shape the value takes, so it is easy to guess wrong (bare hostname vs full URL) on a first install. The devbox chart already relies on this key for a non-AWS store (charts/flyte-devbox/values.yaml), so the behavior is established and this only documents it.What changes were proposed in this pull request?
Two comment lines above
endpointincharts/flyte-binary/values.yaml, following the existing two-linev2Signingcomment style a few lines above: leave it empty for Amazon S3, otherwise set the provider URL, with an example URL shape and a few S3-compatible stores named as examples.No values, templates, or defaults change.
How was this patch tested?
No tests were added, since the change is comment-only. Two local checks:
helm-docs --chart-search-root=charts/flyte-binarywith helm-docs v1.8.0 installed viago install, matching.github/workflows/check-helm-docs.yml, regeneratescharts/flyte-binary/README.mdwith no diff. These are plain comments, not helm-docs# --comments, so the generated table is unaffected.values.yamlparsed withyaml.safe_loadand compared againstmain: the resulting tree is identical, so rendered manifests are unchanged.Labels
changed
Check all the applicable boxes