teseladb start
How to use teseladb start, with its options and its examples.
Usage
teseladb start [--dbpath <dir>] [--cores <n>] [--bind_ip <dirs>] [--port <n>] [--peer-listen <addr>] [--admin-listen <addr>] [--join <addr>] [--insecure] [--insecure-allow-remote] [--log-format text|json] [--config <fichero.yaml>]Description
Starts a node. Without --insecure, it creates or loads the PKI of the data directory, serves the client port only with TLS and asks for authentication on every command except the handshake. Once the cluster exists, it prints ready node_id=<n> cluster_id=<hex> peer=<ip:port> on standard output.
Options
| Option | Default | Description |
|---|---|---|
--dbpath | ./teseladb-data | Data directory of the node. In teseladb admin, the directory whose PKI provides the credentials. |
--cores | the logical cores | Number of cores, the same on every node. |
--bind_ip | 127.0.0.1 | Addresses of the client port, comma separated. |
--port | 27017 | Client port. With 0, the system picks one. In dev, node k listens on this port plus k. |
--peer-listen | 127.0.0.1:27100 | Address of the port between nodes. |
--admin-listen | 127.0.0.1:27200 | Address of the administration port. |
--join | Address of a cluster node to join. | |
--insecure | Starts without PKI or users, only on 127.0.0.1. For local tests only. | |
--insecure-allow-remote | With --insecure, allows listening outside 127.0.0.1. | |
--log-format | text | Format of the log, with a line of text or a JSON object per event. |
--config | YAML configuration file with the subset of mongod keys. The command line wins over the file. | |
--enroll-token | Enrolment token the node uses to join the cluster the first time. | |
--tlsMode | TLS mode of the client port, which takes requireTLS, allowTLS, preferTLS or disabled. | |
--tlsCertificateKeyFile | the PKI ones | Certificate and key in PEM. On a node, they replace the PKI ones; in admin and mcp, they are the client's. |
--tlsCAFile | the PKI one | CA in PEM. On a node, the one that verifies client certificates; in admin and mcp, the one that signed the node certificate. |
--tlsCertificateKeyFilePassword | Password of an encrypted private key. | |
--tlsCRLFile | Revocation list. The node refuses the client certificates revoked in it. | |
--tlsAllowConnectionsWithoutCertificates | false | Lets clients without a certificate in even with --tlsCAFile. |
--tlsFIPSMode | false | Restricts the algorithms to FIPS mode. |
--enableEncryption | false | Encrypts on disk everything the node stores. |
--encryptionKeyFile | File with your own encryption key. Without it, the key comes from the PKI master key. | |
--encryptionCipherMode | AES256-CBC | Algorithm of the encryption at rest, AES256-CBC or AES256-GCM. |
--kmipServerName | KMIP server that keeps the master key. | |
--kmipPort | Port of the KMIP server. | |
--kmipKeyIdentifier | Identifier of the key on the KMIP server. | |
--kmipClientCertificateFile | Client certificate for the KMIP server. | |
--kmipServerCAFile | CA of the KMIP server. | |
--kmipRotateMasterKey | Rotates the master key on the KMIP server at start. | |
--auditFormat | Format of the audit log in a file: JSON or BSON. Required with --auditDestination file. | |
--auditSchema | mongo | Schema of the audit events, mongo or OCSF. |
--auditDestination | no auditing | Destination of the audit log, which can be file, syslog or console. |
--auditPath | Audit log file with --auditDestination file. | |
--auditFilter | Filter of the audited events, shaped like MongoDB's auditLog.filter. | |
--redactClientLogData | false | Hides client data in the log. |
--ldapServers | LDAP servers for the PLAIN mechanism, with the other MongoDB LDAP options. | |
--setParameter | Sets a server parameter in the name=value form. | |
--noscripting | Turns server-side JavaScript off. Queries that use it answer with an error. | |
--cpu-list | the CPUs allowed to the process | CPUs each core thread is pinned to, in order. |
--io-executor | auto | Disk executor, which can be io_uring, I/O threads or the automatic choice. |
--direct-io | auto | Writing with O_DIRECT, which can be on, off or automatic. |
--memory-limit | 75% of the lower of physical memory and the cgroup limit | Total memory of the node. |
--auth | Accepted for compatibility. Authorization is always on except with --insecure. | |
--keyFile | Shared key file for authentication between nodes, as in MongoDB. | |
--clusterAuthMode | x509 | How nodes authenticate each other. |
--replSet | Presents the cluster as a replica set with that name. | |
--maxConns | 1,000,000 | Maximum client connections. |
--networkMessageCompressors | zstd,snappy,zlib | Message compressors the node accepts. |
--logpath | Log file. Without it, the log goes to standard error. | |
--logappend | Appends to the log file instead of replacing it. | |
--quiet | Writes less to the log. | |
--verbose | Writes more detail to the log. | |
--profile | 0 | Level of the query profiler, which can be 0, 1 or 2. |
--slowms | 100 | Milliseconds above which an operation counts as slow. |
--slowOpSampleRate | 1.0 | Fraction of slow operations that are recorded. |
--http-port | Port of the REST API and the MCP server. | |
--http-bind | that of --bind_ip | Address of the REST API and the MCP server. |
Examples
A new node
Shell
teseladb start --dbpath /var/lib/teseladbA node that joins a cluster
Shell
teseladb start --dbpath /var/lib/teseladb --join node-01:27100 --enroll-token <token>Exit codes
0The command finished correctly.1The command failed while running; the error says why.2The command was written wrongly, with an argument missing or an unknown option.