This is an automated email from the ASF dual-hosted git repository. yuqi1129 pushed a commit to branch fileset-hide-credential-properties-11642 in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to
refs/heads/fileset-hide-credential-properties-11642 by this push:
new 89d21ab23f fix docs
89d21ab23f is described below
commit 89d21ab23fe3be533e2ff4d10b18ec1ffa6023c0
Author: yuqi <[email protected]>
AuthorDate: Fri Jun 26 19:36:47 2026 +0800
fix docs
---
docs/how-to-use-gvfs.md | 54 ++++++++++++++++++++++++-------------------------
1 file changed, 27 insertions(+), 27 deletions(-)
diff --git a/docs/how-to-use-gvfs.md b/docs/how-to-use-gvfs.md
index e0ba98829f..846b882a95 100644
--- a/docs/how-to-use-gvfs.md
+++ b/docs/how-to-use-gvfs.md
@@ -46,33 +46,33 @@ the path mapping and convert automatically.
### Configuration
-| Configuration item | Description
| Default value
| Required [...]
-|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|---------
[...]
-| `fs.AbstractFileSystem.gvfs.impl` | The Gravitino
Virtual File System abstract class, set it to
`org.apache.gravitino.filesystem.hadoop.Gvfs`.
| (none)
| Yes [...]
-| `fs.gvfs.impl` | The Gravitino
Virtual File System implementation class, set it to
`org.apache.gravitino.filesystem.hadoop.GravitinoVirtualFileSystem`.
| (none)
| Yes [...]
-| `fs.gvfs.impl.disable.cache` | Disable the
Gravitino Virtual File System cache in the Hadoop environment. If you need to
proxy multi-user operations, set this value to `true` and create a separate
File System for each user.
| `false`
| No [...]
-| `fs.gravitino.server.uri` | The Gravitino server
URI which GVFS needs to load the fileset metadata.
| (none)
| Yes [...]
-| `fs.gravitino.client.metalake` | The metalake to
which the fileset belongs.
| (none)
| Yes [...]
-| `fs.gravitino.client.authType` | The auth type the
Gravitino client uses with the Gravitino Virtual File System. Supports
`simple`, `oauth2`, and `kerberos`.
| `simple`
| No [...]
-| `fs.gravitino.client.oauth2.serverUri` | The auth server URI
for the Gravitino client when using `oauth2` auth type with the Gravitino
Virtual File System.
| (none)
| Yes if y [...]
-| `fs.gravitino.client.oauth2.credential` | The auth credential
for the Gravitino client when using `oauth2` auth type in the Gravitino Virtual
File System.
| (none)
| Yes if y [...]
-| `fs.gravitino.client.oauth2.path` | The auth server path
for the Gravitino client when using `oauth2` auth type with the Gravitino
Virtual File System. Please remove the first slash `/` from the path, for
example `oauth/token`.
| (none)
| Yes if y [...]
-| `fs.gravitino.client.oauth2.scope` | The auth scope for
the Gravitino client when using `oauth2` auth type with the Gravitino Virtual
File System.
| (none)
| Yes if y [...]
-| `fs.gravitino.client.kerberos.principal` | The auth principal
for the Gravitino client when using `kerberos` auth type with the Gravitino
Virtual File System.
| (none)
| Yes if y [...]
-| `fs.gravitino.client.kerberos.keytabFilePath` | The auth keytab file
path for the Gravitino client when using `kerberos` auth type in the Gravitino
Virtual File System.
| (none)
| No [...]
-| `fs.gravitino.fileset.cache.maxCapacity` | The cache capacity
of the Gravitino Virtual File System.
| `20`
| No [...]
-| `fs.gravitino.fileset.cache.evictionMillsAfterAccess` | The value of time
that the cache expires after accessing in the Gravitino Virtual File System.
The value is in `milliseconds`.
| `3600000`
| No [...]
-| `fs.gravitino.fileset.cache.closeOnEviction` | Whether to close the
underlying FileSystem immediately on cache eviction. Default is `false`: close
is deferred to GVFS shutdown to avoid breaking long-lived streams. Set to
`true` to fall back to the legacy behaviour (closing immediately on eviction).
| `false`
| No [...]
-| `fs.gravitino.current.location.name` | The configuration
used to select the location of the fileset. If this configuration is not set,
the value of environment variable configured by
`fs.gravitino.current.location.name.env.var` will be checked. If neither is
set, the value of fileset property `default-location-name` will be used as the
location name. | the value of
fileset property `default-location-name` | No [...]
-| `fs.gravitino.current.location.name.env.var` | The environment
variable name to get the current location name.
| `CURRENT_LOCATION_NAME`
| No [...]
-| `fs.gravitino.operations.class` | The operations class
to provide the FS operations for the Gravitino Virtual File System. Users can
extends `BaseGVFSOperations` to implement their own operations and configure
the class name in this conf to use custom FS operations.
|
`org.apache.gravitino.filesystem.hadoop.DefaultGVFSOperations` | No [...]
-| `fs.gravitino.hook.class` | The hook class to
inject into the <br/>Gravitino Virtual File System. Users can implement their
own `GravitinoVirtualFileSystemHook` and configure the class name in this conf
to inject custom code.
| `org.apache.gravitino.filesystem.hadoop.NoOpHook`
| No [...]
-| `fs.gravitino.client.request.header.` | The configuration
key prefix for the Gravitino client request header. You can set the request
header for the Gravitino client.
| (none)
| No [...]
-| `fs.gravitino.enableCredentialVending` | Whether to enable
credential vending for the Gravitino Virtual File System. Credential vending
and client-configured storage credentials are mutually exclusive: when set to
`true`, the server-vended credentials are used and any client-configured
storage credentials are ignored; when set to `false`, you must configure your
own storage credentials on the client, otherwise access will fail.
[...]
-| `fs.gravitino.client.` | The configuration
key prefix for the Gravitino client config.
| (none)
| No [...]
-| `fs.gravitino.filesetMetadataCache.enable` | Whether to cache the
fileset, fileset schema or fileset catalog metadata in the Gravitino Virtual
File System. Note that this cache causes a side effect: if you modify the
fileset or fileset catalog metadata, the client cannot see the latest changes.
| `false`
| No [...]
-| `fs.gravitino.autoCreateLocation` | The configuration
key for whether to enable auto-creation of fileset location when the
server-side filesystem ops are disabled and the location does not exist.
| `true`
| No [...]
-| `fs.path.config.<name>` | Defines a logical
location entry. Set `fs.path.config.<name>` to the real base URI (for example,
`hdfs://cluster1/`). Any key that starts with the same prefix (such as
`fs.path.config.<name>.config.resource`) is treated as a location-scoped
property and will be forwarded to the underlying filesystem client. Note:
location names must not contain (`.`, `_`). | (none)
| No [...]
+| Configuration item | Description
| Default value
[...]
+|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------
[...]
+| `fs.AbstractFileSystem.gvfs.impl` | The Gravitino
Virtual File System abstract class, set it to
`org.apache.gravitino.filesystem.hadoop.Gvfs`.
| (none) [...]
+| `fs.gvfs.impl` | The Gravitino
Virtual File System implementation class, set it to
`org.apache.gravitino.filesystem.hadoop.GravitinoVirtualFileSystem`.
| (none) [...]
+| `fs.gvfs.impl.disable.cache` | Disable the
Gravitino Virtual File System cache in the Hadoop environment. If you need to
proxy multi-user operations, set this value to `true` and create a separate
File System for each user.
| `false`
[...]
+| `fs.gravitino.server.uri` | The Gravitino server
URI which GVFS needs to load the fileset metadata.
| (none)
[...]
+| `fs.gravitino.client.metalake` | The metalake to
which the fileset belongs.
| (none)
[...]
+| `fs.gravitino.client.authType` | The auth type the
Gravitino client uses with the Gravitino Virtual File System. Supports
`simple`, `oauth2`, and `kerberos`.
| `simple`
[...]
+| `fs.gravitino.client.oauth2.serverUri` | The auth server URI
for the Gravitino client when using `oauth2` auth type with the Gravitino
Virtual File System.
| (none)
[...]
+| `fs.gravitino.client.oauth2.credential` | The auth credential
for the Gravitino client when using `oauth2` auth type in the Gravitino Virtual
File System.
| (none)
[...]
+| `fs.gravitino.client.oauth2.path` | The auth server path
for the Gravitino client when using `oauth2` auth type with the Gravitino
Virtual File System. Please remove the first slash `/` from the path, for
example `oauth/token`.
| (none)
[...]
+| `fs.gravitino.client.oauth2.scope` | The auth scope for
the Gravitino client when using `oauth2` auth type with the Gravitino Virtual
File System.
| (none)
[...]
+| `fs.gravitino.client.kerberos.principal` | The auth principal
for the Gravitino client when using `kerberos` auth type with the Gravitino
Virtual File System.
| (none)
[...]
+| `fs.gravitino.client.kerberos.keytabFilePath` | The auth keytab file
path for the Gravitino client when using `kerberos` auth type in the Gravitino
Virtual File System.
| (none)
[...]
+| `fs.gravitino.fileset.cache.maxCapacity` | The cache capacity
of the Gravitino Virtual File System.
| `20`
[...]
+| `fs.gravitino.fileset.cache.evictionMillsAfterAccess` | The value of time
that the cache expires after accessing in the Gravitino Virtual File System.
The value is in `milliseconds`.
| `3600000`
[...]
+| `fs.gravitino.fileset.cache.closeOnEviction` | Whether to close the
underlying FileSystem immediately on cache eviction. Default is `false`: close
is deferred to GVFS shutdown to avoid breaking long-lived streams. Set to
`true` to fall back to the legacy behaviour (closing immediately on eviction).
| `false`
[...]
+| `fs.gravitino.current.location.name` | The configuration
used to select the location of the fileset. If this configuration is not set,
the value of environment variable configured by
`fs.gravitino.current.location.name.env.var` will be checked. If neither is
set, the value of fileset property `default-location-name` will be used as the
location name.
| the value of fileset property `default-lo [...]
+| `fs.gravitino.current.location.name.env.var` | The environment
variable name to get the current location name.
|
`CURRENT_LOCATION_NAME` [...]
+| `fs.gravitino.operations.class` | The operations class
to provide the FS operations for the Gravitino Virtual File System. Users can
extends `BaseGVFSOperations` to implement their own operations and configure
the class name in this conf to use custom FS operations.
|
`org.apache.gravitino.filesystem.hadoop.D [...]
+| `fs.gravitino.hook.class` | The hook class to
inject into the <br/>Gravitino Virtual File System. Users can implement their
own `GravitinoVirtualFileSystemHook` and configure the class name in this conf
to inject custom code.
|
`org.apache.gravitino.filesystem.hadoop.N [...]
+| `fs.gravitino.client.request.header.` | The configuration
key prefix for the Gravitino client request header. You can set the request
header for the Gravitino client.
| (none)
[...]
+| `fs.gravitino.enableCredentialVending` | Whether to enable
credential vending for the Gravitino Virtual File System. Credential vending
and client-configured storage credentials are mutually exclusive: when set to
`true`, the server-vended credentials are used and any client-configured
storage credentials are ignored; when set to `false`, you must configure your
own storage credentials on the client, otherwise access will fail. | `false`
[...]
+| `fs.gravitino.client.` | The configuration
key prefix for the Gravitino client config.
| (none)
[...]
+| `fs.gravitino.filesetMetadataCache.enable` | Whether to cache the
fileset, fileset schema or fileset catalog metadata in the Gravitino Virtual
File System. Note that this cache causes a side effect: if you modify the
fileset or fileset catalog metadata, the client cannot see the latest changes.
| `false`
[...]
+| `fs.gravitino.autoCreateLocation` | The configuration
key for whether to enable auto-creation of fileset location when the
server-side filesystem ops are disabled and the location does not exist.
| `true`
[...]
+| `fs.path.config.<name>` | Defines a logical
location entry. Set `fs.path.config.<name>` to the real base URI (for example,
`hdfs://cluster1/`). Any key that starts with the same prefix (such as
`fs.path.config.<name>.config.resource`) is treated as a location-scoped
property and will be forwarded to the underlying filesystem client. Note:
location names must not contain (`.`, `_`). |
(none) [...]
To configure the Gravitino client, use properties prefixed with
`fs.gravitino.client.`. These properties will be passed to the Gravitino client
after removing the `fs.` prefix.
