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

docs(readme): add architecture diagram #1995

Merged
merged 2 commits into from
May 17, 2024
Merged

docs(readme): add architecture diagram #1995

merged 2 commits into from
May 17, 2024

Conversation

cfm
Copy link
Member

@cfm cfm commented May 8, 2024

Status

Ready for review

Description

@deeplow and I have walked through the log/ portion of this repository and mapped out:

  • what spawns what services;
  • what triggers what RPCs; and
  • what reads/writes from/to what.

It should be descriptive and uncontroversial, except that we couldn't account for:

  1. securedrop-log, which nothing in either securedrop-client or securedrop-workstation appears to invoke; or
  2. securedrop_log, which nothing in either securedrop-client or securedrop-workstation appears to load.

Are they remnants of an earlier implementation, before the securedrop-redis-log → securedrop-log-saver buffering pipeline and the sd-rsyslog → qrexec securedrop.Log RPC?

@cfm cfm requested a review from a team as a code owner May 8, 2024 19:17
log/README.md Outdated Show resolved Hide resolved
log/README.md Outdated Show resolved Hide resolved
@legoktm
Copy link
Member

legoktm commented May 9, 2024

It should be descriptive and uncontroversial, except that we couldn't account for:

  1. securedrop-log, which nothing in either securedrop-client or securedrop-workstation appears to invoke; or
  2. securedrop_log, which nothing in either securedrop-client or securedrop-workstation appears to load.

I've discovered this before as well, and came to the same conclusion. If you look at the first commit to securedrop-log (9ff16b6), the original idea was that clients directly log to the VM via a custom log handler, but that was dropped later on in favor of rsyslog (see freedomofpress/securedrop-log#7 and 29c1cf7), but the old approach was never deleted.

@legoktm
Copy link
Member

legoktm commented May 9, 2024

Also: this is great, will make it very easy to visualize the proposed changes in #1719 once we get there :)

@cfm cfm changed the title [WIP] docs(readme): add architecture diagram docs(readme): add architecture diagram May 9, 2024
@cfm
Copy link
Member Author

cfm commented May 9, 2024

Thanks for the reassuring confirmation, @legoktm. I've removed the [WIP] prefix here, so now it's truly ready for review. I've deliberately left these in, as an annoying visual TODO for #1998:

securedrop-log???
securedrop_log??? -.qrexec.-> securedrop.Log

Copy link
Member

@legoktm legoktm left a comment

Choose a reason for hiding this comment

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

LGTM, will hold off on merging so @deeplow has the chance to review too.

@legoktm
Copy link
Member

legoktm commented May 17, 2024

(gonna land this, we can always make follow-up changes if it's not accurate)

@legoktm legoktm merged commit 561e31b into main May 17, 2024
48 checks passed
@legoktm legoktm deleted the log-arch-diagram branch May 17, 2024 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants