forked from Seagate/cortx-s3server
-
Notifications
You must be signed in to change notification settings - Fork 0
/
s3config.yaml.sample
128 lines (127 loc) · 12.7 KB
/
s3config.yaml.sample
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
#
# Copyright (c) 2020 Seagate Technology LLC and/or its Affiliates
#
# Licensed 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.
#
# For any questions about this software or licensing,
# please email opensource@seagate.com or cortx-questions@seagate.com.
#
S3Config_Sections: [S3_SERVER_CONFIG, S3_AUTH_CONFIG, S3_MOTR_CONFIG, S3_THIRDPARTY_CONFIG, S3_VERSION_CONFIG]
S3_SERVER_CONFIG:
S3_DI_DISABLE_DATA_CORRUPTION_IEM: false # disable sending of IEM messages by s3server in case of data integrity checksum fails
S3_DI_DISABLE_METADATA_CORRUPTION_IEM: false # disable sending of IEM messages by s3server in case of metadata corruption is detected
S3_DAEMON_WORKING_DIR: "/var/log/seagate/motr/" # S3 Daemon will run in the specified directory
S3_DAEMON_DO_REDIRECTION: 0 # Do redirection of stderr, stdout and stdin to /dev/null
S3_LOG_DIR: "/var/log/seagate/s3" # S3 Log directory, for output to stderr have value as "" and set S3_DAEMON_DO_REDIRECTION to 0
S3_LOG_MODE: DEBUG # logging levels, levels can be DEBUG, INFO, WARN, ERROR, FATAL, default is INFO
S3_LOG_FILE_MAX_SIZE: 100 # Maximum log file size in MB, default is 100 MB
S3_LOG_ENABLE_BUFFERING: false # DEBUG, INFO & WARN logs are buffered if buffering is enabled. ERROR and FATAL logs are always flushed. Default is true.
S3_ENABLE_AUTH_SSL: false # Enable ssl communication between s3 server and auth server
S3_REUSEPORT: false # Enable reusing s3 server port
S3_WRITE_DATA_INTEGRITY_CHECK: false # TBD
S3_READ_DATA_INTEGRITY_CHECK: false # TBD
S3_METADATA_INTEGRITY_CHECK: true # TBD
S3_SALT_CHECKSUM: true # TBD
S3_PI_TYPE: "PI_TYPE_MD5_INC_CONTEXT" # TBD
S3_MOTR_HTTP_REUSEPORT: true # Enable reusing motr http server port
S3_IAM_CERT_FILE: "/etc/ssl/stx-s3/s3auth/s3authserver.crt" # IAM Auth certificate file
S3_LOG_FLUSH_FREQUENCY: 30 # Time in seconds, after which logs will be flushed. Valid only if S3_LOG_ENABLE_BUFFERING is true. Default is 30 seconds.
S3_AUDIT_LOG_DIR: "/var/log/seagate/s3" # S3 Audit log directory
S3_AUDIT_LOG_CONFIG: "/opt/seagate/cortx/s3/conf/s3server_audit_log.properties" # S3 Server Audit log configuration file.
S3_AUDIT_LOG_FORMAT_TYPE: "JSON" # S3 Server Audit log format type. JSON logs in json format & S3_FORMAT logs in s3 format.
S3_AUDIT_LOGGER_POLICY: "disabled" # Audit info logger policy: disabled - logger disabled; rsyslog-tcp - send logs to rsyslog via tcp socket; log4cxx - use log4cxx; syslog - send logs to rsyslog via syslog call; kafka-web - send logs to Kafka Web;
S3_AUDIT_LOGGER_HOST: "localhost" # Remote host name to connect to if logger needs to work via network
S3_AUDIT_LOGGER_PORT: 514 # Port on which rsyslog or kafka webserver is listening
S3_AUDIT_LOGGER_RSYSLOG_MSGID: "s3server-audit-logging" # Rsyslog msgid to filter messages
S3_AUDIT_LOGGER_KAFKA_WEB_PATH: "/topics/s3auditlogs" # URL path for POST requests
S3_IEM_HOST: "localhost" # host to connect for IEM
S3_IEM_PORT: 28300 # IEM rest server port
S3_IEM_PATH: "/EventMessage/event" # IEM URL path for POST requests
S3_AUDIT_MAX_RETRY_COUNT: 5 # Max retry count in case of audit log failure
S3_SERVER_IPV4_BIND_ADDR: 0.0.0.0 # S3 Server ipv4 bind address, 0.0.0.0 is default. ~ means option is ignored/not to listen on IPv4 address.
S3_SERVER_IPV6_BIND_ADDR: "~" # S3 Server ipv6 bind address, ::/128 is default. ~ means option is ignored/not to listen on IPv6 address.
S3_SERVER_BIND_PORT: 28071 # S3 Server port number
S3_SERVER_MOTR_HTTP_BIND_ADDR: 127.0.0.1 # S3 Server bind addresss to perform motr operations over HTTP, 127.0.0.1 is default.
S3_SERVER_MOTR_HTTP_BIND_PORT: 28049 # Port number to perform motr operations over HTTP.
S3_SERVER_REGION_ENDPOINTS: [s3-us-west-2.seagate.com, s3-us.seagate.com, s3-europe.seagate.com, s3-asia.seagate.com]
S3_SERVER_DEFAULT_ENDPOINT: s3.seagate.com
S3_SERVER_SHUTDOWN_GRACE_PERIOD: 7 # S3 server shutdown grace period in seconds, default is 10 seconds.
S3_SERVER_SSL_ENABLE: false # Enable ssl in s3server
S3_SERVER_CERT_FILE: "/etc/ssl/stx-s3/s3/ca.crt" # s3server ssl cerificate file
S3_SERVER_PEM_FILE: "/etc/ssl/stx-s3/s3/s3server.pem" # s3server ssl pem file
S3_SERVER_SSL_SESSION_TIMEOUT: 172800 # SSL session timeout in seconds 48 hrs
S3_ENABLE_PERF: 0 # S3 Performance metric collection, to enable have value 1, default is 0 (disabled)
S3_PERF_LOG_FILENAME: "/var/log/seagate/s3/perf.log" # S3 Perf Log file name
S3_READ_AHEAD_MULTIPLE: 1 # Maximum units of size (S3_MOTR_UNIT_SIZE * S3_MOTR_MAX_UNITS_PER_REQUEST) to read ahead or buffer in-memory
S3_MAX_RETRY_COUNT: 3 # Max retry count in case of failure
S3_ENABLE_MURMURHASH_OID: false # Enable OID generation using Murmur Hash Alg. Default is to have unique OID generated by motr helper library.
S3_RETRY_INTERVAL_MILLISEC: 500 # Retry interval in milliseconds, total retry time = retry_count * retry_interval (RETRY1: 500, RETRY2: 1000, RETRY3: 1500)
S3_CLIENT_REQ_READ_TIMEOUT_SECS: 20 # Read timeout in seconds.
S3_ENABLE_STATS: false # Enable the Stats feature. Default is false.
S3_STATSD_IP_ADDR: 127.0.0.1 # StatsD server IP address
S3_STATSD_PORT: 8125 # StatsD server port
S3_STATSD_MAX_SEND_RETRY: 3 # Limit the user requested retry count. A retry is attempted in case message delivery to StatsD server fails.
S3_STATS_ALLOWLIST_FILENAME: "/opt/seagate/cortx/s3/conf/s3stats-allowlist.yaml" # Allow list of Stats metrics to be published to the backend.
S3_PERF_STATS_INOUT_BYTES_INTERVAL_MSEC: 1000 # Specifies how often to send number of in/out-comping bytes to StatsD. Milliseconds.
S3_SERVER_OBJECT_DELAYED_DELETE: true # When true, skips deleting old object during PUT object overwrite and DEL object
S3_REDIS_SERVER_ADDRESS: "127.0.0.1" # In case if redis is used for kvs contains redis server address
S3_REDIS_SERVER_PORT: 6379 # In case if redis is used for kvs contains redis server port
S3_SERVER_MOTR_ETIMEDOUT_MAX_THRESHOLD: 100 # Number of ETIMEDOUT errors per monitoring window before s3server restart
S3_SERVER_MOTR_ETIMEDOUT_WINDOW_SEC: 1 # Monitoring window for motr ETIMEDOUT errors in seconds
S3_SERVER_ENABLE_ADDB_DUMP: true # If set to true, then addb dump will be collected
S3_BUCKET_METADATA_CACHE_MAX_SIZE: 1 # Max count of entries in bucket MD cache
S3_BUCKET_METADATA_CACHE_EXPIRE_SEC: 5 # Expiration time for bucket metadata in cache
S3_BUCKET_METADATA_CACHE_REFRESH_SEC: 4 # Refresh timeout. After this timeout proactive MD re-load will happen.
S3_AUTH_CONFIG:
S3_AUTH_IP_ADDR: ipv4:127.0.0.1 # Auth server IP address Should be in below format:
# ipv4 address format: ipv4:127.0.0.1
# ipv6 address format: ipv6:::1
S3_AUTH_PORT: 28050 # Auth server port for http request
S3_MOTR_CONFIG: # Section for S3 Motr
S3_MOTR_LOCAL_ADDR: <ipaddress>@tcp:12345:33:100 # Motr end points, replace <ipaddress> with host's ip address
S3_MOTR_HA_ADDR: <ipaddress>@tcp:12345:34:1 # Motr end point, replace <ipaddress> with host's ip address
S3_MOTR_PROF: <0x7000000000000001:0> # Motr end point
S3_MOTR_LAYOUT_ID: 9 # Motr will select a Unit size of a layout according to the
# layout id set in the configuration file, mapping is as follows:
# 1->4K, 2->8K, 3->16K, 4->32K, 5->64K, 6->128K, 7->256K, 8->512K, 9->1024K,
# 10->2048K, 11->4096K, 12->8192K, 13->16384K, 14->32768K, default is layout id 9 (1 MB)
S3_MOTR_UNIT_SIZE: 1048576 # Motr unit size w.r.t layout id for an IO operation
S3_MOTR_MAX_UNITS_PER_REQUEST: 1 # Maximum units per read/write request to motr
S3_MOTR_MAX_IDX_FETCH_COUNT: 30 # Motr will read from index at a time maximim of this many key values, used in objects listing
S3_MOTR_IS_OOSTORE: true # Motr oostore mode is set when this flag is true, default is false (oostore mode is not set)
S3_MOTR_IS_READ_VERIFY: false # Motr Flag for verify-on-read. Parity is checked during READ's if this flag is true, default is false
S3_MOTR_TM_RECV_QUEUE_MIN_LEN: 16 # Minimum length of the 'tm' receive queue for motr, default is 2
S3_MOTR_MAX_RPC_MSG_SIZE: 524288 # Maximum rpc message size for motr, default is 131072 (128k)
S3_MOTR_PROCESS_FID: <0x7200000000000000:0> # FID of the Resource manager for Motr
S3_MOTR_IDX_SERVICE_ID: 1 # Types of index services supported by Motr, mapping is: 0->Mock KVS, 1->Motr KVS, 2->Cassandra KVS, default is 2 (Cassandra KVS)
S3_MOTR_CASS_CLUSTER_EP: 127.0.0.1 # Cassandra cluster end point
S3_MOTR_CASS_KEYSPACE: "motr_index_keyspace" # Cassandra keyspace
S3_MOTR_CASS_MAX_COL_FAMILY_NUM: 1 # Cassandra max column family number, default is 1
S3_UNIT_SIZES_FOR_MEMORY_POOL: [16384] # Memory pool will be created for each of these unit_size with following properties
S3_MOTR_READ_POOL_INITIAL_BUFFER_COUNT: 10 # 10 blocks, the initial pool size = multiple of S3_MOTR_UNIT_SIZE
S3_MOTR_READ_POOL_EXPANDABLE_COUNT: 50 # 50 blocks, pool's expandable size, multiple of S3_MOTR_UNIT_SIZE
S3_MOTR_READ_POOL_MAX_THRESHOLD: 524288000 # 500 MB, The maximum memory threshold for the pool, multiple of S3_MOTR_UNIT_SIZE
S3_MOTR_READ_MEMPOOL_ZERO_BUFFER: false # Enable Motr Mempool 'zeroing' after use (like secure erase) - disabled by default
S3_MOTR_OPERATION_WAIT_PERIOD: 90 # 90 s, Maximum wait duration for sync motr operations.
S3_MOTR_FIRST_READ_SIZE: 4 # Size in MB of the First Read Request to MOTR
S3_THIRDPARTY_CONFIG:
S3_LIBEVENT_POOL_BUFFER_SIZE: 16384 # Pool buffer size, in case of S3_MOTR_UNIT_SIZE of size 1MB, it is recommended to have S3_LIBEVENT_POOL_BUFFER_SIZE of size 16384
S3_LIBEVENT_MAX_READ_SIZE: 16384 # Maximum read in a single read operation, as per libevent documentation in code, user should not try to read more than this value
S3_LIBEVENT_POOL_INITIAL_SIZE: 209715200 # Two Hundred 1mb blocks, the initial pool size, multiple of S3_MOTR_UNIT_SIZE
S3_LIBEVENT_POOL_EXPANDABLE_SIZE: 104857600 # 100mb, pool's expandable size, multiple of S3_MOTR_UNIT_SIZE
S3_LIBEVENT_POOL_MAX_THRESHOLD: 524288000 # 500 MB, The maximum memory threshold for the pool, multiple of S3_MOTR_UNIT_SIZE
S3_LIBEVENT_POOL_RESERVE_SIZE: 1048576 # Deny PUT request if mempool free space is less than the mentioned size in bytes
S3_LIBEVENT_MEMPOOL_ZERO_BUFFER: false # Enable Libevent Mempool 'zeroing' after use (like secure erase) - disabled by default
S3_LIBEVENT_POOL_RESERVE_PERCENT: 5 # Deny PUT request if mempool free space in percent is less than the mentioned percent
S3_VERSION_CONFIG:
VERSION: 1