This is an automated email from the ASF dual-hosted git repository.
rakeshr pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ozone.git
The following commit(s) were added to refs/heads/master by this push:
new ab8cc32 HDDS-6073. Document: Fix images alignment in the doc pages
(#2898)
ab8cc32 is described below
commit ab8cc32e9edbac38cb91c52d18252f5ef6ab6535
Author: Jyotinder Singh <[email protected]>
AuthorDate: Wed Dec 8 21:04:07 2021 +0530
HDDS-6073. Document: Fix images alignment in the doc pages (#2898)
---
hadoop-hdds/docs/content/concept/Containers.md | 2 +-
hadoop-hdds/docs/content/concept/Datanodes.md | 4 ++--
hadoop-hdds/docs/content/concept/OzoneManager.md | 6 +++---
hadoop-hdds/docs/content/concept/Recon.md | 6 +++---
hadoop-hdds/docs/content/feature/OM-HA.md | 5 +++--
hadoop-hdds/docs/content/feature/PrefixFSO.md | 8 +++++---
hadoop-hdds/docs/content/feature/SCM-HA.md | 2 +-
.../themes/ozonedoc/layouts/shortcodes/image.html | 19 +++++++++++++++++++
8 files changed, 37 insertions(+), 15 deletions(-)
diff --git a/hadoop-hdds/docs/content/concept/Containers.md
b/hadoop-hdds/docs/content/concept/Containers.md
index 4e46acc..b5894a6 100644
--- a/hadoop-hdds/docs/content/concept/Containers.md
+++ b/hadoop-hdds/docs/content/concept/Containers.md
@@ -28,7 +28,7 @@ Containers are the fundamental replication unit of
Ozone/HDDS, they are managed
Containers are big binary units (5Gb by default) which can contain multiple
blocks:
-
+{{< image src="Containers.png">}}
Blocks are local information and not managed by SCM. Therefore even if
billions of small files are created in the system (which means billions of
blocks are created), only of the status of the containers will be reported by
the Datanodes and containers will be replicated.
diff --git a/hadoop-hdds/docs/content/concept/Datanodes.md
b/hadoop-hdds/docs/content/concept/Datanodes.md
index 1910d6c..4372da6 100644
--- a/hadoop-hdds/docs/content/concept/Datanodes.md
+++ b/hadoop-hdds/docs/content/concept/Datanodes.md
@@ -31,7 +31,7 @@ about the blocks written by the clients.
## Storage Containers
-
+{{< image src="ContainerMetadata.png">}}
A storage container is a self-contained super block. It has a list of Ozone
blocks that reside inside it, as well as on-disk files which contain the
@@ -50,7 +50,7 @@ that make up that key.
An Ozone block contains the container ID and a local ID. The figure below
shows the logical layout out of Ozone block.
-
+{{< image src="OzoneBlock.png">}}
The container ID lets the clients discover the location of the container. The
authoritative information about where a container is located is with the
diff --git a/hadoop-hdds/docs/content/concept/OzoneManager.md
b/hadoop-hdds/docs/content/concept/OzoneManager.md
index 51eae11..50bf441 100644
--- a/hadoop-hdds/docs/content/concept/OzoneManager.md
+++ b/hadoop-hdds/docs/content/concept/OzoneManager.md
@@ -24,7 +24,7 @@ summary: Ozone Manager is the principal name space service of
Ozone. OM manages
limitations under the License.
-->
-
+{{< image src="OzoneManager.png">}}
Ozone Manager (OM) is the namespace manager for Ozone.
@@ -60,7 +60,7 @@ understood if we trace what happens during a key write and
key read.
### Key Write
-
+{{< image src="OzoneManager-WritePath.png">}}
* To write a key to Ozone, a client tells Ozone manager that it would like to
write a key into a bucket that lives inside a specific volume. Once Ozone
@@ -84,7 +84,7 @@ information on Ozone manager.
### Key Reads
-
+{{< image src="OzoneManager-ReadPath.png">}}
* Key reads are simpler, the client requests the block list from the Ozone
Manager
diff --git a/hadoop-hdds/docs/content/concept/Recon.md
b/hadoop-hdds/docs/content/concept/Recon.md
index 902c865..e3f6350 100644
--- a/hadoop-hdds/docs/content/concept/Recon.md
+++ b/hadoop-hdds/docs/content/concept/Recon.md
@@ -31,7 +31,7 @@ the current state of the cluster through REST based APIs and
rich web UI.
## High Level Design
-{{<figure src="/concept/ReconHighLevelDesign.png" width="800px">}}
+{{< image src="/concept/ReconHighLevelDesign.png">}}
<br/>
@@ -50,7 +50,7 @@ the web UI.
## Recon and Ozone Manager
-{{<figure src="/concept/ReconOmDesign.png" width="800px">}}
+{{< image src="/concept/ReconOmDesign.png">}}
<br/>
@@ -68,7 +68,7 @@ further processing by OM db tasks via [Recon Task
Framework](#task-framework).
## Recon and Storage Container Manager
-{{<figure src="/concept/ReconScmDesign.png" width="800px">}}
+{{< image src="/concept/ReconScmDesign.png">}}
<br/>
diff --git a/hadoop-hdds/docs/content/feature/OM-HA.md
b/hadoop-hdds/docs/content/feature/OM-HA.md
index 1da660c..0719a29 100644
--- a/hadoop-hdds/docs/content/feature/OM-HA.md
+++ b/hadoop-hdds/docs/content/feature/OM-HA.md
@@ -35,7 +35,8 @@ This document explain the HA setup of Ozone Manager (OM) HA,
please check [this
A single Ozone Manager uses [RocksDB](https://github.com/facebook/rocksdb/) to
persist metadata (volumes, buckets, keys) locally. HA version of Ozone Manager
does exactly the same but all the data is replicated with the help of the RAFT
consensus algorithm to follower Ozone Manager instances.
-
+{{< image src="HA-OM.png">}}
+
Client connects to the Leader Ozone Manager which process the request and
schedule the replication with RAFT. When the request is replicated to all the
followers the leader can return with the response.
## Configuration
@@ -105,7 +106,7 @@ Raft can guarantee the replication of any request if the
request is persisted to
RocksDB instance are updated by a background thread with batching transactions
(so called "double buffer" as when one of the buffers is used to commit the
data the other one collects all the new requests for the next commit.) To make
all data available for the next request even if the background process is not
yet wrote them the key data is cached in the memory.
-
+{{< image src="HA-OM-doublebuffer.png">}}
The details of this approach discussed in a separated [design doc]({{< ref
"design/omha.md" >}}) but it's integral part of the OM HA design.
diff --git a/hadoop-hdds/docs/content/feature/PrefixFSO.md
b/hadoop-hdds/docs/content/feature/PrefixFSO.md
index f54deea..78a5bc3 100644
--- a/hadoop-hdds/docs/content/feature/PrefixFSO.md
+++ b/hadoop-hdds/docs/content/feature/PrefixFSO.md
@@ -46,18 +46,20 @@ Simple is the existing OM metadata format, which stores key
entry with full path
prefixed by the unique identifier of its parent directory, `<parent
unique-id>/<filename>`.
-
+{{< image src="PrefixFSO-Format.png">}}
### Directory delete operation with prefix layout: ###
Following picture describes the OM metadata changes while performing a delete
operation on a directory.
-
+
+{{< image src="PrefixFSO-Delete.png">}}
### Directory rename operation with prefix layout: ###
Following picture describes the OM metadata changes while performing a rename
operation on a directory.
-
+
+{{< image src="PrefixFSO-Rename.png">}}
## Configuration
By default the feature is disabled. It can be enabled with the following
diff --git a/hadoop-hdds/docs/content/feature/SCM-HA.md
b/hadoop-hdds/docs/content/feature/SCM-HA.md
index a6f8627..78aafcf 100644
--- a/hadoop-hdds/docs/content/feature/SCM-HA.md
+++ b/hadoop-hdds/docs/content/feature/SCM-HA.md
@@ -109,7 +109,7 @@ Based on the `ozone.scm.primordial.node.id`, the init
process will be ignored on
## SCM HA Security
-
+{{< image src="scm-secure-ha.png">}}
In a secure SCM HA cluster on the SCM where we perform init, we call this SCM
as a primordial SCM.
Primordial SCM starts root-CA with self-signed certificates and is used to
issue a signed certificate
diff --git a/hadoop-hdds/docs/themes/ozonedoc/layouts/shortcodes/image.html
b/hadoop-hdds/docs/themes/ozonedoc/layouts/shortcodes/image.html
new file mode 100644
index 0000000..07c55b3
--- /dev/null
+++ b/hadoop-hdds/docs/themes/ozonedoc/layouts/shortcodes/image.html
@@ -0,0 +1,19 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- shortcode to easily scale images according to page width-->
+<img src='{{ .Get "src" }}' style="max-width:100%"/>
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
