Run a box.cfg application¶
An application that configures Tarantool with box.cfg in its own script,
as the init.lua and <instance>.init.lua applications of tt 2.x did, runs
as records with script: Tarantool instances configured by their script
rather than by the cluster config. Such an application needs no
config.yaml.
Describe the instances¶
.templates/default/instances.yaml:
legacy-001:
script: init.lua # relative to the application directory
env: {TT_MEMTX_MEMORY: "268435456"}
init.lua:
box.cfg{}
box.schema.space.create('kv', {if_not_exists = true})
$ tt instance start
$ tt instance status
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
legacy:legacy-001 RUNNING 1330686 RW -- running --
$ echo "return box.cfg.memtx_memory" | tt connect legacy:legacy-001 -f-
---
- 268435456
...
Where the instance keeps its files¶
Tarantool runs the script in the application directory. box.cfg takes the
options the script does not pass from the environment, and tt sets the ones
of the layout there:
TT_WAL_DIR,TT_MEMTX_DIRandTT_VINYL_DIR: the data directory,<root>/var/lib/<app>/<instance>/;TT_LISTEN: the unix sockettarantool.sockin the run directory, unlessTT_LISTENis set in the environment of tt.
The console socket is tarantool.control in the run directory, and the
output goes to tt.log. env of the record goes on top and may move the
data with the same variables; in the user and system scopes a relative path
there is refused.
A relative path the script passes to box.cfg itself, tt cannot check. In
the user and system scopes it is resolved against the installed version, so
the instance writes into the version, which an upgrade replaces: let the
script take the paths from the environment.
What works on it¶
tt connect,tt data play,tt instance statusandtt instance logrotatework as with any Tarantool instance. The CONFIG column of the status is--: the script does not use the cluster config.tt instance checkchecks the syntax of the script.tt instance cleanremoves its data and log.tt cluster showandtt cluster publishrefuse it: no cluster config configures it.- The application targets of
tt replicasetleave it out when the application has instances of the cluster config too. An application of script instances alone keeps them, andtt replicasetacts on it with the custom orchestrator without--custom;--configand--customstill force an orchestrator.
See also Migrate from tt 2.x.