| /** |
| * 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 |
| * <p> |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * <p> |
| * 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.ozone.om; |
| |
| import java.util.concurrent.TimeUnit; |
| |
| import org.apache.hadoop.hdds.client.ReplicationFactor; |
| import org.apache.hadoop.hdds.client.ReplicationType; |
| import org.apache.hadoop.ozone.om.helpers.BucketLayout; |
| import org.apache.ratis.util.TimeDuration; |
| |
| /** |
| * Ozone Manager Constants. |
| */ |
| public final class OMConfigKeys { |
| /** |
| * Never constructed. |
| */ |
| private OMConfigKeys() { |
| } |
| |
| // Location where the OM stores its DB files. In the future we may support |
| // multiple entries for performance (sharding).. |
| public static final String OZONE_OM_DB_DIRS = "ozone.om.db.dirs"; |
| |
| public static final String OZONE_OM_HANDLER_COUNT_KEY = |
| "ozone.om.handler.count.key"; |
| public static final int OZONE_OM_HANDLER_COUNT_DEFAULT = 100; |
| |
| public static final String OZONE_OM_INTERNAL_SERVICE_ID = |
| "ozone.om.internal.service.id"; |
| |
| public static final String OZONE_OM_SERVICE_IDS_KEY = |
| "ozone.om.service.ids"; |
| public static final String OZONE_OM_NODES_KEY = |
| "ozone.om.nodes"; |
| public static final String OZONE_OM_NODE_ID_KEY = |
| "ozone.om.node.id"; |
| public static final String OZONE_OM_DECOMMISSIONED_NODES_KEY = |
| "ozone.om.decommissioned.nodes"; |
| |
| public static final String OZONE_OM_ADDRESS_KEY = |
| "ozone.om.address"; |
| public static final String OZONE_OM_BIND_HOST_DEFAULT = |
| "0.0.0.0"; |
| public static final int OZONE_OM_PORT_DEFAULT = 9862; |
| public static final String OZONE_OM_GRPC_PORT_KEY = |
| "ozone.om.grpc.port"; |
| public static final String OZONE_OM_HTTP_ENABLED_KEY = |
| "ozone.om.http.enabled"; |
| public static final String OZONE_OM_HTTP_BIND_HOST_KEY = |
| "ozone.om.http-bind-host"; |
| public static final String OZONE_OM_HTTPS_BIND_HOST_KEY = |
| "ozone.om.https-bind-host"; |
| public static final String OZONE_OM_HTTP_ADDRESS_KEY = |
| "ozone.om.http-address"; |
| public static final String OZONE_OM_HTTPS_ADDRESS_KEY = |
| "ozone.om.https-address"; |
| public static final String OZONE_OM_HTTP_BIND_HOST_DEFAULT = "0.0.0.0"; |
| public static final int OZONE_OM_HTTP_BIND_PORT_DEFAULT = 9874; |
| public static final int OZONE_OM_HTTPS_BIND_PORT_DEFAULT = 9875; |
| |
| public static final String OZONE_OM_VOLUME_LISTALL_ALLOWED = |
| "ozone.om.volume.listall.allowed"; |
| public static final boolean OZONE_OM_VOLUME_LISTALL_ALLOWED_DEFAULT = true; |
| public static final String OZONE_OM_USER_MAX_VOLUME = |
| "ozone.om.user.max.volume"; |
| public static final int OZONE_OM_USER_MAX_VOLUME_DEFAULT = 1024; |
| |
| public static final String OZONE_KEY_DELETING_LIMIT_PER_TASK = |
| "ozone.key.deleting.limit.per.task"; |
| public static final int OZONE_KEY_DELETING_LIMIT_PER_TASK_DEFAULT = 20000; |
| |
| public static final String OZONE_OM_OPEN_KEY_CLEANUP_SERVICE_INTERVAL = |
| "ozone.om.open.key.cleanup.service.interval"; |
| public static final String |
| OZONE_OM_OPEN_KEY_CLEANUP_SERVICE_INTERVAL_DEFAULT = "24h"; |
| |
| public static final String OZONE_OM_OPEN_KEY_EXPIRE_THRESHOLD = |
| "ozone.om.open.key.expire.threshold"; |
| public static final String OZONE_OM_OPEN_KEY_EXPIRE_THRESHOLD_DEFAULT = |
| "7d"; |
| |
| public static final String OZONE_OM_OPEN_KEY_CLEANUP_LIMIT_PER_TASK = |
| "ozone.om.open.key.cleanup.limit.per.task"; |
| public static final int OZONE_OM_OPEN_KEY_CLEANUP_LIMIT_PER_TASK_DEFAULT = |
| 1000; |
| |
| public static final String OZONE_OM_METRICS_SAVE_INTERVAL = |
| "ozone.om.save.metrics.interval"; |
| public static final String OZONE_OM_METRICS_SAVE_INTERVAL_DEFAULT = "5m"; |
| |
| /** |
| * OM Ratis related configurations. |
| */ |
| public static final String OZONE_OM_RATIS_ENABLE_KEY |
| = "ozone.om.ratis.enable"; |
| public static final boolean OZONE_OM_RATIS_ENABLE_DEFAULT |
| = true; |
| public static final String OZONE_OM_RATIS_PORT_KEY |
| = "ozone.om.ratis.port"; |
| public static final int OZONE_OM_RATIS_PORT_DEFAULT |
| = 9872; |
| public static final String OZONE_OM_RATIS_RPC_TYPE_KEY |
| = "ozone.om.ratis.rpc.type"; |
| public static final String OZONE_OM_RATIS_RPC_TYPE_DEFAULT |
| = "GRPC"; |
| |
| // OM Ratis Log configurations |
| public static final String OZONE_OM_RATIS_STORAGE_DIR |
| = "ozone.om.ratis.storage.dir"; |
| public static final String OZONE_OM_RATIS_SEGMENT_SIZE_KEY |
| = "ozone.om.ratis.segment.size"; |
| public static final String OZONE_OM_RATIS_SEGMENT_SIZE_DEFAULT |
| = "4MB"; |
| public static final String OZONE_OM_RATIS_SEGMENT_PREALLOCATED_SIZE_KEY |
| = "ozone.om.ratis.segment.preallocated.size"; |
| public static final String OZONE_OM_RATIS_SEGMENT_PREALLOCATED_SIZE_DEFAULT |
| = "4MB"; |
| |
| // OM Ratis Log Appender configurations |
| public static final String |
| OZONE_OM_RATIS_LOG_APPENDER_QUEUE_NUM_ELEMENTS = |
| "ozone.om.ratis.log.appender.queue.num-elements"; |
| public static final int |
| OZONE_OM_RATIS_LOG_APPENDER_QUEUE_NUM_ELEMENTS_DEFAULT = 1024; |
| public static final String OZONE_OM_RATIS_LOG_APPENDER_QUEUE_BYTE_LIMIT = |
| "ozone.om.ratis.log.appender.queue.byte-limit"; |
| public static final String |
| OZONE_OM_RATIS_LOG_APPENDER_QUEUE_BYTE_LIMIT_DEFAULT = "32MB"; |
| public static final String OZONE_OM_RATIS_LOG_PURGE_GAP = |
| "ozone.om.ratis.log.purge.gap"; |
| public static final int OZONE_OM_RATIS_LOG_PURGE_GAP_DEFAULT = 1000000; |
| |
| public static final String OZONE_OM_RATIS_SNAPSHOT_AUTO_TRIGGER_THRESHOLD_KEY |
| = "ozone.om.ratis.snapshot.auto.trigger.threshold"; |
| public static final long |
| OZONE_OM_RATIS_SNAPSHOT_AUTO_TRIGGER_THRESHOLD_DEFAULT = 400000; |
| |
| // OM Ratis server configurations |
| public static final String OZONE_OM_RATIS_SERVER_REQUEST_TIMEOUT_KEY |
| = "ozone.om.ratis.server.request.timeout"; |
| public static final TimeDuration |
| OZONE_OM_RATIS_SERVER_REQUEST_TIMEOUT_DEFAULT |
| = TimeDuration.valueOf(3000, TimeUnit.MILLISECONDS); |
| public static final String |
| OZONE_OM_RATIS_SERVER_RETRY_CACHE_TIMEOUT_KEY |
| = "ozone.om.ratis.server.retry.cache.timeout"; |
| public static final TimeDuration |
| OZONE_OM_RATIS_SERVER_RETRY_CACHE_TIMEOUT_DEFAULT |
| = TimeDuration.valueOf(600000, TimeUnit.MILLISECONDS); |
| public static final String OZONE_OM_RATIS_MINIMUM_TIMEOUT_KEY |
| = "ozone.om.ratis.minimum.timeout"; |
| public static final TimeDuration OZONE_OM_RATIS_MINIMUM_TIMEOUT_DEFAULT |
| = TimeDuration.valueOf(5, TimeUnit.SECONDS); |
| |
| public static final String OZONE_OM_RATIS_SERVER_FAILURE_TIMEOUT_DURATION_KEY |
| = "ozone.om.ratis.server.failure.timeout.duration"; |
| public static final TimeDuration |
| OZONE_OM_RATIS_SERVER_FAILURE_TIMEOUT_DURATION_DEFAULT |
| = TimeDuration.valueOf(120, TimeUnit.SECONDS); |
| |
| public static final String OZONE_OM_RATIS_SERVER_ELECTION_PRE_VOTE = |
| "ozone.om.ratis.server.leaderelection.pre-vote"; |
| public static final boolean |
| OZONE_OM_RATIS_SERVER_ELECTION_PRE_VOTE_DEFAULT = false; |
| |
| |
| // OM SnapshotProvider configurations |
| public static final String OZONE_OM_RATIS_SNAPSHOT_DIR = |
| "ozone.om.ratis.snapshot.dir"; |
| public static final String OZONE_OM_SNAPSHOT_PROVIDER_SOCKET_TIMEOUT_KEY = |
| "ozone.om.snapshot.provider.socket.timeout"; |
| public static final TimeDuration |
| OZONE_OM_SNAPSHOT_PROVIDER_SOCKET_TIMEOUT_DEFAULT = |
| TimeDuration.valueOf(5000, TimeUnit.MILLISECONDS); |
| |
| public static final String OZONE_OM_SNAPSHOT_PROVIDER_CONNECTION_TIMEOUT_KEY = |
| "ozone.om.snapshot.provider.connection.timeout"; |
| public static final TimeDuration |
| OZONE_OM_SNAPSHOT_PROVIDER_CONNECTION_TIMEOUT_DEFAULT = |
| TimeDuration.valueOf(5000, TimeUnit.MILLISECONDS); |
| |
| public static final String OZONE_OM_SNAPSHOT_PROVIDER_REQUEST_TIMEOUT_KEY = |
| "ozone.om.snapshot.provider.request.timeout"; |
| public static final TimeDuration |
| OZONE_OM_SNAPSHOT_PROVIDER_REQUEST_TIMEOUT_DEFAULT = |
| TimeDuration.valueOf(5000, TimeUnit.MILLISECONDS); |
| |
| public static final String OZONE_OM_KERBEROS_KEYTAB_FILE_KEY = "ozone.om." |
| + "kerberos.keytab.file"; |
| public static final String OZONE_OM_KERBEROS_PRINCIPAL_KEY = "ozone.om" |
| + ".kerberos.principal"; |
| public static final String OZONE_OM_HTTP_KERBEROS_KEYTAB_FILE = |
| "ozone.om.http.auth.kerberos.keytab"; |
| public static final String OZONE_OM_HTTP_KERBEROS_PRINCIPAL_KEY |
| = "ozone.om.http.auth.kerberos.principal"; |
| public static final String OZONE_OM_HTTP_AUTH_TYPE = |
| "ozone.om.http.auth.type"; |
| public static final String OZONE_OM_HTTP_AUTH_CONFIG_PREFIX = |
| "ozone.om.http.auth."; |
| |
| // Delegation token related keys |
| public static final String DELEGATION_REMOVER_SCAN_INTERVAL_KEY = |
| "ozone.manager.delegation.remover.scan.interval"; |
| public static final long DELEGATION_REMOVER_SCAN_INTERVAL_DEFAULT = |
| 60 * 60 * 1000; |
| public static final String DELEGATION_TOKEN_RENEW_INTERVAL_KEY = |
| "ozone.manager.delegation.token.renew-interval"; |
| public static final long DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT = |
| 24 * 60 * 60 * 1000; // 1 day = 86400000 ms |
| public static final String DELEGATION_TOKEN_MAX_LIFETIME_KEY = |
| "ozone.manager.delegation.token.max-lifetime"; |
| public static final long DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT = |
| 7 * 24 * 60 * 60 * 1000; // 7 days |
| |
| public static final String OZONE_DB_CHECKPOINT_TRANSFER_RATE_KEY = |
| "ozone.manager.db.checkpoint.transfer.bandwidthPerSec"; |
| public static final long OZONE_DB_CHECKPOINT_TRANSFER_RATE_DEFAULT = |
| 0; //no throttling |
| |
| // Comma separated acls (users, groups) allowing clients accessing |
| // OM client protocol |
| // when hadoop.security.authorization is true, this needs to be set in |
| // hadoop-policy.xml, "*" allows all users/groups to access. |
| public static final String OZONE_OM_SECURITY_CLIENT_PROTOCOL_ACL = |
| "ozone.om.security.client.protocol.acl"; |
| |
| // Comma separated acls (users, groups) allowing clients accessing |
| // OM admin protocol. |
| // When hadoop.security.authorization is true, this needs to be set in |
| // hadoop-policy.xml, "*" allows all users/groups to access. |
| public static final String OZONE_OM_SECURITY_ADMIN_PROTOCOL_ACL = |
| "ozone.om.security.admin.protocol.acl"; |
| |
| public static final String OZONE_OM_KEYNAME_CHARACTER_CHECK_ENABLED_KEY = |
| "ozone.om.keyname.character.check.enabled"; |
| public static final boolean OZONE_OM_KEYNAME_CHARACTER_CHECK_ENABLED_DEFAULT = |
| false; |
| |
| // This config needs to be enabled, when S3G created objects used via |
| // FileSystem API. |
| public static final String OZONE_OM_ENABLE_FILESYSTEM_PATHS = |
| "ozone.om.enable.filesystem.paths"; |
| public static final boolean OZONE_OM_ENABLE_FILESYSTEM_PATHS_DEFAULT = |
| false; |
| |
| public static final String OZONE_SERVER_DEFAULT_REPLICATION_KEY = |
| "ozone.server.default.replication"; |
| public static final String OZONE_SERVER_DEFAULT_REPLICATION_DEFAULT = |
| ReplicationFactor.THREE.toString(); |
| |
| public static final String OZONE_SERVER_DEFAULT_REPLICATION_TYPE_KEY = |
| "ozone.server.default.replication.type"; |
| public static final String OZONE_SERVER_DEFAULT_REPLICATION_TYPE_DEFAULT = |
| ReplicationType.RATIS.toString(); |
| |
| public static final String OZONE_OM_HA_PREFIX = "ozone.om.ha"; |
| |
| public static final String OZONE_FS_TRASH_INTERVAL_KEY = |
| "ozone.fs.trash.interval"; |
| |
| public static final long OZONE_FS_TRASH_INTERVAL_DEFAULT = 0; |
| |
| public static final String OZONE_FS_TRASH_CHECKPOINT_INTERVAL_KEY = |
| "ozone.fs.trash.checkpoint.interval"; |
| |
| public static final long OZONE_FS_TRASH_CHECKPOINT_INTERVAL_DEFAULT = 0; |
| |
| // This property is used to define the metadata layout of file system |
| // paths. If it is configured as PREFIX in combination with |
| // ozone.om.enable.filesystem.paths to true then this allows to perform |
| // atomic rename and delete of any directory at any level in the namespace. |
| // Defaulting to SIMPLE. Supported values: SIMPLE and PREFIX. |
| |
| // Default bucket layout used by Ozone Manager during bucket creation |
| // when a client does not specify the bucket layout option. |
| public static final String OZONE_DEFAULT_BUCKET_LAYOUT = |
| "ozone.default.bucket.layout"; |
| public static final String OZONE_DEFAULT_BUCKET_LAYOUT_DEFAULT = |
| BucketLayout.LEGACY.name(); |
| public static final String OZONE_BUCKET_LAYOUT_FILE_SYSTEM_OPTIMIZED = |
| BucketLayout.FILE_SYSTEM_OPTIMIZED.name(); |
| public static final String OZONE_BUCKET_LAYOUT_OBJECT_STORE = |
| BucketLayout.OBJECT_STORE.name(); |
| |
| /** |
| * Configuration properties for Directory Deleting Service. |
| */ |
| public static final String OZONE_DIR_DELETING_SERVICE_INTERVAL = |
| "ozone.directory.deleting.service.interval"; |
| public static final String OZONE_DIR_DELETING_SERVICE_INTERVAL_DEFAULT |
| = "60s"; |
| |
| public static final String OZONE_PATH_DELETING_LIMIT_PER_TASK = |
| "ozone.path.deleting.limit.per.task"; |
| public static final int OZONE_PATH_DELETING_LIMIT_PER_TASK_DEFAULT = 10000; |
| |
| public static final String OZONE_OM_GRPC_MAXIMUM_RESPONSE_LENGTH = |
| "ozone.om.grpc.maximum.response.length"; |
| /** Default value for GRPC_MAXIMUM_RESPONSE_LENGTH. */ |
| public static final int OZONE_OM_GRPC_MAXIMUM_RESPONSE_LENGTH_DEFAULT = |
| 128 * 1024 * 1024; |
| |
| public static final String OZONE_OM_S3_GPRC_SERVER_ENABLED = |
| "ozone.om.s3.grpc.server_enabled"; |
| public static final boolean OZONE_OM_S3_GRPC_SERVER_ENABLED_DEFAULT = |
| false; |
| /** |
| * Configuration properties for OMAdminProtcol service. |
| */ |
| public static final String OZONE_OM_ADMIN_PROTOCOL_MAX_RETRIES_KEY = |
| "ozone.om.admin.protocol.max.retries"; |
| public static final int OZONE_OM_ADMIN_PROTOCOL_MAX_RETRIES_DEFAULT = 20; |
| public static final String OZONE_OM_ADMIN_PROTOCOL_WAIT_BETWEEN_RETRIES_KEY = |
| "ozone.om.admin.protocol.wait.between.retries"; |
| public static final long OZONE_OM_ADMIN_PROTOCOL_WAIT_BETWEEN_RETRIES_DEFAULT |
| = 1000; |
| public static final String OZONE_OM_TRANSPORT_CLASS = |
| "ozone.om.transport.class"; |
| public static final String OZONE_OM_TRANSPORT_CLASS_DEFAULT = |
| "org.apache.hadoop.ozone.om.protocolPB" |
| + ".Hadoop3OmTransportFactory"; |
| public static final String OZONE_OM_UNFLUSHED_TRANSACTION_MAX_COUNT = |
| "ozone.om.unflushed.transaction.max.count"; |
| public static final int OZONE_OM_UNFLUSHED_TRANSACTION_MAX_COUNT_DEFAULT |
| = 10000; |
| |
| /** |
| * This configuration shall be enabled to utilize the functionality of the |
| * fine-grained KEY_PATH_LOCK. |
| */ |
| public static final String OZONE_OM_KEY_PATH_LOCK_ENABLED = |
| "ozone.om.key.path.lock.enabled"; |
| public static final boolean OZONE_OM_KEY_PATH_LOCK_ENABLED_DEFAULT = false; |
| } |
