Tendrl / documentation

Project-wide documentation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Clarification of component diagram in *Deploying Tendrl*

mbukatov opened this issue · comments

In Deploying Tendrl document there is a diagram with Tendrl Core Components, which presents a general overview and doesn't try to convey particular deployment scenario.

The problem is that I'm not sure if I understand a relation between Non-HA Layout and the Tendrl Core Components diagram:

  • Storage Node from the Non-HA Layout matches with Storage Node from the diagram, that's clear
  • It seems that Tendrl Master machine (from the Non-HA Layout) contain all other components from the diagram, including Central Store, Tendrl Application and UI, do I read it right?
  • It seems that Central Store is provided by etcd, right?

If answers the these questions are yes, I would suggest to improve the description of the Layout so that the relation is absolutely clear (eg. there is no clear statement that Central Store is provided by etcd anywhere including Glossary and Components Overview documents). Suggested improvements include:

  • update the diagram to make it clear what box is a machine, group of machines or a component.
  • add/update description of Tendrl Master and Storage Node so that the same terminology is used and relation between a particular layout and the general component overview is clear

On the other hand, if any answer to the questions above is no, more work would be needed to make the document clear.

The diagram seems to provide a HA layout, but if I read the status of #12 right, details of HA deployment has not been settled yet.