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 17671402a HDDS-15095. [Auto] Update configuration documentation (#425)
17671402a is described below
commit 17671402ab017a71b53ab55e348b4f88c6121fbd
Author: asf-ci-deploy <[email protected]>
AuthorDate: Wed May 13 08:17:54 2026 +0200
HDDS-15095. [Auto] Update configuration documentation (#425)
---
.../02-configuration/99-appendix.md | 32 +++++++++++-----------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/docs/05-administrator-guide/02-configuration/99-appendix.md
b/docs/05-administrator-guide/02-configuration/99-appendix.md
index 488de05d8..46c365b33 100644
--- a/docs/05-administrator-guide/02-configuration/99-appendix.md
+++ b/docs/05-administrator-guide/02-configuration/99-appendix.md
@@ -336,9 +336,9 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.authorization.enabled` | true | `OZONE`, `SECURITY`, `AUTHORIZATION`
| Master switch to enable/disable authorization checks in Ozone (admin
privilege checks and ACL checks). This property only takes effect when
`ozone.security.enabled` is true. When true: admin privilege checks are always
performed, and object ACL checks are controlled by `ozone.acl.enabled`. When
false: no authorization checks are performed. Default is true. |
| `ozone.blacklist.groups` | | | Ozone blacklisted groups delimited by the
comma. If set, This is the list of groups that are not allowed to do any
operations even if the blacklisted user is also under (readonly) admin / admin
group, |
| `ozone.blacklist.users` | | | Ozone blacklisted users delimited by the
comma. If set, This is the list of users that are not allowed to do any
operations even if the blacklisted user is also under (readonly) admin / admin
group, |
-| `ozone.block.deleting.service.interval` | 1m | `OZONE`, `PERFORMANCE`, `SCM`
| Time interval of the block deleting service. The block deleting service runs
on each datanode periodically and deletes blocks queued for deletion. Unit
could be defined with postfix (ns,ms,s,m,h,d) |
-| `ozone.block.deleting.service.timeout` | 300000ms | `OZONE`, `PERFORMANCE`,
`SCM` | A timeout value of block deletion service. If this is set greater than
0, the service will stop waiting for the block deleting completion after this
time. This setting supports multiple time unit suffixes as described in
dfs.heartbeat.interval. If no suffix is specified, then milliseconds is
assumed. |
-| `ozone.block.deleting.service.workers` | 10 | `OZONE`, `PERFORMANCE`, `SCM`
| Number of workers executed of block deletion service. This configuration
should be set to greater than 0. |
+| `ozone.block.deleting.service.interval` | 1m | `OZONE`, `PERFORMANCE`,
`SCM`, `DELETION` | Time interval of the block deleting service. The block
deleting service runs on each datanode periodically and deletes blocks queued
for deletion. Unit could be defined with postfix (ns,ms,s,m,h,d) |
+| `ozone.block.deleting.service.timeout` | 300000ms | `OZONE`, `PERFORMANCE`,
`SCM`, `DELETION` | A timeout value of block deletion service. If this is set
greater than 0, the service will stop waiting for the block deleting completion
after this time. This setting supports multiple time unit suffixes as described
in dfs.heartbeat.interval. If no suffix is specified, then milliseconds is
assumed. |
+| `ozone.block.deleting.service.workers` | 10 | `OZONE`, `PERFORMANCE`, `SCM`,
`DELETION` | Number of workers executed of block deletion service. This
configuration should be set to greater than 0. |
| `ozone.chunk.read.buffer.default.size` | 1MB | `OZONE`, `SCM`, `CONTAINER`,
`PERFORMANCE` | The default read buffer size during read chunk operations when
checksum is disabled. Chunk data will be cached in buffers of this capacity.
For chunk data with checksum, the read buffer size will be the same as the
number of bytes per checksum (`ozone.client.bytes.per.checksum`) corresponding
to the chunk. |
| `ozone.chunk.read.mapped.buffer.max.count` | 0 | `OZONE`, `SCM`,
`CONTAINER`, `PERFORMANCE` | The default max count of memory mapped buffers
allowed for a DN. Default 0 means no mapped buffers allowed for data read. |
| `ozone.chunk.read.mapped.buffer.threshold` | 32KB | `OZONE`, `SCM`,
`CONTAINER`, `PERFORMANCE` | The default read threshold to use memory mapped
buffers. |
@@ -399,7 +399,7 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.csi.s3g.address` | http://localhost:9878 | `STORAGE` | The address of
S3 Gateway endpoint. |
| `ozone.csi.socket` | /var/lib/csi.sock | `STORAGE` | The socket where all
the CSI services will listen (file name). |
| `ozone.default.bucket.layout` | | `OZONE`, `MANAGEMENT` | Default bucket
layout used by Ozone Manager during bucket creation when a client does not
specify the bucket layout option. Supported values are OBJECT_STORE and
FILE_SYSTEM_OPTIMIZED. OBJECT_STORE: This layout allows the bucket to behave as
a pure object store and will not allow interoperability between S3 and FS APIs.
FILE_SYSTEM_OPTIMIZED: This layout allows the bucket to support atomic
rename/delete operations and also allo [...]
-| `ozone.directory.deleting.service.interval` | 1m | `OZONE`, `PERFORMANCE`,
`OM` | Time interval of the directory deleting service. It runs on OM
periodically and cleanup orphan directory and its sub-tree. For every orphan
directory it deletes the sub-path tree structure(dirs/files). It sends
sub-files to KeyDeletingService to deletes its blocks. Unit could be defined
with postfix (ns,ms,s,m,h,d) |
+| `ozone.directory.deleting.service.interval` | 1m | `OZONE`, `PERFORMANCE`,
`OM`, `DELETION` | Time interval of the directory deleting service. It runs on
OM periodically and cleanup orphan directory and its sub-tree. For every orphan
directory it deletes the sub-path tree structure(dirs/files). It sends
sub-files to KeyDeletingService to deletes its blocks. Unit could be defined
with postfix (ns,ms,s,m,h,d) |
| `ozone.filesystem.snapshot.enabled` | true | `OZONE`, `OM` | Enables Ozone
filesystem snapshot feature if set to true on the OM side. Disables it
otherwise. |
| `ozone.freon.http-address` | 0.0.0.0:9884 | `OZONE`, `MANAGEMENT` | The
address and the base port where the FREON web ui will listen on. If the port is
0 then the server will start on a free port. |
| `ozone.freon.http-bind-host` | 0.0.0.0 | `OZONE`, `MANAGEMENT` | The actual
address the Freon web server will bind to. If this optional address is set, it
overrides only the hostname portion of `ozone.freon.http-address`. |
@@ -422,7 +422,7 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.https.client.keystore.resource` | ssl-client.xml | `OZONE`,
`SECURITY`, `MANAGEMENT` | Resource file from which ssl client keystore
information will be extracted |
| `ozone.https.client.need-auth` | false | `OZONE`, `SECURITY`, `MANAGEMENT` |
Whether SSL client certificate authentication is required |
| `ozone.https.server.keystore.resource` | ssl-server.xml | `OZONE`,
`SECURITY`, `MANAGEMENT` | Resource file from which ssl server keystore
information will be extracted |
-| `ozone.key.deleting.limit.per.task` | 50000 | `OM`, `PERFORMANCE` | A
maximum number of keys to be scanned by key deleting service per time interval
in OM. Those keys are sent to delete metadata and generate transactions in SCM
for next async deletion between SCM and DataNode. |
+| `ozone.key.deleting.limit.per.task` | 50000 | `OM`, `PERFORMANCE`,
`DELETION` | A maximum number of keys to be scanned by key deleting service per
time interval in OM. Those keys are sent to delete metadata and generate
transactions in SCM for next async deletion between SCM and DataNode. |
| `ozone.key.preallocation.max.blocks` | 64 | `OZONE`, `OM`, `PERFORMANCE` |
While allocating blocks from OM, this configuration limits the maximum number
of blocks being allocated. This configuration ensures that the allocated block
response do not exceed rpc payload limit. If client needs more space for the
write, separate block allocation requests will be made. |
| `ozone.manager.delegation.remover.scan.interval` | 3600000 | | Time
interval after which ozone secret manger scans for expired delegation token. |
| `ozone.manager.delegation.token.max-lifetime` | 7d | | Default max time
interval after which ozone delegation token will not be renewed. Delegation
Token is signed and verified using secret key which has a max
`hdds.secret.key.expiry.duration` lifetime. To guarantee that the delegation
token can be properly loaded, verified, and renewed during its lifetime,
(`ozone.manager.delegation.token.max-lifetime` +
`hdds.secret.key.rotate.duration` +
`ozone.manager.delegation.remover.scan.inter [...]
@@ -571,7 +571,7 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.om.user.max.volume` | 1024 | `OM`, `MANAGEMENT` | The maximum number
of volumes a user can have on a cluster.Increasing or decreasing this number
has no real impact on ozone cluster. This is defined only for operational
purposes. Only an administrator can create a volume, once a volume is created
there are no restrictions on the number of buckets or keys inside each bucket a
user can create. |
| `ozone.om.user.rights` | ALL | `OM`, `SECURITY` | Default user permissions
set for an object in OzoneManager. |
| `ozone.om.volume.listall.allowed` | true | `OM`, `MANAGEMENT` | Allows
everyone to list all volumes when set to true. Defaults to true. When set to
false, non-admin users can only list the volumes they have access to. Admins
can always list all volumes. Note that this config only applies to
OzoneNativeAuthorizer. For other authorizers, admin needs to set policies
accordingly to allow all volume listing e.g. for Ranger, a new policy with
special volume "/" can be added to allow group pu [...]
-| `ozone.path.deleting.limit.per.task` | 20000 | `OZONE`, `PERFORMANCE`, `OM`
| A maximum number of paths(dirs/files) to be deleted by directory deleting
service per time interval. |
+| `ozone.path.deleting.limit.per.task` | 20000 | `OZONE`, `PERFORMANCE`, `OM`,
`DELETION` | A maximum number of paths(dirs/files) to be deleted by directory
deleting service per time interval. |
| `ozone.read.blacklist.groups` | | | Ozone read blacklist groups delimited
by the comma. If set, This is the list of groups are not allowed to do any read
operations even if the blacklisted user is also under (readonly) admin / admin
group. |
| `ozone.read.blacklist.users` | | | Ozone read blacklist users delimited by
the comma. If set, This is the list of users are not allowed to do any read
operations even if the blacklisted user is also under (readonly) admin / admin
group. |
| `ozone.readonly.administrators` | | | Ozone read only admin users
delimited by the comma. If set, This is the list of users are allowed to read
operations skip checkAccess. |
@@ -672,7 +672,7 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.scm.block.client.address` | | `OZONE`, `SCM` | The address of the
Ozone SCM block client service. If not defined value of
`ozone.scm.client.address` is used. |
| `ozone.scm.block.client.bind.host` | 0.0.0.0 | `OZONE`, `SCM` | The hostname
or IP address used by the SCM block client endpoint to bind. |
| `ozone.scm.block.client.port` | 9863 | `OZONE`, `SCM` | The port number of
the Ozone SCM block client service. |
-| `ozone.scm.block.deletion.per.dn.distribution.factor` | 8 | `OZONE`, `SCM` |
Factor with which number of delete blocks sent to each datanode in every
interval. If total number of DNs are 100 and
`hdds.scm.block.deletion.per-interval.max` is 500000 Then maximum
500000/(100/8) = 40000 blocks will be sent to each DN in every interval. |
+| `ozone.scm.block.deletion.per.dn.distribution.factor` | 8 | `OZONE`, `SCM`,
`DELETION` | Factor with which number of delete blocks sent to each datanode in
every interval. If total number of DNs are 100 and
`hdds.scm.block.deletion.per-interval.max` is 500000 Then maximum
500000/(100/8) = 40000 blocks will be sent to each DN in every interval. |
| `ozone.scm.block.handler.count.key` | 100 | `OZONE`, `MANAGEMENT`,
`PERFORMANCE` | Used to set the number of RPC handlers when accessing blocks.
The default value is 100. |
| `ozone.scm.block.read.threadpool` | 10 | `OZONE`, `MANAGEMENT`,
`PERFORMANCE` | The number of threads in RPC server reading from the socket
when accessing blocks. This config overrides Hadoop configuration
"ipc.server.read.threadpool.size" for SCMBlockProtocolServer. The default value
is 10. |
| `ozone.scm.block.size` | 256MB | `OZONE`, `SCM` | The default size of a scm
block. This is maps to the default Ozone block size. |
@@ -744,7 +744,7 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.scm.https-address` | 0.0.0.0:9877 | `OZONE`, `MANAGEMENT` | The
address and the base port where the SCM web UI will listen on using HTTPS. If
the port is 0 then the server will start on a free port. |
| `ozone.scm.https-bind-host` | 0.0.0.0 | `OZONE`, `MANAGEMENT` | The actual
address the SCM web server will bind to using HTTPS. If this optional address
is set, it overrides only the hostname portion of `ozone.scm.https-address`. |
| `ozone.scm.info.wait.duration` | 10m | `OZONE`, `SCM`, `OM` | Maximum amount
of duration OM/SCM waits to get Scm Info/Scm signed cert during OzoneManager
init/SCM bootstrap. |
-| `ozone.scm.keyvalue.container.deletion-choosing.policy` |
org.apache.hadoop.ozone.container.common.impl.TopNOrderedContainerDeletionChoosingPolicy
| `OZONE`, `MANAGEMENT` | The policy used for choosing desired keyvalue
containers for block deletion. Datanode selects some containers to process
block deletion in a certain interval defined by
`ozone.block.deleting.service.interval`. The number of containers to process in
each interval is defined by ozone.block.deleting.container.limit.per [...]
+| `ozone.scm.keyvalue.container.deletion-choosing.policy` |
org.apache.hadoop.ozone.container.common.impl.TopNOrderedContainerDeletionChoosingPolicy
| `OZONE`, `MANAGEMENT`, `DELETION` | The policy used for choosing desired
keyvalue containers for block deletion. Datanode selects some containers to
process block deletion in a certain interval defined by
`ozone.block.deleting.service.interval`. The number of containers to process in
each interval is defined by ozone.block.deleting.contain [...]
| `ozone.scm.names` | | `OZONE`, `REQUIRED` | The value of this property is a
set of DNS \| DNS:PORT \| IP Address \| IP:PORT. Written as a comma separated
string. e.g. scm1, scm2:8020, 7.7.7.7:7777. This property allows datanodes to
discover where SCM is, so that datanodes can send heartbeat to SCM. |
| `ozone.scm.network.topology.schema.file` | network-topology-default.xml |
`OZONE`, `MANAGEMENT` | The schema file defines the ozone network topology. We
currently support xml(default) and yaml format. Refer to the samples in the
topology awareness document for xml and yaml topology definition samples. |
| `ozone.scm.node.id` | | `OZONE`, `SCM`, `HA` | The ID of this SCM node. If
the SCM node ID is not configured it is determined automatically by matching
the local node's address with the configured address. If node ID is not
deterministic from the configuration, then it is set to the scmId from the SCM
version file. |
@@ -777,20 +777,20 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.server.default.replication` | 3 | `OZONE` | Default replication
value. The actual number of replications can be specified when writing the key.
The default is used if replication is not specified when creating key or no
default replication set at bucket. Supported values: For RATIS: 1, 3 For EC
(Erasure Coding) supported format:
`{ECCodec}`-`{DataBlocks}`-`{ParityBlocks}`-`{ChunkSize}` ECCodec: Codec for
encoding stripe. Supported values : XOR, RS (Reed Solomon) DataBlocks: Numb
[...]
| `ozone.server.default.replication.type` | RATIS | `OZONE` | Default
replication type to be used while writing key into ozone. The value can be
specified when writing the key, default is used when nothing is specified when
creating key or no default value set at bucket. Supported values: RATIS, EC. |
| `ozone.service.shutdown.timeout` | 60s | `OZONE`, `OM`, `SCM`, `DATANODE`,
`RECON`, `S3GATEWAY` | Timeout to wait for each shutdown operation to
completeIf a hook takes longer than this time to complete, it will be
interrupted, so the service will shutdown. This allows the service shutdown to
recover from a blocked operation. The minimum duration of the timeout is 1
second, if hook has been configured with a timeout less than 1 second. |
-| `ozone.snapshot.deep.cleaning.enabled` | false | `OZONE`, `PERFORMANCE`,
`OM` | Flag to enable/disable snapshot deep cleaning. |
+| `ozone.snapshot.deep.cleaning.enabled` | true | `OZONE`, `PERFORMANCE`,
`OM`, `DELETION` | Flag to enable/disable snapshot deep cleaning. |
| `ozone.snapshot.defrag.limit.per.task` | 1 | `OZONE`, `PERFORMANCE`, `OM` |
The maximum number of snapshots that would be defragmented in each task run of
snapshot defragmentation service. |
| `ozone.snapshot.defrag.service.interval` | -1 | `OZONE`, `PERFORMANCE`, `OM`
| Task interval of snapshot defragmentation service. |
| `ozone.snapshot.defrag.service.timeout` | 300s | `OZONE`, `PERFORMANCE`,
`OM` | Timeout value of a run of snapshot defragmentation service. |
-| `ozone.snapshot.deleting.limit.per.task` | 10 | `OZONE`, `PERFORMANCE`, `OM`
| The maximum number of snapshots that would be reclaimed by Snapshot Deleting
Service per run. |
-| `ozone.snapshot.deleting.service.interval` | 30s | `OZONE`, `PERFORMANCE`,
`OM` | The time interval between successive SnapshotDeletingService thread run.
|
-| `ozone.snapshot.deleting.service.timeout` | 300s | `OZONE`, `PERFORMANCE`,
`OM` | Timeout value for SnapshotDeletingService. |
+| `ozone.snapshot.deleting.limit.per.task` | 10 | `OZONE`, `PERFORMANCE`,
`OM`, `DELETION` | The maximum number of snapshots that would be reclaimed by
Snapshot Deleting Service per run. |
+| `ozone.snapshot.deleting.service.interval` | 30s | `OZONE`, `PERFORMANCE`,
`OM`, `DELETION` | The time interval between successive SnapshotDeletingService
thread run. |
+| `ozone.snapshot.deleting.service.timeout` | 300s | `OZONE`, `PERFORMANCE`,
`OM`, `DELETION` | Timeout value for SnapshotDeletingService. |
| `ozone.snapshot.directory.service.interval` | 24h | `OZONE`, `PERFORMANCE`,
`OM`, `DEPRECATED` | DEPRECATED. The time interval between successive
SnapshotDirectoryCleaningService thread run. |
| `ozone.snapshot.directory.service.timeout` | 300s | `OZONE`, `PERFORMANCE`,
`OM`, `DEPRECATED` | DEPRECATED. Timeout value for
SnapshotDirectoryCleaningService. |
-| `ozone.snapshot.filtering.limit.per.task` | 2 | `OZONE`, `PERFORMANCE`, `OM`
| A maximum number of snapshots to be filtered by sst filtering service per
time interval. |
-| `ozone.snapshot.filtering.service.interval` | 1m | `OZONE`, `PERFORMANCE`,
`OM` | Time interval of the SST File filtering service from Snapshot. |
-| `ozone.snapshot.key.deleting.limit.per.task` | 20000 | `OM`, `PERFORMANCE` |
The maximum number of deleted keys to be scanned by Snapshot Deleting Service
per snapshot run. |
+| `ozone.snapshot.filtering.limit.per.task` | 2 | `OZONE`, `PERFORMANCE`,
`OM`, `DELETION` | A maximum number of snapshots to be filtered by sst
filtering service per time interval. |
+| `ozone.snapshot.filtering.service.interval` | 1m | `OZONE`, `PERFORMANCE`,
`OM`, `DELETION` | Time interval of the SST File filtering service from
Snapshot. |
+| `ozone.snapshot.key.deleting.limit.per.task` | 20000 | `OM`, `PERFORMANCE`,
`DELETION` | The maximum number of deleted keys to be scanned by Snapshot
Deleting Service per snapshot run. |
| `ozone.ssl.enabled.protocols` | | `OZONE`, `SECURITY`, `CRYPTO_COMPLIANCE`
| The supported SSL protocols used to restrict connections towards the WebUI of
different components, and the S3 GateWay. |
-| `ozone.sst.filtering.service.timeout` | 300000ms | `OZONE`, `PERFORMANCE`,
`OM` | A timeout value of sst filtering service. |
+| `ozone.sst.filtering.service.timeout` | 300000ms | `OZONE`, `PERFORMANCE`,
`OM`, `DELETION` | A timeout value of sst filtering service. |
| `ozone.tracing.enabled` | false | `OZONE`, `HDDS` | If true, tracing is
initialized and spans may be exported (subject to sampling). |
| `ozone.tracing.endpoint` | | `OZONE`, `HDDS` | OTLP gRPC receiver endpoint
URL. |
| `ozone.tracing.sampler` | -1 | `OZONE`, `HDDS` | Root trace sampling ratio
(0.0 to 1.0). |
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
