Skip to content

[Config] Document the 'credentials' option #3666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Tracked by #3957
andreyaksenov opened this issue Sep 1, 2023 · 0 comments · Fixed by #4024 or #4035
Closed
Tracked by #3957

[Config] Document the 'credentials' option #3666

andreyaksenov opened this issue Sep 1, 2023 · 0 comments · Fixed by #4024 or #4035
Assignees

Comments

@andreyaksenov
Copy link
Contributor

andreyaksenov commented Sep 1, 2023

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

@andreyaksenov andreyaksenov mentioned this issue Sep 14, 2023
@andreyaksenov andreyaksenov changed the title [Config] Update the 'Access control' guide to using a new config [Config] Add information about the 'credentials' option to the 'Access control' guide Oct 26, 2023
@andreyaksenov andreyaksenov self-assigned this Jan 16, 2024
@andreyaksenov andreyaksenov changed the title [Config] Add information about the 'credentials' option to the 'Access control' guide [Config] Document the 'credentials' option Jan 16, 2024
@andreyaksenov andreyaksenov reopened this Feb 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant