Skip to content

[Config] Document the 'credentials' option #3666

@andreyaksenov

Description

@andreyaksenov

Product: Tarantool
Since: 3.0
Root document: https://www.tarantool.io/en/doc/latest/reference/configuration/configuration_reference/#credentials
SME: @ Totktonada
Related doc issues: #3953, #3628

Details

A new credentials section introduced in a new YAML configuration requires documenting what are users, roles, and privileges. Currently this information lives in the Access control topic related to user administration.

Given that we need earlier introduction of access control concepts, we can have the following content structure:

  1. Add a new Credentials topic in the Configuration section. This topic describes specific of configuring service users (replication, sharding). All the concepts (users, roles, and privileges) are described in the existing Access control topic.
  2. Update Access control to make it clearer. The Privileges and Access Control explained page might be very helpful here.
    • Add information about new privileges.
    • Mention that specific roles (sharding, replication) should be used for a cluster config (a new Credentials topic).
  3. Reference page:

Related admin functions

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions