Skip to content

Commit

Permalink
[DOCFIX] Update generated tables with docGen
Browse files Browse the repository at this point in the history
pr-link: #17133
change-id: cid-edd9b8f6eaa4b01b081879a3743097098ce2f4f8
  • Loading branch information
Xenorith committed Mar 23, 2023
1 parent b16a3fb commit a95d3de
Show file tree
Hide file tree
Showing 8 changed files with 41 additions and 5 deletions.
12 changes: 10 additions & 2 deletions docs/_data/table/common-configuration.csv
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
propertyName,defaultValue
alluxio.conf.dynamic.update.enabled,"false"
alluxio.debug,"false"
alluxio.exit.collect.info,"true"
alluxio.fuse.auth.policy.class,"alluxio.fuse.auth.LaunchUserGroupAuthPolicy"
alluxio.fuse.auth.policy.custom.group,""
alluxio.fuse.auth.policy.custom.user,""
Expand Down Expand Up @@ -82,22 +83,29 @@ alluxio.network.host.resolution.timeout,"5sec"
alluxio.network.ip.address.used,"false"
alluxio.proxy.audit.logging.enabled,"false"
alluxio.proxy.s3.bucket.naming.restrictions.enabled,"false"
alluxio.proxy.s3.bucketpathcache.timeout,"1min"
alluxio.proxy.s3.complete.multipart.upload.keepalive.enabled,"false"
alluxio.proxy.s3.complete.multipart.upload.keepalive.time.interval,"30sec"
alluxio.proxy.s3.complete.multipart.upload.min.part.size,"5MB"
alluxio.proxy.s3.complete.multipart.upload.pool.size,"20"
alluxio.proxy.s3.deletetype,"ALLUXIO_AND_UFS"
alluxio.proxy.s3.global.read.rate.limit.mb,"0"
alluxio.proxy.s3.header.metadata.max.size,"2KB"
alluxio.proxy.s3.multipart.upload.cleaner.enabled,"true"
alluxio.proxy.s3.multipart.upload.cleaner.enabled,"false"
alluxio.proxy.s3.multipart.upload.cleaner.pool.size,"1"
alluxio.proxy.s3.multipart.upload.cleaner.retry.count,"3"
alluxio.proxy.s3.multipart.upload.cleaner.retry.delay,"10sec"
alluxio.proxy.s3.multipart.upload.cleaner.timeout,"10min"
alluxio.proxy.s3.single.connection.read.rate.limit.mb,"0"
alluxio.proxy.s3.tagging.restrictions.enabled,"true"
alluxio.proxy.s3.v2.async.heavy.pool.core.thread.number,"8"
alluxio.proxy.s3.v2.async.heavy.pool.maximum.thread.number,"64"
alluxio.proxy.s3.v2.async.heavy.pool.queue.size,"65536"
alluxio.proxy.s3.v2.async.light.pool.core.thread.number,"8"
alluxio.proxy.s3.v2.async.light.pool.maximum.thread.number,"64"
alluxio.proxy.s3.v2.async.light.pool.queue.size,"65536"
alluxio.proxy.s3.v2.async.processing.enabled,"false"
alluxio.proxy.s3.v2.version.enabled,"false"
alluxio.proxy.s3.v2.version.enabled,"true"
alluxio.proxy.s3.writetype,"CACHE_THROUGH"
alluxio.proxy.stream.cache.timeout,"1hour"
alluxio.proxy.web.bind.host,"0.0.0.0"
Expand Down
18 changes: 17 additions & 1 deletion docs/_data/table/en/common-configuration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ alluxio.conf.dynamic.update.enabled:
'Whether to support dynamic update property.'
alluxio.debug:
'Set to true to enable debug mode which has additional logging and info in the Web UI.'
alluxio.exit.collect.info:
'If true, the process will dump metrics and jstack into the log folder. This only applies to Alluxio master and worker processes.'
alluxio.fuse.auth.policy.class:
'The fuse auth policy class. Valid options include: `alluxio.fuse.auth.LaunchUserGroupAuthPolicy` using the user launching the AlluxioFuse application to do authentication, `alluxio.fuse.auth.SystemUserGroupAuthPolicy` using the end-user running the fuse command to do authentication which matches POSIX standard but sacrifices performance, `alluxio.fuse.auth.CustomAuthPolicy` using the custom user group to do authentication.'
alluxio.fuse.auth.policy.custom.group:
Expand Down Expand Up @@ -164,6 +166,8 @@ alluxio.proxy.audit.logging.enabled:
'Set to true to enable proxy audit.'
alluxio.proxy.s3.bucket.naming.restrictions.enabled:
'Toggles whether or not the Alluxio S3 API will enforce AWS S3 bucket naming restrictions. See https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html.'
alluxio.proxy.s3.bucketpathcache.timeout:
'Expire bucket path statistics in cache for this time period. Set 0min to disable the cache.'
alluxio.proxy.s3.complete.multipart.upload.keepalive.enabled:
'Whether or not to enabled sending whitespace characters as a keepalive message during CompleteMultipartUpload. Enabling this will cause any errors to be silently ignored. However, the errors will appear in the Proxy logs.'
alluxio.proxy.s3.complete.multipart.upload.keepalive.time.interval:
Expand All @@ -179,7 +183,7 @@ alluxio.proxy.s3.global.read.rate.limit.mb:
alluxio.proxy.s3.header.metadata.max.size:
'The maximum size to allow for user-defined metadata in S3 PUTrequest headers. Set to 0 to disable size limits.'
alluxio.proxy.s3.multipart.upload.cleaner.enabled:
'Whether or not to enable automatic cleanup of long-running multipart uploads.'
'Enable automatic cleanup of long-running multipart uploads.'
alluxio.proxy.s3.multipart.upload.cleaner.pool.size:
'The abort multipart upload cleaner pool size.'
alluxio.proxy.s3.multipart.upload.cleaner.retry.count:
Expand All @@ -192,6 +196,18 @@ alluxio.proxy.s3.single.connection.read.rate.limit.mb:
'Limit the maximum read speed for each connection. Set value less than or equal to 0 to disable rate limits.'
alluxio.proxy.s3.tagging.restrictions.enabled:
'Toggles whether or not the Alluxio S3 API will enforce AWS S3 tagging restrictions (10 tags, 128 character keys, 256 character values) See https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging-managing.html.'
alluxio.proxy.s3.v2.async.heavy.pool.core.thread.number:
'Core thread number for async heavy thread pool.'
alluxio.proxy.s3.v2.async.heavy.pool.maximum.thread.number:
'Maximum thread number for async heavy thread pool.'
alluxio.proxy.s3.v2.async.heavy.pool.queue.size:
'Queue size for async heavy thread pool.'
alluxio.proxy.s3.v2.async.light.pool.core.thread.number:
'Core thread number for async light thread pool.'
alluxio.proxy.s3.v2.async.light.pool.maximum.thread.number:
'Maximum thread number for async light thread pool.'
alluxio.proxy.s3.v2.async.light.pool.queue.size:
'Queue size for async light thread pool.'
alluxio.proxy.s3.v2.async.processing.enabled:
'(Experimental) If enabled, handle S3 request in async mode when v2 version of Alluxio s3 proxy service is enabled.'
alluxio.proxy.s3.v2.version.enabled:
Expand Down
6 changes: 6 additions & 0 deletions docs/_data/table/en/master-configuration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,14 @@ alluxio.master.embedded.journal.unsafe.flush.enabled:
'If true, embedded journal entries will be committed without waiting for the entry to be flushed to disk. This may improve performance of write operations on the Alluxio master if the journal is written to a slow or contested disk. WARNING: enabling this property may result in metadata loss if half or more of the master nodes fail. See Ratis property raft.server.log.unsafe-flush.enabled at https://github.com/apache/ratis/blob/master/ratis-docs/src/site/markdown/configuraions.md.'
alluxio.master.embedded.journal.write.timeout:
'Maximum time to wait for a write/flush on embedded journal.'
alluxio.master.failover.collect.info:
'If true, the primary master will persist metrics and jstack into the log folder when it transitions to standby. '
alluxio.master.file.access.time.journal.flush.interval:
'The minimum interval between files access time update journal entries get flushed asynchronously. Setting it to a non-positive value will make the the journal update synchronous. Asynchronous update reduces the performance impact of tracking access time but can lose some access time update when master stops unexpectedly.'
alluxio.master.file.access.time.update.precision:
'The file last access time is precise up to this value. Setting it toa non-positive value will update last access time on every file access operation.Longer precision will help reduce the performance impact of tracking access time by reduce the amount of metadata writes occur while reading the same group of files repetitively.'
alluxio.master.file.access.time.updater.enabled:
'If enabled, file access time updater will update the file last access time when an inode is accessed. This property can be turned off to improve performance and reduce the number of journal entries if your application does not rely on the file access time metadata.'
alluxio.master.file.access.time.updater.shutdown.timeout:
'Maximum time to wait for access updater to stop on shutdown.'
alluxio.master.filesystem.liststatus.result.message.length:
Expand Down Expand Up @@ -346,6 +350,8 @@ alluxio.master.standby.heartbeat.interval:
'The heartbeat interval between Alluxio primary master and standby masters.'
alluxio.master.startup.block.integrity.check.enabled:
'Whether the system should be checked on startup for orphaned blocks (blocks having no corresponding files but still taking system resource due to various system failures). Orphaned blocks will be deleted during master startup if this property is true. This property is available since 1.7.1'
alluxio.master.state.lock.error.threshold:
'Used to trace and debug state lock issues. When a thread recursively acquires the state lock more than threshold, log an error for further debugging.'
alluxio.master.throttle.active.cpu.load.ratio:
'N/A'
alluxio.master.throttle.active.heap.gc.time:
Expand Down
2 changes: 2 additions & 0 deletions docs/_data/table/en/master-metrics.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Master.BlockHeapSize:
'An estimate of the blocks heap size'
Master.BlockReplicaCount:
'Total number of block replicas in Alluxio'
Master.CachedBlockLocations:
'Total number of cached block locations'
Master.CompleteFileOps:
'Total number of the CompleteFile operations'
Master.CompletedOperationRetryCount:
Expand Down
2 changes: 1 addition & 1 deletion docs/_data/table/en/user-configuration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ alluxio.user.file.copyfromlocal.block.location.policy.class:
alluxio.user.file.create.ttl:
'Time to live for files created by a user, no ttl by default.'
alluxio.user.file.create.ttl.action:
'When file''s ttl is expired, the action performs on it. Options: DELETE_ALLUXIO(default), FREE or DELETE'
'When file''s ttl is expired, the action performs on it. Options: FREE(default), DELETE_ALLUXIO or DELETE'
alluxio.user.file.delete.unchecked:
'Whether to check if the UFS contents are in sync with Alluxio before attempting to delete persisted directories recursively.'
alluxio.user.file.include.operation.id:
Expand Down
3 changes: 3 additions & 0 deletions docs/_data/table/master-configuration.csv
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,10 @@ alluxio.master.embedded.journal.transport.max.inbound.message.size,"100MB"
alluxio.master.embedded.journal.transport.request.timeout.ms,"5sec"
alluxio.master.embedded.journal.unsafe.flush.enabled,"false"
alluxio.master.embedded.journal.write.timeout,"30sec"
alluxio.master.failover.collect.info,"true"
alluxio.master.file.access.time.journal.flush.interval,"1h"
alluxio.master.file.access.time.update.precision,"1d"
alluxio.master.file.access.time.updater.enabled,"true"
alluxio.master.file.access.time.updater.shutdown.timeout,"1sec"
alluxio.master.filesystem.liststatus.result.message.length,"10000"
alluxio.master.filesystem.merge.inode.journals,"true"
Expand Down Expand Up @@ -173,6 +175,7 @@ alluxio.master.shell.backup.state.lock.timeout,"0s"
alluxio.master.shell.backup.state.lock.try.duration,"0s"
alluxio.master.standby.heartbeat.interval,"2min"
alluxio.master.startup.block.integrity.check.enabled,"false"
alluxio.master.state.lock.error.threshold,"20"
alluxio.master.throttle.active.cpu.load.ratio,"0.5"
alluxio.master.throttle.active.heap.gc.time,"1sec"
alluxio.master.throttle.active.heap.used.ratio,"0.5"
Expand Down
1 change: 1 addition & 0 deletions docs/_data/table/master-metrics.csv
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Master.AsyncPersistSuccess,COUNTER
Master.AuditLogEntriesSize,GAUGE
Master.BlockHeapSize,GAUGE
Master.BlockReplicaCount,GAUGE
Master.CachedBlockLocations,GAUGE
Master.CompleteFileOps,COUNTER
Master.CompletedOperationRetryCount,COUNTER
Master.CreateDirectoryOps,COUNTER
Expand Down
2 changes: 1 addition & 1 deletion docs/_data/table/user-configuration.csv
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ alluxio.user.date.format.pattern,"MM-dd-yyyy HH:mm:ss:SSS"
alluxio.user.file.buffer.bytes,"8MB"
alluxio.user.file.copyfromlocal.block.location.policy.class,"alluxio.client.block.policy.RoundRobinPolicy"
alluxio.user.file.create.ttl,"-1"
alluxio.user.file.create.ttl.action,"DELETE_ALLUXIO"
alluxio.user.file.create.ttl.action,"FREE"
alluxio.user.file.delete.unchecked,"false"
alluxio.user.file.include.operation.id,"true"
alluxio.user.file.master.client.pool.gc.interval,"120sec"
Expand Down

0 comments on commit a95d3de

Please sign in to comment.