Skip to content

Configuration Name Changes

Derek Moore edited this page Jul 9, 2021 · 33 revisions

Related Issues: PR 4713

Overview

The above PR replaced most of the old configuration item names with new names, according to the new Configuration Naming Guidelines. The next section lists both the old and new configuration names side-by-side.

Note about backward compatibility:

  • As of v0.8, old configuration names are deprecated but continue to work. At a later point, old configurations will be removed, so prefer using new names going forward.
  • A deployment may use new and old names for different configuration items. However, that should be avoided in order to avoid confusion.
  • If a configuration is specified using both old and new configuration, the one specified using the old name takes precedence. For example, if you configure a configuration using both old and new names controller.containerCount=4 (old) and controller.container.count=8 (new), the system will interpret the configuration as having the value 4.

Changes in Configuration Property Names

Controller

Old Property Name New Property Name
controller.containerCount controller.container.count
controller.hostMonitorEnabled controller.hostMonitor.enable
controller.minRebalanceIntervalSeconds controller.rebalance.interval.seconds.min
controller.replyWithStackTraceOnError controller.request.replyWithStackTraceOnError.enable
controller.requestTracingEnabled controller.request.tracing.enable
controller.dumpStackOnShutdown controller.dumpStackOnShutdown.enable
controller.usePravegaTables controller.pravegaTables.enable
controller.service.port controller.service.rpc.listener.port
controller.service.restIp controller.service.rest.listener.host.ip
controller.service.restPort controller.service.rest.listener.port
controller.service.asyncTaskPoolSize controller.service.asyncTaskPool.size
controller.service.hostIp controller.segmentstore.connect.host.nameOrIp
controller.service.hostPort controller.segmentstore.connect.port
controller.service.publishedRPCHost controller.service.rpc.published.host.nameOrIp
controller.service.publishedRPCPort controller.service.rpc.published.port
controller.service.cluster controller.cluster.name
controller.rest.tlsKeyStoreFile controller.security.tls.server.keyStore.location
controller.rest.tlsKeyStorePasswordFile controller.security.tls.server.keyStore.pwd.location
controller.auth.enabled controller.security.auth.enable
controller.auth.userPasswordFile controller.security.pwdAuthHandler.accountsDb.location
controller.auth.tokenSigningKey controller.security.auth.delegationToken.signingKey.basis
controller.auth.accessTokenTtlSeconds controller.security.auth.delegationToken.ttl.seconds
controller.auth.tlsEnabled controller.security.tls.enable
controller.auth.tlsCertFile controller.security.tls.server.certificate.location
controller.auth.tlsTrustStore controller.security.tls.trustStore.location
controller.auth.tlsKeyFile controller.security.tls.server.privateKey.location
controller.auth.segmentStoreTlsEnabled controller.segmentstore.connect.channel.tls
controller.zkURL controller.zk.connect.uri
controller.zk.retryIntervalMillis controller.zk.connect.retries.interval.milliseconds
controller.maxRetries controller.zk.connect.retries.count.max
controller.sessionTimeoutMillis controller.zk.connect.session.timeout.milliseconds
controller.secureConnection controller.zk.connect.security.enable
controller.zk.tlsTrustStoreFile controller.zk.connect.security.tls.trustStore.location
controller.zk.tlsTrustStorePasswordFile controller.zk.connect.security.tls.trustStore.pwd.location
controller.retention.frequencyMinutes controller.retention.frequency.minutes
controller.retention.bucketCount controller.retention.bucket.count
controller.retention.threadCount controller.retention.thread.count
controller.transaction.minLeaseValue controller.transaction.lease.count.min
controller.transaction.maxLeaseValue controller.transaction.lease.count.max
controller.transaction.ttlHours controller.transaction.ttl.hours
controller.watermarking.frequencySeconds controller.watermarking.frequency.seconds
controller.watermarking.bucketCount controller.watermarking.bucket.count
controller.watermarking.threadCount controller.watermarking.thread.count
controller.scale.streamName controller.scale.request.stream.name
controller.scale.ReaderGroup controller.scale.request.readerGroup.name

Segment Store

PravegaService

