Skip to content
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

Document the architecture of k8up #482

Closed
cimnine opened this issue Aug 16, 2021 · 0 comments · Fixed by #498
Closed

Document the architecture of k8up #482

cimnine opened this issue Aug 16, 2021 · 0 comments · Fixed by #498
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@cimnine
Copy link
Contributor

cimnine commented Aug 16, 2021

Summary

As an operator using k8up
I want to understand how it's bits and pieces work together
So that I can debug my problem with greater accuracy.

As a (new) developer of k8up
I want to understand the overall idea behind the code
So that I can wrap my around and find the best solution to integrate new features and fix bugs.

Context

In #474 (part of #359), the component wrestic, previously in it's own repository yet never actually independent, was integrated into the k8up codebase.

For a person fresh to the project, it would be great to understand where these two components live in the repository and how they interact with each other.

Out of Scope

  • Changes to the code that are not documentation.
  • Graphics for all the exception cases – focus on the main flow.
  • Links to actual pieces of code, as they outdate pretty quickly.

Further links

Acceptance criteria

  • The interaction of restic / wrestic / k8up is made clear as good as possible.

Implementation Ideas

  • Some graphical overview would be nice, like a component diagram or a sequence diagram.
  • A high level overview of the folders and/or go modules that are relevant for the operator module.
  • A high level overview of the folders and/or go modules that are relevant for the restic module.
@cimnine cimnine added the enhancement New feature or request label Aug 16, 2021
@cimnine cimnine added this to the Wrestic Integration milestone Aug 16, 2021
@cimnine cimnine mentioned this issue Aug 16, 2021
11 tasks
@cimnine cimnine self-assigned this Sep 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant