-
Notifications
You must be signed in to change notification settings - Fork 43
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
TCM data storages: etcd and Tarantool #4123
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool, added several minor suggestions
@@ -1040,8 +1040,7 @@ The ``log`` section defines the |tcm| logging parameters. | |||
storage | |||
------- | |||
|
|||
The ``storage`` section defines the parameters of the configuration storage that | |||
|tcm| uses for connected clusters. | |||
The ``storage`` section defines the parameters of the |tcm| data storage. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
data storage
backend store connection ? I'd also add a link to the Backend store
topic.
users, roles, cluster connections, settings, and other objects that you manipulate in |tcm|. | ||
The backend store can be either an etcd or a Tarantool cluster. | ||
|
||
Typically, the backend store works independently from |tcm|. For example, it can |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure that typicaly
works good here. Maybe, we can say something about reliability to be more specific.
|
||
Typically, the backend store works independently from |tcm|. For example, it can | ||
be the same ectd or Tarantool cluster that you use as a :ref:`centralized configuration storage <configuration_etcd>`. | ||
This makes |tcm| stateless: all objects created or modified in its web UI are sent |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are sent
Looks like sent
is better for requests
or smth like this. I'd use save
here.
|
||
To use an etcd cluster as a |tcm| backend store, set the ``storage.provider`` option | ||
to ``etcd`` and specify connection parameters in ``storage.etcd.*`` options. | ||
A minimal etcd configuration includes the storage endpoints: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minimal etcd configuration
Looks like an https
endpoint also requires specifying storage.etcd.tls.*
settings. Please double check. If yes, I'd changed all the samples to using http
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, right: local etcd without SSL params works on http.
|
||
storage.etcd.embed.enabled: true | ||
|
||
To start |tcm| with default settings and an embedded etcd without a YAML configuration, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This way looks simpler than running with YAML config. Shouldn't it be described earlier?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's simple but secondary IMO: first comes the real-life case, and then the simple way for specific and limited use (local testing in this case)
workdir: node3.etcd | ||
|
||
|
||
To set up a cluster from embedded Tarantool-based backend stores: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe, it's worth creating separate subsections for etcd and Tarantool examples inside Setting up a cluster of embedded backend stores
. But this will add third-level nesting :(.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, no fourth level headings in our docs.
Co-authored-by: Andrey Aksenov <38073144+andreyaksenov@users.noreply.github.com>
Resolves #3904
Deployment: https://docs.d.tarantool.io/en/doc/gh-3904-tcm-data-storage/reference/tooling/tcm/tcm_backend_store/