Add getting started with TCM tutorial #4022
Conversation
| :dedent: | ||
|
|
||
| This configuration sets up a cluster of three nodes in one replica set, | ||
| one leader and two followers. |
There was a problem hiding this comment.
| one leader and two followers. | |
| one leader, and two followers. |
There was a problem hiding this comment.
Seems that colon conveys the meaning better:
three nodes in one replica set: one leader and two followers.
doc/how-to/getting_started_tcm.rst
Outdated
|
|
||
| .. code-block:: console | ||
|
|
||
| $ tar -xvzf tarantool-enterprise-sdk-gc64-<VERSION>-<HASH>-r<REVISION>>.linux.x86_64.tar.gz |
There was a problem hiding this comment.
Given that we show the specific versions after installation, I'd use the real archive name here (tarantool-enterprise-sdk-gc64-3.0.0-0-gf58f7d82a-r23.linux.x86_64.tar.gz). This is also helpful for copy-pasting.
There was a problem hiding this comment.
This name is already outdated since 3.0.1 SDK is released :)
In the version check, we're just giving an example.
doc/how-to/getting_started_tcm.rst
Outdated
|
|
||
| #. Find the connection properties of the configuration storage that the cluster uses. | ||
| By default, it's an etcd storage with a prefix ``/default`` running on port | ||
| ``2379`` (default etcd port) on the same host. Click **Next**. |
There was a problem hiding this comment.
I'd separate the concepts of storage and prefix:
- an etcd storage is running on port 2379
/defaultis a key prefix used to search a configuration
For example: By default, it's an etcd storage running on port **** and storing a configuration in a key with the **** prefix.
doc/how-to/getting_started_tcm.rst
Outdated
|
|
||
| #. Check the Tarantool user that |tcm| uses to connect to the cluster instances. | ||
| It's ``guest`` by default. Click **Update** to save the changes and return to | ||
| the **Clusters** page. |
There was a problem hiding this comment.
Looks like we didn't change anything in steps 1-4. Do we really need to click Update?
There was a problem hiding this comment.
Agree, nothing changes if we just switch to another TCM page without clicking Update.
| include the default etcd and Tarantool connection parameters. Check these properties | ||
| to find out where TCM sends the cluster configuration that you write. | ||
|
|
||
| To view the **Default cluster**'s properties: |
There was a problem hiding this comment.
Maybe, extract info about viewing configuration to a separate sub-section? Smth like this:
- Setting up a Tarantool EE cluster
- Checking a cluster's connection settings
- Configuring a cluster
- Deploying the cluster locally
doc/how-to/getting_started_tcm.rst
Outdated
| ---------------- | ||
|
|
||
| #. Open a web browser and go to ``http://127.0.0.1:8080/``. | ||
| #. Log in with the ``admin`` username. The initial password is generated automatically |
There was a problem hiding this comment.
Minor suggestion: Maybe, it's worth mentioning about the generated password in the previous step (while a user in a terminal). Currently, a user runs TCM, then opens a browser, then returns to a terminal once again to find a password.
doc/how-to/getting_started_tcm.rst
Outdated
| :alt: Instance terminal in TCM | ||
|
|
||
| Creating a space | ||
| ---------------- |
There was a problem hiding this comment.
In the Managing the cluster in TCM, we list the following use cases:
Checking the cluster state.
Creating a space.
Writing data.
Viewing data.
Doesn't this mean that the section structure should look as follows?
- Managing the cluster in TCM
- Checking state
- Connecting to the instance
- Creating a space (now it is on the top level)
- Writing data
- Reading data
- Checking replication
There was a problem hiding this comment.
Sure, thanks. This was an incorrect heading level.
doc/how-to/getting_started_tcm.rst
Outdated
|
|
||
| #. Go to **Configuration**. | ||
| #. Click **+** and provide an arbitrary name for the configuration, for example, ``all``. | ||
| #. Paste the following YAML configuration into the editor: |
There was a problem hiding this comment.
YAML configuration
Maybe, add a link to https://www.tarantool.io/en/doc/latest/concepts/configuration/#configuration-overview ?
Co-authored-by: Andrey Aksenov <[email protected]>
|
|
||
| .. important:: | ||
|
|
||
| The |tcm| bootstrap log in the terminal includes a message with the credentials |
There was a problem hiding this comment.
An important note looks a bit weird after not so important note. I'd use two steps in this section:
1) Start tcm
2) Find the message with creds and remember them
> not so important note
Co-authored-by: Andrey Aksenov <[email protected]>
Resolves #4000
a complete tutorial for Tarantool 3.0)
Deployment: https://docs.d.tarantool.io/en/doc/gh-4000-tcm-quick-start/how-to/getting_started_tcm/