From 93a8b76070bcec210e3453ca7f506553e382b5b6 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Fri, 16 Dec 2022 15:17:25 -0500 Subject: [PATCH 01/31] Add defaults for influxdb --- salt/influxdb/defaults.yaml | 154 ++++++++++++++++++++++++++++++++++++ salt/influxdb/init.sls | 2 - 2 files changed, 154 insertions(+), 2 deletions(-) diff --git a/salt/influxdb/defaults.yaml b/salt/influxdb/defaults.yaml index 177ebdfa2..d32c471fd 100644 --- a/salt/influxdb/defaults.yaml +++ b/salt/influxdb/defaults.yaml @@ -1,4 +1,158 @@ influxdb: + config: + meta: + dir: '/var/lib/influxdb/meta' + retention-autocreate: true + logging-enabled: true + data: + dir: '/var/lib/influxdb/data' + wal-dir: /var/lib/influxdb/wal' + wal-fsync-delay: '0s' + index-version: 'inmem' + race-logging-enabled: false + query-log-enabled: true + validate-keys: false + cache-max-memory-size: '1g' + cache-snapshot-memory-size: '25m' + cache-snapshot-write-cold-duration: '10m' + compact-full-write-cold-duration: '4h' + max-concurrent-compactions: 0 + compact-throughput: '48m' + compact-throughput-burst: '48m' + max-index-log-file-size: '1m' + max-series-per-database: 1000000 + max-values-per-tag: 100000 + tsm-use-madv-willneed: false + coordinator: + write-timeout: '10s' + max-concurrent-queries: 0 + query-timeout: '0s' + log-queries-after: '0s' + max-select-point: 0 + max-select-series: 0 + max-select-buckets: 0 + retention: + enabled: true + check-interval: '30m' + shard-precreation: + enabled: true + check-interval: '10m' + advance-period: '30m' + monitor: + store-enabled: true + store-database: '_internal' + store-interval: '10s' + http: + enabled: true + flux-enabled: true + bind-address: ':8086' + auth-enabled: false + realm: 'InfluxDB' + log-enabled: false + suppress-write-log: false + access-log-path: '' + access-log-status-filters: [] + write-tracing: false + pprof-enabled: true + debug-pprof-enabled: false + https-enabled: true + https-certificate: '/etc/ssl/influxdb.crt' + https-private-key: '/etc/ssl/influxdb.key' + shared-secret: '' + max-row-limit: 0 + max-connection-limit: 0 + unix-socket-enabled: false + bind-socket: '/var/run/influxdb.sock' + max-body-size: 25000000 + max-concurrent-write-limit: 0 + max-enqueued-write-limit: 0 + enqueued-write-timeout: 0 + logging: + format: 'auto' + level: 'info' + suppress-logo: false + subscriber: + enabled: true + http-timeout: '30s' + insecure-skip-verify: false + ca-certs: '' + write-concurrency: 40 + write-buffer-size: 1000 + graphite: + enabled: false + database: 'graphite' + retention-policy: '' + bind-address: ':2003' + protocol: 'tcp' + consistency-level: 'one' + batch-size: 5000 + batch-pending: 10 + batch-timeout: '1s' + udp-read-buffer: 0 + separator: '.' + tags: '' + templates: '' + colectd: + enabled: false + bind-address: ':25826' + database: 'collectd' + retention-policy: '' + typesdb: '/usr/local/share/collectd' + security-level: 'none' + auth-file: '/etc/collectd/auth_file' + batch-size: 5000 + bath-pending: 10 + read-buffer: 0 + parse-multivalue-plugin: 'split' + opentsdb: + enabled: false + bind-address: ':4242' + database: 'opentsdb' + retention-policy: '' + consistency-level: 'one' + tls-enabled: false + certificate: '/etc/ssl/influxdb.pem' + log-point-errors: true + batch-size: 1000 + batch-pending: 5 + bath-timeout: '1s' + udp: + enabled: false + bind-address: ':8089' + database: 'udp' + retention-policy: '' + precision: '' + batch-size: 5000 + batch-pending: 10 + batch-timeout: '1s' + read-buffer: 0 + continuous_queries: + enabled: true + log-enabled: true + query-stats-enabled: false + run-interval: '1s' + tls: + ciphers: + - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA + - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 + - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA + - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 + - TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305 + - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA + - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 + - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 + - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA + - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305 + - TLS_RSA_WITH_AES_128_CBC_SHA + - TLS_RSA_WITH_AES_128_CBC_SHA256 + - TLS_RSA_WITH_AES_128_GCM_SHA256 + - TLS_RSA_WITH_AES_256_CBC_SHA + - TLS_RSA_WITH_AES_256_GCM_SHA384 + min-version: 'tls1.2' + max-version: 'tls1.2' + retention_policies: so_short_term: default: True diff --git a/salt/influxdb/init.sls b/salt/influxdb/init.sls index 321ce76d6..ae2b98072 100644 --- a/salt/influxdb/init.sls +++ b/salt/influxdb/init.sls @@ -47,8 +47,6 @@ so-influxdb: docker_container.running: - image: {{ GLOBALS.registry_host }}:5000/{{ GLOBALS.image_repo }}/so-influxdb:{{ GLOBALS.so_version }} - hostname: influxdb - - environment: - - INFLUXDB_HTTP_LOG_ENABLED=false - binds: - /opt/so/log/influxdb/:/log:rw - /opt/so/conf/influxdb/etc/influxdb.conf:/etc/influxdb/influxdb.conf:ro From 4c90c1af121986d8350d0c0c6e1aa1db7941d77a Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Sun, 18 Dec 2022 18:07:02 -0500 Subject: [PATCH 02/31] Add defaults for redis --- salt/redis/defaults.yaml | 90 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 salt/redis/defaults.yaml diff --git a/salt/redis/defaults.yaml b/salt/redis/defaults.yaml new file mode 100644 index 000000000..26be06229 --- /dev/null +++ b/salt/redis/defaults.yaml @@ -0,0 +1,90 @@ +redis: + config: + bind: '0.0.0.0' + protected-mode: 'no' + tls-cert-file: '/certs/redis.crt' + tls-key-file: '/certs/redis.key' + tls-ca-cert-file: '/certs/ca.crt' + tls-port: 9696 + tls-auth-clients: 'no' + port: 6379 + tcp-backlog: 511 + timeout: 0 + tcp-keepalive: 300 + tls-replication: 'no' + tls-cluster: no + tls-protocols: '"TLSv1.2 TLSv1.3"' + tls-ciphers: 'DEFAULT:!MEDIUM' + tls-ciphersuites: 'TLS_CHACHA20_POLY1305_SHA256' + tls-prefer-server-ciphers: 'yes' + tls-session-caching: 'no' + tls-session-cache-size: 5000 + tls-session-cache-timeout: 60 + daemonize: 'no' + supervised: 'no' + pidfile: '/var/run/redis_6379.pid' + loglevel: 'notice' + logfile: '"/var/log/redis/redis-server.log"' + syslog-enabled: 'no' + syslog-ident: 'redis' + syslog-facility: 'local0' + databases: 16 + always-show-logo: 'yes' + save: + 900: 1 + 300: 1 + 60: 1000 + stop-writes-on-bgsave-error: 'yes' + rdbcompression: 'yes' + rdbchecksum: 'yes' + dbfilename: 'dump.rdb' + rdb-del-sync-files: 'no' + dir: './' + replica-serve-stale-data: 'yes' + replica-read-only: 'yes' + repl-diskless-sync: 'no' + repl-diskless-sync-delay: 5 + repl-diskless-load: 'disabled' + repl-disable-tcp-nodelay: 'no' + replica-priority: 100 + acllog-max-len: 128 + maxmemory: '812m' + maxmemory-policy: 'noeviction' + maxmemory-samples: 5 + lazyfree-lazy-eviction: 'no' + lazyfree-lazy-expire: 'no' + lazyfree-lazy-server-del: 'no' + replica-lazy-flush: 'no' + lazyfree-lazy-user-del: 'no' + appendonly: 'no' + appendfilename: '"appendonly.aof"' + appendfsync: 'everysec' + no-appendfsync-on-rewrite: 'no' + auto-aof-rewrite-percentage: 100 + auto-aof-rewrite-min-size: '64mb' + aof-load-truncated: 'yes' + aof-use-rdb-preamble: 'yes' + lua-time-limit: 5000 + slowlog-log-slower-than: 10000 + slowlog-max-len: 128 + latency-monitor-threshold: 0 + notify-keyspace-events: '""' + hash-max-ziplist-entries: 512 + hash-max-ziplist-value: 64 + list-max-ziplist-size: -2 + list-compress-depth: 0 + set-max-intset-entries: 512 + zset-max-ziplist-entries: 128 + zset-max-ziplist-value: 64 + hll-sparse-max-bytes: 3000 + stream-node-max-bytes: 4096 + stream-node-max-entries: 100 + activerehashing: yes + client-output-buffer-limit: 'normal 0 0 0' + client-output-buffer-limit: 'replica 256mb 64mb 60' + client-output-buffer-limit: 'pubsub 32mb 8mb 60' + hz: 10 + dynamic-hz: 'yes' + aof-rewrite-incremental-fsync: 'yes' + rdb-save-incremental-fsync: 'yes' + jemalloc-bg-thread: 'yes' \ No newline at end of file From 01d6b2b1f106784edb53e64703c2ab3b4ddf2fba Mon Sep 17 00:00:00 2001 From: m0duspwnens Date: Mon, 19 Dec 2022 10:14:48 -0500 Subject: [PATCH 03/31] jinja the redis config --- salt/redis/etc/redis.conf | 1839 ------------------------------- salt/redis/etc/redis.conf.jinja | 11 + salt/redis/init.sls | 2 +- 3 files changed, 12 insertions(+), 1840 deletions(-) delete mode 100644 salt/redis/etc/redis.conf create mode 100644 salt/redis/etc/redis.conf.jinja diff --git a/salt/redis/etc/redis.conf b/salt/redis/etc/redis.conf deleted file mode 100644 index 7c52a6217..000000000 --- a/salt/redis/etc/redis.conf +++ /dev/null @@ -1,1839 +0,0 @@ -{% set MAXMEM = salt['pillar.get']('redis_settings:redis_maxmemory', 812) %} - -# Redis configuration file example. -# -# Note that in order to read the configuration file, Redis must be -# started with the file path as first argument: -# -# ./redis-server /path/to/redis.conf - -# Note on units: when memory size is needed, it is possible to specify -# it in the usual form of 1k 5GB 4M and so forth: -# -# 1k => 1000 bytes -# 1kb => 1024 bytes -# 1m => 1000000 bytes -# 1mb => 1024*1024 bytes -# 1g => 1000000000 bytes -# 1gb => 1024*1024*1024 bytes -# -# units are case insensitive so 1GB 1Gb 1gB are all the same. - -################################## INCLUDES ################################### - -# Include one or more other config files here. This is useful if you -# have a standard template that goes to all Redis servers but also need -# to customize a few per-server settings. Include files can include -# other files, so use this wisely. -# -# Notice option "include" won't be rewritten by command "CONFIG REWRITE" -# from admin or Redis Sentinel. Since Redis always uses the last processed -# line as value of a configuration directive, you'd better put includes -# at the beginning of this file to avoid overwriting config change at runtime. -# -# If instead you are interested in using includes to override configuration -# options, it is better to use include as the last line. -# -# include /path/to/local.conf -# include /path/to/other.conf - -################################## MODULES ##################################### - -# Load modules at startup. If the server is not able to load modules -# it will abort. It is possible to use multiple loadmodule directives. -# -# loadmodule /path/to/my_module.so -# loadmodule /path/to/other_module.so - -################################## NETWORK ##################################### - -# By default, if no "bind" configuration directive is specified, Redis listens -# for connections from all the network interfaces available on the server. -# It is possible to listen to just one or multiple selected interfaces using -# the "bind" configuration directive, followed by one or more IP addresses. -# -# Examples: -# -# bind 192.168.1.100 10.0.0.1 -# bind 127.0.0.1 ::1 -# -# ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the -# internet, binding to all the interfaces is dangerous and will expose the -# instance to everybody on the internet. So by default we uncomment the -# following bind directive, that will force Redis to listen only into -# the IPv4 loopback interface address (this means Redis will be able to -# accept connections only from clients running into the same computer it -# is running). -# -# IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES -# JUST COMMENT THE FOLLOWING LINE. -# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -bind 0.0.0.0 - -# Protected mode is a layer of security protection, in order to avoid that -# Redis instances left open on the internet are accessed and exploited. -# -# When protected mode is on and if: -# -# 1) The server is not binding explicitly to a set of addresses using the -# "bind" directive. -# 2) No password is configured. -# -# The server only accepts connections from clients connecting from the -# IPv4 and IPv6 loopback addresses 127.0.0.1 and ::1, and from Unix domain -# sockets. -# -# By default protected mode is enabled. You should disable it only if -# you are sure you want clients from other hosts to connect to Redis -# even if no authentication is configured, nor a specific set of interfaces -# are explicitly listed using the "bind" directive. -protected-mode no -tls-cert-file /certs/redis.crt -tls-key-file /certs/redis.key -tls-ca-cert-file /certs/ca.crt -tls-port 9696 -tls-auth-clients no - -# Accept connections on the specified port, default is 6379 (IANA #815344). -# If port 0 is specified Redis will not listen on a TCP socket. -port 6379 - -# TCP listen() backlog. -# -# In high requests-per-second environments you need an high backlog in order -# to avoid slow clients connections issues. Note that the Linux kernel -# will silently truncate it to the value of /proc/sys/net/core/somaxconn so -# make sure to raise both the value of somaxconn and tcp_max_syn_backlog -# in order to get the desired effect. -tcp-backlog 511 - -# Unix socket. -# -# Specify the path for the Unix socket that will be used to listen for -# incoming connections. There is no default, so Redis will not listen -# on a unix socket when not specified. -# -# unixsocket /tmp/redis.sock -# unixsocketperm 700 - -# Close the connection after a client is idle for N seconds (0 to disable) -timeout 0 - -# TCP keepalive. -# -# If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence -# of communication. This is useful for two reasons: -# -# 1) Detect dead peers. -# 2) Take the connection alive from the point of view of network -# equipment in the middle. -# -# On Linux, the specified value (in seconds) is the period used to send ACKs. -# Note that to close the connection the double of the time is needed. -# On other kernels the period depends on the kernel configuration. -# -# A reasonable value for this option is 300 seconds, which is the new -# Redis default starting with Redis 3.2.1. -tcp-keepalive 300 - -################################# TLS/SSL ##################################### - -# By default, TLS/SSL is disabled. To enable it, the "tls-port" configuration -# directive can be used to define TLS-listening ports. To enable TLS on the -# default port, use: -# -# port 0 -# tls-port 6379 - -# Configure a X.509 certificate and private key to use for authenticating the -# server to connected clients, masters or cluster peers. These files should be -# PEM formatted. -# -# tls-cert-file redis.crt -# tls-key-file redis.key - -# Configure a DH parameters file to enable Diffie-Hellman (DH) key exchange: -# -# tls-dh-params-file redis.dh - -# Configure a CA certificate(s) bundle or directory to authenticate TLS/SSL -# clients and peers. Redis requires an explicit configuration of at least one -# of these, and will not implicitly use the system wide configuration. -# -# tls-ca-cert-file ca.crt -# tls-ca-cert-dir /etc/ssl/certs - -# By default, clients (including replica servers) on a TLS port are required -# to authenticate using valid client side certificates. -# -# It is possible to disable authentication using this directive. -# -# tls-auth-clients no - -# By default, a Redis replica does not attempt to establish a TLS connection -# with its master. -# -# Use the following directive to enable TLS on replication links. -# -# tls-replication yes - -# By default, the Redis Cluster bus uses a plain TCP connection. To enable -# TLS for the bus protocol, use the following directive: -# -# tls-cluster yes - -# Explicitly specify TLS versions to support. Allowed values are case insensitive -# and include "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3" (OpenSSL >= 1.1.1) or -# any combination. To enable only TLSv1.2 and TLSv1.3, use: -# -# tls-protocols "TLSv1.2 TLSv1.3" - -# Configure allowed ciphers. See the ciphers(1ssl) manpage for more information -# about the syntax of this string. -# -# Note: this configuration applies only to <= TLSv1.2. -# -# tls-ciphers DEFAULT:!MEDIUM - -# Configure allowed TLSv1.3 ciphersuites. See the ciphers(1ssl) manpage for more -# information about the syntax of this string, and specifically for TLSv1.3 -# ciphersuites. -# -# tls-ciphersuites TLS_CHACHA20_POLY1305_SHA256 - -# When choosing a cipher, use the server's preference instead of the client -# preference. By default, the server follows the client's preference. -# -# tls-prefer-server-ciphers yes - -# By default, TLS session caching is enabled to allow faster and less expensive -# reconnections by clients that support it. Use the following directive to disable -# caching. -# -# tls-session-caching no - -# Change the default number of TLS sessions cached. A zero value sets the cache -# to unlimited size. The default size is 20480. -# -# tls-session-cache-size 5000 - -# Change the default timeout of cached TLS sessions. The default timeout is 300 -# seconds. -# -# tls-session-cache-timeout 60 - -################################# GENERAL ##################################### - -# By default Redis does not run as a daemon. Use 'yes' if you need it. -# Note that Redis will write a pid file in /var/run/redis.pid when daemonized. -daemonize no - -# If you run Redis from upstart or systemd, Redis can interact with your -# supervision tree. Options: -# supervised no - no supervision interaction -# supervised upstart - signal upstart by putting Redis into SIGSTOP mode -# supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET -# supervised auto - detect upstart or systemd method based on -# UPSTART_JOB or NOTIFY_SOCKET environment variables -# Note: these supervision methods only signal "process is ready." -# They do not enable continuous liveness pings back to your supervisor. -supervised no - -# If a pid file is specified, Redis writes it where specified at startup -# and removes it at exit. -# -# When the server runs non daemonized, no pid file is created if none is -# specified in the configuration. When the server is daemonized, the pid file -# is used even if not specified, defaulting to "/var/run/redis.pid". -# -# Creating a pid file is best effort: if Redis is not able to create it -# nothing bad happens, the server will start and run normally. -pidfile /var/run/redis_6379.pid - -# Specify the server verbosity level. -# This can be one of: -# debug (a lot of information, useful for development/testing) -# verbose (many rarely useful info, but not a mess like the debug level) -# notice (moderately verbose, what you want in production probably) -# warning (only very important / critical messages are logged) -loglevel notice - -# Specify the log file name. Also the empty string can be used to force -# Redis to log on the standard output. Note that if you use standard -# output for logging but daemonize, logs will be sent to /dev/null -logfile "/var/log/redis/redis-server.log" - -# To enable logging to the system logger, just set 'syslog-enabled' to yes, -# and optionally update the other syslog parameters to suit your needs. -# syslog-enabled no - -# Specify the syslog identity. -# syslog-ident redis - -# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. -# syslog-facility local0 - -# Set the number of databases. The default database is DB 0, you can select -# a different one on a per-connection basis using SELECT where -# dbid is a number between 0 and 'databases'-1 -databases 16 - -# By default Redis shows an ASCII art logo only when started to log to the -# standard output and if the standard output is a TTY. Basically this means -# that normally a logo is displayed only in interactive sessions. -# -# However it is possible to force the pre-4.0 behavior and always show a -# ASCII art logo in startup logs by setting the following option to yes. -always-show-logo yes - -################################ SNAPSHOTTING ################################ -# -# Save the DB on disk: -# -# save -# -# Will save the DB if both the given number of seconds and the given -# number of write operations against the DB occurred. -# -# In the example below the behaviour will be to save: -# after 900 sec (15 min) if at least 1 key changed -# after 300 sec (5 min) if at least 10 keys changed -# after 60 sec if at least 10000 keys changed -# -# Note: you can disable saving completely by commenting out all "save" lines. -# -# It is also possible to remove all the previously configured save -# points by adding a save directive with a single empty string argument -# like in the following example: -# -# save "" - -save 900 1 -save 300 10 -save 60 10000 - -# By default Redis will stop accepting writes if RDB snapshots are enabled -# (at least one save point) and the latest background save failed. -# This will make the user aware (in a hard way) that data is not persisting -# on disk properly, otherwise chances are that no one will notice and some -# disaster will happen. -# -# If the background saving process will start working again Redis will -# automatically allow writes again. -# -# However if you have setup your proper monitoring of the Redis server -# and persistence, you may want to disable this feature so that Redis will -# continue to work as usual even if there are problems with disk, -# permissions, and so forth. -stop-writes-on-bgsave-error yes - -# Compress string objects using LZF when dump .rdb databases? -# For default that's set to 'yes' as it's almost always a win. -# If you want to save some CPU in the saving child set it to 'no' but -# the dataset will likely be bigger if you have compressible values or keys. -rdbcompression yes - -# Since version 5 of RDB a CRC64 checksum is placed at the end of the file. -# This makes the format more resistant to corruption but there is a performance -# hit to pay (around 10%) when saving and loading RDB files, so you can disable it -# for maximum performances. -# -# RDB files created with checksum disabled have a checksum of zero that will -# tell the loading code to skip the check. -rdbchecksum yes - -# The filename where to dump the DB -dbfilename dump.rdb - -# Remove RDB files used by replication in instances without persistence -# enabled. By default this option is disabled, however there are environments -# where for regulations or other security concerns, RDB files persisted on -# disk by masters in order to feed replicas, or stored on disk by replicas -# in order to load them for the initial synchronization, should be deleted -# ASAP. Note that this option ONLY WORKS in instances that have both AOF -# and RDB persistence disabled, otherwise is completely ignored. -# -# An alternative (and sometimes better) way to obtain the same effect is -# to use diskless replication on both master and replicas instances. However -# in the case of replicas, diskless is not always an option. -rdb-del-sync-files no - -# The working directory. -# -# The DB will be written inside this directory, with the filename specified -# above using the 'dbfilename' configuration directive. -# -# The Append Only File will also be created inside this directory. -# -# Note that you must specify a directory here, not a file name. -dir ./ - -################################# REPLICATION ################################# - -# Master-Replica replication. Use replicaof to make a Redis instance a copy of -# another Redis server. A few things to understand ASAP about Redis replication. -# -# +------------------+ +---------------+ -# | Master | ---> | Replica | -# | (receive writes) | | (exact copy) | -# +------------------+ +---------------+ -# -# 1) Redis replication is asynchronous, but you can configure a master to -# stop accepting writes if it appears to be not connected with at least -# a given number of replicas. -# 2) Redis replicas are able to perform a partial resynchronization with the -# master if the replication link is lost for a relatively small amount of -# time. You may want to configure the replication backlog size (see the next -# sections of this file) with a sensible value depending on your needs. -# 3) Replication is automatic and does not need user intervention. After a -# network partition replicas automatically try to reconnect to masters -# and resynchronize with them. -# -# replicaof - -# If the master is password protected (using the "requirepass" configuration -# directive below) it is possible to tell the replica to authenticate before -# starting the replication synchronization process, otherwise the master will -# refuse the replica request. -# -# masterauth -# -# However this is not enough if you are using Redis ACLs (for Redis version -# 6 or greater), and the default user is not capable of running the PSYNC -# command and/or other commands needed for replication. In this case it's -# better to configure a special user to use with replication, and specify the -# masteruser configuration as such: -# -# masteruser -# -# When masteruser is specified, the replica will authenticate against its -# master using the new AUTH form: AUTH . - -# When a replica loses its connection with the master, or when the replication -# is still in progress, the replica can act in two different ways: -# -# 1) if replica-serve-stale-data is set to 'yes' (the default) the replica will -# still reply to client requests, possibly with out of date data, or the -# data set may just be empty if this is the first synchronization. -# -# 2) if replica-serve-stale-data is set to 'no' the replica will reply with -# an error "SYNC with master in progress" to all the kind of commands -# but to INFO, replicaOF, AUTH, PING, SHUTDOWN, REPLCONF, ROLE, CONFIG, -# SUBSCRIBE, UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, PUBLISH, PUBSUB, -# COMMAND, POST, HOST: and LATENCY. -# -replica-serve-stale-data yes - -# You can configure a replica instance to accept writes or not. Writing against -# a replica instance may be useful to store some ephemeral data (because data -# written on a replica will be easily deleted after resync with the master) but -# may also cause problems if clients are writing to it because of a -# misconfiguration. -# -# Since Redis 2.6 by default replicas are read-only. -# -# Note: read only replicas are not designed to be exposed to untrusted clients -# on the internet. It's just a protection layer against misuse of the instance. -# Still a read only replica exports by default all the administrative commands -# such as CONFIG, DEBUG, and so forth. To a limited extent you can improve -# security of read only replicas using 'rename-command' to shadow all the -# administrative / dangerous commands. -replica-read-only yes - -# Replication SYNC strategy: disk or socket. -# -# New replicas and reconnecting replicas that are not able to continue the -# replication process just receiving differences, need to do what is called a -# "full synchronization". An RDB file is transmitted from the master to the -# replicas. -# -# The transmission can happen in two different ways: -# -# 1) Disk-backed: The Redis master creates a new process that writes the RDB -# file on disk. Later the file is transferred by the parent -# process to the replicas incrementally. -# 2) Diskless: The Redis master creates a new process that directly writes the -# RDB file to replica sockets, without touching the disk at all. -# -# With disk-backed replication, while the RDB file is generated, more replicas -# can be queued and served with the RDB file as soon as the current child -# producing the RDB file finishes its work. With diskless replication instead -# once the transfer starts, new replicas arriving will be queued and a new -# transfer will start when the current one terminates. -# -# When diskless replication is used, the master waits a configurable amount of -# time (in seconds) before starting the transfer in the hope that multiple -# replicas will arrive and the transfer can be parallelized. -# -# With slow disks and fast (large bandwidth) networks, diskless replication -# works better. -repl-diskless-sync no - -# When diskless replication is enabled, it is possible to configure the delay -# the server waits in order to spawn the child that transfers the RDB via socket -# to the replicas. -# -# This is important since once the transfer starts, it is not possible to serve -# new replicas arriving, that will be queued for the next RDB transfer, so the -# server waits a delay in order to let more replicas arrive. -# -# The delay is specified in seconds, and by default is 5 seconds. To disable -# it entirely just set it to 0 seconds and the transfer will start ASAP. -repl-diskless-sync-delay 5 - -# ----------------------------------------------------------------------------- -# WARNING: RDB diskless load is experimental. Since in this setup the replica -# does not immediately store an RDB on disk, it may cause data loss during -# failovers. RDB diskless load + Redis modules not handling I/O reads may also -# cause Redis to abort in case of I/O errors during the initial synchronization -# stage with the master. Use only if your do what you are doing. -# ----------------------------------------------------------------------------- -# -# Replica can load the RDB it reads from the replication link directly from the -# socket, or store the RDB to a file and read that file after it was completely -# recived from the master. -# -# In many cases the disk is slower than the network, and storing and loading -# the RDB file may increase replication time (and even increase the master's -# Copy on Write memory and salve buffers). -# However, parsing the RDB file directly from the socket may mean that we have -# to flush the contents of the current database before the full rdb was -# received. For this reason we have the following options: -# -# "disabled" - Don't use diskless load (store the rdb file to the disk first) -# "on-empty-db" - Use diskless load only when it is completely safe. -# "swapdb" - Keep a copy of the current db contents in RAM while parsing -# the data directly from the socket. note that this requires -# sufficient memory, if you don't have it, you risk an OOM kill. -repl-diskless-load disabled - -# Replicas send PINGs to server in a predefined interval. It's possible to -# change this interval with the repl_ping_replica_period option. The default -# value is 10 seconds. -# -# repl-ping-replica-period 10 - -# The following option sets the replication timeout for: -# -# 1) Bulk transfer I/O during SYNC, from the point of view of replica. -# 2) Master timeout from the point of view of replicas (data, pings). -# 3) Replica timeout from the point of view of masters (REPLCONF ACK pings). -# -# It is important to make sure that this value is greater than the value -# specified for repl-ping-replica-period otherwise a timeout will be detected -# every time there is low traffic between the master and the replica. -# -# repl-timeout 60 - -# Disable TCP_NODELAY on the replica socket after SYNC? -# -# If you select "yes" Redis will use a smaller number of TCP packets and -# less bandwidth to send data to replicas. But this can add a delay for -# the data to appear on the replica side, up to 40 milliseconds with -# Linux kernels using a default configuration. -# -# If you select "no" the delay for data to appear on the replica side will -# be reduced but more bandwidth will be used for replication. -# -# By default we optimize for low latency, but in very high traffic conditions -# or when the master and replicas are many hops away, turning this to "yes" may -# be a good idea. -repl-disable-tcp-nodelay no - -# Set the replication backlog size. The backlog is a buffer that accumulates -# replica data when replicas are disconnected for some time, so that when a -# replica wants to reconnect again, often a full resync is not needed, but a -# partial resync is enough, just passing the portion of data the replica -# missed while disconnected. -# -# The bigger the replication backlog, the longer the time the replica can be -# disconnected and later be able to perform a partial resynchronization. -# -# The backlog is only allocated once there is at least a replica connected. -# -# repl-backlog-size 1mb - -# After a master has no longer connected replicas for some time, the backlog -# will be freed. The following option configures the amount of seconds that -# need to elapse, starting from the time the last replica disconnected, for -# the backlog buffer to be freed. -# -# Note that replicas never free the backlog for timeout, since they may be -# promoted to masters later, and should be able to correctly "partially -# resynchronize" with the replicas: hence they should always accumulate backlog. -# -# A value of 0 means to never release the backlog. -# -# repl-backlog-ttl 3600 - -# The replica priority is an integer number published by Redis in the INFO -# output. It is used by Redis Sentinel in order to select a replica to promote -# into a master if the master is no longer working correctly. -# -# A replica with a low priority number is considered better for promotion, so -# for instance if there are three replicas with priority 10, 100, 25 Sentinel -# will pick the one with priority 10, that is the lowest. -# -# However a special priority of 0 marks the replica as not able to perform the -# role of master, so a replica with priority of 0 will never be selected by -# Redis Sentinel for promotion. -# -# By default the priority is 100. -replica-priority 100 - -# It is possible for a master to stop accepting writes if there are less than -# N replicas connected, having a lag less or equal than M seconds. -# -# The N replicas need to be in "online" state. -# -# The lag in seconds, that must be <= the specified value, is calculated from -# the last ping received from the replica, that is usually sent every second. -# -# This option does not GUARANTEE that N replicas will accept the write, but -# will limit the window of exposure for lost writes in case not enough replicas -# are available, to the specified number of seconds. -# -# For example to require at least 3 replicas with a lag <= 10 seconds use: -# -# min-replicas-to-write 3 -# min-replicas-max-lag 10 -# -# Setting one or the other to 0 disables the feature. -# -# By default min-replicas-to-write is set to 0 (feature disabled) and -# min-replicas-max-lag is set to 10. - -# A Redis master is able to list the address and port of the attached -# replicas in different ways. For example the "INFO replication" section -# offers this information, which is used, among other tools, by -# Redis Sentinel in order to discover replica instances. -# Another place where this info is available is in the output of the -# "ROLE" command of a master. -# -# The listed IP and address normally reported by a replica is obtained -# in the following way: -# -# IP: The address is auto detected by checking the peer address -# of the socket used by the replica to connect with the master. -# -# Port: The port is communicated by the replica during the replication -# handshake, and is normally the port that the replica is using to -# listen for connections. -# -# However when port forwarding or Network Address Translation (NAT) is -# used, the replica may be actually reachable via different IP and port -# pairs. The following two options can be used by a replica in order to -# report to its master a specific set of IP and port, so that both INFO -# and ROLE will report those values. -# -# There is no need to use both the options if you need to override just -# the port or the IP address. -# -# replica-announce-ip 5.5.5.5 -# replica-announce-port 1234 - -############################### KEYS TRACKING ################################# - -# Redis implements server assisted support for client side caching of values. -# This is implemented using an invalidation table that remembers, using -# 16 millions of slots, what clients may have certain subsets of keys. In turn -# this is used in order to send invalidation messages to clients. Please -# to understand more about the feature check this page: -# -# https://redis.io/topics/client-side-caching -# -# When tracking is enabled for a client, all the read only queries are assumed -# to be cached: this will force Redis to store information in the invalidation -# table. When keys are modified, such information is flushed away, and -# invalidation messages are sent to the clients. However if the workload is -# heavily dominated by reads, Redis could use more and more memory in order -# to track the keys fetched by many clients. -# -# For this reason it is possible to configure a maximum fill value for the -# invalidation table. By default it is set to 1M of keys, and once this limit -# is reached, Redis will start to evict keys in the invalidation table -# even if they were not modified, just to reclaim memory: this will in turn -# force the clients to invalidate the cached values. Basically the table -# maximum size is a trade off between the memory you want to spend server -# side to track information about who cached what, and the ability of clients -# to retain cached objects in memory. -# -# If you set the value to 0, it means there are no limits, and Redis will -# retain as many keys as needed in the invalidation table. -# In the "stats" INFO section, you can find information about the number of -# keys in the invalidation table at every given moment. -# -# Note: when key tracking is used in broadcasting mode, no memory is used -# in the server side so this setting is useless. -# -# tracking-table-max-keys 1000000 - -################################## SECURITY ################################### - -# Warning: since Redis is pretty fast an outside user can try up to -# 1 million passwords per second against a modern box. This means that you -# should use very strong passwords, otherwise they will be very easy to break. -# Note that because the password is really a shared secret between the client -# and the server, and should not be memorized by any human, the password -# can be easily a long string from /dev/urandom or whatever, so by using a -# long and unguessable password no brute force attack will be possible. - -# Redis ACL users are defined in the following format: -# -# user ... acl rules ... -# -# For example: -# -# user worker +@list +@connection ~jobs:* on >ffa9203c493aa99 -# -# The special username "default" is used for new connections. If this user -# has the "nopass" rule, then new connections will be immediately authenticated -# as the "default" user without the need of any password provided via the -# AUTH command. Otherwise if the "default" user is not flagged with "nopass" -# the connections will start in not authenticated state, and will require -# AUTH (or the HELLO command AUTH option) in order to be authenticated and -# start to work. -# -# The ACL rules that describe what an user can do are the following: -# -# on Enable the user: it is possible to authenticate as this user. -# off Disable the user: it's no longer possible to authenticate -# with this user, however the already authenticated connections -# will still work. -# + Allow the execution of that command -# - Disallow the execution of that command -# +@ Allow the execution of all the commands in such category -# with valid categories are like @admin, @set, @sortedset, ... -# and so forth, see the full list in the server.c file where -# the Redis command table is described and defined. -# The special category @all means all the commands, but currently -# present in the server, and that will be loaded in the future -# via modules. -# +|subcommand Allow a specific subcommand of an otherwise -# disabled command. Note that this form is not -# allowed as negative like -DEBUG|SEGFAULT, but -# only additive starting with "+". -# allcommands Alias for +@all. Note that it implies the ability to execute -# all the future commands loaded via the modules system. -# nocommands Alias for -@all. -# ~ Add a pattern of keys that can be mentioned as part of -# commands. For instance ~* allows all the keys. The pattern -# is a glob-style pattern like the one of KEYS. -# It is possible to specify multiple patterns. -# allkeys Alias for ~* -# resetkeys Flush the list of allowed keys patterns. -# > Add this passowrd to the list of valid password for the user. -# For example >mypass will add "mypass" to the list. -# This directive clears the "nopass" flag (see later). -# < Remove this password from the list of valid passwords. -# nopass All the set passwords of the user are removed, and the user -# is flagged as requiring no password: it means that every -# password will work against this user. If this directive is -# used for the default user, every new connection will be -# immediately authenticated with the default user without -# any explicit AUTH command required. Note that the "resetpass" -# directive will clear this condition. -# resetpass Flush the list of allowed passwords. Moreover removes the -# "nopass" status. After "resetpass" the user has no associated -# passwords and there is no way to authenticate without adding -# some password (or setting it as "nopass" later). -# reset Performs the following actions: resetpass, resetkeys, off, -# -@all. The user returns to the same state it has immediately -# after its creation. -# -# ACL rules can be specified in any order: for instance you can start with -# passwords, then flags, or key patterns. However note that the additive -# and subtractive rules will CHANGE MEANING depending on the ordering. -# For instance see the following example: -# -# user alice on +@all -DEBUG ~* >somepassword -# -# This will allow "alice" to use all the commands with the exception of the -# DEBUG command, since +@all added all the commands to the set of the commands -# alice can use, and later DEBUG was removed. However if we invert the order -# of two ACL rules the result will be different: -# -# user alice on -DEBUG +@all ~* >somepassword -# -# Now DEBUG was removed when alice had yet no commands in the set of allowed -# commands, later all the commands are added, so the user will be able to -# execute everything. -# -# Basically ACL rules are processed left-to-right. -# -# For more information about ACL configuration please refer to -# the Redis web site at https://redis.io/topics/acl - -# ACL LOG -# -# The ACL Log tracks failed commands and authentication events associated -# with ACLs. The ACL Log is useful to troubleshoot failed commands blocked -# by ACLs. The ACL Log is stored in memory. You can reclaim memory with -# ACL LOG RESET. Define the maximum entry length of the ACL Log below. -acllog-max-len 128 - -# Using an external ACL file -# -# Instead of configuring users here in this file, it is possible to use -# a stand-alone file just listing users. The two methods cannot be mixed: -# if you configure users here and at the same time you activate the exteranl -# ACL file, the server will refuse to start. -# -# The format of the external ACL user file is exactly the same as the -# format that is used inside redis.conf to describe users. -# -# aclfile /etc/redis/users.acl - -# IMPORTANT NOTE: starting with Redis 6 "requirepass" is just a compatiblity -# layer on top of the new ACL system. The option effect will be just setting -# the password for the default user. Clients will still authenticate using -# AUTH as usually, or more explicitly with AUTH default -# if they follow the new protocol: both will work. -# -# requirepass foobared - -# Command renaming (DEPRECATED). -# -# ------------------------------------------------------------------------ -# WARNING: avoid using this option if possible. Instead use ACLs to remove -# commands from the default user, and put them only in some admin user you -# create for administrative purposes. -# ------------------------------------------------------------------------ -# -# It is possible to change the name of dangerous commands in a shared -# environment. For instance the CONFIG command may be renamed into something -# hard to guess so that it will still be available for internal-use tools -# but not available for general clients. -# -# Example: -# -# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52 -# -# It is also possible to completely kill a command by renaming it into -# an empty string: -# -# rename-command CONFIG "" -# -# Please note that changing the name of commands that are logged into the -# AOF file or transmitted to replicas may cause problems. - -################################### CLIENTS #################################### - -# Set the max number of connected clients at the same time. By default -# this limit is set to 10000 clients, however if the Redis server is not -# able to configure the process file limit to allow for the specified limit -# the max number of allowed clients is set to the current file limit -# minus 32 (as Redis reserves a few file descriptors for internal uses). -# -# Once the limit is reached Redis will close all the new connections sending -# an error 'max number of clients reached'. -# -# IMPORTANT: When Redis Cluster is used, the max number of connections is also -# shared with the cluster bus: every node in the cluster will use two -# connections, one incoming and another outgoing. It is important to size the -# limit accordingly in case of very large clusters. -# -# maxclients 10000 - -############################## MEMORY MANAGEMENT ################################ - -# Set a memory usage limit to the specified amount of bytes. -# When the memory limit is reached Redis will try to remove keys -# according to the eviction policy selected (see maxmemory-policy). -# -# If Redis can't remove keys according to the policy, or if the policy is -# set to 'noeviction', Redis will start to reply with errors to commands -# that would use more memory, like SET, LPUSH, and so on, and will continue -# to reply to read-only commands like GET. -# -# This option is usually useful when using Redis as an LRU or LFU cache, or to -# set a hard memory limit for an instance (using the 'noeviction' policy). -# -# WARNING: If you have replicas attached to an instance with maxmemory on, -# the size of the output buffers needed to feed the replicas are subtracted -# from the used memory count, so that network problems / resyncs will -# not trigger a loop where keys are evicted, and in turn the output -# buffer of replicas is full with DELs of keys evicted triggering the deletion -# of more keys, and so forth until the database is completely emptied. -# -# In short... if you have replicas attached it is suggested that you set a lower -# limit for maxmemory so that there is some free RAM on the system for replica -# output buffers (but this is not needed if the policy is 'noeviction'). -# -maxmemory {{ MAXMEM }}m - -# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory -# is reached. You can select one from the following behaviors: -# -# volatile-lru -> Evict using approximated LRU, only keys with an expire set. -# allkeys-lru -> Evict any key using approximated LRU. -# volatile-lfu -> Evict using approximated LFU, only keys with an expire set. -# allkeys-lfu -> Evict any key using approximated LFU. -# volatile-random -> Remove a random key having an expire set. -# allkeys-random -> Remove a random key, any key. -# volatile-ttl -> Remove the key with the nearest expire time (minor TTL) -# noeviction -> Don't evict anything, just return an error on write operations. -# -# LRU means Least Recently Used -# LFU means Least Frequently Used -# -# Both LRU, LFU and volatile-ttl are implemented using approximated -# randomized algorithms. -# -# Note: with any of the above policies, Redis will return an error on write -# operations, when there are no suitable keys for eviction. -# -# At the date of writing these commands are: set setnx setex append -# incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd -# sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby -# zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby -# getset mset msetnx exec sort -# -# The default is: -# -maxmemory-policy noeviction - -# LRU, LFU and minimal TTL algorithms are not precise algorithms but approximated -# algorithms (in order to save memory), so you can tune it for speed or -# accuracy. For default Redis will check five keys and pick the one that was -# used less recently, you can change the sample size using the following -# configuration directive. -# -# The default of 5 produces good enough results. 10 Approximates very closely -# true LRU but costs more CPU. 3 is faster but not very accurate. -# -# maxmemory-samples 5 - -# Starting from Redis 5, by default a replica will ignore its maxmemory setting -# (unless it is promoted to master after a failover or manually). It means -# that the eviction of keys will be just handled by the master, sending the -# DEL commands to the replica as keys evict in the master side. -# -# This behavior ensures that masters and replicas stay consistent, and is usually -# what you want, however if your replica is writable, or you want the replica -# to have a different memory setting, and you are sure all the writes performed -# to the replica are idempotent, then you may change this default (but be sure -# to understand what you are doing). -# -# Note that since the replica by default does not evict, it may end using more -# memory than the one set via maxmemory (there are certain buffers that may -# be larger on the replica, or data structures may sometimes take more memory -# and so forth). So make sure you monitor your replicas and make sure they -# have enough memory to never hit a real out-of-memory condition before the -# master hits the configured maxmemory setting. -# -# replica-ignore-maxmemory yes - -# Redis reclaims expired keys in two ways: upon access when those keys are -# found to be expired, and also in background, in what is called the -# "active expire key". The key space is slowly and interactively scanned -# looking for expired keys to reclaim, so that it is possible to free memory -# of keys that are expired and will never be accessed again in a short time. -# -# The default effort of the expire cycle will try to avoid having more than -# ten percent of expired keys still in memory, and will try to avoid consuming -# more than 25% of total memory and to add latency to the system. However -# it is possible to increase the expire "effort" that is normally set to -# "1", to a greater value, up to the value "10". At its maximum value the -# system will use more CPU, longer cycles (and technically may introduce -# more latency), and will tollerate less already expired keys still present -# in the system. It's a tradeoff betweeen memory, CPU and latecy. -# -# active-expire-effort 1 - -############################# LAZY FREEING #################################### - -# Redis has two primitives to delete keys. One is called DEL and is a blocking -# deletion of the object. It means that the server stops processing new commands -# in order to reclaim all the memory associated with an object in a synchronous -# way. If the key deleted is associated with a small object, the time needed -# in order to execute the DEL command is very small and comparable to most other -# O(1) or O(log_N) commands in Redis. However if the key is associated with an -# aggregated value containing millions of elements, the server can block for -# a long time (even seconds) in order to complete the operation. -# -# For the above reasons Redis also offers non blocking deletion primitives -# such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and -# FLUSHDB commands, in order to reclaim memory in background. Those commands -# are executed in constant time. Another thread will incrementally free the -# object in the background as fast as possible. -# -# DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled. -# It's up to the design of the application to understand when it is a good -# idea to use one or the other. However the Redis server sometimes has to -# delete keys or flush the whole database as a side effect of other operations. -# Specifically Redis deletes objects independently of a user call in the -# following scenarios: -# -# 1) On eviction, because of the maxmemory and maxmemory policy configurations, -# in order to make room for new data, without going over the specified -# memory limit. -# 2) Because of expire: when a key with an associated time to live (see the -# EXPIRE command) must be deleted from memory. -# 3) Because of a side effect of a command that stores data on a key that may -# already exist. For example the RENAME command may delete the old key -# content when it is replaced with another one. Similarly SUNIONSTORE -# or SORT with STORE option may delete existing keys. The SET command -# itself removes any old content of the specified key in order to replace -# it with the specified string. -# 4) During replication, when a replica performs a full resynchronization with -# its master, the content of the whole database is removed in order to -# load the RDB file just transferred. -# -# In all the above cases the default is to delete objects in a blocking way, -# like if DEL was called. However you can configure each case specifically -# in order to instead release memory in a non-blocking way like if UNLINK -# was called, using the following configuration directives. - -lazyfree-lazy-eviction no -lazyfree-lazy-expire no -lazyfree-lazy-server-del no -replica-lazy-flush no - -# It is also possible, for the case when to replace the user code DEL calls -# with UNLINK calls is not easy, to modify the default behavior of the DEL -# command to act exactly like UNLINK, using the following configuration -# directive: - -lazyfree-lazy-user-del no - -################################ THREADED I/O ################################# - -# Redis is mostly single threaded, however there are certain threaded -# operations such as UNLINK, slow I/O accesses and other things that are -# performed on side threads. -# -# Now it is also possible to handle Redis clients socket reads and writes -# in different I/O threads. Since especially writing is so slow, normally -# Redis users use pipelining in order to speedup the Redis performances per -# core, and spawn multiple instances in order to scale more. Using I/O -# threads it is possible to easily speedup two times Redis without resorting -# to pipelining nor sharding of the instance. -# -# By default threading is disabled, we suggest enabling it only in machines -# that have at least 4 or more cores, leaving at least one spare core. -# Using more than 8 threads is unlikely to help much. We also recommend using -# threaded I/O only if you actually have performance problems, with Redis -# instances being able to use a quite big percentage of CPU time, otherwise -# there is no point in using this feature. -# -# So for instance if you have a four cores boxes, try to use 2 or 3 I/O -# threads, if you have a 8 cores, try to use 6 threads. In order to -# enable I/O threads use the following configuration directive: -# -# io-threads 4 -# -# Setting io-threads to 1 will just use the main thread as usually. -# When I/O threads are enabled, we only use threads for writes, that is -# to thread the write(2) syscall and transfer the client buffers to the -# socket. However it is also possible to enable threading of reads and -# protocol parsing using the following configuration directive, by setting -# it to yes: -# -# io-threads-do-reads no -# -# Usually threading reads doesn't help much. -# -# NOTE 1: This configuration directive cannot be changed at runtime via -# CONFIG SET. Aso this feature currently does not work when SSL is -# enabled. -# -# NOTE 2: If you want to test the Redis speedup using redis-benchmark, make -# sure you also run the benchmark itself in threaded mode, using the -# --threads option to match the number of Redis theads, otherwise you'll not -# be able to notice the improvements. - -############################## APPEND ONLY MODE ############################### - -# By default Redis asynchronously dumps the dataset on disk. This mode is -# good enough in many applications, but an issue with the Redis process or -# a power outage may result into a few minutes of writes lost (depending on -# the configured save points). -# -# The Append Only File is an alternative persistence mode that provides -# much better durability. For instance using the default data fsync policy -# (see later in the config file) Redis can lose just one second of writes in a -# dramatic event like a server power outage, or a single write if something -# wrong with the Redis process itself happens, but the operating system is -# still running correctly. -# -# AOF and RDB persistence can be enabled at the same time without problems. -# If the AOF is enabled on startup Redis will load the AOF, that is the file -# with the better durability guarantees. -# -# Please check http://redis.io/topics/persistence for more information. - -appendonly no - -# The name of the append only file (default: "appendonly.aof") - -appendfilename "appendonly.aof" - -# The fsync() call tells the Operating System to actually write data on disk -# instead of waiting for more data in the output buffer. Some OS will really flush -# data on disk, some other OS will just try to do it ASAP. -# -# Redis supports three different modes: -# -# no: don't fsync, just let the OS flush the data when it wants. Faster. -# always: fsync after every write to the append only log. Slow, Safest. -# everysec: fsync only one time every second. Compromise. -# -# The default is "everysec", as that's usually the right compromise between -# speed and data safety. It's up to you to understand if you can relax this to -# "no" that will let the operating system flush the output buffer when -# it wants, for better performances (but if you can live with the idea of -# some data loss consider the default persistence mode that's snapshotting), -# or on the contrary, use "always" that's very slow but a bit safer than -# everysec. -# -# More details please check the following article: -# http://antirez.com/post/redis-persistence-demystified.html -# -# If unsure, use "everysec". - -# appendfsync always -appendfsync everysec -# appendfsync no - -# When the AOF fsync policy is set to always or everysec, and a background -# saving process (a background save or AOF log background rewriting) is -# performing a lot of I/O against the disk, in some Linux configurations -# Redis may block too long on the fsync() call. Note that there is no fix for -# this currently, as even performing fsync in a different thread will block -# our synchronous write(2) call. -# -# In order to mitigate this problem it's possible to use the following option -# that will prevent fsync() from being called in the main process while a -# BGSAVE or BGREWRITEAOF is in progress. -# -# This means that while another child is saving, the durability of Redis is -# the same as "appendfsync none". In practical terms, this means that it is -# possible to lose up to 30 seconds of log in the worst scenario (with the -# default Linux settings). -# -# If you have latency problems turn this to "yes". Otherwise leave it as -# "no" that is the safest pick from the point of view of durability. - -no-appendfsync-on-rewrite no - -# Automatic rewrite of the append only file. -# Redis is able to automatically rewrite the log file implicitly calling -# BGREWRITEAOF when the AOF log size grows by the specified percentage. -# -# This is how it works: Redis remembers the size of the AOF file after the -# latest rewrite (if no rewrite has happened since the restart, the size of -# the AOF at startup is used). -# -# This base size is compared to the current size. If the current size is -# bigger than the specified percentage, the rewrite is triggered. Also -# you need to specify a minimal size for the AOF file to be rewritten, this -# is useful to avoid rewriting the AOF file even if the percentage increase -# is reached but it is still pretty small. -# -# Specify a percentage of zero in order to disable the automatic AOF -# rewrite feature. - -auto-aof-rewrite-percentage 100 -auto-aof-rewrite-min-size 64mb - -# An AOF file may be found to be truncated at the end during the Redis -# startup process, when the AOF data gets loaded back into memory. -# This may happen when the system where Redis is running -# crashes, especially when an ext4 filesystem is mounted without the -# data=ordered option (however this can't happen when Redis itself -# crashes or aborts but the operating system still works correctly). -# -# Redis can either exit with an error when this happens, or load as much -# data as possible (the default now) and start if the AOF file is found -# to be truncated at the end. The following option controls this behavior. -# -# If aof-load-truncated is set to yes, a truncated AOF file is loaded and -# the Redis server starts emitting a log to inform the user of the event. -# Otherwise if the option is set to no, the server aborts with an error -# and refuses to start. When the option is set to no, the user requires -# to fix the AOF file using the "redis-check-aof" utility before to restart -# the server. -# -# Note that if the AOF file will be found to be corrupted in the middle -# the server will still exit with an error. This option only applies when -# Redis will try to read more data from the AOF file but not enough bytes -# will be found. -aof-load-truncated yes - -# When rewriting the AOF file, Redis is able to use an RDB preamble in the -# AOF file for faster rewrites and recoveries. When this option is turned -# on the rewritten AOF file is composed of two different stanzas: -# -# [RDB file][AOF tail] -# -# When loading Redis recognizes that the AOF file starts with the "REDIS" -# string and loads the prefixed RDB file, and continues loading the AOF -# tail. -aof-use-rdb-preamble yes - -################################ LUA SCRIPTING ############################### - -# Max execution time of a Lua script in milliseconds. -# -# If the maximum execution time is reached Redis will log that a script is -# still in execution after the maximum allowed time and will start to -# reply to queries with an error. -# -# When a long running script exceeds the maximum execution time only the -# SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be -# used to stop a script that did not yet called write commands. The second -# is the only way to shut down the server in the case a write command was -# already issued by the script but the user doesn't want to wait for the natural -# termination of the script. -# -# Set it to 0 or a negative value for unlimited execution without warnings. -lua-time-limit 5000 - -################################ REDIS CLUSTER ############################### - -# Normal Redis instances can't be part of a Redis Cluster; only nodes that are -# started as cluster nodes can. In order to start a Redis instance as a -# cluster node enable the cluster support uncommenting the following: -# -# cluster-enabled yes - -# Every cluster node has a cluster configuration file. This file is not -# intended to be edited by hand. It is created and updated by Redis nodes. -# Every Redis Cluster node requires a different cluster configuration file. -# Make sure that instances running in the same system do not have -# overlapping cluster configuration file names. -# -# cluster-config-file nodes-6379.conf - -# Cluster node timeout is the amount of milliseconds a node must be unreachable -# for it to be considered in failure state. -# Most other internal time limits are multiple of the node timeout. -# -# cluster-node-timeout 15000 - -# A replica of a failing master will avoid to start a failover if its data -# looks too old. -# -# There is no simple way for a replica to actually have an exact measure of -# its "data age", so the following two checks are performed: -# -# 1) If there are multiple replicas able to failover, they exchange messages -# in order to try to give an advantage to the replica with the best -# replication offset (more data from the master processed). -# Replicas will try to get their rank by offset, and apply to the start -# of the failover a delay proportional to their rank. -# -# 2) Every single replica computes the time of the last interaction with -# its master. This can be the last ping or command received (if the master -# is still in the "connected" state), or the time that elapsed since the -# disconnection with the master (if the replication link is currently down). -# If the last interaction is too old, the replica will not try to failover -# at all. -# -# The point "2" can be tuned by user. Specifically a replica will not perform -# the failover if, since the last interaction with the master, the time -# elapsed is greater than: -# -# (node-timeout * replica-validity-factor) + repl-ping-replica-period -# -# So for example if node-timeout is 30 seconds, and the replica-validity-factor -# is 10, and assuming a default repl-ping-replica-period of 10 seconds, the -# replica will not try to failover if it was not able to talk with the master -# for longer than 310 seconds. -# -# A large replica-validity-factor may allow replicas with too old data to failover -# a master, while a too small value may prevent the cluster from being able to -# elect a replica at all. -# -# For maximum availability, it is possible to set the replica-validity-factor -# to a value of 0, which means, that replicas will always try to failover the -# master regardless of the last time they interacted with the master. -# (However they'll always try to apply a delay proportional to their -# offset rank). -# -# Zero is the only value able to guarantee that when all the partitions heal -# the cluster will always be able to continue. -# -# cluster-replica-validity-factor 10 - -# Cluster replicas are able to migrate to orphaned masters, that are masters -# that are left without working replicas. This improves the cluster ability -# to resist to failures as otherwise an orphaned master can't be failed over -# in case of failure if it has no working replicas. -# -# Replicas migrate to orphaned masters only if there are still at least a -# given number of other working replicas for their old master. This number -# is the "migration barrier". A migration barrier of 1 means that a replica -# will migrate only if there is at least 1 other working replica for its master -# and so forth. It usually reflects the number of replicas you want for every -# master in your cluster. -# -# Default is 1 (replicas migrate only if their masters remain with at least -# one replica). To disable migration just set it to a very large value. -# A value of 0 can be set but is useful only for debugging and dangerous -# in production. -# -# cluster-migration-barrier 1 - -# By default Redis Cluster nodes stop accepting queries if they detect there -# is at least an hash slot uncovered (no available node is serving it). -# This way if the cluster is partially down (for example a range of hash slots -# are no longer covered) all the cluster becomes, eventually, unavailable. -# It automatically returns available as soon as all the slots are covered again. -# -# However sometimes you want the subset of the cluster which is working, -# to continue to accept queries for the part of the key space that is still -# covered. In order to do so, just set the cluster-require-full-coverage -# option to no. -# -# cluster-require-full-coverage yes - -# This option, when set to yes, prevents replicas from trying to failover its -# master during master failures. However the master can still perform a -# manual failover, if forced to do so. -# -# This is useful in different scenarios, especially in the case of multiple -# data center operations, where we want one side to never be promoted if not -# in the case of a total DC failure. -# -# cluster-replica-no-failover no - -# This option, when set to yes, allows nodes to serve read traffic while the -# the cluster is in a down state, as long as it believes it owns the slots. -# -# This is useful for two cases. The first case is for when an application -# doesn't require consistency of data during node failures or network partitions. -# One example of this is a cache, where as long as the node has the data it -# should be able to serve it. -# -# The second use case is for configurations that don't meet the recommended -# three shards but want to enable cluster mode and scale later. A -# master outage in a 1 or 2 shard configuration causes a read/write outage to the -# entire cluster without this option set, with it set there is only a write outage. -# Without a quorum of masters, slot ownership will not change automatically. -# -# cluster-allow-reads-when-down no - -# In order to setup your cluster make sure to read the documentation -# available at http://redis.io web site. - -########################## CLUSTER DOCKER/NAT support ######################## - -# In certain deployments, Redis Cluster nodes address discovery fails, because -# addresses are NAT-ted or because ports are forwarded (the typical case is -# Docker and other containers). -# -# In order to make Redis Cluster working in such environments, a static -# configuration where each node knows its public address is needed. The -# following two options are used for this scope, and are: -# -# * cluster-announce-ip -# * cluster-announce-port -# * cluster-announce-bus-port -# -# Each instruct the node about its address, client port, and cluster message -# bus port. The information is then published in the header of the bus packets -# so that other nodes will be able to correctly map the address of the node -# publishing the information. -# -# If the above options are not used, the normal Redis Cluster auto-detection -# will be used instead. -# -# Note that when remapped, the bus port may not be at the fixed offset of -# clients port + 10000, so you can specify any port and bus-port depending -# on how they get remapped. If the bus-port is not set, a fixed offset of -# 10000 will be used as usually. -# -# Example: -# -# cluster-announce-ip 10.1.1.5 -# cluster-announce-port 6379 -# cluster-announce-bus-port 6380 - -################################## SLOW LOG ################################### - -# The Redis Slow Log is a system to log queries that exceeded a specified -# execution time. The execution time does not include the I/O operations -# like talking with the client, sending the reply and so forth, -# but just the time needed to actually execute the command (this is the only -# stage of command execution where the thread is blocked and can not serve -# other requests in the meantime). -# -# You can configure the slow log with two parameters: one tells Redis -# what is the execution time, in microseconds, to exceed in order for the -# command to get logged, and the other parameter is the length of the -# slow log. When a new command is logged the oldest one is removed from the -# queue of logged commands. - -# The following time is expressed in microseconds, so 1000000 is equivalent -# to one second. Note that a negative number disables the slow log, while -# a value of zero forces the logging of every command. -slowlog-log-slower-than 10000 - -# There is no limit to this length. Just be aware that it will consume memory. -# You can reclaim memory used by the slow log with SLOWLOG RESET. -slowlog-max-len 128 - -################################ LATENCY MONITOR ############################## - -# The Redis latency monitoring subsystem samples different operations -# at runtime in order to collect data related to possible sources of -# latency of a Redis instance. -# -# Via the LATENCY command this information is available to the user that can -# print graphs and obtain reports. -# -# The system only logs operations that were performed in a time equal or -# greater than the amount of milliseconds specified via the -# latency-monitor-threshold configuration directive. When its value is set -# to zero, the latency monitor is turned off. -# -# By default latency monitoring is disabled since it is mostly not needed -# if you don't have latency issues, and collecting data has a performance -# impact, that while very small, can be measured under big load. Latency -# monitoring can easily be enabled at runtime using the command -# "CONFIG SET latency-monitor-threshold " if needed. -latency-monitor-threshold 0 - -############################# EVENT NOTIFICATION ############################## - -# Redis can notify Pub/Sub clients about events happening in the key space. -# This feature is documented at http://redis.io/topics/notifications -# -# For instance if keyspace events notification is enabled, and a client -# performs a DEL operation on key "foo" stored in the Database 0, two -# messages will be published via Pub/Sub: -# -# PUBLISH __keyspace@0__:foo del -# PUBLISH __keyevent@0__:del foo -# -# It is possible to select the events that Redis will notify among a set -# of classes. Every class is identified by a single character: -# -# K Keyspace events, published with __keyspace@__ prefix. -# E Keyevent events, published with __keyevent@__ prefix. -# g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... -# $ String commands -# l List commands -# s Set commands -# h Hash commands -# z Sorted set commands -# x Expired events (events generated every time a key expires) -# e Evicted events (events generated when a key is evicted for maxmemory) -# t Stream commands -# m Key-miss events (Note: It is not included in the 'A' class) -# A Alias for g$lshzxet, so that the "AKE" string means all the events -# (Except key-miss events which are excluded from 'A' due to their -# unique nature). -# -# The "notify-keyspace-events" takes as argument a string that is composed -# of zero or multiple characters. The empty string means that notifications -# are disabled. -# -# Example: to enable list and generic events, from the point of view of the -# event name, use: -# -# notify-keyspace-events Elg -# -# Example 2: to get the stream of the expired keys subscribing to channel -# name __keyevent@0__:expired use: -# -# notify-keyspace-events Ex -# -# By default all notifications are disabled because most users don't need -# this feature and the feature has some overhead. Note that if you don't -# specify at least one of K or E, no events will be delivered. -notify-keyspace-events "" - -############################### GOPHER SERVER ################################# - -# Redis contains an implementation of the Gopher protocol, as specified in -# the RFC 1436 (https://www.ietf.org/rfc/rfc1436.txt). -# -# The Gopher protocol was very popular in the late '90s. It is an alternative -# to the web, and the implementation both server and client side is so simple -# that the Redis server has just 100 lines of code in order to implement this -# support. -# -# What do you do with Gopher nowadays? Well Gopher never *really* died, and -# lately there is a movement in order for the Gopher more hierarchical content -# composed of just plain text documents to be resurrected. Some want a simpler -# internet, others believe that the mainstream internet became too much -# controlled, and it's cool to create an alternative space for people that -# want a bit of fresh air. -# -# Anyway for the 10nth birthday of the Redis, we gave it the Gopher protocol -# as a gift. -# -# --- HOW IT WORKS? --- -# -# The Redis Gopher support uses the inline protocol of Redis, and specifically -# two kind of inline requests that were anyway illegal: an empty request -# or any request that starts with "/" (there are no Redis commands starting -# with such a slash). Normal RESP2/RESP3 requests are completely out of the -# path of the Gopher protocol implementation and are served as usually as well. -# -# If you open a connection to Redis when Gopher is enabled and send it -# a string like "/foo", if there is a key named "/foo" it is served via the -# Gopher protocol. -# -# In order to create a real Gopher "hole" (the name of a Gopher site in Gopher -# talking), you likely need a script like the following: -# -# https://github.com/antirez/gopher2redis -# -# --- SECURITY WARNING --- -# -# If you plan to put Redis on the internet in a publicly accessible address -# to server Gopher pages MAKE SURE TO SET A PASSWORD to the instance. -# Once a password is set: -# -# 1. The Gopher server (when enabled, not by default) will still serve -# content via Gopher. -# 2. However other commands cannot be called before the client will -# authenticate. -# -# So use the 'requirepass' option to protect your instance. -# -# To enable Gopher support uncomment the following line and set -# the option from no (the default) to yes. -# -# gopher-enabled no - -############################### ADVANCED CONFIG ############################### - -# Hashes are encoded using a memory efficient data structure when they have a -# small number of entries, and the biggest entry does not exceed a given -# threshold. These thresholds can be configured using the following directives. -hash-max-ziplist-entries 512 -hash-max-ziplist-value 64 - -# Lists are also encoded in a special way to save a lot of space. -# The number of entries allowed per internal list node can be specified -# as a fixed maximum size or a maximum number of elements. -# For a fixed maximum size, use -5 through -1, meaning: -# -5: max size: 64 Kb <-- not recommended for normal workloads -# -4: max size: 32 Kb <-- not recommended -# -3: max size: 16 Kb <-- probably not recommended -# -2: max size: 8 Kb <-- good -# -1: max size: 4 Kb <-- good -# Positive numbers mean store up to _exactly_ that number of elements -# per list node. -# The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size), -# but if your use case is unique, adjust the settings as necessary. -list-max-ziplist-size -2 - -# Lists may also be compressed. -# Compress depth is the number of quicklist ziplist nodes from *each* side of -# the list to *exclude* from compression. The head and tail of the list -# are always uncompressed for fast push/pop operations. Settings are: -# 0: disable all list compression -# 1: depth 1 means "don't start compressing until after 1 node into the list, -# going from either the head or tail" -# So: [head]->node->node->...->node->[tail] -# [head], [tail] will always be uncompressed; inner nodes will compress. -# 2: [head]->[next]->node->node->...->node->[prev]->[tail] -# 2 here means: don't compress head or head->next or tail->prev or tail, -# but compress all nodes between them. -# 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail] -# etc. -list-compress-depth 0 - -# Sets have a special encoding in just one case: when a set is composed -# of just strings that happen to be integers in radix 10 in the range -# of 64 bit signed integers. -# The following configuration setting sets the limit in the size of the -# set in order to use this special memory saving encoding. -set-max-intset-entries 512 - -# Similarly to hashes and lists, sorted sets are also specially encoded in -# order to save a lot of space. This encoding is only used when the length and -# elements of a sorted set are below the following limits: -zset-max-ziplist-entries 128 -zset-max-ziplist-value 64 - -# HyperLogLog sparse representation bytes limit. The limit includes the -# 16 bytes header. When an HyperLogLog using the sparse representation crosses -# this limit, it is converted into the dense representation. -# -# A value greater than 16000 is totally useless, since at that point the -# dense representation is more memory efficient. -# -# The suggested value is ~ 3000 in order to have the benefits of -# the space efficient encoding without slowing down too much PFADD, -# which is O(N) with the sparse encoding. The value can be raised to -# ~ 10000 when CPU is not a concern, but space is, and the data set is -# composed of many HyperLogLogs with cardinality in the 0 - 15000 range. -hll-sparse-max-bytes 3000 - -# Streams macro node max size / items. The stream data structure is a radix -# tree of big nodes that encode multiple items inside. Using this configuration -# it is possible to configure how big a single node can be in bytes, and the -# maximum number of items it may contain before switching to a new node when -# appending new stream entries. If any of the following settings are set to -# zero, the limit is ignored, so for instance it is possible to set just a -# max entires limit by setting max-bytes to 0 and max-entries to the desired -# value. -stream-node-max-bytes 4096 -stream-node-max-entries 100 - -# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in -# order to help rehashing the main Redis hash table (the one mapping top-level -# keys to values). The hash table implementation Redis uses (see dict.c) -# performs a lazy rehashing: the more operation you run into a hash table -# that is rehashing, the more rehashing "steps" are performed, so if the -# server is idle the rehashing is never complete and some more memory is used -# by the hash table. -# -# The default is to use this millisecond 10 times every second in order to -# actively rehash the main dictionaries, freeing memory when possible. -# -# If unsure: -# use "activerehashing no" if you have hard latency requirements and it is -# not a good thing in your environment that Redis can reply from time to time -# to queries with 2 milliseconds delay. -# -# use "activerehashing yes" if you don't have such hard requirements but -# want to free memory asap when possible. -activerehashing yes - -# The client output buffer limits can be used to force disconnection of clients -# that are not reading data from the server fast enough for some reason (a -# common reason is that a Pub/Sub client can't consume messages as fast as the -# publisher can produce them). -# -# The limit can be set differently for the three different classes of clients: -# -# normal -> normal clients including MONITOR clients -# replica -> replica clients -# pubsub -> clients subscribed to at least one pubsub channel or pattern -# -# The syntax of every client-output-buffer-limit directive is the following: -# -# client-output-buffer-limit -# -# A client is immediately disconnected once the hard limit is reached, or if -# the soft limit is reached and remains reached for the specified number of -# seconds (continuously). -# So for instance if the hard limit is 32 megabytes and the soft limit is -# 16 megabytes / 10 seconds, the client will get disconnected immediately -# if the size of the output buffers reach 32 megabytes, but will also get -# disconnected if the client reaches 16 megabytes and continuously overcomes -# the limit for 10 seconds. -# -# By default normal clients are not limited because they don't receive data -# without asking (in a push way), but just after a request, so only -# asynchronous clients may create a scenario where data is requested faster -# than it can read. -# -# Instead there is a default limit for pubsub and replica clients, since -# subscribers and replicas receive data in a push fashion. -# -# Both the hard or the soft limit can be disabled by setting them to zero. -client-output-buffer-limit normal 0 0 0 -client-output-buffer-limit replica 256mb 64mb 60 -client-output-buffer-limit pubsub 32mb 8mb 60 - -# Client query buffers accumulate new commands. They are limited to a fixed -# amount by default in order to avoid that a protocol desynchronization (for -# instance due to a bug in the client) will lead to unbound memory usage in -# the query buffer. However you can configure it here if you have very special -# needs, such us huge multi/exec requests or alike. -# -# client-query-buffer-limit 1gb - -# In the Redis protocol, bulk requests, that are, elements representing single -# strings, are normally limited ot 512 mb. However you can change this limit -# here. -# -# proto-max-bulk-len 512mb - -# Redis calls an internal function to perform many background tasks, like -# closing connections of clients in timeout, purging expired keys that are -# never requested, and so forth. -# -# Not all tasks are performed with the same frequency, but Redis checks for -# tasks to perform according to the specified "hz" value. -# -# By default "hz" is set to 10. Raising the value will use more CPU when -# Redis is idle, but at the same time will make Redis more responsive when -# there are many keys expiring at the same time, and timeouts may be -# handled with more precision. -# -# The range is between 1 and 500, however a value over 100 is usually not -# a good idea. Most users should use the default of 10 and raise this up to -# 100 only in environments where very low latency is required. -hz 10 - -# Normally it is useful to have an HZ value which is proportional to the -# number of clients connected. This is useful in order, for instance, to -# avoid too many clients are processed for each background task invocation -# in order to avoid latency spikes. -# -# Since the default HZ value by default is conservatively set to 10, Redis -# offers, and enables by default, the ability to use an adaptive HZ value -# which will temporary raise when there are many connected clients. -# -# When dynamic HZ is enabled, the actual configured HZ will be used -# as a baseline, but multiples of the configured HZ value will be actually -# used as needed once more clients are connected. In this way an idle -# instance will use very little CPU time while a busy instance will be -# more responsive. -dynamic-hz yes - -# When a child rewrites the AOF file, if the following option is enabled -# the file will be fsync-ed every 32 MB of data generated. This is useful -# in order to commit the file to the disk more incrementally and avoid -# big latency spikes. -aof-rewrite-incremental-fsync yes - -# When redis saves RDB file, if the following option is enabled -# the file will be fsync-ed every 32 MB of data generated. This is useful -# in order to commit the file to the disk more incrementally and avoid -# big latency spikes. -rdb-save-incremental-fsync yes - -# Redis LFU eviction (see maxmemory setting) can be tuned. However it is a good -# idea to start with the default settings and only change them after investigating -# how to improve the performances and how the keys LFU change over time, which -# is possible to inspect via the OBJECT FREQ command. -# -# There are two tunable parameters in the Redis LFU implementation: the -# counter logarithm factor and the counter decay time. It is important to -# understand what the two parameters mean before changing them. -# -# The LFU counter is just 8 bits per key, it's maximum value is 255, so Redis -# uses a probabilistic increment with logarithmic behavior. Given the value -# of the old counter, when a key is accessed, the counter is incremented in -# this way: -# -# 1. A random number R between 0 and 1 is extracted. -# 2. A probability P is calculated as 1/(old_value*lfu_log_factor+1). -# 3. The counter is incremented only if R < P. -# -# The default lfu-log-factor is 10. This is a table of how the frequency -# counter changes with a different number of accesses with different -# logarithmic factors: -# -# +--------+------------+------------+------------+------------+------------+ -# | factor | 100 hits | 1000 hits | 100K hits | 1M hits | 10M hits | -# +--------+------------+------------+------------+------------+------------+ -# | 0 | 104 | 255 | 255 | 255 | 255 | -# +--------+------------+------------+------------+------------+------------+ -# | 1 | 18 | 49 | 255 | 255 | 255 | -# +--------+------------+------------+------------+------------+------------+ -# | 10 | 10 | 18 | 142 | 255 | 255 | -# +--------+------------+------------+------------+------------+------------+ -# | 100 | 8 | 11 | 49 | 143 | 255 | -# +--------+------------+------------+------------+------------+------------+ -# -# NOTE: The above table was obtained by running the following commands: -# -# redis-benchmark -n 1000000 incr foo -# redis-cli object freq foo -# -# NOTE 2: The counter initial value is 5 in order to give new objects a chance -# to accumulate hits. -# -# The counter decay time is the time, in minutes, that must elapse in order -# for the key counter to be divided by two (or decremented if it has a value -# less <= 10). -# -# The default value for the lfu-decay-time is 1. A Special value of 0 means to -# decay the counter every time it happens to be scanned. -# -# lfu-log-factor 10 -# lfu-decay-time 1 - -########################### ACTIVE DEFRAGMENTATION ####################### -# -# What is active defragmentation? -# ------------------------------- -# -# Active (online) defragmentation allows a Redis server to compact the -# spaces left between small allocations and deallocations of data in memory, -# thus allowing to reclaim back memory. -# -# Fragmentation is a natural process that happens with every allocator (but -# less so with Jemalloc, fortunately) and certain workloads. Normally a server -# restart is needed in order to lower the fragmentation, or at least to flush -# away all the data and create it again. However thanks to this feature -# implemented by Oran Agra for Redis 4.0 this process can happen at runtime -# in an "hot" way, while the server is running. -# -# Basically when the fragmentation is over a certain level (see the -# configuration options below) Redis will start to create new copies of the -# values in contiguous memory regions by exploiting certain specific Jemalloc -# features (in order to understand if an allocation is causing fragmentation -# and to allocate it in a better place), and at the same time, will release the -# old copies of the data. This process, repeated incrementally for all the keys -# will cause the fragmentation to drop back to normal values. -# -# Important things to understand: -# -# 1. This feature is disabled by default, and only works if you compiled Redis -# to use the copy of Jemalloc we ship with the source code of Redis. -# This is the default with Linux builds. -# -# 2. You never need to enable this feature if you don't have fragmentation -# issues. -# -# 3. Once you experience fragmentation, you can enable this feature when -# needed with the command "CONFIG SET activedefrag yes". -# -# The configuration parameters are able to fine tune the behavior of the -# defragmentation process. If you are not sure about what they mean it is -# a good idea to leave the defaults untouched. - -# Enabled active defragmentation -# activedefrag no - -# Minimum amount of fragmentation waste to start active defrag -# active-defrag-ignore-bytes 100mb - -# Minimum percentage of fragmentation to start active defrag -# active-defrag-threshold-lower 10 - -# Maximum percentage of fragmentation at which we use maximum effort -# active-defrag-threshold-upper 100 - -# Minimal effort for defrag in CPU percentage, to be used when the lower -# threshold is reached -# active-defrag-cycle-min 1 - -# Maximal effort for defrag in CPU percentage, to be used when the upper -# threshold is reached -# active-defrag-cycle-max 25 - -# Maximum number of set/hash/zset/list fields that will be processed from -# the main dictionary scan -# active-defrag-max-scan-fields 1000 - -# Jemalloc background thread for purging will be enabled by default -jemalloc-bg-thread yes - -# It is possible to pin different threads and processes of Redis to specific -# CPUs in your system, in order to maximize the performances of the server. -# This is useful both in order to pin different Redis threads in different -# CPUs, but also in order to make sure that multiple Redis instances running -# in the same host will be pinned to different CPUs. -# -# Normally you can do this using the "taskset" command, however it is also -# possible to this via Redis configuration directly, both in Linux and FreeBSD. -# -# You can pin the server/IO threads, bio threads, aof rewrite child process, and -# the bgsave child process. The syntax to specify the cpu list is the same as -# the taskset command: -# -# Set redis server/io threads to cpu affinity 0,2,4,6: -# server_cpulist 0-7:2 -# -# Set bio threads to cpu affinity 1,3: -# bio_cpulist 1,3 -# -# Set aof rewrite child process to cpu affinity 8,9,10,11: -# aof_rewrite_cpulist 8-11 -# -# Set bgsave child process to cpu affinity 1,10,11 -# bgsave_cpulist 1,10-11 diff --git a/salt/redis/etc/redis.conf.jinja b/salt/redis/etc/redis.conf.jinja new file mode 100644 index 000000000..3fa6e4388 --- /dev/null +++ b/salt/redis/etc/redis.conf.jinja @@ -0,0 +1,11 @@ +{% import_yaml 'redis/defaults.yaml' as redis %} + +{%- for k, v in redis.redis.config.items() %} +{%- if v is iterable and v is not string %} +{%- for v1, v2 in v.items() %} +{{k}} {{v1}} {{v2}} +{%- endfor %} +{%- else %} +{{ k }} {{ v }} +{%- endif %} +{%- endfor %} diff --git a/salt/redis/init.sls b/salt/redis/init.sls index 1a353a1f0..398240761 100644 --- a/salt/redis/init.sls +++ b/salt/redis/init.sls @@ -36,7 +36,7 @@ redislogdir: redisconf: file.managed: - name: /opt/so/conf/redis/etc/redis.conf - - source: salt://redis/etc/redis.conf + - source: salt://redis/etc/redis.conf.jinja - user: 939 - group: 939 - template: jinja From 3c00d6787995d64b37f38c9418f9d8c58f4e24d6 Mon Sep 17 00:00:00 2001 From: m0duspwnens Date: Mon, 19 Dec 2022 10:24:28 -0500 Subject: [PATCH 04/31] fix redis defaults --- salt/redis/defaults.yaml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/salt/redis/defaults.yaml b/salt/redis/defaults.yaml index 26be06229..aacb7dbba 100644 --- a/salt/redis/defaults.yaml +++ b/salt/redis/defaults.yaml @@ -80,11 +80,12 @@ redis: stream-node-max-bytes: 4096 stream-node-max-entries: 100 activerehashing: yes - client-output-buffer-limit: 'normal 0 0 0' - client-output-buffer-limit: 'replica 256mb 64mb 60' - client-output-buffer-limit: 'pubsub 32mb 8mb 60' + client-output-buffer-limit: + normal: '0 0 0' + replica: '256mb 64mb 60' + pubsub: '32mb 8mb 60' hz: 10 dynamic-hz: 'yes' aof-rewrite-incremental-fsync: 'yes' rdb-save-incremental-fsync: 'yes' - jemalloc-bg-thread: 'yes' \ No newline at end of file + jemalloc-bg-thread: 'yes' From 42157ff2b10c967c8d1881ca8acadc4126e1f3bb Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Mon, 19 Dec 2022 10:36:35 -0500 Subject: [PATCH 05/31] fix defaults for redis --- salt/redis/defaults.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salt/redis/defaults.yaml b/salt/redis/defaults.yaml index aacb7dbba..e93512b22 100644 --- a/salt/redis/defaults.yaml +++ b/salt/redis/defaults.yaml @@ -12,7 +12,7 @@ redis: timeout: 0 tcp-keepalive: 300 tls-replication: 'no' - tls-cluster: no + tls-cluster: 'no' tls-protocols: '"TLSv1.2 TLSv1.3"' tls-ciphers: 'DEFAULT:!MEDIUM' tls-ciphersuites: 'TLS_CHACHA20_POLY1305_SHA256' From d9343d845003f10da682cae183fa09b509ee1919 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Mon, 19 Dec 2022 10:38:11 -0500 Subject: [PATCH 06/31] fix defaults for redis --- salt/redis/defaults.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salt/redis/defaults.yaml b/salt/redis/defaults.yaml index e93512b22..9b5801ba7 100644 --- a/salt/redis/defaults.yaml +++ b/salt/redis/defaults.yaml @@ -79,7 +79,7 @@ redis: hll-sparse-max-bytes: 3000 stream-node-max-bytes: 4096 stream-node-max-entries: 100 - activerehashing: yes + activerehashing: 'yes' client-output-buffer-limit: normal: '0 0 0' replica: '256mb 64mb 60' From 56f326d123a2aad362a5fe9ce4f64ffe4497be1e Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Mon, 19 Dec 2022 10:46:39 -0500 Subject: [PATCH 07/31] fix defaults for influx --- salt/influxdb/defaults.yaml | 113 ++++++++++++++++++------------------ 1 file changed, 56 insertions(+), 57 deletions(-) diff --git a/salt/influxdb/defaults.yaml b/salt/influxdb/defaults.yaml index d32c471fd..32d73151c 100644 --- a/salt/influxdb/defaults.yaml +++ b/salt/influxdb/defaults.yaml @@ -1,17 +1,17 @@ influxdb: config: meta: - dir: '/var/lib/influxdb/meta' - retention-autocreate: true - logging-enabled: true + dir: '"/var/lib/influxdb/meta"' + retention-autocreate: 'true' + logging-enabled: 'true' data: - dir: '/var/lib/influxdb/data' - wal-dir: /var/lib/influxdb/wal' + dir: '"/var/lib/influxdb/data"' + wal-dir: '"/var/lib/influxdb/wal"' wal-fsync-delay: '0s' index-version: 'inmem' - race-logging-enabled: false - query-log-enabled: true - validate-keys: false + race-logging-enabled: 'false' + query-log-enabled: 'true' + validate-keys: 'false' cache-max-memory-size: '1g' cache-snapshot-memory-size: '25m' cache-snapshot-write-cold-duration: '10m' @@ -22,7 +22,7 @@ influxdb: max-index-log-file-size: '1m' max-series-per-database: 1000000 max-values-per-tag: 100000 - tsm-use-madv-willneed: false + tsm-use-madv-willneed: 'false' coordinator: write-timeout: '10s' max-concurrent-queries: 0 @@ -32,37 +32,37 @@ influxdb: max-select-series: 0 max-select-buckets: 0 retention: - enabled: true + enabled: 'true' check-interval: '30m' shard-precreation: - enabled: true + enabled: 'true' check-interval: '10m' advance-period: '30m' monitor: - store-enabled: true + store-enabled: 'true' store-database: '_internal' store-interval: '10s' http: - enabled: true - flux-enabled: true + enabled: 'true' + flux-enabled: 'true' bind-address: ':8086' - auth-enabled: false + auth-enabled: 'false' realm: 'InfluxDB' - log-enabled: false - suppress-write-log: false + log-enabled: 'false' + suppress-write-log: 'false' access-log-path: '' - access-log-status-filters: [] - write-tracing: false - pprof-enabled: true - debug-pprof-enabled: false - https-enabled: true - https-certificate: '/etc/ssl/influxdb.crt' - https-private-key: '/etc/ssl/influxdb.key' + access-log-status-filters: '[]'' + write-tracing: 'false' + pprof-enabled: 'true' + debug-pprof-enabled: 'false' + https-enabled: 'true' + https-certificate: '"/etc/ssl/influxdb.crt"' + https-private-key: '"/etc/ssl/influxdb.key"' shared-secret: '' max-row-limit: 0 max-connection-limit: 0 - unix-socket-enabled: false - bind-socket: '/var/run/influxdb.sock' + unix-socket-enabled: 'false' + bind-socket: '"/var/run/influxdb.sock"' max-body-size: 25000000 max-concurrent-write-limit: 0 max-enqueued-write-limit: 0 @@ -70,16 +70,16 @@ influxdb: logging: format: 'auto' level: 'info' - suppress-logo: false + suppress-logo: 'false' subscriber: - enabled: true + enabled: 'true' http-timeout: '30s' - insecure-skip-verify: false + insecure-skip-verify: 'false' ca-certs: '' write-concurrency: 40 write-buffer-size: 1000 graphite: - enabled: false + enabled: 'false' database: 'graphite' retention-policy: '' bind-address: ':2003' @@ -93,13 +93,13 @@ influxdb: tags: '' templates: '' colectd: - enabled: false + enabled: 'false' bind-address: ':25826' database: 'collectd' retention-policy: '' - typesdb: '/usr/local/share/collectd' + typesdb: '"/usr/local/share/collectd"' security-level: 'none' - auth-file: '/etc/collectd/auth_file' + auth-file: '"/etc/collectd/auth_file"' batch-size: 5000 bath-pending: 10 read-buffer: 0 @@ -110,14 +110,14 @@ influxdb: database: 'opentsdb' retention-policy: '' consistency-level: 'one' - tls-enabled: false + tls-enabled: 'false' certificate: '/etc/ssl/influxdb.pem' - log-point-errors: true + log-point-errors: 'true' batch-size: 1000 batch-pending: 5 bath-timeout: '1s' udp: - enabled: false + enabled: 'false' bind-address: ':8089' database: 'udp' retention-policy: '' @@ -127,32 +127,31 @@ influxdb: batch-timeout: '1s' read-buffer: 0 continuous_queries: - enabled: true - log-enabled: true - query-stats-enabled: false + enabled: 'true' + log-enabled: 'true' + query-stats-enabled: 'false' run-interval: '1s' tls: ciphers: - - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - - TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305 - - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305 - - TLS_RSA_WITH_AES_128_CBC_SHA - - TLS_RSA_WITH_AES_128_CBC_SHA256 - - TLS_RSA_WITH_AES_128_GCM_SHA256 - - TLS_RSA_WITH_AES_256_CBC_SHA - - TLS_RSA_WITH_AES_256_GCM_SHA384 + - '"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA"' + - '"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256"' + - '"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256"' + - '"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA"' + - '"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"' + - '"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305"' + - '"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"' + - '"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"' + - '"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"' + - '"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"' + - '"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"' + - '"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305"' + - '"TLS_RSA_WITH_AES_128_CBC_SHA"' + - '"TLS_RSA_WITH_AES_128_CBC_SHA256"' + - '"TLS_RSA_WITH_AES_128_GCM_SHA256"' + - '"TLS_RSA_WITH_AES_256_CBC_SHA"' + - '"TLS_RSA_WITH_AES_256_GCM_SHA384"' min-version: 'tls1.2' max-version: 'tls1.2' - retention_policies: so_short_term: default: True From 61bfeb82d9ea7b26814ba5f74143eafb0d254cb3 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Mon, 19 Dec 2022 11:01:19 -0500 Subject: [PATCH 08/31] fix defaults for influx --- salt/influxdb/defaults.yaml | 113 ++++++++++++++++++------------------ 1 file changed, 57 insertions(+), 56 deletions(-) diff --git a/salt/influxdb/defaults.yaml b/salt/influxdb/defaults.yaml index 32d73151c..5390a62df 100644 --- a/salt/influxdb/defaults.yaml +++ b/salt/influxdb/defaults.yaml @@ -7,58 +7,58 @@ influxdb: data: dir: '"/var/lib/influxdb/data"' wal-dir: '"/var/lib/influxdb/wal"' - wal-fsync-delay: '0s' - index-version: 'inmem' + wal-fsync-delay: '"0s"' + index-version: '"inmem"' race-logging-enabled: 'false' query-log-enabled: 'true' validate-keys: 'false' - cache-max-memory-size: '1g' - cache-snapshot-memory-size: '25m' - cache-snapshot-write-cold-duration: '10m' - compact-full-write-cold-duration: '4h' + cache-max-memory-size: '"1g"' + cache-snapshot-memory-size: '"25m"' + cache-snapshot-write-cold-duration: '"10m"' + compact-full-write-cold-duration: '"4h"' max-concurrent-compactions: 0 - compact-throughput: '48m' - compact-throughput-burst: '48m' - max-index-log-file-size: '1m' + compact-throughput: '"48m"' + compact-throughput-burst: '"48m"' + max-index-log-file-size: '"1m"' max-series-per-database: 1000000 max-values-per-tag: 100000 tsm-use-madv-willneed: 'false' coordinator: - write-timeout: '10s' + write-timeout: '"10s"' max-concurrent-queries: 0 - query-timeout: '0s' - log-queries-after: '0s' + query-timeout: '"0s"' + log-queries-after: '"0s"' max-select-point: 0 max-select-series: 0 max-select-buckets: 0 retention: enabled: 'true' - check-interval: '30m' + check-interval: '"30m"' shard-precreation: enabled: 'true' - check-interval: '10m' - advance-period: '30m' + check-interval: '"10m"' + advance-period: '"30m"' monitor: - store-enabled: 'true' - store-database: '_internal' - store-interval: '10s' + store-enabled: '"true"' + store-database: '"_internal"' + store-interval: '"10s"' http: enabled: 'true' flux-enabled: 'true' - bind-address: ':8086' + bind-address: '":8086"' auth-enabled: 'false' - realm: 'InfluxDB' + realm: '"InfluxDB"' log-enabled: 'false' suppress-write-log: 'false' - access-log-path: '' - access-log-status-filters: '[]'' + access-log-path: '""' + access-log-status-filters: '[]' write-tracing: 'false' pprof-enabled: 'true' debug-pprof-enabled: 'false' https-enabled: 'true' https-certificate: '"/etc/ssl/influxdb.crt"' https-private-key: '"/etc/ssl/influxdb.key"' - shared-secret: '' + shared-secret: '""' max-row-limit: 0 max-connection-limit: 0 unix-socket-enabled: 'false' @@ -68,69 +68,70 @@ influxdb: max-enqueued-write-limit: 0 enqueued-write-timeout: 0 logging: - format: 'auto' - level: 'info' + format: '"auto"' + level: '"info"' suppress-logo: 'false' subscriber: enabled: 'true' - http-timeout: '30s' + http-timeout: '"30s"' insecure-skip-verify: 'false' - ca-certs: '' + ca-certs: '""' write-concurrency: 40 write-buffer-size: 1000 graphite: enabled: 'false' - database: 'graphite' - retention-policy: '' - bind-address: ':2003' - protocol: 'tcp' - consistency-level: 'one' + database: '"graphite"' + retention-policy: '""' + bind-address: '":2003"' + protocol: '"tcp"' + consistency-level: '"one"' batch-size: 5000 batch-pending: 10 - batch-timeout: '1s' + batch-timeout: '"1s"' udp-read-buffer: 0 - separator: '.' - tags: '' - templates: '' - colectd: + separator: '"."' + tags: '[]' + templates: '[]' + collectd: enabled: 'false' - bind-address: ':25826' - database: 'collectd' - retention-policy: '' + bind-address: '":25826"' + database: '"collectd"' + retention-policy: '""' typesdb: '"/usr/local/share/collectd"' - security-level: 'none' + security-level: '"none"' auth-file: '"/etc/collectd/auth_file"' batch-size: 5000 bath-pending: 10 + batch-timeout: '"10s"' read-buffer: 0 - parse-multivalue-plugin: 'split' + parse-multivalue-plugin: '"split"' opentsdb: enabled: false - bind-address: ':4242' - database: 'opentsdb' - retention-policy: '' - consistency-level: 'one' + bind-address: '":4242"' + database: '"opentsdb"' + retention-policy: '""' + consistency-level: '"one"' tls-enabled: 'false' - certificate: '/etc/ssl/influxdb.pem' + certificate: '"/etc/ssl/influxdb.pem"' log-point-errors: 'true' batch-size: 1000 batch-pending: 5 - bath-timeout: '1s' + bath-timeout: '"1s"' udp: enabled: 'false' - bind-address: ':8089' - database: 'udp' - retention-policy: '' - precision: '' + bind-address: '":8089"' + database: '"udp"' + retention-policy: '""' + precision: '""' batch-size: 5000 batch-pending: 10 - batch-timeout: '1s' + batch-timeout: '"1s"' read-buffer: 0 continuous_queries: enabled: 'true' log-enabled: 'true' query-stats-enabled: 'false' - run-interval: '1s' + run-interval: '"1s"' tls: ciphers: - '"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA"' @@ -150,8 +151,8 @@ influxdb: - '"TLS_RSA_WITH_AES_128_GCM_SHA256"' - '"TLS_RSA_WITH_AES_256_CBC_SHA"' - '"TLS_RSA_WITH_AES_256_GCM_SHA384"' - min-version: 'tls1.2' - max-version: 'tls1.2' + min-version: '"tls1.2"' + max-version: '"tls1.2"' retention_policies: so_short_term: default: True From fde65db021ce089afc7accc0d7fa9aa9a7edaf13 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Mon, 19 Dec 2022 12:03:00 -0500 Subject: [PATCH 09/31] Add influx pillars during setup --- setup/so-functions | 10 +++++++--- setup/so-variables | 8 +++++++- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/setup/so-functions b/setup/so-functions index c76cb6ba5..db7c21997 100755 --- a/setup/so-functions +++ b/setup/so-functions @@ -1494,9 +1494,13 @@ docker_pillar() { redis_pillar() { title "Create the redis pillar file" touch $adv_redis_pillar_file - printf '%s\n'\ - "redis_settings:"\ - " redis_maxmemory: 812" > "$redis_pillar_file" + touch $redis_pillar_file +} + +influxdb_pillar() { + title "Create the influxdb pillar file" + touch $adv_influxdb_pillar_file + touch $influxdb_pillar_file } mark_version() { diff --git a/setup/so-variables b/setup/so-variables index 8833154eb..9cf279f3d 100644 --- a/setup/so-variables +++ b/setup/so-variables @@ -84,7 +84,7 @@ mkdir -p $local_salt_dir/salt/firewall/hostgroups mkdir -p $local_salt_dir/salt/firewall/portgroups mkdir -p $local_salt_dir/salt/firewall/ports -for THEDIR in bpf pcap elasticsearch ntp firewall redis backup strelka sensoroni curator soc soctopus docker zeek suricata nginx telegraf filebeat logstash soc manager kratos idstools idh elastalert +for THEDIR in bpf pcap elasticsearch ntp firewall redis backup influxdb strelka sensoroni curator soc soctopus docker zeek suricata nginx telegraf filebeat logstash soc manager kratos idstools idh elastalert do mkdir -p $local_salt_dir/pillar/$THEDIR touch $local_salt_dir/pillar/$THEDIR/adv_$THEDIR.sls @@ -210,3 +210,9 @@ export telegraf_pillar_file adv_telegraf_pillar_file="$local_salt_dir/pillar/telegraf/adv_telegraf.sls" export adv_telegraf_pillar_file + +influxdb_pillar_file="$local_salt_dir/pillar/influxdb/soc_influxdb.sls" +export influxdb_pillar_file + +adv_influxdb_pillar_file="$local_salt_dir/pillar/influxdb/adv_influxdb.sls" +export adv_influxdb_pillar_file \ No newline at end of file From 149038d08ea1ef6fafc8a0a341eef603ef1e0f61 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Mon, 19 Dec 2022 12:06:45 -0500 Subject: [PATCH 10/31] pillar tops --- pillar/top.sls | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pillar/top.sls b/pillar/top.sls index 550433f21..bdcae9b79 100644 --- a/pillar/top.sls +++ b/pillar/top.sls @@ -45,6 +45,10 @@ base: - manager.adv_manager - soc.soc_soc - soc.adv_soc + - redis.soc_telegraf + - redis.adv_telegraf + - influxdb.soc_telegraf + - influxdb.adv_telegraf - backup.soc_backup - backup.adv_backup - minions.{{ grains.id }} From c20f8c230b0921648b8e609a28e5e896d4fde714 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Mon, 19 Dec 2022 14:02:01 -0500 Subject: [PATCH 11/31] Initial SOC file for influx --- salt/influxdb/soc_influxdb.yaml | 336 ++++++++++++++++++++++++++++++++ 1 file changed, 336 insertions(+) diff --git a/salt/influxdb/soc_influxdb.yaml b/salt/influxdb/soc_influxdb.yaml index 8bcd4b97a..7b11757b1 100644 --- a/salt/influxdb/soc_influxdb.yaml +++ b/salt/influxdb/soc_influxdb.yaml @@ -1,4 +1,340 @@ influxdb: + config: + meta: + logging-enabled: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + data: + wal-fsync-delay: + description: The amount of time that a write will wait before fsyncing. + global: True + helpLink: influxdb.html + index-version: + description: The type of shard index to use for new shards. + global: True + helpLink: influxdb.html + trace-logging-enabled: + description: Trace logging provides more verbose output around the tsm engine. + global: True + advanced: True + helpLink: influxdb.html + query-log-enabled: + description: Whether queries should be logged before execution. + global: True + helpLink: influxdb.html + validate-keys: + description: Validates incoming writes to ensure keys only have valid unicode characters. + global: True + advanced: True + helpLink: influxdb.html + cache-max-memory-size: + description: The maximum size a shard's cache can reach before it starts rejecting writes. + global: True + helpLink: influxdb.html + cache-snapshot-memory-size: + description: The size at which the engine will snapshot the cache and write it to a TSM file, freeing up memory. + global: True + advanced: True + helpLink: influxdb.html + cache-snapshot-write-cold-duration: + description: The length of time at which the engine will snapshot the cache and write it to a new TSM file if the shard hasn't received writes or deletes. + global: True + advanced: True + helpLink: influxdb.html + compact-full-write-cold-duration: + description: The duration at which the engine will compact all TSM files in a shard if it hasn't received a write or delete. + global: True + advanced: True + helpLink: influxdb.html + max-concurrent-compactions: + description: The maximum number of concurrent full and level compactions that can run at one time. + global: True + helpLink: influxdb.html + compact-throughput: + description: The rate limit in bytes per second that we will allow TSM compactions to write to disk. + global: True + advanced: True + helpLink: influxdb.html + compact-throughput-burst: + description: The rate limit in bytes per second that we will allow TSM compactions to write to disk. + global: True + advanced: True + helpLink: influxdb.html + max-index-log-file-size: + description: The threshold, in bytes, when an index write-ahead log file will compact into an index file. + global: True + advanced: True + helpLink: influxdb.html + max-series-per-database: + description: The maximum series allowed per database before writes are dropped. + global: True + advanced: True + helpLink: influxdb.html + max-values-per-tag: + description: The maximum number of tag values per tag that are allowed before writes are dropped. + global: True + advanced: True + helpLink: influxdb.html + tsm-use-madv-willneed: + description: If true, then the mmap advise value MADV_WILLNEED will be provided to the kernel with respect to TSM files. + global: True + advanced: True + helpLink: influxdb.html + coordinator: + write-timeout: + description: The default time a write request will wait until a "timeout" error is returned to the caller. + global: True + helpLink: influxdb.html + max-concurrent-queries: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + query-timeout: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + log-queries-after: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + max-select-point: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + max-select-series: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + max-select-buckets: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + retention: + enabled: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + check-interval: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + shard-precreation: + enabled: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + check-interval: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + advance-period: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + monitor: + store-enabled: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + store-database: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + store-interval: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + http: + enabled: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + flux-enabled: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + bind-address: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + auth-enabled: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + realm: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + log-enabled: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + suppress-write-log: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + access-log-path: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + access-log-status-filters: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + write-tracing: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + pprof-enabled: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + debug-pprof-enabled: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + https-enabled: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + https-certificate: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + https-private-key: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + shared-secret: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + max-row-limit: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + max-connection-limit: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + unix-socket-enabled: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + bind-socket: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + max-body-size: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + max-concurrent-write-limit: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + max-enqueued-write-limit: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + enqueued-write-timeout: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + logging: + format: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + level: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + suppress-logo: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + subscriber: + enabled: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + http-timeout: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + insecure-skip-verify: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + ca-certs: + description: Enable InfluxDB meta server logging. + global: True + advanced: True + helpLink: influxdb.html + write-concurrency: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + write-buffer-size: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + continuous_queries: + enabled: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + log-enabled: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + query-stats-enabled: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + run-interval: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + tls: + ciphers: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + min-version: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html + max-version: + description: Enable InfluxDB meta server logging. + global: True + helpLink: influxdb.html retention_policies: so_short_term: duration: From e5d38255fa97b62eca6c99b9985a961801872b99 Mon Sep 17 00:00:00 2001 From: m0duspwnens Date: Mon, 19 Dec 2022 14:40:37 -0500 Subject: [PATCH 12/31] jinja conf for influxdb --- salt/influxdb/defaults.yaml | 220 +++++----- salt/influxdb/etc/influxdb.conf | 579 -------------------------- salt/influxdb/etc/influxdb.conf.jinja | 23 + salt/influxdb/init.sls | 2 +- 4 files changed, 134 insertions(+), 690 deletions(-) delete mode 100644 salt/influxdb/etc/influxdb.conf create mode 100644 salt/influxdb/etc/influxdb.conf.jinja diff --git a/salt/influxdb/defaults.yaml b/salt/influxdb/defaults.yaml index 5390a62df..299666023 100644 --- a/salt/influxdb/defaults.yaml +++ b/salt/influxdb/defaults.yaml @@ -1,158 +1,158 @@ influxdb: config: meta: - dir: '"/var/lib/influxdb/meta"' - retention-autocreate: 'true' - logging-enabled: 'true' + dir: /var/lib/influxdb/meta + retention-autocreate: true + logging-enabled: true data: - dir: '"/var/lib/influxdb/data"' - wal-dir: '"/var/lib/influxdb/wal"' - wal-fsync-delay: '"0s"' - index-version: '"inmem"' - race-logging-enabled: 'false' - query-log-enabled: 'true' - validate-keys: 'false' - cache-max-memory-size: '"1g"' - cache-snapshot-memory-size: '"25m"' - cache-snapshot-write-cold-duration: '"10m"' - compact-full-write-cold-duration: '"4h"' + dir: /var/lib/influxdb/data + wal-dir: /var/lib/influxdb/wal + wal-fsync-delay: 0s + index-version: inmem + race-logging-enabled: false + query-log-enabled: true + validate-keys: false + cache-max-memory-size: 1g + cache-snapshot-memory-size: 25m + cache-snapshot-write-cold-duration: 10m + compact-full-write-cold-duration: 4h max-concurrent-compactions: 0 - compact-throughput: '"48m"' - compact-throughput-burst: '"48m"' - max-index-log-file-size: '"1m"' + compact-throughput: 48m + compact-throughput-burst: 48m + max-index-log-file-size: 1m max-series-per-database: 1000000 max-values-per-tag: 100000 - tsm-use-madv-willneed: 'false' + tsm-use-madv-willneed: false coordinator: - write-timeout: '"10s"' + write-timeout: 10s max-concurrent-queries: 0 - query-timeout: '"0s"' - log-queries-after: '"0s"' + query-timeout: 0s + log-queries-after: 0s max-select-point: 0 max-select-series: 0 max-select-buckets: 0 retention: - enabled: 'true' - check-interval: '"30m"' + enabled: true + check-interval: 30m shard-precreation: - enabled: 'true' - check-interval: '"10m"' - advance-period: '"30m"' + enabled: true + check-interval: 10m + advance-period: 30m monitor: - store-enabled: '"true"' - store-database: '"_internal"' - store-interval: '"10s"' + store-enabled: true + store-database: _internal + store-interval: 10s http: - enabled: 'true' - flux-enabled: 'true' - bind-address: '":8086"' - auth-enabled: 'false' - realm: '"InfluxDB"' - log-enabled: 'false' - suppress-write-log: 'false' - access-log-path: '""' - access-log-status-filters: '[]' - write-tracing: 'false' - pprof-enabled: 'true' - debug-pprof-enabled: 'false' - https-enabled: 'true' - https-certificate: '"/etc/ssl/influxdb.crt"' - https-private-key: '"/etc/ssl/influxdb.key"' - shared-secret: '""' + enabled: true + flux-enabled: true + bind-address: ':8086' + auth-enabled: false + realm: InfluxDB + log-enabled: false + suppress-write-log: false + access-log-path: '' + access-log-status-filters: [] + write-tracing: false + pprof-enabled: true + debug-pprof-enabled: false + https-enabled: true + https-certificate: /etc/ssl/influxdb.crt + https-private-key: /etc/ssl/influxdb.key + shared-secret: '' max-row-limit: 0 max-connection-limit: 0 - unix-socket-enabled: 'false' - bind-socket: '"/var/run/influxdb.sock"' + unix-socket-enabled: false + bind-socket: /var/run/influxdb.sock max-body-size: 25000000 max-concurrent-write-limit: 0 max-enqueued-write-limit: 0 enqueued-write-timeout: 0 logging: - format: '"auto"' - level: '"info"' - suppress-logo: 'false' + format: auto + level: info + suppress-logo: false subscriber: - enabled: 'true' - http-timeout: '"30s"' - insecure-skip-verify: 'false' - ca-certs: '""' + enabled: true + http-timeout: 30s + insecure-skip-verify: false + ca-certs: '' write-concurrency: 40 write-buffer-size: 1000 graphite: - enabled: 'false' - database: '"graphite"' - retention-policy: '""' - bind-address: '":2003"' - protocol: '"tcp"' - consistency-level: '"one"' + enabled: false + database: graphite + retention-policy: '' + bind-address: ':2003' + protocol: tcp + consistency-level: one batch-size: 5000 batch-pending: 10 - batch-timeout: '"1s"' + batch-timeout: 1s udp-read-buffer: 0 - separator: '"."' - tags: '[]' - templates: '[]' + separator: '.' + tags: [] + templates: [] collectd: - enabled: 'false' - bind-address: '":25826"' - database: '"collectd"' - retention-policy: '""' - typesdb: '"/usr/local/share/collectd"' - security-level: '"none"' - auth-file: '"/etc/collectd/auth_file"' + enabled: false + bind-address: ':25826' + database: collectd + retention-policy: '' + typesdb: /usr/local/share/collectd + security-level: none + auth-file: /etc/collectd/auth_file batch-size: 5000 bath-pending: 10 - batch-timeout: '"10s"' + batch-timeout: 10s read-buffer: 0 - parse-multivalue-plugin: '"split"' + parse-multivalue-plugin: split opentsdb: enabled: false - bind-address: '":4242"' - database: '"opentsdb"' - retention-policy: '""' - consistency-level: '"one"' - tls-enabled: 'false' - certificate: '"/etc/ssl/influxdb.pem"' - log-point-errors: 'true' + bind-address: ':4242' + database: opentsdb + retention-policy: '' + consistency-level: one + tls-enabled: false + certificate: /etc/ssl/influxdb.pem + log-point-errors: true batch-size: 1000 batch-pending: 5 - bath-timeout: '"1s"' + bath-timeout: 1s udp: - enabled: 'false' - bind-address: '":8089"' - database: '"udp"' - retention-policy: '""' - precision: '""' + enabled: false + bind-address: ':8089' + database: udp + retention-policy: '' + precision: '' batch-size: 5000 batch-pending: 10 - batch-timeout: '"1s"' + batch-timeout: 1s read-buffer: 0 continuous_queries: - enabled: 'true' - log-enabled: 'true' - query-stats-enabled: 'false' - run-interval: '"1s"' + enabled: true + log-enabled: true + query-stats-enabled: false + run-interval: 1s tls: ciphers: - - '"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA"' - - '"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256"' - - '"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256"' - - '"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA"' - - '"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"' - - '"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305"' - - '"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"' - - '"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"' - - '"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"' - - '"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"' - - '"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"' - - '"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305"' - - '"TLS_RSA_WITH_AES_128_CBC_SHA"' - - '"TLS_RSA_WITH_AES_128_CBC_SHA256"' - - '"TLS_RSA_WITH_AES_128_GCM_SHA256"' - - '"TLS_RSA_WITH_AES_256_CBC_SHA"' - - '"TLS_RSA_WITH_AES_256_GCM_SHA384"' - min-version: '"tls1.2"' - max-version: '"tls1.2"' + - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA + - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 + - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA + - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 + - TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305 + - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA + - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 + - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 + - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA + - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305 + - TLS_RSA_WITH_AES_128_CBC_SHA + - TLS_RSA_WITH_AES_128_CBC_SHA256 + - TLS_RSA_WITH_AES_128_GCM_SHA256 + - TLS_RSA_WITH_AES_256_CBC_SHA + - TLS_RSA_WITH_AES_256_GCM_SHA384 + min-version: tls1.2 + max-version: tls1.2 retention_policies: so_short_term: default: True diff --git a/salt/influxdb/etc/influxdb.conf b/salt/influxdb/etc/influxdb.conf deleted file mode 100644 index 9d89ca774..000000000 --- a/salt/influxdb/etc/influxdb.conf +++ /dev/null @@ -1,579 +0,0 @@ -### Welcome to the InfluxDB configuration file. - -# The values in this file override the default values used by the system if -# a config option is not specified. The commented out lines are the configuration -# field and the default value used. Uncommenting a line and changing the value -# will change the value used at runtime when the process is restarted. - -# Once every 24 hours InfluxDB will report usage data to usage.influxdata.com -# The data includes a random ID, os, arch, version, the number of series and other -# usage data. No data from user databases is ever transmitted. -# Change this option to true to disable reporting. -# reporting-disabled = false - -# Bind address to use for the RPC service for backup and restore. -# bind-address = "127.0.0.1:8088" - -### -### [meta] -### -### Controls the parameters for the Raft consensus group that stores metadata -### about the InfluxDB cluster. -### - -[meta] - # Where the metadata/raft database is stored - dir = "/var/lib/influxdb/meta" - - # Automatically create a default retention policy when creating a database. - # retention-autocreate = true - - # If log messages are printed for the meta service - # logging-enabled = true - -### -### [data] -### -### Controls where the actual shard data for InfluxDB lives and how it is -### flushed from the WAL. "dir" may need to be changed to a suitable place -### for your system, but the WAL settings are an advanced configuration. The -### defaults should work for most systems. -### - -[data] - # The directory where the TSM storage engine stores TSM files. - dir = "/var/lib/influxdb/data" - - # The directory where the TSM storage engine stores WAL files. - wal-dir = "/var/lib/influxdb/wal" - - # The amount of time that a write will wait before fsyncing. A duration - # greater than 0 can be used to batch up multiple fsync calls. This is useful for slower - # disks or when WAL write contention is seen. A value of 0s fsyncs every write to the WAL. - # Values in the range of 0-100ms are recommended for non-SSD disks. - # wal-fsync-delay = "0s" - - - # The type of shard index to use for new shards. The default is an in-memory index that is - # recreated at startup. A value of "tsi1" will use a disk based index that supports higher - # cardinality datasets. - # index-version = "inmem" - - # Trace logging provides more verbose output around the tsm engine. Turning - # this on can provide more useful output for debugging tsm engine issues. - # trace-logging-enabled = false - - # Whether queries should be logged before execution. Very useful for troubleshooting, but will - # log any sensitive data contained within a query. - # query-log-enabled = true - - # Validates incoming writes to ensure keys only have valid unicode characters. - # This setting will incur a small overhead because every key must be checked. - # validate-keys = false - - # Settings for the TSM engine - - # CacheMaxMemorySize is the maximum size a shard's cache can - # reach before it starts rejecting writes. - # Valid size suffixes are k, m, or g (case insensitive, 1024 = 1k). - # Values without a size suffix are in bytes. - # cache-max-memory-size = "1g" - - # CacheSnapshotMemorySize is the size at which the engine will - # snapshot the cache and write it to a TSM file, freeing up memory - # Valid size suffixes are k, m, or g (case insensitive, 1024 = 1k). - # Values without a size suffix are in bytes. - # cache-snapshot-memory-size = "25m" - - # CacheSnapshotWriteColdDuration is the length of time at - # which the engine will snapshot the cache and write it to - # a new TSM file if the shard hasn't received writes or deletes - # cache-snapshot-write-cold-duration = "10m" - - # CompactFullWriteColdDuration is the duration at which the engine - # will compact all TSM files in a shard if it hasn't received a - # write or delete - # compact-full-write-cold-duration = "4h" - - # The maximum number of concurrent full and level compactions that can run at one time. A - # value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater - # than 0 limits compactions to that value. This setting does not apply - # to cache snapshotting. - # max-concurrent-compactions = 0 - - # CompactThroughput is the rate limit in bytes per second that we - # will allow TSM compactions to write to disk. Note that short bursts are allowed - # to happen at a possibly larger value, set by CompactThroughputBurst - # compact-throughput = "48m" - - # CompactThroughputBurst is the rate limit in bytes per second that we - # will allow TSM compactions to write to disk. - # compact-throughput-burst = "48m" - - # The threshold, in bytes, when an index write-ahead log file will compact - # into an index file. Lower sizes will cause log files to be compacted more - # quickly and result in lower heap usage at the expense of write throughput. - # Higher sizes will be compacted less frequently, store more series in-memory, - # and provide higher write throughput. - # Valid size suffixes are k, m, or g (case insensitive, 1024 = 1k). - # Values without a size suffix are in bytes. - # max-index-log-file-size = "1m" - - # The maximum series allowed per database before writes are dropped. This limit can prevent - # high cardinality issues at the database level. This limit can be disabled by setting it to - # 0. - # max-series-per-database = 1000000 - - # The maximum number of tag values per tag that are allowed before writes are dropped. This limit - # can prevent high cardinality tag values from being written to a measurement. This limit can be - # disabled by setting it to 0. - # max-values-per-tag = 100000 - - # If true, then the mmap advise value MADV_WILLNEED will be provided to the kernel with respect to - # TSM files. This setting has been found to be problematic on some kernels, and defaults to off. - # It might help users who have slow disks in some cases. - # tsm-use-madv-willneed = false - -### -### [coordinator] -### -### Controls the clustering service configuration. -### - -[coordinator] - # The default time a write request will wait until a "timeout" error is returned to the caller. - # write-timeout = "10s" - - # The maximum number of concurrent queries allowed to be executing at one time. If a query is - # executed and exceeds this limit, an error is returned to the caller. This limit can be disabled - # by setting it to 0. - # max-concurrent-queries = 0 - - # The maximum time a query will is allowed to execute before being killed by the system. This limit - # can help prevent run away queries. Setting the value to 0 disables the limit. - # query-timeout = "0s" - - # The time threshold when a query will be logged as a slow query. This limit can be set to help - # discover slow or resource intensive queries. Setting the value to 0 disables the slow query logging. - # log-queries-after = "0s" - - # The maximum number of points a SELECT can process. A value of 0 will make - # the maximum point count unlimited. This will only be checked every second so queries will not - # be aborted immediately when hitting the limit. - # max-select-point = 0 - - # The maximum number of series a SELECT can run. A value of 0 will make the maximum series - # count unlimited. - # max-select-series = 0 - - # The maxium number of group by time bucket a SELECT can create. A value of zero will max the maximum - # number of buckets unlimited. - # max-select-buckets = 0 - -### -### [retention] -### -### Controls the enforcement of retention policies for evicting old data. -### - -[retention] - # Determines whether retention policy enforcement enabled. - # enabled = true - - # The interval of time when retention policy enforcement checks run. - # check-interval = "30m" - -### -### [shard-precreation] -### -### Controls the precreation of shards, so they are available before data arrives. -### Only shards that, after creation, will have both a start- and end-time in the -### future, will ever be created. Shards are never precreated that would be wholly -### or partially in the past. - -[shard-precreation] - # Determines whether shard pre-creation service is enabled. - # enabled = true - - # The interval of time when the check to pre-create new shards runs. - # check-interval = "10m" - - # The default period ahead of the endtime of a shard group that its successor - # group is created. - # advance-period = "30m" - -### -### Controls the system self-monitoring, statistics and diagnostics. -### -### The internal database for monitoring data is created automatically if -### if it does not already exist. The target retention within this database -### is called 'monitor' and is also created with a retention period of 7 days -### and a replication factor of 1, if it does not exist. In all cases the -### this retention policy is configured as the default for the database. - -[monitor] - # Whether to record statistics internally. - # store-enabled = true - - # The destination database for recorded statistics - # store-database = "_internal" - - # The interval at which to record statistics - # store-interval = "10s" - -### -### [http] -### -### Controls how the HTTP endpoints are configured. These are the primary -### mechanism for getting data into and out of InfluxDB. -### - -[http] - # Determines whether HTTP endpoint is enabled. - # enabled = true - - # Determines whether the Flux query endpoint is enabled. - flux-enabled = true - - # The bind address used by the HTTP service. - # bind-address = ":8086" - - # Determines whether user authentication is enabled over HTTP/HTTPS. - # auth-enabled = false - - # The default realm sent back when issuing a basic auth challenge. - # realm = "InfluxDB" - - # Determines whether HTTP request logging is enabled. - # log-enabled = true - - # Determines whether the HTTP write request logs should be suppressed when the log is enabled. - # suppress-write-log = false - - # When HTTP request logging is enabled, this option specifies the path where - # log entries should be written. If unspecified, the default is to write to stderr, which - # intermingles HTTP logs with internal InfluxDB logging. - # - # If influxd is unable to access the specified path, it will log an error and fall back to writing - # the request log to stderr. - # access-log-path = "" - - # Filters which requests should be logged. Each filter is of the pattern NNN, NNX, or NXX where N is - # a number and X is a wildcard for any number. To filter all 5xx responses, use the string 5xx. - # If multiple filters are used, then only one has to match. The default is to have no filters which - # will cause every request to be printed. - # access-log-status-filters = [] - - # Determines whether detailed write logging is enabled. - # write-tracing = false - - # Determines whether the pprof endpoint is enabled. This endpoint is used for - # troubleshooting and monitoring. - # pprof-enabled = true - - # Enables a pprof endpoint that binds to localhost:6060 immediately on startup. - # This is only needed to debug startup issues. - # debug-pprof-enabled = false - - # Determines whether HTTPS is enabled. - https-enabled = true - - # The SSL certificate to use when HTTPS is enabled. - https-certificate = "/etc/ssl/influxdb.crt" - - # Use a separate private key location. - https-private-key = "/etc/ssl/influxdb.key" - - # The JWT auth shared secret to validate requests using JSON web tokens. - # shared-secret = "" - - # The default chunk size for result sets that should be chunked. - # max-row-limit = 0 - - # The maximum number of HTTP connections that may be open at once. New connections that - # would exceed this limit are dropped. Setting this value to 0 disables the limit. - # max-connection-limit = 0 - - # Enable http service over unix domain socket - # unix-socket-enabled = false - - # The path of the unix domain socket. - # bind-socket = "/var/run/influxdb.sock" - - # The maximum size of a client request body, in bytes. Setting this value to 0 disables the limit. - # max-body-size = 25000000 - - # The maximum number of writes processed concurrently. - # Setting this to 0 disables the limit. - # max-concurrent-write-limit = 0 - - # The maximum number of writes queued for processing. - # Setting this to 0 disables the limit. - # max-enqueued-write-limit = 0 - - # The maximum duration for a write to wait in the queue to be processed. - # Setting this to 0 or setting max-concurrent-write-limit to 0 disables the limit. - # enqueued-write-timeout = 0 - -### -### [logging] -### -### Controls how the logger emits logs to the output. -### - -[logging] - # Determines which log encoder to use for logs. Available options - # are auto, logfmt, and json. auto will use a more a more user-friendly - # output format if the output terminal is a TTY, but the format is not as - # easily machine-readable. When the output is a non-TTY, auto will use - # logfmt. - # format = "auto" - - # Determines which level of logs will be emitted. The available levels - # are error, warn, info, and debug. Logs that are equal to or above the - # specified level will be emitted. - # level = "info" - - # Suppresses the logo output that is printed when the program is started. - # The logo is always suppressed if STDOUT is not a TTY. - # suppress-logo = false - -### -### [subscriber] -### -### Controls the subscriptions, which can be used to fork a copy of all data -### received by the InfluxDB host. -### - -[subscriber] - # Determines whether the subscriber service is enabled. - # enabled = true - - # The default timeout for HTTP writes to subscribers. - # http-timeout = "30s" - - # Allows insecure HTTPS connections to subscribers. This is useful when testing with self- - # signed certificates. - # insecure-skip-verify = false - - # The path to the PEM encoded CA certs file. If the empty string, the default system certs will be used - # ca-certs = "" - - # The number of writer goroutines processing the write channel. - # write-concurrency = 40 - - # The number of in-flight writes buffered in the write channel. - # write-buffer-size = 1000 - - -### -### [[graphite]] -### -### Controls one or many listeners for Graphite data. -### - -[[graphite]] - # Determines whether the graphite endpoint is enabled. - # enabled = false - # database = "graphite" - # retention-policy = "" - # bind-address = ":2003" - # protocol = "tcp" - # consistency-level = "one" - - # These next lines control how batching works. You should have this enabled - # otherwise you could get dropped metrics or poor performance. Batching - # will buffer points in memory if you have many coming in. - - # Flush if this many points get buffered - # batch-size = 5000 - - # number of batches that may be pending in memory - # batch-pending = 10 - - # Flush at least this often even if we haven't hit buffer limit - # batch-timeout = "1s" - - # UDP Read buffer size, 0 means OS default. UDP listener will fail if set above OS max. - # udp-read-buffer = 0 - - ### This string joins multiple matching 'measurement' values providing more control over the final measurement name. - # separator = "." - - ### Default tags that will be added to all metrics. These can be overridden at the template level - ### or by tags extracted from metric - # tags = ["region=us-east", "zone=1c"] - - ### Each template line requires a template pattern. It can have an optional - ### filter before the template and separated by spaces. It can also have optional extra - ### tags following the template. Multiple tags should be separated by commas and no spaces - ### similar to the line protocol format. There can be only one default template. - # templates = [ - # "*.app env.service.resource.measurement", - # # Default template - # "server.*", - # ] - -### -### [collectd] -### -### Controls one or many listeners for collectd data. -### - -[[collectd]] - # enabled = false - # bind-address = ":25826" - # database = "collectd" - # retention-policy = "" - # - # The collectd service supports either scanning a directory for multiple types - # db files, or specifying a single db file. - # typesdb = "/usr/local/share/collectd" - # - # security-level = "none" - # auth-file = "/etc/collectd/auth_file" - - # These next lines control how batching works. You should have this enabled - # otherwise you could get dropped metrics or poor performance. Batching - # will buffer points in memory if you have many coming in. - - # Flush if this many points get buffered - # batch-size = 5000 - - # Number of batches that may be pending in memory - # batch-pending = 10 - - # Flush at least this often even if we haven't hit buffer limit - # batch-timeout = "10s" - - # UDP Read buffer size, 0 means OS default. UDP listener will fail if set above OS max. - # read-buffer = 0 - - # Multi-value plugins can be handled two ways. - # "split" will parse and store the multi-value plugin data into separate measurements - # "join" will parse and store the multi-value plugin as a single multi-value measurement. - # "split" is the default behavior for backward compatability with previous versions of influxdb. - # parse-multivalue-plugin = "split" -### -### [opentsdb] -### -### Controls one or many listeners for OpenTSDB data. -### - -[[opentsdb]] - # enabled = false - # bind-address = ":4242" - # database = "opentsdb" - # retention-policy = "" - # consistency-level = "one" - # tls-enabled = false - # certificate= "/etc/ssl/influxdb.pem" - - # Log an error for every malformed point. - # log-point-errors = true - - # These next lines control how batching works. You should have this enabled - # otherwise you could get dropped metrics or poor performance. Only points - # metrics received over the telnet protocol undergo batching. - - # Flush if this many points get buffered - # batch-size = 1000 - - # Number of batches that may be pending in memory - # batch-pending = 5 - - # Flush at least this often even if we haven't hit buffer limit - # batch-timeout = "1s" - -### -### [[udp]] -### -### Controls the listeners for InfluxDB line protocol data via UDP. -### - -[[udp]] - # enabled = false - # bind-address = ":8089" - # database = "udp" - # retention-policy = "" - - # InfluxDB precision for timestamps on received points ("" or "n", "u", "ms", "s", "m", "h") - # precision = "" - - # These next lines control how batching works. You should have this enabled - # otherwise you could get dropped metrics or poor performance. Batching - # will buffer points in memory if you have many coming in. - - # Flush if this many points get buffered - # batch-size = 5000 - - # Number of batches that may be pending in memory - # batch-pending = 10 - - # Will flush at least this often even if we haven't hit buffer limit - # batch-timeout = "1s" - - # UDP Read buffer size, 0 means OS default. UDP listener will fail if set above OS max. - # read-buffer = 0 - -### -### [continuous_queries] -### -### Controls how continuous queries are run within InfluxDB. -### - -[continuous_queries] - # Determines whether the continuous query service is enabled. - # enabled = true - - # Controls whether queries are logged when executed by the CQ service. - # log-enabled = true - - # Controls whether queries are logged to the self-monitoring data store. - # query-stats-enabled = false - - # interval for how often continuous queries will be checked if they need to run - # run-interval = "1s" - -### -### [tls] -### -### Global configuration settings for TLS in InfluxDB. -### - -[tls] - # Determines the available set of cipher suites. See https://golang.org/pkg/crypto/tls/#pkg-constants - # for a list of available ciphers, which depends on the version of Go (use the query - # SHOW DIAGNOSTICS to see the version of Go used to build InfluxDB). If not specified, uses - # the default settings from Go's crypto/tls package. - # ciphers = [ - # "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305", - # "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", - # ] - ciphers = [ - "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", - "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", - "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", - "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", - "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", - "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305", - "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", - "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", - "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", - "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", - "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", - "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305", - "TLS_RSA_WITH_AES_128_CBC_SHA", - "TLS_RSA_WITH_AES_128_CBC_SHA256", - "TLS_RSA_WITH_AES_128_GCM_SHA256", - "TLS_RSA_WITH_AES_256_CBC_SHA", - "TLS_RSA_WITH_AES_256_GCM_SHA384", - ] - - # Minimum version of the tls protocol that will be negotiated. If not specified, uses the - # default settings from Go's crypto/tls package. - # min-version = "tls1.2" - - # Maximum version of the tls protocol that will be negotiated. If not specified, uses the - # default settings from Go's crypto/tls package. - # max-version = "tls1.2" diff --git a/salt/influxdb/etc/influxdb.conf.jinja b/salt/influxdb/etc/influxdb.conf.jinja new file mode 100644 index 000000000..77d59e681 --- /dev/null +++ b/salt/influxdb/etc/influxdb.conf.jinja @@ -0,0 +1,23 @@ +{% import_yaml 'influx.defaults.yaml' as influx %} + +{%- for header in influx.influxdb.config.keys() %} +[{{header}}] +{%- for k, v in influx.influxdb.config[header].items() %} +{#- is v a list? #} +{%- if v is iterable and (v is not string and v is not mapping) %} + {{k}} = [ +{%- for li in v %} + "{{li}}", +{%- endfor %} + ] +{%- else %} +{%- if v is string %} + {{k}} = "{{v}}" +{%- elif v is boolean %} + {{k}} = {{v|string|lower}} +{%- else %} + {{k}} = {{v}} +{%- endif %} +{%- endif %} +{%- endfor %} +{%- endfor %} diff --git a/salt/influxdb/init.sls b/salt/influxdb/init.sls index ae2b98072..ddcf36195 100644 --- a/salt/influxdb/init.sls +++ b/salt/influxdb/init.sls @@ -41,7 +41,7 @@ influxdbconf: - user: 939 - group: 939 - template: jinja - - source: salt://influxdb/etc/influxdb.conf + - source: salt://influxdb/etc/influxdb.conf.jinja so-influxdb: docker_container.running: From ce0b9201950d639ef05264274cce006f7e5a4124 Mon Sep 17 00:00:00 2001 From: m0duspwnens Date: Mon, 19 Dec 2022 14:44:52 -0500 Subject: [PATCH 13/31] jinja conf for influxdb --- salt/influxdb/etc/influxdb.conf.jinja | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/salt/influxdb/etc/influxdb.conf.jinja b/salt/influxdb/etc/influxdb.conf.jinja index 77d59e681..a82e8a551 100644 --- a/salt/influxdb/etc/influxdb.conf.jinja +++ b/salt/influxdb/etc/influxdb.conf.jinja @@ -1,7 +1,11 @@ -{% import_yaml 'influx.defaults.yaml' as influx %} +{%- import_yaml 'influx/defaults.yaml' as influx %} {%- for header in influx.influxdb.config.keys() %} +{%- if header in ['graphite', 'collectd', 'opentsdb', 'udp'] %} +[[{{header}}]] +{%- else %} [{{header}}] +{%- endif %} {%- for k, v in influx.influxdb.config[header].items() %} {#- is v a list? #} {%- if v is iterable and (v is not string and v is not mapping) %} From 30419e5b2b6537df293277f0fd90eaea83d83082 Mon Sep 17 00:00:00 2001 From: m0duspwnens Date: Mon, 19 Dec 2022 14:51:12 -0500 Subject: [PATCH 14/31] fix import and jinja spacing --- salt/influxdb/etc/influxdb.conf.jinja | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/salt/influxdb/etc/influxdb.conf.jinja b/salt/influxdb/etc/influxdb.conf.jinja index a82e8a551..0c4d93eae 100644 --- a/salt/influxdb/etc/influxdb.conf.jinja +++ b/salt/influxdb/etc/influxdb.conf.jinja @@ -1,27 +1,27 @@ -{%- import_yaml 'influx/defaults.yaml' as influx %} +{%- import_yaml 'influxdb/defaults.yaml' as influx %} {%- for header in influx.influxdb.config.keys() %} {%- if header in ['graphite', 'collectd', 'opentsdb', 'udp'] %} [[{{header}}]] -{%- else %} +{%- else %} [{{header}}] -{%- endif %} +{%- endif %} {%- for k, v in influx.influxdb.config[header].items() %} {#- is v a list? #} {%- if v is iterable and (v is not string and v is not mapping) %} {{k}} = [ {%- for li in v %} "{{li}}", -{%- endfor %} +{%- endfor %} ] {%- else %} -{%- if v is string %} +{%- if v is string %} {{k}} = "{{v}}" -{%- elif v is boolean %} +{%- elif v is boolean %} {{k}} = {{v|string|lower}} -{%- else %} +{%- else %} {{k}} = {{v}} -{%- endif %} +{%- endif %} {%- endif %} {%- endfor %} {%- endfor %} From 6a4718ec0f87a53f02ea7572fff79e789f32baad Mon Sep 17 00:00:00 2001 From: m0duspwnens Date: Mon, 19 Dec 2022 15:55:35 -0500 Subject: [PATCH 15/31] merge defaults with pillar --- salt/influxdb/etc/influxdb.conf.jinja | 15 +++++++-------- salt/redis/etc/redis.conf.jinja | 5 +++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/salt/influxdb/etc/influxdb.conf.jinja b/salt/influxdb/etc/influxdb.conf.jinja index 0c4d93eae..ce607292d 100644 --- a/salt/influxdb/etc/influxdb.conf.jinja +++ b/salt/influxdb/etc/influxdb.conf.jinja @@ -1,12 +1,13 @@ -{%- import_yaml 'influxdb/defaults.yaml' as influx %} +{%- import_yaml 'influxdb/defaults.yaml' as INFLUXDEFAULTS %} +{%- set INFLUXMERGED = salt['pillar.get']('influxdb', default=INFLUXDEFAULTS.influxdb, merge=true) %} -{%- for header in influx.influxdb.config.keys() %} +{%- for header in INFLUXMERGED.config.keys() %} {%- if header in ['graphite', 'collectd', 'opentsdb', 'udp'] %} [[{{header}}]] {%- else %} [{{header}}] {%- endif %} -{%- for k, v in influx.influxdb.config[header].items() %} +{%- for k, v in INFLUXMERGED.config[header].items() %} {#- is v a list? #} {%- if v is iterable and (v is not string and v is not mapping) %} {{k}} = [ @@ -14,14 +15,12 @@ "{{li}}", {%- endfor %} ] -{%- else %} -{%- if v is string %} +{%- elif v is string %} {{k}} = "{{v}}" -{%- elif v is boolean %} +{%- elif v is boolean %} {{k}} = {{v|string|lower}} -{%- else %} +{%- else %} {{k}} = {{v}} -{%- endif %} {%- endif %} {%- endfor %} {%- endfor %} diff --git a/salt/redis/etc/redis.conf.jinja b/salt/redis/etc/redis.conf.jinja index 3fa6e4388..c3291c3e8 100644 --- a/salt/redis/etc/redis.conf.jinja +++ b/salt/redis/etc/redis.conf.jinja @@ -1,6 +1,7 @@ -{% import_yaml 'redis/defaults.yaml' as redis %} +{%- import_yaml 'redis/defaults.yaml' as REDISDEFAULTS %} +{%- set REDISMERGED = salt['pillar.get']('redis', default=REDISDEFAULTS.redis, merge=true) %} -{%- for k, v in redis.redis.config.items() %} +{%- for k, v in REDISMERGED.config.items() %} {%- if v is iterable and v is not string %} {%- for v1, v2 in v.items() %} {{k}} {{v1}} {{v2}} From 74af54a2007eabdfb554cac5ff0aee3fe59b70b1 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Mon, 19 Dec 2022 16:16:48 -0500 Subject: [PATCH 16/31] SOC file for influx --- salt/influxdb/soc_influxdb.yaml | 108 ++++++++++++++++---------------- 1 file changed, 54 insertions(+), 54 deletions(-) diff --git a/salt/influxdb/soc_influxdb.yaml b/salt/influxdb/soc_influxdb.yaml index 7b11757b1..4ef705191 100644 --- a/salt/influxdb/soc_influxdb.yaml +++ b/salt/influxdb/soc_influxdb.yaml @@ -87,252 +87,252 @@ influxdb: global: True helpLink: influxdb.html max-concurrent-queries: - description: Enable InfluxDB meta server logging. + description: The maximum number of concurrent queries allowed to be executing at one time. global: True helpLink: influxdb.html query-timeout: - description: Enable InfluxDB meta server logging. + description: The maximum time a query will is allowed to execute before being killed by the system. global: True helpLink: influxdb.html log-queries-after: - description: Enable InfluxDB meta server logging. + description: The time threshold when a query will be logged as a slow query. global: True helpLink: influxdb.html max-select-point: - description: Enable InfluxDB meta server logging. + description: The maximum number of points a SELECT can process. global: True advanced: True helpLink: influxdb.html max-select-series: - description: Enable InfluxDB meta server logging. + description: The maximum number of series a SELECT can run. global: True advanced: True helpLink: influxdb.html max-select-buckets: - description: Enable InfluxDB meta server logging. + description: The maxium number of group by time bucket a SELECT can create. global: True advanced: True helpLink: influxdb.html retention: enabled: - description: Enable InfluxDB meta server logging. + description: Determines whether retention policy enforcement enabled. global: True advanced: True helpLink: influxdb.html check-interval: - description: Enable InfluxDB meta server logging. + description: The interval of time when retention policy enforcement checks run. global: True helpLink: influxdb.html shard-precreation: enabled: - description: Enable InfluxDB meta server logging. + description: Determines whether shard pre-creation service is enabled. global: True advanced: True helpLink: influxdb.html check-interval: - description: Enable InfluxDB meta server logging. + description: The interval of time when the check to pre-create new shards runs. global: True helpLink: influxdb.html advance-period: - description: Enable InfluxDB meta server logging. + description: The default period ahead of the endtime of a shard group that its successor group is created. global: True advanced: True helpLink: influxdb.html monitor: store-enabled: - description: Enable InfluxDB meta server logging. + description: Whether to record statistics internally. global: True helpLink: influxdb.html store-database: - description: Enable InfluxDB meta server logging. + description: The destination database for recorded statistics. global: True advanced: True helpLink: influxdb.html store-interval: - description: Enable InfluxDB meta server logging. + description: The interval at which to record statistics. global: True helpLink: influxdb.html http: enabled: - description: Enable InfluxDB meta server logging. + description: Determines whether HTTP endpoint is enabled. global: True advanced: True helpLink: influxdb.html flux-enabled: - description: Enable InfluxDB meta server logging. + description: Determines whether the Flux query endpoint is enabled. global: True advanced: True helpLink: influxdb.html bind-address: - description: Enable InfluxDB meta server logging. + description: The bind address used by the HTTP service. global: True advanced: True helpLink: influxdb.html auth-enabled: - description: Enable InfluxDB meta server logging. + description: Determines whether user authentication is enabled over HTTP/HTTPS. global: True advanced: True helpLink: influxdb.html realm: - description: Enable InfluxDB meta server logging. + description: The default realm sent back when issuing a basic auth challenge. global: True advanced: True helpLink: influxdb.html log-enabled: - description: Enable InfluxDB meta server logging. + description: Determines whether HTTP request logging is enabled. global: True helpLink: influxdb.html suppress-write-log: - description: Enable InfluxDB meta server logging. + description: Determines whether the HTTP write request logs should be suppressed when the log is enabled. global: True helpLink: influxdb.html access-log-path: - description: Enable InfluxDB meta server logging. + description: Path for http access logs. global: True advanced: True helpLink: influxdb.html access-log-status-filters: - description: Enable InfluxDB meta server logging. + description: Filters which requests should be logged. global: True advanced: True helpLink: influxdb.html write-tracing: - description: Enable InfluxDB meta server logging. + description: Determines whether detailed write logging is enabled. global: True advanced: True helpLink: influxdb.html pprof-enabled: - description: Enable InfluxDB meta server logging. + description: Determines whether the pprof endpoint is enabled. global: True advanced: True helpLink: influxdb.html debug-pprof-enabled: - description: Enable InfluxDB meta server logging. + description: Determines whether the pprof endpoint is enabled in debug mode. global: True advanced: True helpLink: influxdb.html https-enabled: - description: Enable InfluxDB meta server logging. + description: Determines whether HTTPS is enabled. global: True helpLink: influxdb.html https-certificate: - description: Enable InfluxDB meta server logging. + description: The SSL certificate to use when HTTPS is enabled. global: True advanced: True helpLink: influxdb.html https-private-key: - description: Enable InfluxDB meta server logging. + description: Use a separate private key location. global: True advanced: True helpLink: influxdb.html shared-secret: - description: Enable InfluxDB meta server logging. + description: The JWT auth shared secret to validate requests using JSON web tokens. global: True advanced: True helpLink: influxdb.html max-row-limit: - description: Enable InfluxDB meta server logging. + description: The default chunk size for result sets that should be chunked. global: True helpLink: influxdb.html max-connection-limit: - description: Enable InfluxDB meta server logging. + description: The maximum number of HTTP connections that may be open at once. global: True helpLink: influxdb.html unix-socket-enabled: - description: Enable InfluxDB meta server logging. + description: Enable http service over unix domain socket. global: True advanced: True helpLink: influxdb.html bind-socket: - description: Enable InfluxDB meta server logging. + description: The path of the unix domain socket. global: True advanced: True helpLink: influxdb.html max-body-size: - description: Enable InfluxDB meta server logging. + description: The maximum size of a client request body, in bytes. global: True helpLink: influxdb.html max-concurrent-write-limit: - description: Enable InfluxDB meta server logging. + description: The maximum number of writes processed concurrently. global: True helpLink: influxdb.html max-enqueued-write-limit: - description: Enable InfluxDB meta server logging. + description: The maximum number of writes queued for processing. global: True helpLink: influxdb.html enqueued-write-timeout: - description: Enable InfluxDB meta server logging. + description: The maximum duration for a write to wait in the queue to be processed. global: True helpLink: influxdb.html logging: format: - description: Enable InfluxDB meta server logging. + description: Determines which log encoder to use for logs. global: True helpLink: influxdb.html level: - description: Enable InfluxDB meta server logging. + description: Determines which level of logs will be emitted. global: True helpLink: influxdb.html suppress-logo: - description: Enable InfluxDB meta server logging. + description: Suppresses the logo output that is printed when the program is started. global: True helpLink: influxdb.html subscriber: enabled: - description: Enable InfluxDB meta server logging. + description: Determines whether the subscriber service is enabled. global: True advanced: True helpLink: influxdb.html http-timeout: - description: Enable InfluxDB meta server logging. + description: The default timeout for HTTP writes to subscribers. global: True helpLink: influxdb.html insecure-skip-verify: - description: Enable InfluxDB meta server logging. + description: Allows insecure HTTPS connections to subscribers. global: True advanced: True helpLink: influxdb.html ca-certs: - description: Enable InfluxDB meta server logging. + description: The path to the PEM encoded CA certs file. global: True advanced: True helpLink: influxdb.html write-concurrency: - description: Enable InfluxDB meta server logging. + description: he number of writer goroutines processing the write channel. global: True helpLink: influxdb.html write-buffer-size: - description: Enable InfluxDB meta server logging. + description: The number of in-flight writes buffered in the write channel. global: True helpLink: influxdb.html continuous_queries: enabled: - description: Enable InfluxDB meta server logging. + description: Determines whether the continuous query service is enabled. global: True helpLink: influxdb.html log-enabled: - description: Enable InfluxDB meta server logging. + description: Controls whether queries are logged when executed by the CQ service. global: True helpLink: influxdb.html query-stats-enabled: - description: Enable InfluxDB meta server logging. + description: Controls whether queries are logged to the self-monitoring data store. global: True helpLink: influxdb.html run-interval: - description: Enable InfluxDB meta server logging. + description: Interval for how often continuous queries will be checked if they need to run. global: True helpLink: influxdb.html tls: ciphers: - description: Enable InfluxDB meta server logging. + description: Determines the available set of cipher suites. global: True helpLink: influxdb.html min-version: - description: Enable InfluxDB meta server logging. + description: Minimum version of the tls protocol that will be negotiated. global: True helpLink: influxdb.html max-version: - description: Enable InfluxDB meta server logging. + description: Maximum version of the tls protocol that will be negotiated. global: True helpLink: influxdb.html retention_policies: From c0c2d28d190ee87abf5d4352b6d1d7b3ba693759 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Tue, 20 Dec 2022 11:09:49 -0500 Subject: [PATCH 17/31] SOC files for Redis --- salt/redis/defaults.yaml | 8 +- salt/redis/soc_redis.yaml | 285 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 289 insertions(+), 4 deletions(-) create mode 100644 salt/redis/soc_redis.yaml diff --git a/salt/redis/defaults.yaml b/salt/redis/defaults.yaml index 9b5801ba7..987406cf6 100644 --- a/salt/redis/defaults.yaml +++ b/salt/redis/defaults.yaml @@ -17,9 +17,9 @@ redis: tls-ciphers: 'DEFAULT:!MEDIUM' tls-ciphersuites: 'TLS_CHACHA20_POLY1305_SHA256' tls-prefer-server-ciphers: 'yes' - tls-session-caching: 'no' - tls-session-cache-size: 5000 - tls-session-cache-timeout: 60 + tls-session-caching: 'yes' + tls-session-cache-size: 20480 + tls-session-cache-timeout: 300 daemonize: 'no' supervised: 'no' pidfile: '/var/run/redis_6379.pid' @@ -32,7 +32,7 @@ redis: always-show-logo: 'yes' save: 900: 1 - 300: 1 + 300: 10 60: 1000 stop-writes-on-bgsave-error: 'yes' rdbcompression: 'yes' diff --git a/salt/redis/soc_redis.yaml b/salt/redis/soc_redis.yaml new file mode 100644 index 000000000..59f397994 --- /dev/null +++ b/salt/redis/soc_redis.yaml @@ -0,0 +1,285 @@ +redis: + config: + bind: + description: The IP address to bind to. + global: True + advanced: True + helpLink: redis.html + protected-mode: + description: Force authentication to access redis. + global: True + advanced: True + helpLink: redis.html + tls-cert-file: + description: TLS cert file location. + global: True + advanced: True + helpLink: redis.html + tls-key-file: + description: TLS key file location. + global: True + advanced: True + helpLink: redis.html + tls-ca-cert-file: + description: TLS CA file location. + global: True + advanced: True + helpLink: redis.html + tls-port: + description: Port to use TLS encryption on. + global: True + advanced: True + helpLink: redis.html + tls-auth-clients: + description: Force TLS authentication. + global: True + advanced: True + helpLink: redis.html + port: + description: Non TLS port for Redis access. + global: True + advanced: True + helpLink: redis.html + tcp-backlog: + description: Set the TCP backlog value. This is normally increasd in high request environments. + global: True + advanced: True + helpLink: redis.html + timeout: + description: Time in seconds to close an idle connection. 0 to disable. + global: True + helpLink: redis.html + tcp-keepalive: + description: Time in seconds to send a keepalive. + global: True + helpLink: redis.html + tls-replication: + description: Enable TLS replication links. + global: True + advanced: True + helpLink: redis.html + tls-protocols: + description: List of acceptable TLS protocols separated by spaces. + global: True + advanced: True + helpLink: redis.html + tls-ciphers: + description: Allowed ciphers. + global: True + advanced: True + helpLink: redis.html + tls-ciphersuites: + description: Acceptable cipher suites. + global: True + advanced: True + helpLink: redis.html + tls-prefer-server-ciphers: + description: Prefer the server side ciphers. + global: True + advanced: True + helpLink: redis.html + tls-session-caching: + description: Enable TLS session caching. + global: True + helpLink: redis.html + tls-session-cache-size: + description: The number of TLS sessions to cache. + global: True + advanced: True + helpLink: redis.html + tls-session-cache-timeout: + description: Timeout in seconds to cache TLS sessions. + global: True + advanced: True + helpLink: redis.html + loglevel: + description: Log verbosity level. + global: True + helpLink: redis.html + logfile: + description: Log file name. + global: True + advanced: True + helpLink: redis.html + syslog-enabled: + description: Enable syslog output. + global: True + advanced: True + helpLink: redis.html + syslog-ident: + description: Set the syslog identity. + global: True + advanced: True + helpLink: redis.html + syslog-facility: + description: Set the syslog facility. + global: True + advanced: True + helpLink: redis.html + databases: + description: Total amount of databases. + global: True + advanced: True + helpLink: redis.html + always-show-logo: + description: The amount of time that a write will wait before fsyncing. + global: True + advanced: True + helpLink: redis.html + save: + 900: + description: Set the amount of keys that need to change to save after 15 minutes. + global: True + helpLink: redis.html + 300: + description: Set the amount of keys that need to change to save after 5 minutes. + global: True + helpLink: redis.html + 60: + description: Set the amount of keys that need to change to save after 1 minute + global: True + helpLink: redis.html + stop-writes-on-bgsave-error: + description: Stop writes to redis is there is an error with the save. + global: True + advanced: True + helpLink: redis.html + rdbcompression: + description: Compress string objects with LZF. + global: True + advanced: True + helpLink: redis.html + rdbchecksum: + description: Enable checksum of rdb files. + global: True + advanced: True + helpLink: redis.html + dbfilename: + description: Filename of the rdb saves. + global: True + advanced: True + helpLink: redis.html + acllog-max-len: + description: Maximum length of the ACL log. + global: True + advanced: True + helpLink: redis.html + maxmemory: + description: Maximum memory for storing redis objects. + global: True + helpLink: redis.html + maxmemory-policy: + description: The policy to use when maxmemory is reached. + global: True + helpLink: redis.html + maxmemory-samples: + description: maxmemory sample size. + global: True + advanced: True + helpLink: redis.html + lua-time-limit: + description: Maximum execution time of LUA scripts. + global: True + advanced: True + helpLink: redis.html + slowlog-log-slower-than: + description: Time in microseconds to write to the slow log. + global: True + advanced: True + helpLink: redis.html + slowlog-max-len: + description: Maximum size of the slow log. + global: True + advanced: True + helpLink: redis.html + hash-max-ziplist-entries: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + hash-max-ziplist-value: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + list-max-ziplist-size: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + list-compress-depth: + description: Depth for list compression. + global: True + advanced: True + helpLink: redis.html + set-max-intset-entries: + description: Sets the limit on the size of the set in order to use the special memory saving encoding. + global: True + advanced: True + helpLink: redis.html + zset-max-ziplist-entries: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + zset-max-ziplist-value: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + hll-sparse-max-bytes: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + stream-node-max-bytes: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + stream-node-max-entries: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + activerehashing: 'yes' + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + client-output-buffer-limit: + normal: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + replica: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + pubsub: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + hz: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + dynamic-hz: + description: Used for advanced performance tuning of Redis. + global: True + advanced: True + helpLink: redis.html + rdb-save-incremental-fsync: + description: fsync redis data. + global: True + advanced: True + helpLink: redis.html + jemalloc-bg-thread: + description: Jemalloc background thread for purging. + global: True + advanced: True + helpLink: redis.html From a2d0de7e495b81e8317f85130618bf8227798e5d Mon Sep 17 00:00:00 2001 From: m0duspwnens Date: Tue, 20 Dec 2022 12:15:33 -0500 Subject: [PATCH 18/31] kratos config jinja --- salt/kratos/defaults.yaml | 57 ++++++++++++++++++++++++ salt/kratos/files/kratos.yaml | 68 ----------------------------- salt/kratos/files/kratos.yaml.jinja | 14 ++++++ setup/so-functions | 8 ++-- 4 files changed, 75 insertions(+), 72 deletions(-) create mode 100644 salt/kratos/defaults.yaml delete mode 100644 salt/kratos/files/kratos.yaml create mode 100644 salt/kratos/files/kratos.yaml.jinja diff --git a/salt/kratos/defaults.yaml b/salt/kratos/defaults.yaml new file mode 100644 index 000000000..2e5fa1f7d --- /dev/null +++ b/salt/kratos/defaults.yaml @@ -0,0 +1,57 @@ +kratos: + config: + session: + lifespan: 24h + whoami: + required_aal: highest_available + selfservice: + methods: + password: + enabled: true + config: + haveibeenpwned_enabled: false + totp: + enabled: true + config: + issuer: Security Onion + flows: + settings: + ui_url: https://URL_BASE/?r=/settings + required_aal: highest_available + + verification: + ui_url: https://URL_BASE/ + + login: + ui_url: https://URL_BASE/login/ + + error: + ui_url: https://URL_BASE/login/ + + registration: + ui_url: https://URL_BASE/login/ + + default_browser_return_url: https://URL_BASE/ + allowed_return_urls: + - http://127.0.0.1 + log: + level: debug + format: json + secrets: + default: [] + serve: + public: + base_url: https://URL_BASE/auth/ + admin: + base_url: https://URL_BASE/kratos/ + hashers: + bcrypt: + cost: 12 + identity: + default_schema_id: default + schemas: + - id: default + url: file:///kratos-conf/schema.json + courier: + smtp: + connection_uri: smtps://URL_BASE:25 diff --git a/salt/kratos/files/kratos.yaml b/salt/kratos/files/kratos.yaml deleted file mode 100644 index 650c8c752..000000000 --- a/salt/kratos/files/kratos.yaml +++ /dev/null @@ -1,68 +0,0 @@ -{%- set KRATOSKEY = salt['pillar.get']('kratos:kratoskey', '') -%} -{%- set SESSIONTIMEOUT = salt['pillar.get']('kratos:sessiontimeout', '') -%} -{%- set MFA_ISSUER = salt['pillar.get']('kratos:mfa_issuer', '') -%} - -session: - lifespan: {{ SESSIONTIMEOUT }} - whoami: - required_aal: highest_available - -selfservice: - methods: - password: - enabled: true - config: - haveibeenpwned_enabled: false - totp: - enabled: true - config: - issuer: {{ MFA_ISSUER }} - - flows: - settings: - ui_url: https://{{ GLOBALS.url_base }}/?r=/settings - required_aal: highest_available - - verification: - ui_url: https://{{ GLOBALS.url_base }}/ - - login: - ui_url: https://{{ GLOBALS.url_base }}/login/ - - error: - ui_url: https://{{ GLOBALS.url_base }}/login/ - - registration: - ui_url: https://{{ GLOBALS.url_base }}/login/ - - default_browser_return_url: https://{{ GLOBALS.url_base }}/ - allowed_return_urls: - - http://127.0.0.1 - -log: - level: debug - format: json - -secrets: - default: - - {{ KRATOSKEY }} - -serve: - public: - base_url: https://{{ GLOBALS.url_base }}/auth/ - admin: - base_url: https://{{ GLOBALS.url_base }}/kratos/ - -hashers: - bcrypt: - cost: 12 - -identity: - default_schema_id: default - schemas: - - id: default - url: file:///kratos-conf/schema.json - -courier: - smtp: - connection_uri: smtps://{{ GLOBALS.url_base }}:25 diff --git a/salt/kratos/files/kratos.yaml.jinja b/salt/kratos/files/kratos.yaml.jinja new file mode 100644 index 000000000..fc67a1db8 --- /dev/null +++ b/salt/kratos/files/kratos.yaml.jinja @@ -0,0 +1,14 @@ +{%- import_yaml 'kratos/defaults.yaml' as KRATOSDEFAULTS %} + +{%- do KRATOSDEFAULTS.kratos.config.selfservice.flows.settings.update({'ui_url': KRATOSDEFAULTS.kratos.config.selfservice.flows.settings.ui_url | replace("URL_BASE", GLOBALS.url_base)}) %} +{%- do KRATOSDEFAULTS.kratos.config.selfservice.flows.verification.update({'ui_url': KRATOSDEFAULTS.kratos.config.selfservice.flows.verification.ui_url | replace("URL_BASE", GLOBALS.url_base)}) %} +{%- do KRATOSDEFAULTS.kratos.config.selfservice.flows.login.update({'ui_url': KRATOSDEFAULTS.kratos.config.selfservice.flows.login.ui_url | replace("URL_BASE", GLOBALS.url_base)}) %} +{%- do KRATOSDEFAULTS.kratos.config.selfservice.flows.error.update({'ui_url': KRATOSDEFAULTS.kratos.config.selfservice.flows.error.ui_url | replace("URL_BASE", GLOBALS.url_base)}) %} +{%- do KRATOSDEFAULTS.kratos.config.selfservice.flows.registration.update({'ui_url': KRATOSDEFAULTS.kratos.config.selfservice.flows.registration.ui_url | replace("URL_BASE", GLOBALS.url_base)}) %} +{%- do KRATOSDEFAULTS.kratos.config.selfservice.update({'default_browser_return_url': KRATOSDEFAULTS.kratos.config.selfservice.default_browser_return_url | replace("URL_BASE", GLOBALS.url_base)}) %} +{%- do KRATOSDEFAULTS.kratos.config.serve.public.update({'base_url': KRATOSDEFAULTS.kratos.config.serve.public.base_url | replace("URL_BASE", GLOBALS.url_base)}) %} +{%- do KRATOSDEFAULTS.kratos.config.serve.admin.update({'base_url': KRATOSDEFAULTS.kratos.config.serve.admin.base_url | replace("URL_BASE", GLOBALS.url_base)}) %} +{%- do KRATOSDEFAULTS.kratos.config.courier.smtp.update({'connection_uri': KRATOSDEFAULTS.kratos.config.courier.smtp.connection_uri | replace("URL_BASE", GLOBALS.url_base)}) %} +{%- set KRATOSMERGED = salt['pillar.get']('kratos:config', default=KRATOSDEFAULTS.kratos.config, merge=true) %} + +{{- KRATOSMERGED | yaml(false) }} diff --git a/setup/so-functions b/setup/so-functions index db7c21997..adbb17d5d 100755 --- a/setup/so-functions +++ b/setup/so-functions @@ -1383,11 +1383,11 @@ kratos_pillar() { touch $adv_kratos_pillar_file printf '%s\n'\ "kratos:"\ - " kratoskey: '$KRATOSKEY'"\ - " sessiontimeout: '24h'"\ - " mfa_issuer: 'Security Onion'"\ + " config:"\ + " secrets:"\ + " default:"\ + " - '$KRATOSKEY'"\ "" > "$kratos_pillar_file" -} create_global() { title "Creating the global.sls" From 13e5fa7544cc0087411864ad4f07e1c4f92621d9 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Tue, 20 Dec 2022 13:30:51 -0500 Subject: [PATCH 19/31] SOC files for Kratos --- salt/kratos/soc_kratos.yaml | 143 ++++++++++++++++++++++++++++++++++++ 1 file changed, 143 insertions(+) create mode 100644 salt/kratos/soc_kratos.yaml diff --git a/salt/kratos/soc_kratos.yaml b/salt/kratos/soc_kratos.yaml new file mode 100644 index 000000000..e98e7ff67 --- /dev/null +++ b/salt/kratos/soc_kratos.yaml @@ -0,0 +1,143 @@ +kratos: + config: + session: + lifespan: + description: Defines the length of a login session. + global: True + helpLink: kratos.html + whoami: + required_aal: + description: Sets the Authenticator Assurance Level. + global: True + advanced: True + helpLink: kratos.html + selfservice: + methods: + password: + enabled: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + config: + haveibeenpwned_enabled: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + totp: + enabled: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + config: + issuer: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + flows: + settings: + ui_url: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + required_aal: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + verification: + ui_url: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + login: + ui_url: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + error: + ui_url: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + registration: + ui_url: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + default_browser_return_url: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + allowed_return_urls: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + log: + level: + description: Log level to use for Kratos logs. + global: True + helpLink: kratos.html + format: + description: Log output format for Kratos logs. + global: True + helpLink: kratos.html + secrets: + default: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + serve: + public: + base_url: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + admin: + base_url: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + hashers: + bcrypt: + cost: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + identity: + default_schema_id: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + schemas: + description: + global: True + advanced: True + helpLink: kratos.html + url: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html + courier: + smtp: + connection_uri: + description: The IP address to bind to. + global: True + advanced: True + helpLink: kratos.html From 2edc3cac110c2cb61c49d25a5eebbe6b7fea41f4 Mon Sep 17 00:00:00 2001 From: Jason Ertel Date: Tue, 20 Dec 2022 14:08:49 -0500 Subject: [PATCH 20/31] Clarify Kratos annotations --- salt/kratos/soc_kratos.yaml | 53 +++++++++++++------------------------ 1 file changed, 19 insertions(+), 34 deletions(-) diff --git a/salt/kratos/soc_kratos.yaml b/salt/kratos/soc_kratos.yaml index e98e7ff67..e26d865fb 100644 --- a/salt/kratos/soc_kratos.yaml +++ b/salt/kratos/soc_kratos.yaml @@ -7,7 +7,7 @@ kratos: helpLink: kratos.html whoami: required_aal: - description: Sets the Authenticator Assurance Level. + description: Sets the Authenticator Assurance Level. Leave as default to ensure proper security protections remain in place. global: True advanced: True helpLink: kratos.html @@ -15,71 +15,71 @@ kratos: methods: password: enabled: - description: The IP address to bind to. + description: Set to True to enable traditional password authentication. Leave as default to ensure proper security protections remain in place. global: True advanced: True helpLink: kratos.html config: haveibeenpwned_enabled: - description: The IP address to bind to. + description: Set to True to check if a newly chosen password has ever been found in a published list of previously-compromised passwords. Requires outbound Internet connectivity when enabled. global: True advanced: True helpLink: kratos.html totp: enabled: - description: The IP address to bind to. + description: Set to True to enable Time-based One-Time Password (TOTP) MFA authentication. Leave as default to ensure proper security protections remain in place. global: True advanced: True helpLink: kratos.html config: issuer: - description: The IP address to bind to. + description: The name to show in the MFA authenticator app. Useful for differentiating between installations that share the same user email address. global: True advanced: True helpLink: kratos.html flows: settings: ui_url: - description: The IP address to bind to. + description: User accessible URL containing the user self-service profile and security settings. Leave as default to ensure proper operation. global: True advanced: True helpLink: kratos.html required_aal: - description: The IP address to bind to. + description: Sets the Authenticator Assurance Level for accessing user self-service profile and security settings. Leave as default to ensure proper security enforcement remains in place. global: True advanced: True helpLink: kratos.html verification: ui_url: - description: The IP address to bind to. + description: User accessible URL containing the Security Onion login page. Leave as default to ensure proper operation. global: True advanced: True helpLink: kratos.html login: ui_url: - description: The IP address to bind to. + description: User accessible URL containing the Security Onion login page. Leave as default to ensure proper operation. global: True advanced: True helpLink: kratos.html error: ui_url: - description: The IP address to bind to. + description: User accessible URL containing the Security Onion login page. Leave as default to ensure proper operation. global: True advanced: True helpLink: kratos.html registration: ui_url: - description: The IP address to bind to. + description: User accessible URL containing the Security Onion login page. Leave as default to ensure proper operation. global: True advanced: True helpLink: kratos.html default_browser_return_url: - description: The IP address to bind to. + description: Security Onion Console landing page URL. Leave as default to ensure proper operation. global: True advanced: True helpLink: kratos.html allowed_return_urls: - description: The IP address to bind to. + description: Internal redirect URL. Leave as default to ensure proper operation. global: True advanced: True helpLink: kratos.html @@ -94,50 +94,35 @@ kratos: helpLink: kratos.html secrets: default: - description: The IP address to bind to. + description: Secret key used for protecting session cookie data. Generated during installation. global: True + sensitive: True advanced: True helpLink: kratos.html serve: public: base_url: - description: The IP address to bind to. + description: User accessible URL for authenticating to Kratos. Leave as default for proper operation. global: True advanced: True helpLink: kratos.html admin: base_url: - description: The IP address to bind to. + description: User accessible URL for accessing Kratos administration API. Leave as default for proper operation. global: True advanced: True helpLink: kratos.html hashers: bcrypt: cost: - description: The IP address to bind to. + description: Bcrypt hashing algorithm cost. Higher values consume more CPU and take longer to complete. Actual cost is computed as 2^X where X is the value in this setting. global: True advanced: True helpLink: kratos.html - identity: - default_schema_id: - description: The IP address to bind to. - global: True - advanced: True - helpLink: kratos.html - schemas: - description: - global: True - advanced: True - helpLink: kratos.html - url: - description: The IP address to bind to. - global: True - advanced: True - helpLink: kratos.html courier: smtp: connection_uri: - description: The IP address to bind to. + description: SMTPS URL for sending outbound account-related emails. Not utilized with the standard Security Onion installation. global: True advanced: True helpLink: kratos.html From eaa705ee3e0330e53b1831e66c56a8c320fc038f Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Tue, 20 Dec 2022 14:38:17 -0500 Subject: [PATCH 21/31] Fix Kratos Pillar entry --- setup/so-functions | 1 + 1 file changed, 1 insertion(+) diff --git a/setup/so-functions b/setup/so-functions index adbb17d5d..6447a7ded 100755 --- a/setup/so-functions +++ b/setup/so-functions @@ -1388,6 +1388,7 @@ kratos_pillar() { " default:"\ " - '$KRATOSKEY'"\ "" > "$kratos_pillar_file" +} create_global() { title "Creating the global.sls" From 16b882a10e076ae47303ef66f5e0bfb0a098f183 Mon Sep 17 00:00:00 2001 From: m0duspwnens Date: Tue, 20 Dec 2022 15:34:10 -0500 Subject: [PATCH 22/31] new states for kratos config and schema --- salt/kratos/init.sls | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/salt/kratos/init.sls b/salt/kratos/init.sls index 3f8503390..5e411240a 100644 --- a/salt/kratos/init.sls +++ b/salt/kratos/init.sls @@ -43,10 +43,18 @@ kratoslogdir: - group: 928 - makedirs: True -kratossync: +kratosschema: file.recurse: - - name: /opt/so/conf/kratos - - source: salt://kratos/files + - name: /opt/so/conf/kratos/schema.json + - source: salt://kratos/files/schema.json + - user: 928 + - group: 928 + - file_mode: 600 + +kratosconfig: + file.managed: + - name: /opt/so/conf/kratos/kratos.yaml + - source: salt://kratos/files/kratos.yaml.jinja - user: 928 - group: 928 - file_mode: 600 @@ -54,14 +62,6 @@ kratossync: - defaults: GLOBALS: {{ GLOBALS }} -kratos_schema: - file.exists: - - name: /opt/so/conf/kratos/schema.json - -kratos_yaml: - file.exists: - - name: /opt/so/conf/kratos/kratos.yaml - so-kratos: docker_container.running: - image: {{ GLOBALS.registry_host }}:5000/{{ GLOBALS.image_repo }}/so-kratos:{{ GLOBALS.so_version }} @@ -77,10 +77,11 @@ so-kratos: - 0.0.0.0:4434:4434 - restart_policy: unless-stopped - watch: - - file: /opt/so/conf/kratos + - file: kratosschema + - file: kratosconfig - require: - - file: kratos_schema - - file: kratos_yaml + - file: kratosschema + - file: kratosconfig - file: kratoslogdir - file: kratosdir From 318aac880e25cc98381689604b5773647019415e Mon Sep 17 00:00:00 2001 From: m0duspwnens Date: Tue, 20 Dec 2022 17:40:29 -0500 Subject: [PATCH 23/31] file.managed for kratos schema --- salt/kratos/init.sls | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salt/kratos/init.sls b/salt/kratos/init.sls index 5e411240a..3df6d86e7 100644 --- a/salt/kratos/init.sls +++ b/salt/kratos/init.sls @@ -44,7 +44,7 @@ kratoslogdir: - makedirs: True kratosschema: - file.recurse: + file.managed: - name: /opt/so/conf/kratos/schema.json - source: salt://kratos/files/schema.json - user: 928 From c3917a373ca6cbff3f25d5c829c76d583924ba7a Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Tue, 20 Dec 2022 20:52:01 -0500 Subject: [PATCH 24/31] Fix Kratos top --- pillar/top.sls | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/pillar/top.sls b/pillar/top.sls index bdcae9b79..002d8cbef 100644 --- a/pillar/top.sls +++ b/pillar/top.sls @@ -14,7 +14,7 @@ base: '* and not *_eval and not *_import': - logstash.nodes - '*_eval or *_helixsensor or *_heavynode or *_sensor or *_standalone or *_import': + '*_eval or *_heavynode or *_sensor or *_standalone or *_import': - match: compound - zeek @@ -45,6 +45,8 @@ base: - manager.adv_manager - soc.soc_soc - soc.adv_soc + - kratos.soc_kratos + - kratos.adv_kratos - redis.soc_telegraf - redis.adv_telegraf - influxdb.soc_telegraf @@ -96,6 +98,11 @@ base: - healthcheck.standalone - soc_global - kratos.soc_kratos + - kratos.adv_kratos + - redis.soc_telegraf + - redis.adv_telegraf + - influxdb.soc_telegraf + - influxdb.adv_telegraf - elasticsearch.soc_elasticsearch - manager.soc_manager - soc.soc_soc From 90061e26838893866988ff378864f769109133bf Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Tue, 20 Dec 2022 20:54:43 -0500 Subject: [PATCH 25/31] Fix Kratos top --- pillar/top.sls | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pillar/top.sls b/pillar/top.sls index 002d8cbef..b2569d752 100644 --- a/pillar/top.sls +++ b/pillar/top.sls @@ -99,10 +99,10 @@ base: - soc_global - kratos.soc_kratos - kratos.adv_kratos - - redis.soc_telegraf - - redis.adv_telegraf - - influxdb.soc_telegraf - - influxdb.adv_telegraf + - redis.soc_redis + - redis.adv_redis + - influxdb.soc_influxdb + - influxdb.adv_influxdb - elasticsearch.soc_elasticsearch - manager.soc_manager - soc.soc_soc From 9428949c79a41b3f61278122e904e2d847bb4af5 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Tue, 20 Dec 2022 20:56:06 -0500 Subject: [PATCH 26/31] Fix Kratos top --- pillar/top.sls | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/pillar/top.sls b/pillar/top.sls index b2569d752..717892847 100644 --- a/pillar/top.sls +++ b/pillar/top.sls @@ -47,10 +47,10 @@ base: - soc.adv_soc - kratos.soc_kratos - kratos.adv_kratos - - redis.soc_telegraf - - redis.adv_telegraf - - influxdb.soc_telegraf - - influxdb.adv_telegraf + - redis.soc_redis + - redis.adv_redis + - influxdb.soc_influxdb + - influxdb.adv_influxdb - backup.soc_backup - backup.adv_backup - minions.{{ grains.id }} @@ -77,6 +77,12 @@ base: - elasticsearch.soc_elasticsearch - manager.soc_manager - soc.soc_soc + - kratos.soc_kratos + - kratos.adv_kratos + - redis.soc_redis + - redis.adv_redis + - influxdb.soc_influxdb + - influxdb.adv_influxdb - backup.soc_backup - backup.adv_backup - minions.{{ grains.id }} From 8c6a2ce83ab0fdbfb3789a3eb873108d90206916 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Tue, 20 Dec 2022 21:00:06 -0500 Subject: [PATCH 27/31] Fix Kratos mode --- salt/kratos/init.sls | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/salt/kratos/init.sls b/salt/kratos/init.sls index 3df6d86e7..2dbb46d35 100644 --- a/salt/kratos/init.sls +++ b/salt/kratos/init.sls @@ -49,7 +49,7 @@ kratosschema: - source: salt://kratos/files/schema.json - user: 928 - group: 928 - - file_mode: 600 + - mode: 600 kratosconfig: file.managed: @@ -57,7 +57,7 @@ kratosconfig: - source: salt://kratos/files/kratos.yaml.jinja - user: 928 - group: 928 - - file_mode: 600 + - mode: 600 - template: jinja - defaults: GLOBALS: {{ GLOBALS }} From 3768c0fee23f4bf30d2bd123e0de408d4f2600c3 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Tue, 20 Dec 2022 21:16:53 -0500 Subject: [PATCH 28/31] Fix Redis --- salt/redis/defaults.yaml | 2 -- salt/redis/soc_redis.yaml | 10 ---------- 2 files changed, 12 deletions(-) diff --git a/salt/redis/defaults.yaml b/salt/redis/defaults.yaml index 987406cf6..7e2d493e4 100644 --- a/salt/redis/defaults.yaml +++ b/salt/redis/defaults.yaml @@ -14,8 +14,6 @@ redis: tls-replication: 'no' tls-cluster: 'no' tls-protocols: '"TLSv1.2 TLSv1.3"' - tls-ciphers: 'DEFAULT:!MEDIUM' - tls-ciphersuites: 'TLS_CHACHA20_POLY1305_SHA256' tls-prefer-server-ciphers: 'yes' tls-session-caching: 'yes' tls-session-cache-size: 20480 diff --git a/salt/redis/soc_redis.yaml b/salt/redis/soc_redis.yaml index 59f397994..8e351ebae 100644 --- a/salt/redis/soc_redis.yaml +++ b/salt/redis/soc_redis.yaml @@ -63,16 +63,6 @@ redis: global: True advanced: True helpLink: redis.html - tls-ciphers: - description: Allowed ciphers. - global: True - advanced: True - helpLink: redis.html - tls-ciphersuites: - description: Acceptable cipher suites. - global: True - advanced: True - helpLink: redis.html tls-prefer-server-ciphers: description: Prefer the server side ciphers. global: True From 38e23a01100df0ba2c5d53cf7332eb3e3dfa510b Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Tue, 20 Dec 2022 21:21:18 -0500 Subject: [PATCH 29/31] Modify Kratos config defaults --- salt/kratos/defaults.yaml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/salt/kratos/defaults.yaml b/salt/kratos/defaults.yaml index 2e5fa1f7d..bcb166772 100644 --- a/salt/kratos/defaults.yaml +++ b/salt/kratos/defaults.yaml @@ -18,19 +18,14 @@ kratos: settings: ui_url: https://URL_BASE/?r=/settings required_aal: highest_available - verification: ui_url: https://URL_BASE/ - login: ui_url: https://URL_BASE/login/ - error: ui_url: https://URL_BASE/login/ - registration: ui_url: https://URL_BASE/login/ - default_browser_return_url: https://URL_BASE/ allowed_return_urls: - http://127.0.0.1 From e1d0f99a14d3f16fde03ffed8a6771435c33d76a Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Tue, 20 Dec 2022 22:00:10 -0500 Subject: [PATCH 30/31] Modify redis config defaults --- salt/kratos/soc_kratos.yaml | 2 +- salt/redis/defaults.yaml | 4 ++-- salt/redis/soc_redis.yaml | 36 ++++++++++++++++++------------------ 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/salt/kratos/soc_kratos.yaml b/salt/kratos/soc_kratos.yaml index e26d865fb..e3b88e28f 100644 --- a/salt/kratos/soc_kratos.yaml +++ b/salt/kratos/soc_kratos.yaml @@ -61,7 +61,7 @@ kratos: global: True advanced: True helpLink: kratos.html - error: + error: ui_url: description: User accessible URL containing the Security Onion login page. Leave as default to ensure proper operation. global: True diff --git a/salt/redis/defaults.yaml b/salt/redis/defaults.yaml index 7e2d493e4..252082901 100644 --- a/salt/redis/defaults.yaml +++ b/salt/redis/defaults.yaml @@ -31,13 +31,13 @@ redis: save: 900: 1 300: 10 - 60: 1000 + 60: 1000 stop-writes-on-bgsave-error: 'yes' rdbcompression: 'yes' rdbchecksum: 'yes' dbfilename: 'dump.rdb' rdb-del-sync-files: 'no' - dir: './' + dir: './' replica-serve-stale-data: 'yes' replica-read-only: 'yes' repl-diskless-sync: 'no' diff --git a/salt/redis/soc_redis.yaml b/salt/redis/soc_redis.yaml index 8e351ebae..dad76bf80 100644 --- a/salt/redis/soc_redis.yaml +++ b/salt/redis/soc_redis.yaml @@ -128,33 +128,33 @@ redis: 60: description: Set the amount of keys that need to change to save after 1 minute global: True - helpLink: redis.html + helpLink: redis.html stop-writes-on-bgsave-error: description: Stop writes to redis is there is an error with the save. global: True advanced: True helpLink: redis.html - rdbcompression: + rdbcompression: description: Compress string objects with LZF. global: True advanced: True helpLink: redis.html - rdbchecksum: + rdbchecksum: description: Enable checksum of rdb files. global: True advanced: True helpLink: redis.html - dbfilename: + dbfilename: description: Filename of the rdb saves. global: True advanced: True helpLink: redis.html - acllog-max-len: + acllog-max-len: description: Maximum length of the ACL log. global: True advanced: True helpLink: redis.html - maxmemory: + maxmemory: description: Maximum memory for storing redis objects. global: True helpLink: redis.html @@ -162,42 +162,42 @@ redis: description: The policy to use when maxmemory is reached. global: True helpLink: redis.html - maxmemory-samples: + maxmemory-samples: description: maxmemory sample size. global: True advanced: True helpLink: redis.html - lua-time-limit: + lua-time-limit: description: Maximum execution time of LUA scripts. global: True advanced: True helpLink: redis.html - slowlog-log-slower-than: + slowlog-log-slower-than: description: Time in microseconds to write to the slow log. global: True advanced: True helpLink: redis.html - slowlog-max-len: + slowlog-max-len: description: Maximum size of the slow log. global: True advanced: True helpLink: redis.html - hash-max-ziplist-entries: + hash-max-ziplist-entries: description: Used for advanced performance tuning of Redis. global: True advanced: True helpLink: redis.html - hash-max-ziplist-value: + hash-max-ziplist-value: description: Used for advanced performance tuning of Redis. global: True advanced: True helpLink: redis.html - list-max-ziplist-size: + list-max-ziplist-size: description: Used for advanced performance tuning of Redis. global: True advanced: True helpLink: redis.html - list-compress-depth: + list-compress-depth: description: Depth for list compression. global: True advanced: True @@ -232,7 +232,7 @@ redis: global: True advanced: True helpLink: redis.html - activerehashing: 'yes' + activerehashing: description: Used for advanced performance tuning of Redis. global: True advanced: True @@ -243,7 +243,7 @@ redis: global: True advanced: True helpLink: redis.html - replica: + replica: description: Used for advanced performance tuning of Redis. global: True advanced: True @@ -258,7 +258,7 @@ redis: global: True advanced: True helpLink: redis.html - dynamic-hz: + dynamic-hz: description: Used for advanced performance tuning of Redis. global: True advanced: True @@ -268,7 +268,7 @@ redis: global: True advanced: True helpLink: redis.html - jemalloc-bg-thread: + jemalloc-bg-thread: description: Jemalloc background thread for purging. global: True advanced: True From aa7690864aeaa1e01de450f2853b79e9e8de11b7 Mon Sep 17 00:00:00 2001 From: Mike Reeves Date: Tue, 20 Dec 2022 22:05:04 -0500 Subject: [PATCH 31/31] Modify redis config defaults --- pillar/top.sls | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pillar/top.sls b/pillar/top.sls index 717892847..1e684c682 100644 --- a/pillar/top.sls +++ b/pillar/top.sls @@ -167,6 +167,12 @@ base: - manager.soc_manager - backup.soc_backup - backup.adv_backup + - kratos.soc_kratos + - kratos.adv_kratos + - redis.soc_redis + - redis.adv_redis + - influxdb.soc_influxdb + - influxdb.adv_influxdb - minions.{{ grains.id }} - minions.adv_{{ grains.id }}