This is an automated email from the ASF dual-hosted git repository.
adoroszlai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ozone-site.git
The following commit(s) were added to refs/heads/master by this push:
new 90f6257ca4 HDDS-8280. [Auto] Update configuration documentation (#563)
90f6257ca4 is described below
commit 90f6257ca4c7b8c34f7e6fde273e7907867695a4
Author: asf-ci-deploy <[email protected]>
AuthorDate: Tue Oct 6 17:44:58 2026 +0200
HDDS-8280. [Auto] Update configuration documentation (#563)
---
docs/05-administrator-guide/02-configuration/99-appendix.md | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/docs/05-administrator-guide/02-configuration/99-appendix.md
b/docs/05-administrator-guide/02-configuration/99-appendix.md
index 9f73d7e4db..4f2dc17612 100644
--- a/docs/05-administrator-guide/02-configuration/99-appendix.md
+++ b/docs/05-administrator-guide/02-configuration/99-appendix.md
@@ -184,6 +184,7 @@ This page provides a comprehensive overview of the
configuration keys available
| `hdds.datanode.slow.op.warning.threshold` | 500ms | `OZONE`, `DATANODE`,
`PERFORMANCE` | Thresholds for printing slow-operation audit logs. |
| `hdds.datanode.storage.utilization.critical.threshold` | 0.95 | `OZONE`,
`SCM`, `MANAGEMENT` | If a datanode overall storage utilization exceeds more
than this value, the datanode will be marked out of space. |
| `hdds.datanode.storage.utilization.warning.threshold` | 0.75 | `OZONE`,
`SCM`, `MANAGEMENT` | If a datanode overall storage utilization exceeds more
than this value, a warning will be logged while processing the nodeReport in
SCM. |
+| `hdds.datanode.stream.read.file.idle.timeout` | 1m | `DATANODE` | How long a
streaming ReadBlock stream may stay idle before the datanode closes the block
file held open for it. The stream itself stays open and the file is reopened by
the next request, so this only bounds the file descriptors pinned by idle
streams. |
| `hdds.datanode.use.datanode.hostname` | false | `OZONE`, `DATANODE` |
Whether Datanodes should use Datanode hostnames when connecting to other
Datanodes for data transfer. |
| `hdds.datanode.volume.choosing.policy` |
org.apache.hadoop.ozone.container.common.volume.CapacityVolumeChoosingPolicy |
`OZONE`, `CONTAINER`, `STORAGE`, `MANAGEMENT` | The class name of the policy
for choosing volumes in the list of directories. Defaults to
org.apache.hadoop.ozone.container.common.volume.CapacityVolumeChoosingPolicy.
This volume choosing policy randomly chooses two volumes with remaining space
and then picks the one with lower utilization. |
| `hdds.datanode.volume.min.free.space` | -1 | `OZONE`, `CONTAINER`,
`STORAGE`, `MANAGEMENT` | Minimum free space (bytes) applied together with
min.free.space.percent (reported to SCM in heartbeat as freeSpaceToSpare) and
min.free.space.hard.limit.percent (local write enforcement). The effective
value for each tier is max(this bytes, capacity * ratio). |
@@ -355,7 +356,7 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.client.datastream.buffer.flush.size` | 16MB | `CLIENT` | The boundary
at which putBlock is executed |
| `ozone.client.datastream.min.packet.size` | 1MB | `CLIENT` | The maximum
size of the ByteBuffer (used via ratis streaming) |
| `ozone.client.datastream.pipeline.mode` | true | `CLIENT` | Streaming write
support both pipeline mode(datanode1->datanode2->datanode3) and star
mode(datanode1->datanode2, datanode1->datanode3). By default we use
pipeline mode. |
-| `ozone.client.datastream.putblock.on.close.enabled` | false | `CLIENT` |
When enabled, use StreamInitWithPutBlock so datanodes commit PutBlock when the
Ratis data stream closes instead of via a separate WriteAsync PutBlock. |
+| `ozone.client.datastream.putblock.without.raft.enabled` | false | `CLIENT` |
When enabled, the PutBlock of a Ratis data stream is committed through the data
stream instead of a separate WriteAsync PutBlock, so that it does not go
through the Raft log: StreamInitWithPutBlock is used so that datanodes commit
PutBlock when the data stream closes, and the PutBlock triggered by a flush in
the middle of the stream is sent as a data stream command. All the datanodes
must support committing Pu [...]
| `ozone.client.datastream.sync.size` | 0B | `CLIENT` | The minimum size of
written data before forcing the datanodes in the pipeline to flush the pending
data to underlying storage. If set to zero or negative, the client will not
force the datanodes to flush. |
| `ozone.client.datastream.window.size` | 64MB | `CLIENT` | Maximum size of
BufferList(used for retry) size per BlockDataStreamOutput instance |
| `ozone.client.ec.grpc.retries.enabled` | true | `CLIENT` | To enable Grpc
client retries for EC. |
@@ -395,7 +396,7 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.client.stream.buffer.max.size` | 32MB | `CLIENT` | Size which
determines at what buffer position write call be blocked till acknowledgement
of the first partial flush happens by all servers. |
| `ozone.client.stream.buffer.size` | 4MB | `CLIENT` | The size of chunks the
client will send to the server |
| `ozone.client.stream.putblock.piggybacking` | false | `CLIENT` | Allow
PutBlock to be piggybacked in WriteChunk requests if the chunk is small. Can be
enabled only when `ozone.client.hbase.enhancements.allowed` = true |
-| `ozone.client.stream.read.pre-read-size` | 33554432 | `CLIENT` | Extra bytes
to prefetch during streaming reads. |
+| `ozone.client.stream.read.pre-read-size` | 33554432 | `CLIENT` | Size of the
pre-read window for streaming reads: the number of bytes requested from the
datanode ahead of the current read position. The window is refilled in bulk
once the bytes requested ahead drop below half of this value. Set to 0 to
disable pre-read. |
| `ozone.client.stream.read.response-data-size` | 1048576 | `CLIENT` | Chunk
size of streaming read responses from datanodes. |
| `ozone.client.stream.read.timeout` | 10s | `CLIENT` | Timeout for receiving
streaming read responses. |
| `ozone.client.stream.readblock.enable` | false | `CLIENT` | Allow ReadBlock
to stream all the readChunk in one request. |
@@ -422,7 +423,7 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.fs.listing.page.size` | 1024 | `OZONE`, `CLIENT` | Listing page size
value used by client for listing number of items on fs related sub-commands
output. Kindly set this config value responsibly to avoid high resource usage.
Maximum value restricted is 5000 for optimum performance. |
| `ozone.fs.listing.page.size.max` | 5000 | `OZONE`, `OM` | Maximum listing
page size value enforced by server for listing items on fs related sub-commands
output. Kindly set this config value responsibly to avoid high resource usage.
Maximum value restricted is 5000 for optimum performance. |
| `ozone.hbase.enhancements.allowed` | false | `OZONE`, `OM` | When set to
false, server-side HBase enhancement-related Ozone (experimental) features are
disabled (not allowed to be enabled) regardless of whether those configs are
set. Here is the list of configs and values overridden when this config is set
to false: 1. `ozone.fs.hsync.enabled` = false A warning message will be printed
if any of the above configs are overridden by this. |
-| `ozone.http.basedir` | | `OZONE`, `OM`, `SCM`, `MANAGEMENT` | The base dir
for HTTP Jetty server to extract contents. If this property is not configured,
by default, Jetty will create a directory inside the directory named by the
`${ozone.metadata.dirs}`/webserver. While in production environment, it's
strongly suggested instructing Jetty to use a different parent directory by
setting this property to the name of the desired parent directory. The value of
the property will be used to [...]
+| `ozone.http.basedir` | | `OZONE`, `OM`, `SCM`, `MANAGEMENT` | The base dir
for the HTTP Jetty server. If this property is not configured, by default the
directory named by `${ozone.metadata.dirs}`/webserver is used. While in a
production environment, it's strongly suggested to point this at a different
parent directory by setting this property. Under this directory Ozone creates
and reuses a per-server subdirectory (named after the server) as Jetty's
persistent temp directory; it is k [...]
| `ozone.http.filter.initializers` | | `OZONE`, `SECURITY`, `KERBEROS` | Set
to org.apache.hadoop.security.AuthenticationFilterInitializer to enable
Kerberos authentication for Ozone HTTP web consoles is enabled using the SPNEGO
protocol. When this property is set, `ozone.security.http.kerberos.enabled`
should be set to true. |
| `ozone.http.policy` | HTTP_ONLY | `OZONE`, `SECURITY`, `MANAGEMENT` | Decide
if HTTPS(SSL) is supported on Ozone This configures the HTTP endpoint for Ozone
daemons: The following values are supported: - HTTP_ONLY : Service is provided
only on http - HTTPS_ONLY : Service is provided only on https - HTTP_AND_HTTPS
: Service is provided both on http and https |
| `ozone.https.client.keystore.resource` | ssl-client.xml | `OZONE`,
`SECURITY`, `MANAGEMENT` | Resource file from which ssl client keystore
information will be extracted |
@@ -737,11 +738,12 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.scm.dead.node.interval` | 10m | `OZONE`, `MANAGEMENT` | The interval
between heartbeats before a node is tagged as dead. |
| `ozone.scm.default.service.id` | | `OZONE`, `SCM`, `HA` | Service ID of the
SCM. If this is not set fall back to `ozone.scm.service.ids` to find the
service ID it belongs to. |
| `ozone.scm.ec.pipeline.minimum` | 5 | `STORAGE` | The minimum number of
pipelines to have open for each Erasure Coding configuration |
-| `ozone.scm.ec.pipeline.per.volume.factor` | 1 | `SCM` | TODO |
+| `ozone.scm.ec.pipeline.per.volume.factor` | 1 | `SCM` | Factor used to
calculate the maximum number of open pipelines for each EC replication config,
based on the number of healthy volumes in the cluster. The limit is max(factor
* total healthy volumes / (data + parity), `ozone.scm.ec.pipeline.minimum`).
Setting it to 0 disables the volume-based limit, so only
`ozone.scm.ec.pipeline.minimum` applies. |
| `ozone.scm.event.ContainerReport.thread.pool.size` | 10 | `OZONE`, `SCM` |
Thread pool size configured to process container reports. |
| `ozone.scm.expired.container.replica.op.scrub.interval` | 5m | `OZONE`,
`SCM`, `CONTAINER` | SCM schedules a fixed interval job using the configured
interval to scrub expired container replica operation. |
| `ozone.scm.grpc.port` | 9895 | `OZONE`, `SCM`, `HA`, `RATIS` | The port
number of the SCM's grpc server. |
| `ozone.scm.ha.dbtransactionbuffer.flush.interval` | 60s | `SCM`, `OZONE` |
Wait duration for flush of buffered transaction. |
+| `ozone.scm.ha.dbtransactionbuffer.flush.pending.limit` | 10000 | `SCM`,
`OZONE` | Maximum number of buffered DB operations the SCM HA transaction
buffer holds before applyTransaction flushes them to RocksDB. This bounds
memory use while a restarted follower applies a large backlog of committed
Ratis log entries. |
| `ozone.scm.ha.grpc.deadline.interval` | 30m | `SCM`, `OZONE`, `HA`, `RATIS`
| Deadline for SCM DB checkpoint interval. |
| `ozone.scm.ha.raft.server.log.appender.wait-time.min` | 0ms | `OZONE`,
`SCM`, `RATIS`, `PERFORMANCE` | Minimum wait time between two appendEntries
calls. |
| `ozone.scm.ha.raft.server.rpc.first-election.timeout` | | `SCM`, `OZONE`,
`HA`, `RATIS` | ratis timeout for the first election of a leader. If not
configured, fallback to `ozone.scm.ha.ratis.leader.election.timeout`. |
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
