Skip to content

update doc for cartridge release 2.16.2 #5250

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
wants to merge 208 commits into from
Closed

update doc for cartridge release 2.16.2 #5250

wants to merge 208 commits into from

Conversation

vakhov
Copy link
Collaborator

@vakhov vakhov commented Jul 15, 2025

Updated documentation for cartridge.

  • Updated changelog: added info about release 2.16.2
  • Updated administrator: added info about release 2.16.2

andreyaksenov and others added 30 commits December 27, 2023 14:09
Co-authored-by: Pavel Semyonov <[email protected]>
Co-authored-by: Anna Balaeva <[email protected]>
Co-authored-by: TarantoolBot <[email protected]>
Co-authored-by: Kseniia Antonova <[email protected]>
Resolves #3734
Resolves #3820

* Add tt console docs
* Add tt connect SSL options
Add the 'Traffic encryption' section and made 'Since version' and 'Dynamic: yes' consistent
Document connection and authentication settings
…#3995)

* Add `flightrec` reference section (YAML)
* Update the Flight Recorder page

Fixes #3669
* Updated and restructured Audit module page
* Documented new audit log fields - uuid, severity
* Added a new Severity level subsection to Custom events section (with examples)
* Added audit_log reference section:
   - audit_log.extract_key, audit_log.spaces - new options
   - other options are moved from the box.cfg reference

* Fixed typo in the tt search description

Fixes #3667
Fixes tarantool/enterprise_doc#258
Fixes tarantool/enterprise_doc#257
Fixes tarantool/enterprise_doc#221 
Fixes tarantool/enterprise_doc#248
Resolves #3999 tarantool/enterprise_doc#260 tarantool/enterprise_doc#259

Co-authored-by: Pavel Sergeev <[email protected]>
Co-authored-by: Andrey Aksenov <[email protected]>
Added: 605, 606, 609, 613, 616
Resolves #3725, #3929

Co-authored-by: Andrey Aksenov <[email protected]>
- Added `snapshot` and `wal` reference sections
- Updated `box.cfg` reference sections related to snapshots or WAL
- Updated `WAL extensions` topic in the Enterprise section
- Added `Persistence` topic to `Configuration` section
- Updated old links
- Slightly updated `File formats` page

Fixes #4013
Fixes #3668
Fixes #3727
Fixes #3396
AArdeev and others added 26 commits May 12, 2025 16:48
Errors were grouped incorrectly.
Fixes #4174
Since January 30th, 2025, actions/upload-artifact and
actions/download-artifact version 3 is deprecated. This patch bumpes its
version to v4.

See more in [GitHub announcement](https://github.blog/changelog/2024-04-16-deprecation-notice-v3-of-the-artifact-actions/).
* Remove incorrect OutOfMemory error
* Add new inherit_fds option description to popen.new

Fixes #3608
Fixes #3609
* Fix "Since version" links format 
* Correct inherit.fds typo (change dot to underscore)

Fixes #3609 and #4174
The box.info.listen is capable of returningan an array of strings if several URIs are configured.
Fixes #5092
…`box.error``. (#5112)

* Add description of the ``name`` parameter
Since 3.1.0 there has been the ``name`` parameter,which returns the name of the error used at creation.

* Add description of box.error.is function
Function allows check whether the argument is an error. Added as a new page

Fixes #4236, #4150
* Updates description of ```box_index.parts``` with new methods
* Since version 3.0.0 the ```box_index.parts``` can use methods of ```key_def```

Fixes #3444
* Added ``box.schema.user.enable`` and ``box.schema.user.disable`` methods description to Submodule ``box.schema``
* 2 new files ("user_enable.rst" and user_disable.rst") added to the ``box.schema`` submodule.
* Files describe methods that grant and revoke permissions.
* References added to existing files ("box_schema.rst", "user_grant.rst", "user_revoke.rst")
Fixes #5122
* Adds description of the ```#``` lua operator usage to key_def
* Standard lua operator ``#`` (__len metamethod) can be used to check the ``key_def`` length (parts count)
Fixes #4275
* Adds description of new ```key_def``` functions comparing data against the ```key_def``` object rules
* Since 3.1.0, new functions are added to ```key_def``` module.
   * ```validate_key(key)``` - validates input key against the rules
   * ```validate_full_key(key)``` - validates input key's all fields against the rules
   * ```compare_keys(key_a, key_b)``` - Compares two keys against each other and the rules
   * ```validate_tuple(tuple)``` - validates the tuple against the rules
* Fixes #4111
* Since 3.1.0 4 new ```key_def``` methods are applicable to ```index_object.parts```
   * ```validate_key()```
   * ```validate_full_key```
   * ```validate_tuple()```
   * ```compare_keys()```
* Functionally methods are equivalent to their description in ```key_def```
* Fixes #5139

* Fixes syntax
* With the ```lua_call``` priviledge any user can be given access to non-persistent functions
* The function may be defined after the priviledge is given
* Fixes #3628
* Adds isolated instance mode description
* The ```isolated: true``` option moves the instance to RO mode
* In this mode, various debugging & maintanance operations can be performed
* Fixes #4632
* Adds hierarchy table description
* Since 3.3.0 the ``hierarchy`` table shows names of the group, replicaset, and the instance itself
* Table is reported in ``config:info()``; ``config:info('v2')``; ``box.info.config``
* Fixes #4608
* ``lua_call`` option allows granting users privileges to call specified lua function on the instance in runtime
* ``lua_call: [all]`` grants access to all global Lua functions except built-in ones
* Fixes 4552
* Adds **Revoking grants from a user** paragraph
* New paragraph explains how to revoke privileges manipulating config file
* Fixes #5152
* Updates calendar details on latest branch
* Updates EOL dates for versions 2.10.x
Fixes #5167
* Changed syntax of previous hyperlink
* Fixes #5184
* Updates default value for replication_sync_timeout
* Changes default value in the description from 300 to 0
* Changes replication_sync_timeout Note text
Co-authored-by: Kseniia Antonova <[email protected]>
Fixes #5183
- Update description in `box.session.su()`, `box.session.user()`, `box.session.uid()`, and `box.session.euid()`
- Add `box.session.effective_user()` page

Fixes #5062
* Adds timeless approach to release page
* Adds description of EOS concept to the release page
* Fixes #4065
…#5232)

* Adds description of the on_event callback to custom application roles
* Added general info about custom roles as an intro to the section'
* Fixes #4666
* Adds description of application role editing process
* Fixes #5230
@vakhov vakhov requested a review from xuniq July 15, 2025 14:10
@xuniq xuniq changed the base branch from latest to 2.11 July 15, 2025 14:25
@vakhov vakhov closed this Jul 15, 2025
@vakhov vakhov deleted the cartridge_2_16_2 branch July 15, 2025 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.