From 4b9643928e53752b9c43eda72b2c7ed59458a9f2 Mon Sep 17 00:00:00 2001
From: Sulverus <sulverus@gmail.com>
Date: Fri, 18 Sep 2015 17:31:50 +0300
Subject: [PATCH] default tarantool configuration file with comments added to
install script
---
debian/tarantool-common.install | 1 +
extra/dist/CMakeLists.txt | 8 ++
extra/dist/default.lua | 217 ++++++++++++++++++++++++++++++++
3 files changed, 226 insertions(+)
create mode 100644 extra/dist/default.lua
diff --git a/debian/tarantool-common.install b/debian/tarantool-common.install
index cbda4cc96f..9ef8f270bb 100644
--- a/debian/tarantool-common.install
+++ b/debian/tarantool-common.install
@@ -1,2 +1,3 @@
/etc/default/tarantool
/usr/bin/tarantoolctl
+/etc/tarantool/instances.enabled/default.lua
diff --git a/extra/dist/CMakeLists.txt b/extra/dist/CMakeLists.txt
index 4db2c9e08d..3c16a7aa02 100644
--- a/extra/dist/CMakeLists.txt
+++ b/extra/dist/CMakeLists.txt
@@ -54,6 +54,14 @@ install (FILES tarantoolctl DESTINATION ${CMAKE_INSTALL_BINDIR}
WORLD_READ WORLD_EXECUTE
)
+install (FILES default.lua DESTINATION
+ ${CMAKE_INSTALL_SYSCONFDIR}/tarantool/instances.enabled
+ PERMISSIONS
+ OWNER_READ OWNER_WRITE OWNER_EXECUTE
+ GROUP_READ GROUP_EXECUTE
+ WORLD_READ WORLD_EXECUTE
+)
+
pod2man (
${CMAKE_SOURCE_DIR}/extra/dist/tarantoolctl
"tarantoolctl" 1 extra/dist
diff --git a/extra/dist/default.lua b/extra/dist/default.lua
new file mode 100644
index 0000000000..17dbc7ba9d
--- /dev/null
+++ b/extra/dist/default.lua
@@ -0,0 +1,217 @@
+-- This is default tarantool initialization file
+-- with easy to use configuration examples including
+-- replication, sharding and all major features
+-- Complete documentation available in: http://tarantool.org/doc/
+--
+-- To start this example just run "sudo tarantoolctl start default"
+-- Features:
+-- 1. Database configuration
+-- 2. Binary logging and snapshots
+-- 3. Replication
+-- 4. Automatinc sharding
+-- 5. Message queue
+-- 6. Data expiration
+
+-----------------
+-- Configuration
+-----------------
+box.cfg {
+ --------------------
+ -- Basic parameters
+ --------------------
+
+ -- UNIX user name to switch to after start
+ -- by default: tarantool
+ username = nil;
+
+ -- A directory where database working files will be stored
+ -- If not specified, defaults to the current directory
+ workdir = nil;
+
+ -- A directory where write-ahead log (.xlog) files are stored
+ -- If not specified, defaults to work_dir
+ wal_dir = ".";
+
+ -- A directory where snapshot (.snap) files will be stored
+ -- If not specified, defaults to work_dir
+ snap_dir = ".";
+
+ -- A directory where sophia files will be stored
+ -- If not specified, defaults to work_dir
+ sophia_dir = "sophia";
+
+ -- The read/write data port number or URI
+ -- Has no default value, so must be specified if
+ -- connections will occur from remote clients
+ -- that do not use “admin addressâ€
+ listen=3301;
+
+ -- Store the process id in this file.
+ -- Can be relative to work_dir.
+ -- Default value is “tarantool.pidâ€.
+ pid_file = nil;
+
+ -- Inject the given string into server process title
+ custom_proc_title = 'tarantool';
+
+ -- Run the server as a background task
+ -- The logger and pid_file parameters
+ -- must be non-null for this to work
+ background = true;
+
+ -------------------------
+ -- Storage configuration
+ -------------------------
+
+ -- How much memory Tarantool allocates
+ -- to actually store tuples, in gigabytes
+ slab_alloc_arena = 1.0;
+
+ -- Size of the smallest allocation unit
+ -- It can be tuned down if most of the tuples are very small
+ slab_alloc_minimal = 64;
+
+ -- Size of the largest allocation unit
+ -- It can be tuned up if it is necessary to store large tuples
+ slab_alloc_maximal = 1048576;
+
+ -- Use slab_alloc_factor as the multiplier for computing
+ -- the sizes of memory chunks that tuples are stored in
+ slab_alloc_factor = 1.06;
+
+ -------------------
+ -- Snapshot daemon
+ -------------------
+
+ -- The interval between actions by the snapshot daemon, in seconds
+ snapshot_period = 0;
+
+ -- The maximum number of snapshots that the snapshot daemon maintans
+ snapshot_count = 6;
+
+ --------------------------------
+ -- Binary logging and snapshots
+ --------------------------------
+
+ -- Abort if there is an error while reading
+ -- the snapshot file (at server start)
+ panic_on_snap_error = true;
+
+ -- Abort if there is an error while reading a write-ahead
+ -- log file (at server start or to relay to a replica)
+ panic_on_wal_error = true;
+
+ -- How many log records to store in a single write-ahead log file
+ rows_per_wal = 500000;
+
+ -- Reduce the throttling effect of box.snapshot() on
+ -- INSERT/UPDATE/DELETE performance by setting a limit
+ -- on how many megabytes per second it can write to disk
+ snap_io_rate_limit = nil;
+
+ -- Specify fiber-WAL-disk synchronization mode as:
+ -- "none": write-ahead log is not maintained;
+ -- "write": fibers wait for their data to be written to the write-ahead log;
+ -- "fsync": fibers wait for their data, fsync follows each write;
+ wal_mode = "none";
+
+ -- Number of seconds between periodic scans of the write-ahead-log file directory
+ wal_dir_rescan_delay = 2.0;
+
+ ---------------
+ -- Replication
+ ---------------
+
+ -- The server is considered to be a Tarantool replica
+ -- it will try to connect to the master
+ -- which replication_source specifies with a URI
+ -- for example konstantin:secret_password@tarantool.org:3301
+ -- by default username is "guest"
+ --replication_source="127.0.0.1:3102";
+
+ --------------
+ -- Networking
+ --------------
+
+ -- The server will sleep for io_collect_interval seconds
+ -- between iterations of the event loop
+ io_collect_interval = nil;
+
+ -- The size of the read-ahead buffer associated with a client connection
+ readahead = 16320;
+
+ ----------
+ -- Logging
+ ----------
+
+ -- How verbose the logging is. There are six log verbosity classes:
+ -- 1 – SYSERROR
+ -- 2 – ERROR
+ -- 3 – CRITICAL
+ -- 4 – WARNING
+ -- 5 – INFO
+ -- 6 – DEBUG
+ log_level = 5;
+
+ -- By default, the log is sent to the standard error stream (stderr)
+ -- If logger is specified, the log is sent to the file named in the string
+ logger = nil;
+
+ -- If true, tarantool does not block on the log file descriptor
+ -- when it’s not ready for write, and drops the message instead
+ logger_nonblock = true;
+
+ -- If processing a request takes longer than
+ -- the given value (in seconds), warn about it in the log
+ too_long_threshold = 0.5;
+}
+
+-----------------------
+-- Automatinc sharding
+-----------------------
+-- N.B. you need install tarantool-shard package to use shadring
+-- Docs: https://github.com/tarantool/shard/blob/master/README.md
+-- Example:
+--local shard = require('shard')
+--local shards = {
+-- servers = {
+-- { uri = [[host1.com:4301]]; zone = [[0]]; };
+-- { uri = [[host2.com:4302]]; zone = [[1]]; };
+-- };
+-- login = 'tester';
+-- password = 'pass';
+-- redundancy = 2;
+-- binary = '127.0.0.1:3301';
+-- monitor = false;
+--}
+--shard.init(cfg)
+
+-----------------
+-- Message queue
+-----------------
+-- N.B. you need install tarantool-queue package to use queue
+-- Docs: https://github.com/tarantool/queue/blob/master/README.md
+-- Example:
+--queue = require('queue')
+--queue.start()
+--queue.create_tube(tube_name, 'fifottl')
+
+-------------------
+-- Data expiration
+-------------------
+-- N.B. you need install tarantool-expirationd package to use expirationd
+-- Docs: https://github.com/tarantool/expirationd/blob/master/README.md
+-- Example:
+--space = box.space.default
+--job_name = 'clean_all'
+--expirationd = require('expirationd')
+--function is_expired(args, tuple)
+-- return true
+--end
+--function delete_tuple(space_id, args, tuple)
+-- box.space[space_id]:delete{tuple[1]}
+--end
+--expirationd.run_task(job_name, space.id, is_expired, {
+-- process_expired_tuple = delete_tuple, args = nil,
+-- tuple_per_item = 50, full_scan_time = 3600
+--})
--
GitLab