tarantool / tarantool/doc

[5pt] List all Cartridge container environment variables in one place

Open
#2,354 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

add details cartridge
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Product: Cartridge
Audience/target: dev
Root document: https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_dev/?
SME: @ sergos
Peer reviewer: @ NickVolynkin?

Details

Looks like information on environment variables is hard to find in Cartridge building docs.
It is provided here: https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_api/modules/cartridge/#cartridge-cfg
and here:
https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_cli/#environment-variables

I see two options:


This is a comment to a Mail.ru expert article about Cartridge CLI:

"Try finding a list of environment variables that are used to configure Tarantool in a Cartridge container. I didn't found this in the doc. But I did in cartridge.yaml in a freshly generated application. It's only logical, but please describe this in the documentation."

"Попробуйте найти список переменных окружения используемых для конфигурации тарантула в контейнере картриджа. В документации этого я не нашёл. Знаете где? В файлике cartridge.yaml во вновь сгенерённом приложении. С одной стороны логично, с другой - в документации опишите." https://habr.com/en/company/mailru/blog/571936/#comment_23359672

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the Cartridge Developer's Guide configuration basics and the existing cartridge-cfg and Cartridge CLI environment-variables sections linked in the issue. Choose whether to add the cross-reference or create a consolidated table, then verify that the relevant variables and options are documented and discoverable from the developer guide.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.