-
Notifications
You must be signed in to change notification settings - Fork 341
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
introduction to sequence diagrams using vscode's draw.io #231
Conversation
f9e7d98
to
07976d8
Compare
@@ -49,6 +49,11 @@ youki is not at the practical stage yet. However, it is getting closer to practi | |||
| Rootless | Running a container without root privileges | It works, but cgroups isn't supported. WIP on [#77](https://github.com/containers/youki/issues/77) | | |||
| OCI Compliance | Compliance with OCI Runtime Spec | 39 out of 55 test cases passing | | |||
|
|||
# Design and implementation of youki | |||
![sequence diagram of youki](docs/.drawio.svg) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we can put this in another document or just link to it so the README doesn't get cluttered?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Eventually, we probably want to move this into /docs
and just have a reference in the README. For now, either way is fine. My 2c.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I'll put only this image in the README, and the others in docs/
. I hope this sequence diagram is easy to understand and motivates some people to contribute to it.
Set up cgroup is in the youki main process. After the intermediate process returns, the youki main process, before update the pid file, applies the cgroup config to the process. Otherwise, LGTM. |
Also, we may want add this link and some documentation on how to create another draw.io render. |
That's right. I put |
In this way, anyone can edit it with relative ease by adding a plug-in to vscode, and create a diagram that is even easier to understand. rendered
https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio