Skip to content

Commit

Permalink
[Minor] fix(docs): Fix mistakes in docs about the example of S3 files…
Browse files Browse the repository at this point in the history
…et. (#5466)

### What changes were proposed in this pull request?

Fix s3 fileset example that uses "oss:/" prefix mistakenly. 

### Why are the changes needed?

It's a mistake. 

### Does this PR introduce _any_ user-facing change?

N/A.

### How was this patch tested?

N/A

Co-authored-by: Qi Yu <[email protected]>
  • Loading branch information
github-actions[bot] and yuqi1129 authored Nov 5, 2024
1 parent ebe820c commit 661c5c9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions docs/how-to-use-gvfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ At the same time, you need to place the corresponding bundle jar [`gravitino-aws

#### GCS fileset

| Configuration item | Description | Default value | Required | Since version |
|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---------------------------|--------------------|
| `fs.gvfs.filesystem.providers` | The file system providers to add. Set it to `gs` if it's a GCS fileset, or a comma separated string that contains `gs` like `gs,s3` to support multiple kinds of fileset including `gs`. | (none) | Yes if it's a GCS fileset.| 0.7.0-incubating |
| `gcs-service-account-file` | The path of GCS service account JSON file. | (none) | Yes if it's a GCS fileset.| 0.7.0-incubating |
| Configuration item | Description | Default value | Required | Since version |
|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---------------------------|------------------|
| `fs.gvfs.filesystem.providers` | The file system providers to add. Set it to `gs` if it's a GCS fileset, or a comma separated string that contains `gs` like `gs,s3` to support multiple kinds of fileset including `gs`. | (none) | Yes if it's a GCS fileset.| 0.7.0-incubating |
| `gcs-service-account-file` | The path of GCS service account JSON file. | (none) | Yes if it's a GCS fileset.| 0.7.0-incubating |

In the meantime, you need to place the corresponding bundle jar [`gravitino-gcp-bundle-${version}.jar`](https://repo1.maven.org/maven2/org/apache/gravitino/gcp-bundle/) in the Hadoop environment(typically located in `${HADOOP_HOME}/share/hadoop/common/lib/`).

Expand Down
12 changes: 6 additions & 6 deletions docs/manage-fileset-metadata-using-gravitino.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ curl -X POST -H "Accept: application/vnd.gravitino.v1+json" \
"comment": "comment",
"provider": "hadoop",
"properties": {
"location": "oss:/bucket/root",
"location": "s3a://bucket/root",
"s3-access-key-id": "access_key",
"s3-secret-access-key": "secret_key",
"s3-endpoint": "http://oss-cn-hangzhou.aliyuncs.com",
"s3-endpoint": "http://s3.ap-northeast-1.amazonaws.com",
"filesystem-providers": "s3"
}
}' http://localhost:8090/api/metalakes/metalake/catalogs
Expand Down Expand Up @@ -93,10 +93,10 @@ Catalog catalog = gravitinoClient.createCatalog("catalog",

// create a S3 catalog
s3Properties = ImmutableMap.<String, String>builder()
.put("location", "oss:/bucket/root")
.put("location", "s3a://bucket/root")
.put("s3-access-key-id", "access_key")
.put("s3-secret-access-key", "secret_key")
.put("s3-endpoint", "http://oss-cn-hangzhou.aliyuncs.com")
.put("s3-endpoint", "http://s3.ap-northeast-1.amazonaws.com")
.put("filesystem-providers", "s3")
.build();

Expand All @@ -121,10 +121,10 @@ catalog = gravitino_client.create_catalog(name="catalog",

# create a S3 catalog
s3_properties = {
"location": "oss:/bucket/root",
"location": "s3a://bucket/root",
"s3-access-key-id": "access_key"
"s3-secret-access-key": "secret_key",
"s3-endpoint": "http://oss-cn-hangzhou.aliyuncs.com"
"s3-endpoint": "http://s3.ap-northeast-1.amazonaws.com"
}

s3_catalog = gravitino_client.create_catalog(name="catalog",
Expand Down

0 comments on commit 661c5c9

Please sign in to comment.