tarantool / tarantool/doc

[Epic] Update the 'Administration' section

Open
#4,154 0 comments 0 reactions 1 assignee View on GitHub

@andreyaksenov is already working on this.

Since Apr 12, 2024.

3.0 epic
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Related doc issue: https://github.com/tarantool/doc/issues/3177

Product: Tarantool
Since: 3.0
Audience/target: admins
Root document: https://www.tarantool.io/en/doc/latest/book/admin/
SME:

Details

There are a set of changes in the 3.0 version of Tarantool that might affect docs in the Administration section:

  • Tarantool uses a new approach for developing cluster applications (epic https://github.com/tarantool/doc/issues/3920). This is not documented yet.
  • To package the resulting application before deployment, the tt pack command can be used.
  • The recommended way of deploying and administering cluster application for Enterprise customers is Ansible Tarantool Enterprise.
  • TCM also allows performing many administrative tasks (switching leaders, monitoring, etc.)

Taking into account all of these, it is necessary to revise the Administration section. Ideas for possible structure: https://docs.google.com/document/d/1F_looF24B6Ai0BL2JNWgVdbLcDcTPJhzVcVOuogDymA/edit?usp=sharing

Note that there are different kind of "layers" of administering a cluster:

  • Tarantool database specifics: connection types, access control, memory usage, configuration errors, etc.
  • Tooling used for administration: system tools (for example, systemd), tt CLI, ATE, TCM.

Related issues

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.