Adding architecture documentation to DVO project

[npecka]

Submitting architecture diagrams to DVO project to assist in understanding the overall picture for DVO

[codecov-commenter]

Codecov Report

Merging #146 (2613693) into master (79d2894) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #146   +/-   ##
=======================================
  Coverage   32.87%   32.87%           
=======================================
  Files          16       16           
  Lines         438      438           
=======================================
  Hits          144      144           
  Misses        274      274           
  Partials       20       20           

[bkez322]

I haven't yet found the opportunity to really dive into this with great detail to what I'd suggest to be added to or amended with this, but I do thank you again for getting this started! It's not easy to go from near-nothing to something with documentation for any project.

The goal of this PR, in my opinion, should be to produce documentation that someone with minimal understanding of this project can look at, and come out with an excellent understanding of how the project works, and that person should be able to confidently explain the project to other people. I don't think this PR is accomplishing this at the moment. I feel this PR is significantly lacking in descriptive context on what the significant parts of DVO are actually doing and how they work.

I think a good next step would be to accompany these 2 diagram you made with written descriptions of what each piece in the diagrams is doing, and what the arrows connecting them actually mean.

[bkez322]

I feel as though the diagrams in the current state are a bit busy and confusing.

It looks like they're trying to combine all the following in a 1-2 diagrams:

• DVO-human-developer workflow (what things does a DVO developer interact with? what is the purpose of each interaction?)
• DVO-human-consumer workflow (what things does a person that wants to install DVO to a openshift cluster interact with? what is the purpose of each interaction?)
• structure of a complete operator-managed DVO deployment (what k8s resources does deploying this create? What do each of these k8s resources do? How they talk to each other? What is the purpose of each of these communication interactions?)
• structure of a complete DVO "observability" deployment (what k8s resources does this create? What do each of these k8s resources do? How they talk to each other? What is the purpose of each of these communication interactions?)
• the structure of DVO's internal codebase ( what are the major dependencies within DVO's codebase? The 2 big ones are kube-linter and the promtheus library. What are these libraries doing currently?)

I would love to see the 2 diagrams we have today split cleanly into 5 separate diagrams as described here. 😀

[bkez322]

(see friendly suggestions above)

[npecka]

(see friendly suggestions above)

I have pushed a change that introduces 5 new diagrams. They are still in rough draft form and will need to be revised to look more aesthetically pleasing. Looking for feedback on the information that goes along with them and what needs to be added / how you're looking for things to be worded. @bkez322 Please take a look and let me know your feedback once you have the chance. Thanks!

[hlipsig]

@npecka you've got an incorrect link: /images/DVO_Observability.drawio.png on line 32 of Architecture.md the filename has as space not an underscore "DVO Observability.drawio.png" so you'll either want change line 32 or remove it. It's referenced correctly later in the doc, so maybe you were looking to reference a different drawing here?

[hlipsig]

We can iterate over this with time, but it's better to have something.

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hlipsig, npecka

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [hlipsig,npecka]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[bkez322]

Sorry I'm late to comment, but LGTM!