Skip to content
This repository was archived by the owner on Apr 17, 2024. It is now read-only.

docs: update architecture diagram#75

Open
galexrt wants to merge 1 commit intomasterfrom
feature/ksd-133
Open

docs: update architecture diagram#75
galexrt wants to merge 1 commit intomasterfrom
feature/ksd-133

Conversation

@galexrt
Copy link
Copy Markdown
Member

@galexrt galexrt commented May 18, 2023

Description of your changes:

I have recreated the architecture in draw.io as I don't think anyone still has the (old) source code for the diagram around. It has slightly less "detail," but now we can easily edit it if needed, e.g., with the ceph exporter coming soon.

image

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide).
  • Skip Tests for Docs: If this is only a documentation change, add the label skip-ci on the PR.
  • Reviewed the developer guide on Submitting a Pull Request
  • Pending release notes updated with breaking and/or notable changes for the next minor release.
  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.
  • Integration tests have been added, if necessary.

@galexrt galexrt added documentation Improvements or additions to documentation skip-ci Skip CI run for a PR labels May 18, 2023
@linear
Copy link
Copy Markdown

linear Bot commented May 18, 2023

KSD-133 Create and update architecture diagrams

Examples: https://docs.galexrt.moe/storage/rook/architecture/

  • Update the architecture diagram in the Koor docs
  • Update other outdated diagrams in the Koor docs

Let's write up a simple architecture diagram that we can use in our intro blog posts. Potentially use Koor Office Hours for it.

Copy link
Copy Markdown
Contributor

@zalsader zalsader left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Minor comments on the diagram:

  • The original diagram organized pods in columns to show they are located on the same node. I think this could be done here.
  • Do we need to show bucket claims too?
  • Should we use Koor branding on our website?
  • The title "OSDs" in the bottom left corner is not centered.

@galexrt galexrt force-pushed the feature/ksd-133 branch from 942cda7 to ab885cd Compare May 18, 2023 16:03
@galexrt
Copy link
Copy Markdown
Member Author

galexrt commented May 18, 2023

@zalsader I have updated it and I think for Koor we should then make it Koor themed.

@galexrt galexrt force-pushed the feature/ksd-133 branch from ab885cd to 8c7fb4d Compare May 18, 2023 16:41
Copy link
Copy Markdown
Contributor

@zalsader zalsader left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Copy link
Copy Markdown
Contributor

@ideepika ideepika left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great, can we also have it in our KBase knowledge centre some way?

I have recreated the architecture in draw.io as I don't think anyone
still has the (old) source code for the diagram around.
It has slightly less "detail" but now we can easily edit it if needed,
e.g., with the ceph exporter coming soon.

Signed-off-by: Alexander Trost <galexrt@googlemail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation skip-ci Skip CI run for a PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants