blob: ab79cdccfcaedaa197af057ffab94a2c9d0f0db8 [file] [log] [blame]
Masayoshi Kobayashif358ff52013-03-22 00:31:59 +00001# Cassandra storage config YAML
2
3# NOTE:
4# See http://wiki.apache.org/cassandra/StorageConfiguration for
5# full explanations of configuration directives
6# /NOTE
7
8# The name of the cluster. This is mainly used to prevent machines in
9# one logical cluster from joining another.
10cluster_name: 'ONOS Test Cluster'
11
12# You should always specify InitialToken when setting up a production
13# cluster for the first time, and often when adding capacity later.
14# The principle is that each node should be given an equal slice of
15# the token ring; see http://wiki.apache.org/cassandra/Operations
16# for more details.
17#
18# If blank, Cassandra will request a token bisecting the range of
19# the heaviest-loaded existing node. If there is no load information
20# available, such as is the case with a new cluster, it will pick
21# a random token, which will lead to hot spots.
22initial_token:
23
24# See http://wiki.apache.org/cassandra/HintedHandoff
25hinted_handoff_enabled: true
26# this defines the maximum amount of time a dead host will have hints
27# generated. After it has been dead this long, hints will be dropped.
28max_hint_window_in_ms: 3600000 # one hour
29# Sleep this long after delivering each hint
30hinted_handoff_throttle_delay_in_ms: 1
31
32# The following setting populates the page cache on memtable flush and compaction
33# WARNING: Enable this setting only when the whole node's data fits in memory.
34# Defaults to: false
35# populate_io_cache_on_flush: false
36
37# authentication backend, implementing IAuthenticator; used to identify users
38authenticator: org.apache.cassandra.auth.AllowAllAuthenticator
39
40# authorization backend, implementing IAuthority; used to limit access/provide permissions
41authority: org.apache.cassandra.auth.AllowAllAuthority
42
43# The partitioner is responsible for distributing rows (by key) across
44# nodes in the cluster. Any IPartitioner may be used, including your
45# own as long as it is on the classpath. Out of the box, Cassandra
46# provides org.apache.cassandra.dht.RandomPartitioner
47# org.apache.cassandra.dht.ByteOrderedPartitioner,
48# org.apache.cassandra.dht.OrderPreservingPartitioner (deprecated),
49# and org.apache.cassandra.dht.CollatingOrderPreservingPartitioner
50# (deprecated).
51#
52# - RandomPartitioner distributes rows across the cluster evenly by md5.
53# When in doubt, this is the best option.
54# - ByteOrderedPartitioner orders rows lexically by key bytes. BOP allows
55# scanning rows in key order, but the ordering can generate hot spots
56# for sequential insertion workloads.
57# - OrderPreservingPartitioner is an obsolete form of BOP, that stores
58# - keys in a less-efficient format and only works with keys that are
59# UTF8-encoded Strings.
60# - CollatingOPP colates according to EN,US rules rather than lexical byte
61# ordering. Use this as an example if you need custom collation.
62#
63# See http://wiki.apache.org/cassandra/Operations for more on
64# partitioners and token selection.
65partitioner: org.apache.cassandra.dht.RandomPartitioner
66
67# directories where Cassandra should store data on disk.
68data_file_directories:
69 - /var/lib/cassandra/data
70
71# commit log
72commitlog_directory: /var/lib/cassandra/commitlog
73
74# Maximum size of the key cache in memory.
75#
76# Each key cache hit saves 1 seek and each row cache hit saves 2 seeks at the
77# minimum, sometimes more. The key cache is fairly tiny for the amount of
78# time it saves, so it's worthwhile to use it at large numbers.
79# The row cache saves even more time, but must store the whole values of
80# its rows, so it is extremely space-intensive. It's best to only use the
81# row cache if you have hot rows or static rows.
82#
83# NOTE: if you reduce the size, you may not get you hottest keys loaded on startup.
84#
85# Default value is empty to make it "auto" (min(5% of Heap (in MB), 100MB)). Set to 0 to disable key cache.
86key_cache_size_in_mb:
87
88# Duration in seconds after which Cassandra should
89# safe the keys cache. Caches are saved to saved_caches_directory as
90# specified in this configuration file.
91#
92# Saved caches greatly improve cold-start speeds, and is relatively cheap in
93# terms of I/O for the key cache. Row cache saving is much more expensive and
94# has limited use.
95#
96# Default is 14400 or 4 hours.
97key_cache_save_period: 14400
98
99# Number of keys from the key cache to save
100# Disabled by default, meaning all keys are going to be saved
101# key_cache_keys_to_save: 100
102
103# Maximum size of the row cache in memory.
104# NOTE: if you reduce the size, you may not get you hottest keys loaded on startup.
105#
106# Default value is 0, to disable row caching.
107row_cache_size_in_mb: 0
108
109# Duration in seconds after which Cassandra should
110# safe the row cache. Caches are saved to saved_caches_directory as specified
111# in this configuration file.
112#
113# Saved caches greatly improve cold-start speeds, and is relatively cheap in
114# terms of I/O for the key cache. Row cache saving is much more expensive and
115# has limited use.
116#
117# Default is 0 to disable saving the row cache.
118row_cache_save_period: 0
119
120# Number of keys from the row cache to save
121# Disabled by default, meaning all keys are going to be saved
122# row_cache_keys_to_save: 100
123
124# The provider for the row cache to use.
125#
126# Supported values are: ConcurrentLinkedHashCacheProvider, SerializingCacheProvider
127#
128# SerializingCacheProvider serialises the contents of the row and stores
129# it in native memory, i.e., off the JVM Heap. Serialized rows take
130# significantly less memory than "live" rows in the JVM, so you can cache
131# more rows in a given memory footprint. And storing the cache off-heap
132# means you can use smaller heap sizes, reducing the impact of GC pauses.
133#
134# It is also valid to specify the fully-qualified class name to a class
135# that implements org.apache.cassandra.cache.IRowCacheProvider.
136#
137# Defaults to SerializingCacheProvider
138row_cache_provider: SerializingCacheProvider
139
140# saved caches
141saved_caches_directory: /var/lib/cassandra/saved_caches
142
143# commitlog_sync may be either "periodic" or "batch."
144# When in batch mode, Cassandra won't ack writes until the commit log
145# has been fsynced to disk. It will wait up to
146# commitlog_sync_batch_window_in_ms milliseconds for other writes, before
147# performing the sync.
148#
149# commitlog_sync: batch
150# commitlog_sync_batch_window_in_ms: 50
151#
152# the other option is "periodic" where writes may be acked immediately
153# and the CommitLog is simply synced every commitlog_sync_period_in_ms
154# milliseconds.
155commitlog_sync: periodic
156commitlog_sync_period_in_ms: 10000
157
158# The size of the individual commitlog file segments. A commitlog
159# segment may be archived, deleted, or recycled once all the data
160# in it (potentally from each columnfamily in the system) has been
161# flushed to sstables.
162#
163# The default size is 32, which is almost always fine, but if you are
164# archiving commitlog segments (see commitlog_archiving.properties),
165# then you probably want a finer granularity of archiving; 8 or 16 MB
166# is reasonable.
167commitlog_segment_size_in_mb: 32
168
169# any class that implements the SeedProvider interface and has a
170# constructor that takes a Map<String, String> of parameters will do.
171seed_provider:
172 # Addresses of hosts that are deemed contact points.
173 # Cassandra nodes use this list of hosts to find each other and learn
174 # the topology of the ring. You must change this if you are running
175 # multiple nodes!
176 - class_name: org.apache.cassandra.locator.SimpleSeedProvider
177 parameters:
178 # seeds is actually a comma-delimited list of addresses.
179 # Ex: "<ip1>,<ip2>,<ip3>"
180# - seeds: "10.0.1.243"
181 - seeds: "__SEED__"
182
183# emergency pressure valve: each time heap usage after a full (CMS)
184# garbage collection is above this fraction of the max, Cassandra will
185# flush the largest memtables.
186#
187# Set to 1.0 to disable. Setting this lower than
188# CMSInitiatingOccupancyFraction is not likely to be useful.
189#
190# RELYING ON THIS AS YOUR PRIMARY TUNING MECHANISM WILL WORK POORLY:
191# it is most effective under light to moderate load, or read-heavy
192# workloads; under truly massive write load, it will often be too
193# little, too late.
194flush_largest_memtables_at: 0.75
195
196# emergency pressure valve #2: the first time heap usage after a full
197# (CMS) garbage collection is above this fraction of the max,
198# Cassandra will reduce cache maximum _capacity_ to the given fraction
199# of the current _size_. Should usually be set substantially above
200# flush_largest_memtables_at, since that will have less long-term
201# impact on the system.
202#
203# Set to 1.0 to disable. Setting this lower than
204# CMSInitiatingOccupancyFraction is not likely to be useful.
205reduce_cache_sizes_at: 0.85
206reduce_cache_capacity_to: 0.6
207
208# For workloads with more data than can fit in memory, Cassandra's
209# bottleneck will be reads that need to fetch data from
210# disk. "concurrent_reads" should be set to (16 * number_of_drives) in
211# order to allow the operations to enqueue low enough in the stack
212# that the OS and drives can reorder them.
213#
214# On the other hand, since writes are almost never IO bound, the ideal
215# number of "concurrent_writes" is dependent on the number of cores in
216# your system; (8 * number_of_cores) is a good rule of thumb.
217concurrent_reads: 16
218concurrent_writes: 16
219
220# Total memory to use for memtables. Cassandra will flush the largest
221# memtable when this much memory is used.
222# If omitted, Cassandra will set it to 1/3 of the heap.
223# memtable_total_space_in_mb: 2048
224
225# Total space to use for commitlogs. Since commitlog segments are
226# mmapped, and hence use up address space, the default size is 32
227# on 32-bit JVMs, and 1024 on 64-bit JVMs.
228#
229# If space gets above this value (it will round up to the next nearest
230# segment multiple), Cassandra will flush every dirty CF in the oldest
231# segment and remove it. So a small total commitlog space will tend
232# to cause more flush activity on less-active columnfamilies.
233# commitlog_total_space_in_mb: 4096
234
235# This sets the amount of memtable flush writer threads. These will
236# be blocked by disk io, and each one will hold a memtable in memory
237# while blocked. If you have a large heap and many data directories,
238# you can increase this value for better flush performance.
239# By default this will be set to the amount of data directories defined.
240#memtable_flush_writers: 1
241
242# the number of full memtables to allow pending flush, that is,
243# waiting for a writer thread. At a minimum, this should be set to
244# the maximum number of secondary indexes created on a single CF.
245memtable_flush_queue_size: 4
246
247# Whether to, when doing sequential writing, fsync() at intervals in
248# order to force the operating system to flush the dirty
249# buffers. Enable this to avoid sudden dirty buffer flushing from
250# impacting read latencies. Almost always a good idea on SSD:s; not
251# necessarily on platters.
252trickle_fsync: false
253trickle_fsync_interval_in_kb: 10240
254
255# TCP port, for commands and data
256storage_port: 7000
257
258# SSL port, for encrypted communication. Unused unless enabled in
259# encryption_options
260ssl_storage_port: 7001
261
262# Address to bind to and tell other Cassandra nodes to connect to. You
263# _must_ change this if you want multiple nodes to be able to
264# communicate!
265#
266# Leaving it blank leaves it up to InetAddress.getLocalHost(). This
267# will always do the Right Thing *if* the node is properly configured
268# (hostname, name resolution, etc), and the Right Thing is to use the
269# address associated with the hostname (it might not be).
270#
271# Setting this to 0.0.0.0 is always wrong.
272listen_address:
273
274# Address to broadcast to other Cassandra nodes
275# Leaving this blank will set it to the same value as listen_address
276# broadcast_address: 1.2.3.4
277
278# The address to bind the Thrift RPC service to -- clients connect
279# here. Unlike ListenAddress above, you *can* specify 0.0.0.0 here if
280# you want Thrift to listen on all interfaces.
281#
282# Leaving this blank has the same effect it does for ListenAddress,
283# (i.e. it will be based on the configured hostname of the node).
284rpc_address: 0.0.0.0
285# port for Thrift to listen for clients on
286rpc_port: 9160
287
288# enable or disable keepalive on rpc connections
289rpc_keepalive: true
290
291# Cassandra provides three options for the RPC Server:
292#
293# sync -> One connection per thread in the rpc pool (see below).
294# For a very large number of clients, memory will be your limiting
295# factor; on a 64 bit JVM, 128KB is the minimum stack size per thread.
296# Connection pooling is very, very strongly recommended.
297#
298# async -> Nonblocking server implementation with one thread to serve
299# rpc connections. This is not recommended for high throughput use
300# cases. Async has been tested to be about 50% slower than sync
301# or hsha and is deprecated: it will be removed in the next major release.
302#
303# hsha -> Stands for "half synchronous, half asynchronous." The rpc thread pool
304# (see below) is used to manage requests, but the threads are multiplexed
305# across the different clients.
306#
307# The default is sync because on Windows hsha is about 30% slower. On Linux,
308# sync/hsha performance is about the same, with hsha of course using less memory.
309rpc_server_type: sync
310
311# Uncomment rpc_min|max|thread to set request pool size.
312# You would primarily set max for the sync server to safeguard against
313# misbehaved clients; if you do hit the max, Cassandra will block until one
314# disconnects before accepting more. The defaults for sync are min of 16 and max
315# unlimited.
316#
317# For the Hsha server, the min and max both default to quadruple the number of
318# CPU cores.
319#
320# This configuration is ignored by the async server.
321#
322# rpc_min_threads: 16
323# rpc_max_threads: 2048
324
325# uncomment to set socket buffer sizes on rpc connections
326# rpc_send_buff_size_in_bytes:
327# rpc_recv_buff_size_in_bytes:
328
329# Frame size for thrift (maximum field length).
330# 0 disables TFramedTransport in favor of TSocket. This option
331# is deprecated; we strongly recommend using Framed mode.
332thrift_framed_transport_size_in_mb: 15
333
334# The max length of a thrift message, including all fields and
335# internal thrift overhead.
336thrift_max_message_length_in_mb: 16
337
338# Set to true to have Cassandra create a hard link to each sstable
339# flushed or streamed locally in a backups/ subdirectory of the
340# Keyspace data. Removing these links is the operator's
341# responsibility.
342incremental_backups: false
343
344# Whether or not to take a snapshot before each compaction. Be
345# careful using this option, since Cassandra won't clean up the
346# snapshots for you. Mostly useful if you're paranoid when there
347# is a data format change.
348snapshot_before_compaction: false
349
350# Whether or not a snapshot is taken of the data before keyspace truncation
351# or dropping of column families. The STRONGLY advised default of true
352# should be used to provide data safety. If you set this flag to false, you will
353# lose data on truncation or drop.
354auto_snapshot: true
355
356# Add column indexes to a row after its contents reach this size.
357# Increase if your column values are large, or if you have a very large
358# number of columns. The competing causes are, Cassandra has to
359# deserialize this much of the row to read a single column, so you want
360# it to be small - at least if you do many partial-row reads - but all
361# the index data is read for each access, so you don't want to generate
362# that wastefully either.
363column_index_size_in_kb: 64
364
365# Size limit for rows being compacted in memory. Larger rows will spill
366# over to disk and use a slower two-pass compaction process. A message
367# will be logged specifying the row key.
368in_memory_compaction_limit_in_mb: 64
369
370# Number of simultaneous compactions to allow, NOT including
371# validation "compactions" for anti-entropy repair. Simultaneous
372# compactions can help preserve read performance in a mixed read/write
373# workload, by mitigating the tendency of small sstables to accumulate
374# during a single long running compactions. The default is usually
375# fine and if you experience problems with compaction running too
376# slowly or too fast, you should look at
377# compaction_throughput_mb_per_sec first.
378#
379# This setting has no effect on LeveledCompactionStrategy.
380#
381# concurrent_compactors defaults to the number of cores.
382# Uncomment to make compaction mono-threaded, the pre-0.8 default.
383#concurrent_compactors: 1
384
385# Multi-threaded compaction. When enabled, each compaction will use
386# up to one thread per core, plus one thread per sstable being merged.
387# This is usually only useful for SSD-based hardware: otherwise,
388# your concern is usually to get compaction to do LESS i/o (see:
389# compaction_throughput_mb_per_sec), not more.
390multithreaded_compaction: false
391
392# Throttles compaction to the given total throughput across the entire
393# system. The faster you insert data, the faster you need to compact in
394# order to keep the sstable count down, but in general, setting this to
395# 16 to 32 times the rate you are inserting data is more than sufficient.
396# Setting this to 0 disables throttling. Note that this account for all types
397# of compaction, including validation compaction.
398compaction_throughput_mb_per_sec: 16
399
400# Track cached row keys during compaction, and re-cache their new
401# positions in the compacted sstable. Disable if you use really large
402# key caches.
403compaction_preheat_key_cache: true
404
405# Throttles all outbound streaming file transfers on this node to the
406# given total throughput in Mbps. This is necessary because Cassandra does
407# mostly sequential IO when streaming data during bootstrap or repair, which
408# can lead to saturating the network connection and degrading rpc performance.
409# When unset, the default is 400 Mbps or 50 MB/s.
410# stream_throughput_outbound_megabits_per_sec: 400
411
412# Time to wait for a reply from other nodes before failing the command
413rpc_timeout_in_ms: 10000
414
415# Enable socket timeout for streaming operation.
416# When a timeout occurs during streaming, streaming is retried from the start
417# of the current file. This *can* involve re-streaming an important amount of
418# data, so you should avoid setting the value too low.
419# Default value is 0, which never timeout streams.
420# streaming_socket_timeout_in_ms: 0
421
422# phi value that must be reached for a host to be marked down.
423# most users should never need to adjust this.
424# phi_convict_threshold: 8
425
426# endpoint_snitch -- Set this to a class that implements
427# IEndpointSnitch. The snitch has two functions:
428# - it teaches Cassandra enough about your network topology to route
429# requests efficiently
430# - it allows Cassandra to spread replicas around your cluster to avoid
431# correlated failures. It does this by grouping machines into
432# "datacenters" and "racks." Cassandra will do its best not to have
433# more than one replica on the same "rack" (which may not actually
434# be a physical location)
435#
436# IF YOU CHANGE THE SNITCH AFTER DATA IS INSERTED INTO THE CLUSTER,
437# YOU MUST RUN A FULL REPAIR, SINCE THE SNITCH AFFECTS WHERE REPLICAS
438# ARE PLACED.
439#
440# Out of the box, Cassandra provides
441# - SimpleSnitch:
442# Treats Strategy order as proximity. This improves cache locality
443# when disabling read repair, which can further improve throughput.
444# Only appropriate for single-datacenter deployments.
445# - PropertyFileSnitch:
446# Proximity is determined by rack and data center, which are
447# explicitly configured in cassandra-topology.properties.
448# - GossipingPropertyFileSnitch
449# The rack and datacenter for the local node are defined in
450# cassandra-rackdc.properties and propagated to other nodes via gossip. If
451# cassandra-topology.properties exists, it is used as a fallback, allowing
452# migration from the PropertyFileSnitch.
453# - RackInferringSnitch:
454# Proximity is determined by rack and data center, which are
455# assumed to correspond to the 3rd and 2nd octet of each node's
456# IP address, respectively. Unless this happens to match your
457# deployment conventions (as it did Facebook's), this is best used
458# as an example of writing a custom Snitch class.
459# - Ec2Snitch:
460# Appropriate for EC2 deployments in a single Region. Loads Region
461# and Availability Zone information from the EC2 API. The Region is
462# treated as the Datacenter, and the Availability Zone as the rack.
463# Only private IPs are used, so this will not work across multiple
464# Regions.
465# - Ec2MultiRegionSnitch:
466# Uses public IPs as broadcast_address to allow cross-region
467# connectivity. (Thus, you should set seed addresses to the public
468# IP as well.) You will need to open the storage_port or
469# ssl_storage_port on the public IP firewall. (For intra-Region
470# traffic, Cassandra will switch to the private IP after
471# establishing a connection.)
472#
473# You can use a custom Snitch by setting this to the full class name
474# of the snitch, which will be assumed to be on your classpath.
475endpoint_snitch: SimpleSnitch
476
477# controls how often to perform the more expensive part of host score
478# calculation
479dynamic_snitch_update_interval_in_ms: 100
480# controls how often to reset all host scores, allowing a bad host to
481# possibly recover
482dynamic_snitch_reset_interval_in_ms: 600000
483# if set greater than zero and read_repair_chance is < 1.0, this will allow
484# 'pinning' of replicas to hosts in order to increase cache capacity.
485# The badness threshold will control how much worse the pinned host has to be
486# before the dynamic snitch will prefer other replicas over it. This is
487# expressed as a double which represents a percentage. Thus, a value of
488# 0.2 means Cassandra would continue to prefer the static snitch values
489# until the pinned host was 20% worse than the fastest.
490dynamic_snitch_badness_threshold: 0.1
491
492# request_scheduler -- Set this to a class that implements
493# RequestScheduler, which will schedule incoming client requests
494# according to the specific policy. This is useful for multi-tenancy
495# with a single Cassandra cluster.
496# NOTE: This is specifically for requests from the client and does
497# not affect inter node communication.
498# org.apache.cassandra.scheduler.NoScheduler - No scheduling takes place
499# org.apache.cassandra.scheduler.RoundRobinScheduler - Round robin of
500# client requests to a node with a separate queue for each
501# request_scheduler_id. The scheduler is further customized by
502# request_scheduler_options as described below.
503request_scheduler: org.apache.cassandra.scheduler.NoScheduler
504
505# Scheduler Options vary based on the type of scheduler
506# NoScheduler - Has no options
507# RoundRobin
508# - throttle_limit -- The throttle_limit is the number of in-flight
509# requests per client. Requests beyond
510# that limit are queued up until
511# running requests can complete.
512# The value of 80 here is twice the number of
513# concurrent_reads + concurrent_writes.
514# - default_weight -- default_weight is optional and allows for
515# overriding the default which is 1.
516# - weights -- Weights are optional and will default to 1 or the
517# overridden default_weight. The weight translates into how
518# many requests are handled during each turn of the
519# RoundRobin, based on the scheduler id.
520#
521# request_scheduler_options:
522# throttle_limit: 80
523# default_weight: 5
524# weights:
525# Keyspace1: 1
526# Keyspace2: 5
527
528# request_scheduler_id -- An identifer based on which to perform
529# the request scheduling. Currently the only valid option is keyspace.
530# request_scheduler_id: keyspace
531
532# index_interval controls the sampling of entries from the primrary
533# row index in terms of space versus time. The larger the interval,
534# the smaller and less effective the sampling will be. In technicial
535# terms, the interval coresponds to the number of index entries that
536# are skipped between taking each sample. All the sampled entries
537# must fit in memory. Generally, a value between 128 and 512 here
538# coupled with a large key cache size on CFs results in the best trade
539# offs. This value is not often changed, however if you have many
540# very small rows (many to an OS page), then increasing this will
541# often lower memory usage without a impact on performance.
542index_interval: 128
543
544# Enable or disable inter-node encryption
545# Default settings are TLS v1, RSA 1024-bit keys (it is imperative that
546# users generate their own keys) TLS_RSA_WITH_AES_128_CBC_SHA as the cipher
547# suite for authentication, key exchange and encryption of the actual data transfers.
548# NOTE: No custom encryption options are enabled at the moment
549# The available internode options are : all, none, dc, rack
550#
551# If set to dc cassandra will encrypt the traffic between the DCs
552# If set to rack cassandra will encrypt the traffic between the racks
553#
554# The passwords used in these options must match the passwords used when generating
555# the keystore and truststore. For instructions on generating these files, see:
556# http://download.oracle.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#CreateKeystore
557#
558encryption_options:
559 internode_encryption: none
560 keystore: conf/.keystore
561 keystore_password: cassandra
562 truststore: conf/.truststore
563 truststore_password: cassandra
564 # More advanced defaults below:
565 # protocol: TLS
566 # algorithm: SunX509
567 # store_type: JKS
568 # cipher_suites: [TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA]