[fix](doc) clarify type vs provider naming on CREATE-STORAGE-VAULT pages#3748
Open
boluor wants to merge 1 commit into
Open
[fix](doc) clarify type vs provider naming on CREATE-STORAGE-VAULT pages#3748boluor wants to merge 1 commit into
boluor wants to merge 1 commit into
Conversation
Issue apache#3124 reports that every non-HDFS example in the CREATE-STORAGE-VAULT docs uses `"type" = "S3"` and `s3.access_key` / `s3.secret_key`, which looks contradictory for OSS / COS / OBS / BOS / MinIO / Azure / GCP vaults. It is not a bug. The FE `StorageVaultType` enum (`fe/fe-core/src/main/java/org/apache/doris/catalog/StorageVault.java`) defines only two values: `S3` and `HDFS` (verified identical in `branch-3.0`, `branch-3.1`, `branch-4.0`, `branch-4.1`). All object-storage backends are accessed via Doris's S3-compatible client and pick the actual cloud through the separate `provider` property; the `s3.*` property prefix follows the same S3-API convention and is not literally about AWS S3. Add a `:::note` admonition right before the `### S3 Vault` parameters table on all 6 pages (current/3.x/4.x EN + zh) so first-time readers don't read the identical-looking examples as a copy-paste error. Closes apache#3124
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #3124. The reporter pointed out that every non-HDFS example on the `CREATE-STORAGE-VAULT` page uses `"type" = "S3"` and `s3.access_key` / `s3.secret_key` — for OSS, COS, OBS, BOS, MinIO, Azure Blob, and GCS — which reads as a copy-paste mistake.
It is not a bug. The FE `StorageVaultType` enum at `fe/fe-core/src/main/java/org/apache/doris/catalog/StorageVault.java` defines only two values, `S3` and `HDFS` (verified identical on `branch-3.0`, `branch-3.1`, `branch-4.0`, `branch-4.1`). All object-storage backends speak to Doris through the S3-compatible client; the actual cloud is selected by the separate `provider` property (`COS`, `OSS`, `S3`, `OBS`, `BOS`, `AZURE`, `GCP`). The `s3.*` property prefix follows the same S3-API convention and is not literally about AWS S3.
This PR adds a `:::note` admonition immediately before the `### S3 Vault` parameters table on all six maintained pages (current/3.x/4.x EN + zh), so first-time readers don't read the examples as duplicated.
Scope
6 files, +24 lines, +0 lines removed:
No changes to existing examples or parameter tables. `version-2.1` does not have the storage-vault feature so no edit needed there.
Test plan
Closes #3124