| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.hadoop.hdds.scm; |
| |
| import org.apache.hadoop.hdds.annotation.InterfaceAudience; |
| import org.apache.hadoop.hdds.annotation.InterfaceStability; |
| import org.apache.ratis.proto.RaftProtos.ReplicationLevel; |
| import org.apache.ratis.util.TimeDuration; |
| |
| import java.util.concurrent.TimeUnit; |
| |
| /** |
| * This class contains constants for configuration keys used in SCM. |
| */ |
| @InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| public final class ScmConfigKeys { |
| |
| // Location of SCM DB files. For now we just support a single |
| // metadata dir but in future we may support multiple for redundancy or |
| // performance. |
| public static final String OZONE_SCM_DB_DIRS = "ozone.scm.db.dirs"; |
| |
| public static final String DFS_CONTAINER_RATIS_ENABLED_KEY |
| = "dfs.container.ratis.enabled"; |
| public static final boolean DFS_CONTAINER_RATIS_ENABLED_DEFAULT |
| = false; |
| public static final String DFS_CONTAINER_RATIS_RPC_TYPE_KEY |
| = "dfs.container.ratis.rpc.type"; |
| public static final String DFS_CONTAINER_RATIS_RPC_TYPE_DEFAULT |
| = "GRPC"; |
| public static final String |
| DFS_CONTAINER_RATIS_NUM_WRITE_CHUNK_THREADS_PER_VOLUME |
| = "dfs.container.ratis.num.write.chunk.threads.per.volume"; |
| public static final int |
| DFS_CONTAINER_RATIS_NUM_WRITE_CHUNK_THREADS_PER_VOLUME_DEFAULT |
| = 10; |
| public static final String DFS_CONTAINER_RATIS_REPLICATION_LEVEL_KEY |
| = "dfs.container.ratis.replication.level"; |
| public static final ReplicationLevel |
| DFS_CONTAINER_RATIS_REPLICATION_LEVEL_DEFAULT = ReplicationLevel.MAJORITY; |
| public static final String DFS_CONTAINER_RATIS_NUM_CONTAINER_OP_EXECUTORS_KEY |
| = "dfs.container.ratis.num.container.op.executors"; |
| public static final int DFS_CONTAINER_RATIS_NUM_CONTAINER_OP_EXECUTORS_DEFAULT |
| = 10; |
| public static final String DFS_CONTAINER_RATIS_SEGMENT_SIZE_KEY = |
| "dfs.container.ratis.segment.size"; |
| public static final String DFS_CONTAINER_RATIS_SEGMENT_SIZE_DEFAULT = |
| "1MB"; |
| public static final String DFS_CONTAINER_RATIS_SEGMENT_PREALLOCATED_SIZE_KEY = |
| "dfs.container.ratis.segment.preallocated.size"; |
| public static final String |
| DFS_CONTAINER_RATIS_SEGMENT_PREALLOCATED_SIZE_DEFAULT = "16KB"; |
| public static final String |
| DFS_CONTAINER_RATIS_STATEMACHINEDATA_SYNC_TIMEOUT = |
| "dfs.container.ratis.statemachinedata.sync.timeout"; |
| public static final TimeDuration |
| DFS_CONTAINER_RATIS_STATEMACHINEDATA_SYNC_TIMEOUT_DEFAULT = |
| TimeDuration.valueOf(10, TimeUnit.SECONDS); |
| public static final String |
| DFS_CONTAINER_RATIS_STATEMACHINEDATA_SYNC_RETRIES = |
| "dfs.container.ratis.statemachinedata.sync.retries"; |
| public static final int |
| DFS_CONTAINER_RATIS_STATEMACHINEDATA_SYNC_RETRIES_DEFAULT = -1; |
| public static final String |
| DFS_CONTAINER_RATIS_STATEMACHINE_MAX_PENDING_APPLY_TXNS = |
| "dfs.container.ratis.statemachine.max.pending.apply-transactions"; |
| // The default value of maximum number of pending state machine apply |
| // transactions is kept same as default snapshot threshold. |
| public static final int |
| DFS_CONTAINER_RATIS_STATEMACHINE_MAX_PENDING_APPLY_TXNS_DEFAULT = |
| 100000; |
| public static final String DFS_CONTAINER_RATIS_LOG_QUEUE_NUM_ELEMENTS = |
| "dfs.container.ratis.log.queue.num-elements"; |
| public static final int DFS_CONTAINER_RATIS_LOG_QUEUE_NUM_ELEMENTS_DEFAULT = |
| 1024; |
| public static final String DFS_CONTAINER_RATIS_LOG_QUEUE_BYTE_LIMIT = |
| "dfs.container.ratis.log.queue.byte-limit"; |
| public static final String DFS_CONTAINER_RATIS_LOG_QUEUE_BYTE_LIMIT_DEFAULT = |
| "4GB"; |
| public static final String |
| DFS_CONTAINER_RATIS_LOG_APPENDER_QUEUE_NUM_ELEMENTS = |
| "dfs.container.ratis.log.appender.queue.num-elements"; |
| public static final int |
| DFS_CONTAINER_RATIS_LOG_APPENDER_QUEUE_NUM_ELEMENTS_DEFAULT = 1; |
| public static final String DFS_CONTAINER_RATIS_LOG_APPENDER_QUEUE_BYTE_LIMIT = |
| "dfs.container.ratis.log.appender.queue.byte-limit"; |
| public static final String |
| DFS_CONTAINER_RATIS_LOG_APPENDER_QUEUE_BYTE_LIMIT_DEFAULT = "32MB"; |
| public static final String DFS_CONTAINER_RATIS_LOG_PURGE_GAP = |
| "dfs.container.ratis.log.purge.gap"; |
| // TODO: Set to 1024 once RATIS issue around purge is fixed. |
| public static final int DFS_CONTAINER_RATIS_LOG_PURGE_GAP_DEFAULT = |
| 1000000; |
| public static final String DFS_CONTAINER_RATIS_LEADER_PENDING_BYTES_LIMIT = |
| "dfs.container.ratis.leader.pending.bytes.limit"; |
| public static final String |
| DFS_CONTAINER_RATIS_LEADER_PENDING_BYTES_LIMIT_DEFAULT = "1GB"; |
| |
| public static final String DFS_RATIS_SERVER_RETRY_CACHE_TIMEOUT_DURATION_KEY = |
| "dfs.ratis.server.retry-cache.timeout.duration"; |
| public static final TimeDuration |
| DFS_RATIS_SERVER_RETRY_CACHE_TIMEOUT_DURATION_DEFAULT = |
| TimeDuration.valueOf(600000, TimeUnit.MILLISECONDS); |
| public static final String |
| DFS_RATIS_LEADER_ELECTION_MINIMUM_TIMEOUT_DURATION_KEY = |
| "dfs.ratis.leader.election.minimum.timeout.duration"; |
| public static final TimeDuration |
| DFS_RATIS_LEADER_ELECTION_MINIMUM_TIMEOUT_DURATION_DEFAULT = |
| TimeDuration.valueOf(5, TimeUnit.SECONDS); |
| |
| public static final String DFS_RATIS_SNAPSHOT_THRESHOLD_KEY = |
| "dfs.ratis.snapshot.threshold"; |
| public static final long DFS_RATIS_SNAPSHOT_THRESHOLD_DEFAULT = 100000; |
| |
| // TODO : this is copied from OzoneConsts, may need to move to a better place |
| public static final String OZONE_SCM_CHUNK_SIZE_KEY = "ozone.scm.chunk.size"; |
| // 4 MB by default |
| public static final String OZONE_SCM_CHUNK_SIZE_DEFAULT = "4MB"; |
| |
| public static final String OZONE_SCM_CHUNK_LAYOUT_KEY = |
| "ozone.scm.chunk.layout"; |
| |
| public static final String OZONE_SCM_CLIENT_PORT_KEY = |
| "ozone.scm.client.port"; |
| public static final int OZONE_SCM_CLIENT_PORT_DEFAULT = 9860; |
| |
| public static final String OZONE_SCM_DATANODE_PORT_KEY = |
| "ozone.scm.datanode.port"; |
| public static final int OZONE_SCM_DATANODE_PORT_DEFAULT = 9861; |
| |
| // OZONE_OM_PORT_DEFAULT = 9862 |
| public static final String OZONE_SCM_BLOCK_CLIENT_PORT_KEY = |
| "ozone.scm.block.client.port"; |
| public static final int OZONE_SCM_BLOCK_CLIENT_PORT_DEFAULT = 9863; |
| |
| public static final String OZONE_SCM_SECURITY_SERVICE_PORT_KEY = |
| "ozone.scm.security.service.port"; |
| public static final int OZONE_SCM_SECURITY_SERVICE_PORT_DEFAULT = 9961; |
| |
| // Container service client |
| public static final String OZONE_SCM_CLIENT_ADDRESS_KEY = |
| "ozone.scm.client.address"; |
| public static final String OZONE_SCM_CLIENT_BIND_HOST_KEY = |
| "ozone.scm.client.bind.host"; |
| public static final String OZONE_SCM_CLIENT_BIND_HOST_DEFAULT = |
| "0.0.0.0"; |
| |
| // Block service client |
| public static final String OZONE_SCM_BLOCK_CLIENT_ADDRESS_KEY = |
| "ozone.scm.block.client.address"; |
| public static final String OZONE_SCM_BLOCK_CLIENT_BIND_HOST_KEY = |
| "ozone.scm.block.client.bind.host"; |
| public static final String OZONE_SCM_BLOCK_CLIENT_BIND_HOST_DEFAULT = |
| "0.0.0.0"; |
| |
| // SCM Security service address. |
| public static final String OZONE_SCM_SECURITY_SERVICE_ADDRESS_KEY = |
| "ozone.scm.security.service.address"; |
| public static final String OZONE_SCM_SECURITY_SERVICE_BIND_HOST_KEY = |
| "ozone.scm.security.service.bind.host"; |
| public static final String OZONE_SCM_SECURITY_SERVICE_BIND_HOST_DEFAULT = |
| "0.0.0.0"; |
| |
| public static final String OZONE_SCM_DATANODE_ADDRESS_KEY = |
| "ozone.scm.datanode.address"; |
| public static final String OZONE_SCM_DATANODE_BIND_HOST_KEY = |
| "ozone.scm.datanode.bind.host"; |
| public static final String OZONE_SCM_DATANODE_BIND_HOST_DEFAULT = |
| "0.0.0.0"; |
| |
| public static final String OZONE_SCM_HTTP_ENABLED_KEY = |
| "ozone.scm.http.enabled"; |
| public static final String OZONE_SCM_HTTP_BIND_HOST_KEY = |
| "ozone.scm.http-bind-host"; |
| public static final String OZONE_SCM_HTTPS_BIND_HOST_KEY = |
| "ozone.scm.https-bind-host"; |
| public static final String OZONE_SCM_HTTP_ADDRESS_KEY = |
| "ozone.scm.http-address"; |
| public static final String OZONE_SCM_HTTPS_ADDRESS_KEY = |
| "ozone.scm.https-address"; |
| |
| public static final String OZONE_SCM_HTTP_BIND_HOST_DEFAULT = "0.0.0.0"; |
| public static final int OZONE_SCM_HTTP_BIND_PORT_DEFAULT = 9876; |
| public static final int OZONE_SCM_HTTPS_BIND_PORT_DEFAULT = 9877; |
| |
| public static final String HDDS_REST_HTTP_ADDRESS_KEY = |
| "hdds.rest.http-address"; |
| public static final String HDDS_REST_HTTP_ADDRESS_DEFAULT = "0.0.0.0:9880"; |
| public static final String HDDS_DATANODE_DIR_KEY = "hdds.datanode.dir"; |
| public static final String HDDS_REST_CSRF_ENABLED_KEY = |
| "hdds.rest.rest-csrf.enabled"; |
| public static final boolean HDDS_REST_CSRF_ENABLED_DEFAULT = false; |
| public static final String HDDS_REST_NETTY_HIGH_WATERMARK = |
| "hdds.rest.netty.high.watermark"; |
| public static final int HDDS_REST_NETTY_HIGH_WATERMARK_DEFAULT = 65536; |
| public static final int HDDS_REST_NETTY_LOW_WATERMARK_DEFAULT = 32768; |
| public static final String HDDS_REST_NETTY_LOW_WATERMARK = |
| "hdds.rest.netty.low.watermark"; |
| |
| public static final String OZONE_SCM_HANDLER_COUNT_KEY = |
| "ozone.scm.handler.count.key"; |
| public static final int OZONE_SCM_HANDLER_COUNT_DEFAULT = 100; |
| |
| public static final String OZONE_SCM_SECURITY_HANDLER_COUNT_KEY = |
| "ozone.scm.security.handler.count.key"; |
| public static final int OZONE_SCM_SECURITY_HANDLER_COUNT_DEFAULT = 2; |
| |
| public static final String OZONE_SCM_DEADNODE_INTERVAL = |
| "ozone.scm.dead.node.interval"; |
| public static final String OZONE_SCM_DEADNODE_INTERVAL_DEFAULT = |
| "10m"; |
| |
| public static final String OZONE_SCM_HEARTBEAT_PROCESS_INTERVAL = |
| "ozone.scm.heartbeat.thread.interval"; |
| public static final String OZONE_SCM_HEARTBEAT_PROCESS_INTERVAL_DEFAULT = |
| "3s"; |
| |
| public static final String OZONE_SCM_STALENODE_INTERVAL = |
| "ozone.scm.stale.node.interval"; |
| public static final String OZONE_SCM_STALENODE_INTERVAL_DEFAULT = |
| "5m"; |
| |
| public static final String OZONE_SCM_HEARTBEAT_RPC_TIMEOUT = |
| "ozone.scm.heartbeat.rpc-timeout"; |
| public static final String OZONE_SCM_HEARTBEAT_RPC_TIMEOUT_DEFAULT = |
| "5s"; |
| |
| public static final String OZONE_SCM_HEARTBEAT_RPC_RETRY_COUNT = |
| "ozone.scm.heartbeat.rpc-retry-count"; |
| public static final int OZONE_SCM_HEARTBEAT_RPC_RETRY_COUNT_DEFAULT = |
| 15; |
| |
| /** |
| * Defines how frequently we will log the missing of heartbeat to a specific |
| * SCM. In the default case we will write a warning message for each 10 |
| * sequential heart beats that we miss to a specific SCM. This is to avoid |
| * overrunning the log with lots of HB missed Log statements. |
| */ |
| public static final String OZONE_SCM_HEARTBEAT_LOG_WARN_INTERVAL_COUNT = |
| "ozone.scm.heartbeat.log.warn.interval.count"; |
| public static final int OZONE_SCM_HEARTBEAT_LOG_WARN_DEFAULT = |
| 10; |
| |
| // ozone.scm.names key 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 |
| // |
| // If this key is not specified datanodes will not be able to find |
| // SCM. The SCM membership can be dynamic, so this key should contain |
| // all possible SCM names. Once the SCM leader is discovered datanodes will |
| // get the right list of SCMs to heartbeat to from the leader. |
| // While it is good for the datanodes to know the names of all SCM nodes, |
| // it is sufficient to actually know the name of on working SCM. That SCM |
| // will be able to return the information about other SCMs that are part of |
| // the SCM replicated Log. |
| // |
| //In case of a membership change, any one of the SCM machines will be |
| // able to send back a new list to the datanodes. |
| public static final String OZONE_SCM_NAMES = "ozone.scm.names"; |
| |
| public static final int OZONE_SCM_DEFAULT_PORT = |
| OZONE_SCM_DATANODE_PORT_DEFAULT; |
| // The path where datanode ID is to be written to. |
| // if this value is not set then container startup will fail. |
| public static final String OZONE_SCM_DATANODE_ID_DIR = |
| "ozone.scm.datanode.id.dir"; |
| |
| public static final String OZONE_SCM_DB_CACHE_SIZE_MB = |
| "ozone.scm.db.cache.size.mb"; |
| public static final int OZONE_SCM_DB_CACHE_SIZE_DEFAULT = 128; |
| |
| public static final String OZONE_SCM_CONTAINER_SIZE = |
| "ozone.scm.container.size"; |
| public static final String OZONE_SCM_CONTAINER_SIZE_DEFAULT = "5GB"; |
| |
| public static final String OZONE_SCM_CONTAINER_PLACEMENT_IMPL_KEY = |
| "ozone.scm.container.placement.impl"; |
| |
| public static final String OZONE_SCM_PIPELINE_OWNER_CONTAINER_COUNT = |
| "ozone.scm.pipeline.owner.container.count"; |
| public static final int OZONE_SCM_PIPELINE_OWNER_CONTAINER_COUNT_DEFAULT = 3; |
| |
| // Pipeline placement policy: |
| // Upper limit for how many pipelines a datanode can engage in. |
| public static final String OZONE_DATANODE_PIPELINE_LIMIT = |
| "ozone.scm.datanode.pipeline.limit"; |
| public static final int OZONE_DATANODE_PIPELINE_LIMIT_DEFAULT = 2; |
| |
| // Upper limit for how many pipelines can be created |
| // across the cluster nodes managed by SCM. |
| // Only for test purpose now. |
| public static final String OZONE_SCM_RATIS_PIPELINE_LIMIT = |
| "ozone.scm.ratis.pipeline.limit"; |
| // Setting to zero by default means this limit doesn't take effect. |
| public static final int OZONE_SCM_RATIS_PIPELINE_LIMIT_DEFAULT = 0; |
| |
| public static final String |
| OZONE_SCM_KEY_VALUE_CONTAINER_DELETION_CHOOSING_POLICY = |
| "ozone.scm.keyvalue.container.deletion-choosing.policy"; |
| |
| public static final String OZONE_SCM_PIPELINE_PER_METADATA_VOLUME = |
| "ozone.scm.pipeline.per.metadata.disk"; |
| |
| public static final int OZONE_SCM_PIPELINE_PER_METADATA_VOLUME_DEFAULT = 2; |
| // Max timeout for pipeline to stay at ALLOCATED state before scrubbed. |
| public static final String OZONE_SCM_PIPELINE_ALLOCATED_TIMEOUT = |
| "ozone.scm.pipeline.allocated.timeout"; |
| |
| public static final String OZONE_SCM_PIPELINE_LEADER_CHOOSING_POLICY = |
| "ozone.scm.pipeline.leader-choose.policy"; |
| |
| public static final String OZONE_SCM_PIPELINE_ALLOCATED_TIMEOUT_DEFAULT = |
| "5m"; |
| |
| public static final String OZONE_SCM_PIPELINE_DESTROY_TIMEOUT = |
| "ozone.scm.pipeline.destroy.timeout"; |
| |
| public static final String OZONE_SCM_PIPELINE_DESTROY_TIMEOUT_DEFAULT = |
| "66s"; |
| |
| public static final String OZONE_SCM_PIPELINE_CREATION_INTERVAL = |
| "ozone.scm.pipeline.creation.interval"; |
| public static final String OZONE_SCM_PIPELINE_CREATION_INTERVAL_DEFAULT = |
| "120s"; |
| |
| // Allow SCM to auto create factor ONE ratis pipeline. |
| public static final String OZONE_SCM_PIPELINE_AUTO_CREATE_FACTOR_ONE = |
| "ozone.scm.pipeline.creation.auto.factor.one"; |
| |
| public static final boolean |
| OZONE_SCM_PIPELINE_AUTO_CREATE_FACTOR_ONE_DEFAULT = true; |
| |
| public static final String OZONE_SCM_BLOCK_DELETION_MAX_RETRY = |
| "ozone.scm.block.deletion.max.retry"; |
| public static final int OZONE_SCM_BLOCK_DELETION_MAX_RETRY_DEFAULT = 4096; |
| |
| public static final String HDDS_SCM_WATCHER_TIMEOUT = |
| "hdds.scm.watcher.timeout"; |
| |
| public static final String HDDS_SCM_WATCHER_TIMEOUT_DEFAULT = |
| "10m"; |
| |
| // Network topology |
| public static final String OZONE_SCM_NETWORK_TOPOLOGY_SCHEMA_FILE = |
| "ozone.scm.network.topology.schema.file"; |
| public static final String OZONE_SCM_NETWORK_TOPOLOGY_SCHEMA_FILE_DEFAULT = |
| "network-topology-default.xml"; |
| |
| public static final String HDDS_TRACING_ENABLED = "hdds.tracing.enabled"; |
| public static final boolean HDDS_TRACING_ENABLED_DEFAULT = false; |
| |
| public static final String OZONE_SCM_DATANODE_ADMIN_MONITOR_INTERVAL = |
| "ozone.scm.datanode.admin.monitor.interval"; |
| public static final String OZONE_SCM_DATANODE_ADMIN_MONITOR_INTERVAL_DEFAULT = |
| "30s"; |
| |
| /** |
| * Never constructed. |
| */ |
| private ScmConfigKeys() { |
| |
| } |
| } |
