Skip to content

Add sequence diagram for shim runtime v2#7606

Merged
dmcgowan merged 1 commit intocontainerd:mainfrom
mxpv:diagram
Nov 1, 2022
Merged

Add sequence diagram for shim runtime v2#7606
dmcgowan merged 1 commit intocontainerd:mainfrom
mxpv:diagram

Conversation

@mxpv
Copy link
Copy Markdown
Member

@mxpv mxpv commented Oct 31, 2022

This PR updates runtime v2 README with sequence diagram to show flow of shim requests when running a container. I plan to add another one to depict flow with sandbox API, but it took me longer then I expected.

Rendered version

Signed-off-by: Maksym Pavlenko [email protected]

Comment thread runtime/v2/README.md
containerd->>shim: TaskService.CreateTaskRequest
shim-->>containerd: Task PID

containerd-->>ctr: Task ID
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I dont get this line

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Oh containerd to CTR. I get it now lol

Comment thread runtime/v2/README.md
ctr->>containerd: Wait task

containerd->>shim: TaskService.WaitRequest
Note right of shim: Block until task exits
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Important to call out that this protocol basically requires TTRPC with a zero timeout here or the block would not be infinite like we rely on here.

Copy link
Copy Markdown
Contributor

@jterry75 jterry75 left a comment

Choose a reason for hiding this comment

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

LGTM

@dmcgowan dmcgowan merged commit 68ff465 into containerd:main Nov 1, 2022
@mxpv mxpv deleted the diagram branch November 28, 2022 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants