shbhmrzd commented on code in PR #3933:
URL:
https://github.com/apache/incubator-opendal/pull/3933#discussion_r1445792824
##########
core/src/services/hdfs_native/docs.md:
##########
@@ -0,0 +1,82 @@
+A distributed file system that provides high-throughput access to application
data.
+
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [ ] copy
+- [x] rename
+- [x] list
+- [ ] ~~scan~~
+- [ ] ~~presign~~
+- [x] blocking
+- [x] append
+
+## Differences with webhdfs
+
+[Webhdfs][crate::services::Webhdfs] is powered by hdfs's RESTful HTTP API.
+
+## Features
+
+Native HDFS support needs to enable feature `services-native-hdfs`.
+
+## Configuration
+
+- `root`: Set the work dir for backend.
+- `name_node`: Set the name node for backend.
+- `enable_append`: enable the append capacity. Default is false.
+
+Refer to [`HdfsNativeBuilder`]'s public API docs for more information.
+
+## Environment
+
+If HDFS has High Availability (HA) enabled with multiple available NameNodes,
some configuration is required:
+1. Obtain the entire HDFS config folder (usually located at
HADOOP_HOME/etc/hadoop).
+2. Set the environment variable HADOOP_CONF_DIR to the path of this folder.
+```shell
+export HADOOP_CONF_DIR=<path of the config folder>
+```
+3. Use the `cluster_name` specified in the `core-site.xml` file (located in
the HADOOP_CONF_DIR folder) to replace namenode:port.
+
+```rust
+builder.name_node("hdfs://cluster_name");
+```
+
+## Example
+
+### Via Builder
+
+```rust
+use std::sync::Arc;
+
+use anyhow::Result;
+use opendal::services::Hdfs;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+ // Create native hdfs backend builder.
+ let mut builder = HdfsNative::default();
Review Comment:
Sure, let me remove it
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
