Description of problem ====================== We need to document the whole architecture of our RHSC 2.0 stack, including: * listing all services involved, it's purpose in the stack, and relations and dependencies among them * for each service involved, list configuration files, log files and endpoints (such as open sockets) * quick overview of components involved in common use cases (such as accepting nodes, creating a cluster, ...) * explanation of common entries from logs (especially error messages) from services across the stack This needs to be done down to the ceph and rhel stack. Without this overview, we can't expect anyone to be able to efficiently debug and solve unexpected issues, because lot of the knowledge is available in source code/rhsc 2.0 config files only so far.
QE validation note ================== All services and crucial tools from any package we ship in RHSC 2.0 repos should be included in this description.
I believe that most technical details should be maintained in the upstream directly: https://github.com/skyrings/skyring/issues/14 From where we can reuse and polish for the purpose of our upstream guide.
To clarify: my idea is that technical details of the architecture would be best maintained in upstream documentation (either along with the source code in doc directory in skyring repo or in a dedicated upstream documentation repo). Then we can cherry pick most important information from there, polish it and include it in out downstream documentation.