Old Property Name New Property Name
pravegaservice.containerCount pravegaservice.container.count
pravegaservice.threadPoolSize pravegaservice.threadPool.core.size
pravegaservice.storageThreadPoolSize pravegaservice.threadPool.storage.size
pravegaservice.lowPriorityThreadPoolSize pravegaservice.threadPool.lowPriorityTasks.size
pravegaservice.listeningPort pravegaservice.service.listener.port
pravegaservice.publishedPort pravegaservice.service.published.port
pravegaservice.listeningIPAddress pravegaservice.service.listener.host.nameOrIp
pravegaservice.publishedIPAddress pravegaservice.service.published.host.nameOrIp
pravegaservice.zkURL pravegaservice.zk.connect.uri
pravegaservice.zkRetrySleepMs pravegaservice.zk.connect.retries.interval.milliseconds
pravegaservice.zkRetryCount pravegaservice.zk.connect.retries.count.max
pravegaservice.zkSessionTimeoutMs pravegaservice.zk.connect.sessionTimeout.milliseconds
pravegaservice.secureZK pravegaservice.zk.connect.security.enable
pravegaservice.zkTrustStore pravegaservice.zk.connect.security.tls.trustStore.location
pravegaservice.zkTrustStorePasswordPath pravegaservice.zk.connect.security.tls.trustStore.pwd.location
pravegaservice.pravega-cluster* pravegaservice.pravega-cluster (Note: Left as is, due to operator dependency
pravegaservice.dataLogImplementation pravegaservice.dataLog.impl.name
pravegaservice.storageImplementation pravegaservice.storage.impl.name
pravegaservice.readOnlySegmentStore pravegaservice.readOnly.enable
pravegaservice.cacheMaxSize pravegaservice.cache.size.max
pravegaservice.cacheTargetUtilizationPercent pravegaservice.cache.utilization.percent.target
pravegaservice.cacheMaxUtilizationPercent pravegaservice.cache.utilization.percent.max
pravegaservice.cacheMaxTimeSeconds pravegaservice.cache.time.seconds.max
pravegaservice.cacheGenerationTimeSeconds pravegaservice.cache.generation.duration.seconds
pravegaservice.replyWithStackTraceOnError pravegaservice.request.replyWithStackTraceOnError.enable
pravegaservice.instance.id pravegaservice.instance.id
pravegaservice.enableTls pravegaservice.security.tls.enable
pravegaservice.certFile pravegaservice.security.tls.server.certificate.location
pravegaservice.keyFile pravegaservice.security.tls.server.privateKey.location
pravegaservice.enableTlsReload pravegaservice.security.tls.certificate.autoReload.enable

Auto Scale

Old Property Name New Property Name
autoScale.requestStream autoScale.requestStream.name
autoScale.cooldownInSeconds autoScale.cooldown.time.seconds
autoScale.muteInSeconds autoScale.mute.time.seconds
autoScale.cacheCleanUpInSeconds autoScale.cache.cleanUp.interval.seconds
autoScale.cacheExpiryInSeconds autoScale.cache.expiry.seconds
autoScale.controllerUri autoScale.controller.connect.uri
autoScale.tlsEnabled autoScale.controller.connect.security.tls.enable
autoScale.tlsCertFile autoScale.controller.connect.security.tls.truststore.location
autoScale.authEnabled autoScale.controller.connect.security.auth.enable
autoScale.tokenSigningKey autoScale.security.auth.token.signingKey.basis
autoScale.validateHostName autoScale.controller.connect.security.tls.validateHostName.enable
autoScale.threadPoolSize autoScale.threadPool.size**

Durable Log

Old Property Name New Property Name
durablelog.checkpointMinCommitCount durablelog.checkpoint.commit.count.min
durablelog.checkpointCommitCountThreshold durablelog.checkpoint.commit.threshold.count
durablelog.checkpointTotalCommitLengthThreshold durablelog.checkpoint.commit.length.total
durablelog.startRetryDelayMillis durablelog.start.retry.delay.millis

Writer

Old Property Name New Property Name
writer.flushThresholdBytes writer.flush.threshold.bytes
writer.flushThresholdMillis writer.flush.threshold.milliseconds
writer.flushAttributesThreshold writer.flush.attributes.threshold
writer.maxFlushSizeBytes writer.flush.size.bytes.max
writer.maxItemsToReadAtOnce writer.itemsToReadAtOnce.max
writer.minReadTimeoutMillis writer.read.timeout.milliseconds.min
writer.maxReadTimeoutMillis writer.read.timeout.milliseconds.max
writer.errorSleepMillis writer.error.sleep.milliseconds
writer.flushTimeoutMillis writer.flush.timeout.milliseconds
writer.ackTimeoutMillis writer.ack.timeout.milliseconds
writer.shutdownTimeoutMillis writer.shutDown.timeout.milliseconds
writer.maxRolloverSizeBytes writer.rollover.size.bytes.max

Read Index

Old Property Name New Property Name
readindex.storageReadAlignment readindex.storageRead.alignment
readindex.memoryReadMinLength readindex.memoryRead.length.min
readindex.storageReadDefaultTimeoutMillis readindex.storageRead.timeout.default.millis

Bookkeeper

Old Property Name New Property Name
bookkeeper.zkAddress bookkeeper.zk.connect.uri
bookkeeper.zkSessionTimeoutMillis bookkeeper.zk.connect.sessionTimeout.milliseconds
bookkeeper.zkConnectionTimeoutMillis bookkeeper.zk.connect.sessionTimeout.milliseconds
bookkeeper.zkMetadataPath bookkeeper.zk.metadata.path
bookkeeper.zkHierarchyDepth bookkeeper.zk.metadata.hierarchy.depth
bookkeeper.maxWriteAttempts bookkeeper.write.attempts.count.max
bookkeeper.bkEnsembleSize bookkeeper.ensemble.size
bookkeeper.bkAckQuorumSize bookkeeper.ack.quorum.size
bookkeeper.bkWriteQuorumSize bookkeeper.write.quorum.size
bookkeeper.bkWriteTimeoutMillis bookkeeper.write.timeout.milliseconds
bookkeeper.bkReadTimeoutMillis bookkeeper.read.timeout.milliseconds
bookkeeper.readBatchSize bookkeeper.read.batch.size
bookkeeper.maxOutstandingBytes bookkeeper.write.outstanding.bytes.max
bookkeeper.bkLedgerMaxSize bookkeeper.ledger.size.max
bookkeeper.bkPass bookkeeper.connect.security.auth.pwd
bookkeeper.bkLedgerPath bookkeeper.ledger.path
bookkeeper.tlsEnabled bookkeeper.connect.security.tls.enable
bookkeeper.tlsTrustStorePath bookkeeper.connect.security.tls.trustStore.location
bookkeeper.tlsTrustStorePasswordPath bookkeeper.connect.security.trustStore.pwd.location
bookkeeper.enforceMinNumRacksPerWriteQuorum bookkeeper.write.quorum.racks.minimumCount.enable
bookkeeper.minNumRacksPerWriteQuorum bookkeeper.write.quorum.racks.count.min
bookkeeper.networkTopologyScriptFileName bookkeeper.networkTopology.script.location
bookkeeper.digestType bookkeeper.digest.type.name

Attribute Index

Old Property Name New Property Name
attributeindex.attributeSegmentRollingSizeBytes attributeindex.attributeSegment.rolling.size.bytes
attributeindex.maxIndexPageSizeBytes attributeindex.attributeSegment.indexPage.size.bytes.max

Segment Containers

Old Property Name New Property Name
containers.segmentMetadataExpirationSeconds containers.segment.metadata.expiry.seconds
containers.metadataStoreInitTimeoutSeconds containers.metadataStore.init.timeout.seconds
containers.maxActiveSegmentCount containers.segment.active.count.max
containers.maxConcurrentSegmentEvictionCount containers.segment.eviction.concurrent.count.max
containers.maxCachedExtendedAttributeCount containers.extended.attribute.cached.count.max

Extended S3

Old Property Name New Property Name
extendeds3.configUri extendeds3.connect.config.uri
extendeds3.bucket extendeds3.bucket
extendeds3.prefix extendeds3.prefix
extendeds3.useNoneMatch extendeds3.noneMatch.enable
extendeds3.smallObjectSizeLimitForConcat extendeds3.concat.smallObject.threshold.size

HDFS

Old Property Name New Property Name
hdfs.hdfsUrl hdfs.connect.uri
hdfs.hdfsRoot hdfs.root
hdfs.replication hdfs.replication.factor
hdfs.blockSize hdfs.block.size
hdfs.replaceDataNodesOnFailure hdfs.replaceDataNodesOnFailure.enable

Storage Extra

Old Property Name New Property Name
storageextra.storageNoOpMode storageextra.noOp.mode.enable
storageextra.storageWriteNoOpLatencyMillis storageextra.noOp.write.latency.milliseconds

Metrics

Old Property Name New Property Name
metrics.enableStatistics metrics.statistics.enable
metrics.dynamicCacheSize metrics.dynamicCache.size
metrics.dynamicCacheEvictionDurationMinutes metrics.dynamicCache.eviction.duration.minutes
metrics.outputFrequencySeconds metrics.output.frequency.seconds
metrics.metricsPrefix metrics.prefix
metrics.statsDHost metrics.statsD.connect.host
metrics.statsDPort metrics.statsD.connect.port
metrics.influxDBURI metrics.influxDB.connect.uri
metrics.influxDBName metrics.influxDB.connect.db.name
metrics.influxDBUserName metrics.influxDB.connect.credentials.username
metrics.influxDBPassword metrics.influxDB.connect.credentials.pwd
metrics.influxDBRetention metrics.influxDB.retention
metrics.enableStatsDReporter metrics.statsD.reporter.enable
metrics.enableInfluxDBReporter metrics.influxDB.reporter.enable

Standalone Mode Cluster

Old Property Name New Property Name
singlenode.zkPort singlenode.zk.port
singlenode.segmentstorePort singlenode.segmentStore.port
singlenode.segmentstoreEnableTlsReload singlenode.segmentStore.tls.certificate.autoReload.enable
singlenode.controllerPort singlenode.controller.rpc.port
singlenode.restServerPort singlenode.controller.rest.port
singlenode.enableRestServer singlenode.controller.rest.enable
singlenode.enableAuth singlenode.security.auth.enable
singlenode.userName singlenode.security.auth.credentials.username
singlenode.passwd singlenode.security.auth.credentials.pwd
singlenode.passwdFile singlenode.security.auth.pwdAuthHandler.accountsDb.location
singlenode.enableTls singlenode.security.tls.enable
singlenode.keyFile singlenode.security.tls.privateKey.location
singlenode.certFile singlenode.security.tls.certificate.location
singlenode.keyStoreJKS singlenode.security.tls.keyStore.location
singlenode.keyStoreJKSPasswordFile singlenode.security.tls.keyStore.pwd.location**
singlenode.trustStoreJKS singlenode.security.tls.trustStore.location

** Configuration names annotated with ** have bugs (that need to be fixed).

Clone this wiki locally