Tarantool Enterprise Manual Release 1.10.4-1
Total Page:16
File Type:pdf, Size:1020Kb
Tarantool Enterprise manual Release 1.10.4-1 Mail.Ru, Tarantool team Sep 28, 2021 Contents 1 Setup 1 1.1 System requirements.........................................1 1.2 Package contents...........................................2 1.3 Installation..............................................3 2 Developer’s guide 4 2.1 Implementing LDAP authorization in the web interface.....................5 2.2 Delivering environment-independent applications.........................5 2.3 Running sample applications....................................8 3 Cluster administrator’s guide 11 3.1 Exploring spaces........................................... 11 3.2 Upgrading in production...................................... 13 4 Security hardening guide 15 4.1 Built-in security features...................................... 15 4.2 Recommendations on security hardening............................. 17 5 Security audit 18 5.1 Encryption of external iproto traffic................................ 18 5.2 Closed iproto ports......................................... 18 5.3 HTTPS connection termination.................................. 18 5.4 Closed HTTP ports......................................... 19 5.5 Restricted access to the administrative console.......................... 19 5.6 Limiting the guest user....................................... 19 5.7 Authorization in the web UI.................................... 19 5.8 Running under the tarantool user................................. 20 5.9 Limiting access to the tarantool user................................ 20 5.10 Keeping two or more snapshots................................... 20 5.11 Enabled write-ahead logging (WAL)................................ 20 5.12 The logging level is INFO or higher................................ 20 5.13 Logging with journald........................................ 21 6 Modules reference 22 6.1 ldap.................................................. 22 6.2 task.................................................. 23 6.3 tracing................................................ 33 i 6.4 ODBC connector for Tarantool................................... 62 6.5 oracle................................................. 73 6.6 space-explorer............................................ 83 6.7 Open source modules........................................ 84 6.8 Closed source modules........................................ 84 6.9 Installing and using modules.................................... 85 7 Appendixes 86 7.1 Appendix A. Audit log....................................... 86 7.2 Appendix B. Useful Tarantool parameters............................. 88 7.3 Appendix C. Monitoring system metrics.............................. 89 7.4 Appendix D. Deprecated features................................. 90 7.5 Appendix E. Orchestrator API reference............................. 92 8 Changelog 106 8.1 Versioning Policy.......................................... 106 8.2 r422.................................................. 106 8.3 r421.................................................. 106 8.4 r419.................................................. 107 8.5 r418.................................................. 107 8.6 r417.................................................. 107 8.7 r416.................................................. 107 8.8 r415.................................................. 107 8.9 r414.................................................. 107 8.10 r413.................................................. 108 8.11 r412.................................................. 108 8.12 r411.................................................. 108 8.13 r410.................................................. 108 8.14 r409.................................................. 108 8.15 r408.................................................. 108 8.16 r407.................................................. 108 8.17 r406.................................................. 108 8.18 r405.................................................. 109 8.19 r404.................................................. 109 8.20 r403.................................................. 109 8.21 r402.................................................. 109 8.22 r401.................................................. 109 8.23 r400.................................................. 109 8.24 r399.................................................. 110 8.25 r398.................................................. 110 8.26 r397.................................................. 110 8.27 r396.................................................. 110 8.28 r395.................................................. 110 8.29 r394.................................................. 110 8.30 r392.................................................. 110 8.31 r391.................................................. 110 8.32 r390.................................................. 111 8.33 r389.................................................. 111 8.34 r388.................................................. 111 8.35 r387.................................................. 111 8.36 r386.................................................. 111 8.37 r385.................................................. 111 8.38 r384.................................................. 111 8.39 r383.................................................. 111 ii 8.40 r382.................................................. 112 8.41 r381.................................................. 112 8.42 r380.................................................. 112 8.43 r376.................................................. 112 8.44 r375.................................................. 112 8.45 r372.................................................. 112 8.46 r371.................................................. 112 8.47 r370.................................................. 113 8.48 r369.................................................. 113 8.49 r368.................................................. 113 8.50 r366.................................................. 113 8.51 r363.................................................. 113 8.52 r360.................................................. 113 8.53 1.10.6-16, 2.2.2-56, 2.3.1-143 and 2.4.2-8.............................. 113 8.54 1.10.5-12 / 2.1.3-1 / 2.2.2-3..................................... 115 8.55 1.10.4-1 / 2.1.2-109......................................... 115 8.56 1.10.3-71 / 2.1.2-63......................................... 117 8.57 1.10.3-29 / 2.1.2-21......................................... 117 8.58 1.10.3-5................................................ 118 8.59 1.10.2-41............................................... 118 8.60 1.10.2-15............................................... 119 8.61 1.10.2-4................................................ 119 8.62 1.10.1-29............................................... 119 8.63 1.10.1................................................. 119 Python Module Index 121 iii CHAPTER 1 Setup This chapter explains how to download and set up Tarantool Enterprise and run a sample application provided with it. 1.1 System requirements The recommended system requirements for running Tarantool Enterprise are as follows. 1.1.1 Hardware requirements To fully ensure the fault tolerance of a distributed data storage system, at least three physical computers or virtual servers are required. For testing/development purposes, the system can be deployed using a smaller number of servers; however, it is not recommended to use such configurations for production. 1.1.2 Software requirements 1. As host operating systems, Tarantool Enterprise supports Red Hat Enterprise Linux and CentOS versions 7.5 and higher. Note: Tarantool Enterprise can run on other systemd-based Linux distributions but it is not tested on them and may not work as expected. 2. glibc 2.17-260.el7_6.6 and higher is required. Take care to check and update, if needed: $ rpm -q glibc glibc-2.17-196.el7_4.2 $ yum update glibc 1 Tarantool Enterprise manual, Release 1.10.4-1 1.1.3 Network requirements Hereinafter, “storage servers” or “Tarantool servers” are the computers used to store and process data, and “administration server” is the computer used by the system operator to install and configure the product. The Tarantool cluster has a full mesh topology, therefore all Tarantool servers should be able to commu- nicate and send traffic from and to TCP/UDP ports used by the cluster’s instances (see advertise_uri: <host>:<port> and config: advertise_uri: '<host>:<port>' in /etc/tarantool/conf.d/*.yml for each in- stance). For example: # /etc/tarantool/conf.d/*.yml myapp.s2-replica: advertise_uri: localhost:3305 # this is a TCP/UDP port http_port: 8085 all: ... hosts: storage-1: config: advertise_uri: 'vm1:3301' # this is a TCP/UDP port http_port: 8081 To configure remote monitoring or to connect via the administrative console, the administration server should be able to access the following TCP ports on Tarantool servers: • 22 to use the SSH protocol, • ports specified in instance configuration (http_port parameter) to monitor the HTTP-metrics. Additionally, it is recommended to apply the following settings for sysctl on all Tarantool servers: $ # TCP KeepAlive setting $ sysctl -w net.ipv4.tcp_keepalive_time=60 $ sysctl -w net.ipv4.tcp_keepalive_intvl=5 $ sysctl -w net.ipv4.tcp_keepalive_probes=5 This optional setup of the Linux network stack helps speed up the troubleshooting of network connectivity when the server physically fails. To achieve the maximum performance, you may also need