Skip to content

Add TCM config reference#3876

Merged
p7nov merged 7 commits into
3.0from
gh-3633-tcm-config
Dec 7, 2023
Merged

Add TCM config reference#3876
p7nov merged 7 commits into
3.0from
gh-3633-tcm-config

Conversation

@p7nov
Copy link
Copy Markdown
Contributor

@p7nov p7nov commented Nov 28, 2023

Resolves #3633

Notes:

  • perhaps we'll move the config reference page into a TCM > Reference section when we write more TCM reference content: UI reference, metrics reference, etc.
  • we'll write separate config tutorials on configuring each aspect: HTTP, logging, security, etc. after 3.0 release. When we have such content, we'll add links to it to the parameters descriptions.

Deployment: https://docs.d.tarantool.io/en/doc/gh-3633-tcm-config/reference/tooling/tcm/tcm_config/

@p7nov p7nov force-pushed the gh-3633-tcm-config branch from 8663986 to c71f5fd Compare December 7, 2023 04:50
@p7nov p7nov marked this pull request as ready for review December 7, 2023 06:54
@p7nov p7nov requested a review from andreyaksenov December 7, 2023 07:39
Comment thread doc/reference/tooling/tcm/tcm_configuration.rst Outdated
- ``TCM_HTTP_HOST`` is a variable for the ``http.host`` parameter.
- ``TCM_HTTP_WEBSESSION_COOKIE_NAME`` is a variable for the ``http.websession-cookie.name`` parameter.

The example below shows how to start |tcm| passing configuration parameters in
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The example below shows how to start |tcm| passing configuration parameters in
The example below shows how to start |tcm| by passing configuration parameters in

multiple |tcm| installations:

- A single YAML file for all installations can contain the common configuration parts.
For example, the |tcm| configuration storage used for all installations or
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

storage used for all -> storage IS used for all ?

Comment thread doc/reference/tooling/tcm/tcm_configuration.rst Outdated

.. TODO: write specific configuration tutorials for http, security, logging, and so on.

This topic describes the |tcm_full_name| configuration model. For the complete
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me, configuration model sounds like a scientific term :) I'd rephrase to smth like ... how to configure ...

https://en.wikipedia.org/wiki/Configuration_model

Comment thread doc/reference/tooling/tcm/tcm_configuration_reference.rst Outdated
Comment thread doc/reference/tooling/tcm/tcm_configuration_reference.rst Outdated

A request timeout for the Tarantool |tcm| configuration storage.

See also `go-tarantool.Opts <https://pkg.go.dev/github.com/tarantool/go-tarantool#Opts>`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link and the same links below are not rendered.

image

configuration storage.

See also: :ref:`Traffic encryption <enterprise-iproto-encryption>`.
|
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like an empty line is missing here:

image

addon
-----

The ``addon`` section defines the |tcm|
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sentence fragment

p7nov and others added 3 commits December 7, 2023 17:18
Co-authored-by: Andrey Aksenov <38073144+andreyaksenov@users.noreply.github.com>
@p7nov p7nov requested a review from andreyaksenov December 7, 2023 11:10
@p7nov p7nov merged commit edf2a0a into 3.0 Dec 7, 2023
@p7nov p7nov deleted the gh-3633-tcm-config branch December 7, 2023 11:37
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.

2 participants