This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/ozone-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new c4aa68f4 [auto] Generated docs from Apache Ozone master
f30870f2a229a2a618f3199aa047d3397e77a9cd
c4aa68f4 is described below
commit c4aa68f4fbeef87d2a8ad5ed14899766d4b88314
Author: Github Actions <[email protected]>
AuthorDate: Thu Oct 30 12:47:12 2025 +0000
[auto] Generated docs from Apache Ozone master
f30870f2a229a2a618f3199aa047d3397e77a9cd
---
docs/edge/en/sitemap.xml | 2 +-
docs/edge/interface/httpfs.html | 80 ++++++++++++++++++++++++++++++++---------
docs/edge/interface/ofs.html | 2 +-
docs/edge/sitemap.xml | 2 +-
docs/edge/zh/interface/ofs.html | 2 +-
5 files changed, 68 insertions(+), 20 deletions(-)
diff --git a/docs/edge/en/sitemap.xml b/docs/edge/en/sitemap.xml
index f1f911e2..5c715f04 100644
--- a/docs/edge/en/sitemap.xml
+++ b/docs/edge/en/sitemap.xml
@@ -523,7 +523,7 @@
/>
</url><url>
<loc>/interface/httpfs.html</loc>
- <lastmod>2024-03-21T14:26:59+05:30</lastmod>
+ <lastmod>2025-10-29T21:56:49+08:00</lastmod>
</url><url>
<loc>/feature/recon.html</loc>
<lastmod>2020-11-24T16:27:12-08:00</lastmod>
diff --git a/docs/edge/interface/httpfs.html b/docs/edge/interface/httpfs.html
index c04b0563..9e081f04 100644
--- a/docs/edge/interface/httpfs.html
+++ b/docs/edge/interface/httpfs.html
@@ -627,21 +627,69 @@ s=d.getElementsByTagName('script')[0];
<p>HttpFS has built-in security supporting Hadoop pseudo authentication and
Kerberos SPNEGO and other pluggable authentication mechanisms. It also provides
Hadoop proxy user support.</p>
<h2 id="getting-started">Getting started</h2>
<p>HttpFS service itself is a Jetty based web-application that uses the Hadoop
FileSystem API to talk to the cluster, it is a separate service which provides
access to Ozone via a REST APIs. It should be started in addition to other
regular Ozone components.</p>
-<p>To try it out, you can start a Docker Compose dev cluster that has an
HttpFS gateway.</p>
-<p>Extract the release tarball, go to the <code>compose/ozone</code> directory
and start the cluster:</p>
-<div class="highlight"><pre tabindex="0"
style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-bash" data-lang="bash"><span
style="display:flex;"><span>docker-compose up -d --scale datanode<span
style="color:#f92672">=</span><span style="color:#ae81ff">3</span>
-</span></span></code></pre></div><p>You can/should find now the HttpFS gateway
in docker with the name <code>ozone_httpfs</code>.
-HttpFS HTTP web-service API calls are HTTP REST calls that map to an Ozone
file system operation. For example, using the <code>curl</code> Unix
command.</p>
-<p>E.g. in the docker cluster you can execute commands like these:</p>
-<ul>
-<li>
-<p><code>curl -i -X PUT
"http://httpfs:14000/webhdfs/v1/vol1?op=MKDIRS&user.name=hdfs"</code>
creates a volume called <code>vol1</code>.</p>
-</li>
-<li>
-<p><code>$ curl
'http://httpfs-host:14000/webhdfs/v1/user/foo/README.txt?op=OPEN&user.name=foo'</code>
returns the content of the key <code>/user/foo/README.txt</code>.</p>
-</li>
-</ul>
-<h2 id="supported-operations">Supported operations</h2>
+<p>To try it out, follow the instructions from the link below to start the
Ozone cluster with Docker Compose.</p>
+<p><a
href="https://ozone.apache.org/docs/edge/start/startfromdockerhub.html";>https://ozone.apache.org/docs/edge/start/startfromdockerhub.html</a></p>
+<div class="highlight"><pre tabindex="0"
style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-bash" data-lang="bash"><span
style="display:flex;"><span>docker compose up -d --scale datanode<span
style="color:#f92672">=</span><span style="color:#ae81ff">3</span>
+</span></span></code></pre></div><p>You can/should find now the HttpFS gateway
in docker with the name like <code>ozone_httpfs</code>,
+and it can be accessed through <code>localhost:14000</code>.
+HttpFS HTTP web-service API calls are HTTP REST calls that map to an Ozone
file system operation.</p>
+<p>Here’s some example usage:</p>
+<h3 id="create-a-volume">Create a volume</h3>
+<div class="highlight"><pre tabindex="0"
style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-bash" data-lang="bash"><span style="display:flex;"><span><span
style="color:#75715e"># creates a volume called `volume1`.</span>
+</span></span><span style="display:flex;"><span>curl -i -X PUT <span
style="color:#e6db74">"http://localhost:14000/webhdfs/v1/volume1?op=MKDIRS&user.name=hdfs"</span>
+</span></span></code></pre></div><p>Example Output:</p>
+<div class="highlight"><pre tabindex="0"
style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-bash" data-lang="bash"><span
style="display:flex;"><span>HTTP/1.1 <span style="color:#ae81ff">200</span> OK
+</span></span><span style="display:flex;"><span>Date: Sat, <span
style="color:#ae81ff">18</span> Oct <span style="color:#ae81ff">2025</span>
07:51:21 GMT
+</span></span><span style="display:flex;"><span>Cache-Control: no-cache
+</span></span><span style="display:flex;"><span>Expires: Sat, <span
style="color:#ae81ff">18</span> Oct <span style="color:#ae81ff">2025</span>
07:51:21 GMT
+</span></span><span style="display:flex;"><span>Pragma: no-cache
+</span></span><span style="display:flex;"><span>Content-Type: application/json
+</span></span><span style="display:flex;"><span>X-Content-Type-Options: nosniff
+</span></span><span style="display:flex;"><span>X-XSS-Protection: 1; mode<span
style="color:#f92672">=</span>block
+</span></span><span style="display:flex;"><span>Set-Cookie: hadoop.auth<span
style="color:#f92672">=</span><span
style="color:#e6db74">"u=hdfs&p=hdfs&t=simple-dt&e=1760809881100&s=OCdVOi8eyMguFySkmEJxm5EkRfj6NbAM9agi5Gue1Iw="</span>;
Path<span style="color:#f92672">=</span>/; HttpOnly
+</span></span><span style="display:flex;"><span>Content-Length: <span
style="color:#ae81ff">17</span>
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span><span
style="color:#f92672">{</span><span
style="color:#e6db74">"boolean"</span>:true<span
style="color:#f92672">}</span>
+</span></span></code></pre></div><h3 id="create-a-bucket">Create a bucket</h3>
+<div class="highlight"><pre tabindex="0"
style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-bash" data-lang="bash"><span style="display:flex;"><span><span
style="color:#75715e"># creates a bucket called `bucket1`.</span>
+</span></span><span style="display:flex;"><span>curl -i -X PUT <span
style="color:#e6db74">"http://localhost:14000/webhdfs/v1/volume1/bucket1?op=MKDIRS&user.name=hdfs"</span>
+</span></span></code></pre></div><p>Example Output:</p>
+<div class="highlight"><pre tabindex="0"
style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-bash" data-lang="bash"><span
style="display:flex;"><span>HTTP/1.1 <span style="color:#ae81ff">200</span> OK
+</span></span><span style="display:flex;"><span>Date: Sat, <span
style="color:#ae81ff">18</span> Oct <span style="color:#ae81ff">2025</span>
07:52:06 GMT
+</span></span><span style="display:flex;"><span>Cache-Control: no-cache
+</span></span><span style="display:flex;"><span>Expires: Sat, <span
style="color:#ae81ff">18</span> Oct <span style="color:#ae81ff">2025</span>
07:52:06 GMT
+</span></span><span style="display:flex;"><span>Pragma: no-cache
+</span></span><span style="display:flex;"><span>Content-Type: application/json
+</span></span><span style="display:flex;"><span>X-Content-Type-Options: nosniff
+</span></span><span style="display:flex;"><span>X-XSS-Protection: 1; mode<span
style="color:#f92672">=</span>block
+</span></span><span style="display:flex;"><span>Set-Cookie: hadoop.auth<span
style="color:#f92672">=</span><span
style="color:#e6db74">"u=hdfs&p=hdfs&t=simple-dt&e=1760809926682&s=yvOaeaRCVJZ+z+nZQ/rM/Y01pzEmS9Pe2mE9f0b+TWw="</span>;
Path<span style="color:#f92672">=</span>/; HttpOnly
+</span></span><span style="display:flex;"><span>Content-Length: <span
style="color:#ae81ff">17</span>
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span><span
style="color:#f92672">{</span><span
style="color:#e6db74">"boolean"</span>:true<span
style="color:#f92672">}</span>
+</span></span></code></pre></div><h3 id="upload-a-file">Upload a file</h3>
+<div class="highlight"><pre tabindex="0"
style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-bash" data-lang="bash"><span style="display:flex;"><span>echo
<span style="color:#e6db74">"hello"</span> >> ./README.txt
+</span></span><span style="display:flex;"><span>curl -i -X PUT <span
style="color:#e6db74">"http://localhost:14000/webhdfs/v1/volume1/bucket1/user/foo/README.txt?op=CREATE&data=true&user.name=hdfs"</span>
-T ./README.txt -H <span style="color:#e6db74">"Content-Type:
application/octet-stream"</span>
+</span></span></code></pre></div><p>Example Output:</p>
+<div class="highlight"><pre tabindex="0"
style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-bash" data-lang="bash"><span
style="display:flex;"><span>HTTP/1.1 <span style="color:#ae81ff">100</span>
Continue
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span>HTTP/1.1 <span
style="color:#ae81ff">201</span> Created
+</span></span><span style="display:flex;"><span>Date: Sat, <span
style="color:#ae81ff">18</span> Oct <span style="color:#ae81ff">2025</span>
08:33:33 GMT
+</span></span><span style="display:flex;"><span>Cache-Control: no-cache
+</span></span><span style="display:flex;"><span>Expires: Sat, <span
style="color:#ae81ff">18</span> Oct <span style="color:#ae81ff">2025</span>
08:33:33 GMT
+</span></span><span style="display:flex;"><span>Pragma: no-cache
+</span></span><span style="display:flex;"><span>X-Content-Type-Options: nosniff
+</span></span><span style="display:flex;"><span>X-XSS-Protection: 1; mode<span
style="color:#f92672">=</span>block
+</span></span><span style="display:flex;"><span>Set-Cookie: hadoop.auth<span
style="color:#f92672">=</span><span
style="color:#e6db74">"u=hdfs&p=hdfs&t=simple-dt&e=1760812413286&s=09t7xKu/p/fjCJiQNL3bvW/Q7mTw28IbeNqDGlslZ6w="</span>;
Path<span style="color:#f92672">=</span>/; HttpOnly
+</span></span><span style="display:flex;"><span>Location:
http://localhost:14000/webhdfs/v1/volume1/bucket1/user/foo/README.txt
+</span></span><span style="display:flex;"><span>Content-Type: application/json
+</span></span><span style="display:flex;"><span>Content-Length: <span
style="color:#ae81ff">84</span>
+</span></span><span style="display:flex;"><span>
+</span></span><span style="display:flex;"><span><span
style="color:#f92672">{</span><span
style="color:#e6db74">"Location"</span>:<span
style="color:#e6db74">"http://localhost:14000/webhdfs/v1/volume1/bucket1/user/foo/README.txt"</span><span
style="color:#f92672">}</span>
+</span></span></code></pre></div><h3 id="read-the-file-content">Read the file
content</h3>
+<div class="highlight"><pre tabindex="0"
style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-bash" data-lang="bash"><span style="display:flex;"><span><span
style="color:#75715e"># returns the content of the key
`/user/foo/README.txt`.</span>
+</span></span><span style="display:flex;"><span>curl <span
style="color:#e6db74">'http://localhost:14000/webhdfs/v1/volume1/bucket1/user/foo/README.txt?op=OPEN&user.name=foo'</span>
+</span></span><span style="display:flex;"><span>hello
+</span></span></code></pre></div><h2 id="supported-operations">Supported
operations</h2>
<p>Here are the tables of WebHDFS REST APIs and their state of support in
Ozone.</p>
<h3 id="file-and-directory-operations">File and Directory Operations</h3>
<table>
@@ -817,7 +865,7 @@ HttpFS HTTP web-service API calls are HTTP REST calls that
map to an Ozone file
<footer class="footer">
<div class="container">
<span class="small text-muted">
- Version: 2.2.0-SNAPSHOT, Last Modified: March 21, 2024 <a
class="hide-child link primary-color"
href="https://github.com/apache/ozone/commit/d70d247a494a69cad28e96d003b25ae4856b8641";>d70d247a49</a>
+ Version: 2.2.0-SNAPSHOT, Last Modified: October 29, 2025 <a
class="hide-child link primary-color"
href="https://github.com/apache/ozone/commit/d4e7d94239ab709841353bf411bb11c9feea5a85";>d4e7d94239</a>
</span>
</div>
</footer>
diff --git a/docs/edge/interface/ofs.html b/docs/edge/interface/ofs.html
index af395eca..faaec6d2 100644
--- a/docs/edge/interface/ofs.html
+++ b/docs/edge/interface/ofs.html
@@ -670,7 +670,7 @@ For example:</p>
<p>Or use the put command to write a file to the bucket.</p>
<div class="highlight"><pre tabindex="0"
style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-bash" data-lang="bash"><span style="display:flex;"><span>hdfs
dfs -put /etc/hosts /volume1/bucket1/test</span></span></code></pre></div>
<p>For more usage, see: <a
href="https://issues.apache.org/jira/secure/attachment/12987636/Design%20ofs%20v1.pdf";>https://issues.apache.org/jira/secure/attachment/12987636/Design%20ofs%20v1.pdf</a></p>
-<h2 id="differences-from-o3fshahahugoshortcode117s5hbhb">Differences from <a
href="../interface/o3fs.html">o3fs</a></h2>
+<h2 id="differences-from-o3fshahahugoshortcode115s5hbhb">Differences from <a
href="../interface/o3fs.html">o3fs</a></h2>
<h3 id="creating-files">Creating files</h3>
<p>OFS doesn’t allow creating keys(files) directly under root or volumes.
Users will receive an error message when they try to do that:</p>
diff --git a/docs/edge/sitemap.xml b/docs/edge/sitemap.xml
index 65511e6c..ac9d8c15 100644
--- a/docs/edge/sitemap.xml
+++ b/docs/edge/sitemap.xml
@@ -4,7 +4,7 @@
<sitemap>
<loc>/en/sitemap.xml</loc>
- <lastmod>2025-10-23T07:34:15-07:00</lastmod>
+ <lastmod>2025-10-29T21:56:49+08:00</lastmod>
</sitemap>
diff --git a/docs/edge/zh/interface/ofs.html b/docs/edge/zh/interface/ofs.html
index 4079a691..ff189243 100644
--- a/docs/edge/zh/interface/ofs.html
+++ b/docs/edge/zh/interface/ofs.html
@@ -484,7 +484,7 @@ ofs://omservice/tmp/key1
<p>或者使用 put 命令向桶中写入一个文件</p>
<div class="highlight"><pre tabindex="0"
style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-bash" data-lang="bash"><span style="display:flex;"><span>hdfs
dfs -put /etc/hosts /volume1/bucket1/test</span></span></code></pre></div>
<p>有关更多用法，请参见： <a
href="https://issues.apache.org/jira/secure/attachment/12987636/Design%20ofs%20v1.pdf";>https://issues.apache.org/jira/secure/attachment/12987636/Design%20ofs%20v1.pdf</a></p>
-<h2 id="与-o3fshahahugoshortcode116s5hbhb-的区别">与 <a
href="../../zh/interface/o3fs.html">o3fs</a> 的区别</h2>
+<h2 id="与-o3fshahahugoshortcode117s5hbhb-的区别">与 <a
href="../../zh/interface/o3fs.html">o3fs</a> 的区别</h2>
<h3 id="创建文件">创建文件</h3>
<p>OFS 不允许直接在根目录或卷下创建键（文件）。
当用户尝试这样做时，他们将收到一个错误消息：</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
