tt.manifest.toml¶
Манифест дистрибутива tt: ядро tt и
модули tt, которые tt binary build tt компилирует в один бинарный файл.
Сборка записывает рядом с ним tt.manifest.lock и tt.manifest.sum.
manifest_version = "0.1"
manifest_kind = "tt-distribution"
[package]
name = "tt"
[core]
tt = "v3.0.0-alpha.3"
[distribution]
title = "Tarantool CLI EE"
edition = "ee"
integrity = "rsa"
standard = true
exclude = ["emmylua"]
builtin = true
external_modules = true
bundle_sources = ["customer-zone", "rws", "github"]
[build]
ssl = "openssl_static"
tags = ["netgo"]
[dependencies]
probe = "../tt-probe"
foo = "github.com/acme/tt-foo@v1.2.0"
bar = { module = "github.com/acme/tools", version = "v0.3.0", package = "github.com/acme/tools/ttbar", symbol = "Commands" }
[replace]
"example.com/lib" = "./libs/lib"
"github.com/acme/lib/v2" = "github.com/acme/lib/v2@main"
Обязательны только manifest_version и manifest_kind: минимальный
манифест собирает сам tt со стандартными модулями на ядре того tt, который
запускает сборку. Неизвестное поле считается ошибкой, если только в
манифесте не объявлена более новая минорная версия manifest_version, чем
известна tt, - в этом случае выводится предупреждение. Другая мажорная
версия отвергается.
Верхний уровень¶
| Поле | Обязательно | |
|---|---|---|
manifest_version |
да | версия формата: "0.1" |
manifest_kind |
да | "tt-distribution"; манифест без него - это манифест приложения, app.manifest.toml |
[package]¶
| Поле | По умолчанию | |
|---|---|---|
name |
tt |
имя бинарного файла: буквы, цифры, ., _ и -, начинается с буквы или цифры |
[core]¶
Ядро tt, на котором собирается бинарный файл. Поля tt и path взаимоисключают друг друга.
| Поле | По умолчанию | |
|---|---|---|
tt |
версия ядра того tt, который запускает сборку | запрос версии Go для модуля ядра |
path |
локальный чекаут tt относительно каталога манифеста | |
module |
github.com/tarantool/tt/v3 |
Go-модуль ядра для форка; чекаут path должен содержать его |
tt разрешается командой go как go list -m <module>@<tt>:
- версия, например
v3.0.0-alpha.3; - хеш коммита для коммита, на который не указывает ни один тег;
latest: самый новый релиз или самый новый пре-релиз, пока релизов нет;- префикс, например
v3илиv3.1: самый новый релиз с этим префиксом. Go воспринимаетv3как префикс версии, но никогда как веткуv3, а префикс не соответствует ни одному пре-релизу: пока у tt 3 есть только пре-релизы,v3не соответствует ничему; - сравнение, например
<v3.1.0; - ветка или тег, имя которого не является версией.
Локфайл фиксирует то, во что разрешился запрос, до запуска с --update.
В любом случае лучше зафиксировать точную версию или коммит, чтобы при
--update и при сборке без локфайла бралось то, что указано в манифесте.
Без tt сборка с помощью tt, версию которого Go не может загрузить
(сборка для разработки), завершается с ошибкой: укажите tt или path.
Флаг --core и переменная TT_DIST_CORE переопределяют секцию [core] на
одну сборку (см.
Сборка на другом ядре).
[distribution]¶
Как бинарный файл представляет себя и что в нём есть помимо модулей.
| Поле | По умолчанию | |
|---|---|---|
title |
Tarantool CLI |
имя, под которым бинарный файл представляет себя в справке и в tt version |
edition |
нет | метаданные сборки semver после короткой версии: ee превращает её в 3.1.0+ee |
integrity |
none |
провайдер целостности: none или rsa (см. Подпись пакетов) |
standard |
true |
стандартные модули ядра на его коммите (см. Стандартные модули) |
exclude |
нет | исключённые стандартные модули, по имени; "builtin" эквивалентно builtin = false. Запрещено при standard = false |
builtin |
true, false, когда exclude содержит builtin |
собственные команды tt, модуль builtin |
external_modules |
true |
внешние модули и tt modules |
bundle_sources |
["customer-zone", "rws", "github"] |
откуда tt binary install и tt binary search берут готовые сборки продуктов, по порядку; продукт спрашивают у первого источника, у которого он есть: customer-zone - личный кабинет tarantool.io, с флагом --credentials-file, для Tarantool Enterprise, SDK, TCM и tt-ee; rws - статические RPM-пакеты rws.tarantool.org, для Tarantool Community 3 на Linux с glibc; github - релизы tt на GitHub, для tt и его последнего релиза. Без личного кабинета эти продукты ставятся только из --local-dir; без rws или github каждая версия Tarantool Community или tt собирается из исходного кода. [] - ни одного источника |
Версия дистрибутива берётся из git describe в каталоге манифеста; за ней
следует VERSION_LABEL.
Стандартные модули¶
Стандартные модули - это модули из репозитория ядра, с которыми собирается
официальный tt: aeon, build, emmylua и wasm в tt 3.0.0-alpha.3. В
модуле build находятся бэкенды сборки tt (см.
манифест приложения); у самого ядра
собственных бэкендов нет. wasm содержит команду tt wasm и проверку
файлов .wasm пакета. Пакет standard ядра,
github.com/tarantool/tt/v3/standard, перечисляет их, поэтому модули,
добавленные более новым ядром, попадают в дистрибутив без правки его
манифеста. Они собираются на коммите ядра или из его чекаута, как и любой
модуль из репозитория ядра.
excludeисключает модули по имени, вместе с их кодом. Имя, которое ядро не перечисляет, считается ошибкой и выводит список допустимых имён.builtin, собственные команды tt, - тоже стандартный модуль, хотя ядро добавляет его само, а не через пакетstandard. Записиexclude = ["builtin"]иbuiltin = falseозначают одно и то же и могут быть указаны вместе;builtin = trueс"builtin"вexcludeсчитается ошибкой. Приstandard = falseвсё определяет толькоbuiltin.- Модуль из
[dependencies]с именем стандартного модуля занимает его место: форкaeonили его локальный чекаут. Укажите его также вexclude, чтобы заявить об этом явно; иначе при сборке выводится предупреждение. Это сделано предупреждением, а не ошибкой, чтобы манифест, в которомaeonуказан явно (как делалось до появления стандартных модулей), а также манифест с модулем, имя которого более новое ядро добавило в этот набор, по-прежнему собирались. - Локфайл перечисляет стандартные модули, вошедшие в бинарный файл, без
исключённых и без тех, что заменены модулями из
[dependencies], а также безbuiltin:standard = ['aeon', 'build', 'wasm']в его секции[core]для манифеста выше. Сборка с--lockedзавершается с ошибкой, если состав модулей изменился. - Сборка читает этот список из исходного кода пакета
standardи импортирует конструктор каждого выбранного модуля в генерируемый модульmain, как и для модулей из[dependencies]; сам модульmainпакет не вызывает. У ядра до v3.0.0-alpha.3 пакетаstandardнет, и сборка на нём с включённымstandardзавершается с ошибкой: укажитеstandard = falseи перечислите модули в[dependencies]. Сборка определяет это по самому пакету, а не по версии, поэтому для форка или коммита ядра проверка срабатывает корректно.
[build]¶
Как компилируется бинарный файл. Локфайл не сохраняет эти параметры: один локфайл подходит для сборки любым способом.
| Поле | По умолчанию | |
|---|---|---|
ssl |
default |
реализация TLS: default, openssl или openssl_static; TT_CLI_BUILD_SSL переопределяет её |
cgo |
включён только для openssl и openssl_static |
собирать с cgo |
tags |
нет | теги сборки, добавляемые к тегам реализации TLS; без запятых и пробелов |
ldflags |
нет | флаги линковщика, добавляемые после собственных флагов tt, по одному флагу на запись |
[dependencies]¶
Модули tt по именам. Имя - это имя модуля в tt: в tt version --modules, в
его записях журнала и в ошибках его команд. Буква, за которой следуют буквы,
цифры, - и _. Имя builtin занято, пока включены собственные команды
tt, см. поля builtin и exclude секции [distribution]. Модуль с
именем стандартного модуля занимает его место (см.
Стандартные модули).
Модуль задаётся строкой или таблицей. Строка представляет собой одно из:
- локальный каталог:
.,..или путь, начинающийся с./,../или/, относительно каталога манифеста; - путь Go-модуля:
github.com/tarantool/tt/modules/aeon; - путь Go-модуля и запрос версии после
@:github.com/acme/tt-foo@v1.2.0.
У таблицы следующие поля:
| Поле | По умолчанию | |
|---|---|---|
module |
из go.mod в path |
путь Go-модуля; обязателен без path и должен совпадать с go.mod при его наличии |
version |
коммит ядра для модуля из репозитория ядра, latest для любого другого |
запрос версии Go; не допускается вместе с path, а также для модуля из репозитория ядра, который следует за ядром |
path |
локальный каталог с модулем относительно каталога манифеста | |
package |
корневой пакет модуля | путь импорта пакета с конструктором; пакет из module |
symbol |
New |
конструктор: экспортируемый идентификатор с типом func(sdk.Services) []sdk.Mount либо func(sdk.Services) sdk.Module для модуля, предоставляющего бэкенды сборки или проверки файлов пакета |
kind |
tt-module |
единственный существующий тип |
source |
path при указанном path, иначе registry |
SDK-модули, требуемые модулем, берутся из ядра - на его коммите или из его
чекаута, - что бы ни было указано в go.mod самого модуля (см.
Написание модуля tt).
[replace]¶
Go-модули сборки, берущиеся из другого места, в виде директив replace
главного модуля, который генерирует сборка (сам модуль tt задать их не
может). Ключ - это путь Go-модуля, с @version для подмены только этой
версии. Значение - локальный каталог (начинается с ./, ../ или /
относительно каталога манифеста), содержащий модуль, либо module@version,
где версия может быть любым запросом; локфайл фиксирует то, во что она
разрешилась. Ядро, модули его репозитория и модули из [dependencies]
подменять здесь нельзя. Подмена, из которой не берётся ни один пакет сборки,
не действует и выводит предупреждение. См.
Подмена модулей Go.