Add TCM overview #3848
Add TCM overview #3848
Conversation
p7nov
force-pushed
the
gh-3601-tcm-section
branch
3 times, most recently
from
1dd98c2
to
178d485
Compare
|
lgtm |
doc/reference/tooling/tcm/index.rst
Outdated
| distribution package. It is shipped as an executable that is ready to run on Linux | ||
| and macOS platforms. | ||
|
|
||
| |tcm| works only with Tarantool EE clusters that are configured through `etcd <https://etcd.io/>`_. |
There was a problem hiding this comment.
configured through etcd sounds like etcd is a tool for configuring a Tarantool, not to store a configuration (smth like configured through a web interface). Maybe, ... that use etcd as a configuration storage would work better.
|
|
||
| |tcm| works only with Tarantool EE clusters that are configured through `etcd <https://etcd.io/>`_. | ||
| When you create or edit a cluster's configuration in |tcm|, it sends the saved | ||
| configuration to etcd. This ensures consistent and reliable configuration storage. |
There was a problem hiding this comment.
Maybe, replace sends with publishes for terminology consistency with tt: ... it publishes the saved configuration to etcd.. Looks like send work better for networking things, for example, sending a network packet.
doc/reference/tooling/tcm/index.rst
Outdated
| |tcm| works only with Tarantool EE clusters that are configured through `etcd <https://etcd.io/>`_. | ||
| When you create or edit a cluster's configuration in |tcm|, it sends the saved | ||
| configuration to etcd. This ensures consistent and reliable configuration storage. | ||
| Learn more about :ref:`storing configuration in etcd <configuration_etcd>`. |
There was a problem hiding this comment.
I'd remove this sentence and update the etcd link above to our internal doc. Looks like the explicit learn more link to a technical tutorial might be unnecessary for a high-level overview.
doc/reference/tooling/tcm/index.rst
Outdated
| Learn more about :ref:`storing configuration in etcd <configuration_etcd>`. | ||
|
|
||
| A single |tcm| installation can manage multiple Tarantool EE clusters. | ||
| A convenient switch in the web UI lets you select the desired cluster in one click. |
There was a problem hiding this comment.
This paragraph sounds a bit too marketingish to me :) At the beginning, we already said about managing EE clusters and this might be enough IMO.
There was a problem hiding this comment.
Thanks, rephrased. AFAIR our PM wanted to highlight that one TCM can manage multiple clusters, so I'm leaving it, although in a more technical wording.
p7nov
force-pushed
the
gh-3601-tcm-section
branch
from
366b529
to
81b8d63
Compare
Resolves #3601
Deployment: https://docs.d.tarantool.io/en/doc/gh-3601-tcm-section/reference/tooling/tcm/
Important notes: