This is an automated email from the ASF dual-hosted git repository.
sarvekshayr 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 68b41867dc HDDS-15171. [Auto] Update configuration documentation (#493)
68b41867dc is described below
commit 68b41867dc2a8c60ad1b9e3a0fe15e320d62efdc
Author: asf-ci-deploy <[email protected]>
AuthorDate: Tue Jul 28 12:31:39 2026 +0200
HDDS-15171. [Auto] Update configuration documentation (#493)
Co-authored-by: github-actions[bot]
<github-actions[bot]@users.noreply.github.com>
---
.../02-configuration/99-appendix.md | 21 ++++++++++++++++-----
1 file changed, 16 insertions(+), 5 deletions(-)
diff --git a/docs/05-administrator-guide/02-configuration/99-appendix.md
b/docs/05-administrator-guide/02-configuration/99-appendix.md
index 35779bcc61..be2907a8e8 100644
--- a/docs/05-administrator-guide/02-configuration/99-appendix.md
+++ b/docs/05-administrator-guide/02-configuration/99-appendix.md
@@ -192,6 +192,7 @@ This page provides a comprehensive overview of the
configuration keys available
| `hdds.grpc.tls.enabled` | false | `OZONE`, `HDDS`, `SECURITY`, `TLS` | If
HDDS GRPC server TLS is enabled. |
| `hdds.grpc.tls.protocols` | | `OZONE`, `HDDS`, `SECURITY`, `TLS`,
`CRYPTO_COMPLIANCE` | Comma-separated list of TLS protocol versions for gRPC
server endpoints (e.g. "TLSv1.3" or "TLSv1.2,TLSv1.3"). When empty, the TLS
provider's defaults are used. Applies to server endpoints only; clients are not
restricted. |
| `hdds.grpc.tls.provider` | OPENSSL | `OZONE`, `HDDS`, `SECURITY`, `TLS`,
`CRYPTO_COMPLIANCE` | HDDS GRPC server TLS provider. |
+| `hdds.heartbeat.address.refresh.missed-count-threshold` | 3 | `OZONE`,
`DATANODE`, `HA` | Consecutive heartbeat failures the DataNode tolerates
against one SCM endpoint before re-resolving its hostname. Only consulted when
`ozone.client.failover.resolve-needed` is true. |
| `hdds.heartbeat.initial-interval` | 2s | `OZONE`, `MANAGEMENT` | Heartbeat
interval used during Datanode initialization for SCM. |
| `hdds.heartbeat.interval` | 30s | `OZONE`, `MANAGEMENT` | The heartbeat
interval from a data node to SCM. Yes, it is not three but 30, since most data
nodes will heart beating via Ratis heartbeats. If a client is not able to talk
to a data node, it will notify OM/SCM eventually. So a 30 second HB seems to
work. This assumes that replication strategy used is Ratis if not, this value
should be set to something smaller like 3 seconds.
ozone.scm.pipeline.close.timeout should also be adjust [...]
| `hdds.heartbeat.recon.initial-interval` | 60s | `OZONE`, `MANAGEMENT`,
`RECON` | Heartbeat interval used during Datanode initialization for Recon. |
@@ -395,11 +396,6 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.client.wait.between.retries.millis` | 2000 | | Expert only. The time
to wait, in milliseconds, between retry attempts to contact OM. Wait time
increases linearly if same OM is retried again. If retrying on multiple OMs
proxies in round robin fashion, the wait time is introduced after all the OM
proxies have been attempted once. |
| `ozone.container.cache.lock.stripes` | 1024 | `PERFORMANCE`, `CONTAINER`,
`STORAGE` | Container DB open is an exclusive operation. We use a stripe lock
to guarantee that different threads can open different container DBs
concurrently, while for one container DB, only one thread can open it at the
same time. This setting controls the lock stripes. |
| `ozone.container.cache.size` | 1024 | `PERFORMANCE`, `CONTAINER`, `STORAGE`
| The open container is cached on the data node side. We maintain an LRU cache
for caching the recently used containers. This setting controls the size of
that cache. |
-| `ozone.csi.default-volume-size` | 1000000000 | `STORAGE` | The default size
of the create volumes (if not specified). |
-| `ozone.csi.mount.command` | goofys --endpoint %s %s %s | `STORAGE` | This is
the mount command which is used to publish volume. these %s will be replicated
by s3gAddress, volumeId and target path. |
-| `ozone.csi.owner` | | `STORAGE` | This is the username which is used to
create the requested storage. Used as a hadoop username and the generated ozone
volume used to store all the buckets. WARNING: It can be a security hole to use
CSI in a secure environments as ALL the users can request the mount of a
specific bucket via the CSI interface. |
-| `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`, `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. |
@@ -426,6 +422,16 @@ This page provides a comprehensive overview of the
configuration keys available
| `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`,
`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.lifecycle.service.delete.batch-size` | 1000 | `OZONE` | Max numbers
of objects allowed for deletion in a batch for a lifecycle evaluating task. |
+| `ozone.lifecycle.service.delete.cached.directory.max-count` | 1000000 |
`OZONE` | Max numbers of directory objects held in memory stack for recursive
FSO bucket evaluating for a lifecycle evaluating task. Once the cached
directory objects exceeds this limit, the evaluation of the involved
directories will abort. |
+| `ozone.lifecycle.service.enabled` | false | `OZONE` | It specifies whether
to enable lifecycle management service. |
+| `ozone.lifecycle.service.interval` | 24h | `OZONE` | Interval at which key
lifecycle management service will run. |
+| `ozone.lifecycle.service.move.to.trash.enabled` | true | `OZONE` | When
enabled KeyLifecycleService will move expired keys/dirs to trash if trash is
available. When disabled, it will delete them directly. |
+| `ozone.lifecycle.service.mpu.abort.limit.per.task` | 1000 | `OZONE` |
Maximum number of multipart upload parts (rounded up to complete uploads) to
abort in a single task when processing AbortIncompleteMultipartUpload lifecycle
rules. |
+| `ozone.lifecycle.service.state.save.interval.ms` | 300000 | `OZONE` | The
interval of bucket scan task saves its pointer to DB. Default is 5 mins. |
+| `ozone.lifecycle.service.state.save.keys.processed` | 100000 | `OZONE` |
Bucket scan task will save its pointer to DB by default every 100000 keys are
scanned. Bucket scan pointer save will happen when either
`ozone.lifecycle.service.state.save.interval.ms` or
`ozone.lifecycle.service.state.save.keys.processed` is satisfied. |
+| `ozone.lifecycle.service.timeout` | 2h | `OZONE` | Timeout for task of key
lifecycle management service. |
+| `ozone.lifecycle.service.workers` | 5 | `OZONE` | Number of workers executed
of key lifecycle management service. This configuration should be set to
greater than 0. |
| `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 [...]
| `ozone.manager.delegation.token.renew-interval` | 1d | | Default time
interval after which ozone delegation token will require renewal before any
further use. |
@@ -440,8 +446,12 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.om.admin.protocol.max.retries` | 20 | `OM`, `MANAGEMENT` | Expert
only. The maximum number of retries for Ozone Manager Admin protocol on each
OM. |
| `ozone.om.admin.protocol.wait.between.retries` | 1000 | `OM`, `MANAGEMENT` |
Expert only. The time to wait, in milliseconds, between retry attempts for
Ozone Manager Admin protocol. |
| `ozone.om.allow.leader.skip.linearizable.read` | false | `OM`,
`PERFORMANCE`, `HA` | Allow leader to handler requests directly, no need to
check the leadership for every request. |
+| `ozone.om.block.write.sort.datanodes.enabled` | false | `OM`, `PERFORMANCE`
| If true, OM sorts the streaming-write pipeline (nearest datanode first)
locally using its cached cluster topology, instead of asking SCM to sort on
every allocateBlock. Defaults to false so SCM performs the sort. Enable this to
offload the sort from SCM when multiple OM services share a single SCM service.
|
+| `ozone.om.bootstrap.checkpoint.estimated.space.headroom.ratio` | 2.0 |
`OZONE`, `OM`, `HA`, `MANAGEMENT` | Multiplier applied to the leader-reported
estimated uncompressed SST byte total
(X-Ozone-Om-Checkpoint-Estimated-Sst-Bytes) to approximate space needed for the
checkpoint tar and unpack on the follower before streaming the response body. |
+| `ozone.om.bootstrap.min.space` | 5GB | `OZONE`, `OM`, `HA`, `MANAGEMENT` |
Minimum free space required on the volume that holds
`ozone.om.ratis.snapshot.dir` before an OM follower downloads a ratis/bootstrap
checkpoint from the leader, when the leader does not supply the
X-Ozone-Om-Checkpoint-Estimated-Sst-Bytes header (incremental checkpoint or
older OM version). Use storage size syntax (e.g. 10GB). Set to 0 to disable
this fallback check. |
| `ozone.om.client.rpc.timeout` | 15m | `OZONE`, `OM`, `CLIENT` | RpcClient
timeout on waiting for the response from OzoneManager. The default value is set
to 15 minutes. If ipc.client.ping is set to true and this rpc-timeout is
greater than the value of ipc.ping.interval, the effective value of the
rpc-timeout is rounded up to multiple of ipc.ping.interval. |
| `ozone.om.client.trash.core.pool.size` | 5 | `OZONE`, `OM`, `CLIENT` | Total
number of threads in pool for the Trash Emptier |
+| `ozone.om.compaction.service.bottommost-level-compaction` | kSkip | `OZONE`,
`OM`, `PERFORMANCE` | Bottommost level compaction type for compaction. Invalid
values will default to kSkip. Valid values: kSkip, kIfHaveCompactionFilter,
kForce, kForceOptimized. |
| `ozone.om.compaction.service.columnfamilies` |
keyTable,fileTable,directoryTable,deletedTable,deletedDirectoryTable,multipartInfoTable
| `OZONE`, `OM`, `PERFORMANCE` | A comma separated, no spaces list of all the
column families that are compacted by the compaction service. If this is empty,
no column families are compacted. |
| `ozone.om.compaction.service.enabled` | false | `OZONE`, `OM`, `PERFORMANCE`
| Enable or disable a background job that periodically compacts rocksdb tables
flagged for compaction. |
| `ozone.om.compaction.service.run.interval` | 6h | `OZONE`, `OM`,
`PERFORMANCE` | A background job that periodically compacts rocksdb tables
flagged for compaction. Unit could be defined with postfix (ns,ms,s,m,h,d) |
@@ -691,6 +701,7 @@ This page provides a comprehensive overview of the
configuration keys available
| `ozone.scm.container.lock.stripes` | 512 | `OZONE`, `SCM`, `PERFORMANCE`,
`MANAGEMENT` | The number of stripes created for the container state manager
lock. |
| `ozone.scm.container.placement.ec.impl` |
org.apache.hadoop.hdds.scm.container.placement.algorithms.SCMContainerPlacementRackScatter
| `OZONE`, `MANAGEMENT` | The full name of class which implements
org.apache.hadoop.hdds.scm.PlacementPolicy. The class decides which datanode
will be used to host the container replica in EC mode. If not set,
org.apache.hadoop.hdds.scm.container.placement.algorithms.SCMContainerPlacementRackScatter
will be used as default value. |
| `ozone.scm.container.placement.impl` |
org.apache.hadoop.hdds.scm.container.placement.algorithms.SCMContainerPlacementRackAware
| `OZONE`, `MANAGEMENT` | The full name of class which implements
org.apache.hadoop.hdds.scm.PlacementPolicy. The class decides which datanode
will be used to host the container replica. If not set,
org.apache.hadoop.hdds.scm.container.placement.algorithms.SCMContainerPlacementRackAware
will be used as default value. |
+| `ozone.scm.container.placement.rack.scatter.capacity.aware.enabled` | false
| `OZONE`, `SCM`, `MANAGEMENT` | Enables capacity-aware datanode selection
within a rack when SCMContainerPlacementRackScatter is used. When enabled, SCM
chooses the less utilized of two randomly selected datanodes. |
| `ozone.scm.container.size` | 5GB | `OZONE`, `PERFORMANCE`, `MANAGEMENT` |
Default container size used by Ozone. There are two considerations while
picking this number. The speed at which a container can be replicated,
determined by the network speed and the metadata that each container generates.
So selecting a large number creates less SCM metadata, but recovery time will
be more. 5GB is a number that maps to quick replication times in gigabit
networks, but still balances the amount o [...]
| `ozone.scm.datanode.address` | | `OZONE`, `MANAGEMENT` | The address of the
Ozone SCM service used for internal communication between the DataNodes and the
SCM. It is a string in the host:port format. The port number is optional and
defaults to 9861. This setting is optional. If unspecified then the hostname
portion is picked from the `ozone.scm.client.address` setting and the default
service port of 9861 is chosen. |
| `ozone.scm.datanode.admin.monitor.interval` | 30s | `SCM` | This sets how
frequently the datanode admin monitor runs to check for nodes added to the
admin workflow or removed from it. The progress of decommissioning and entering
maintenance nodes is also checked to see if they have completed. |
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
