Skip to content

Openwhisk action invocation flow diagram #5340

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

Merged
merged 15 commits into from
Nov 1, 2022
Merged

Conversation

Rajiv2605
Copy link
Contributor

I have created a flow diagram to depict about what happens in the internals on an action invocation. I would like to contribute it to Openwhisk's README for future reference.

I had struggled a lot to figure this out and had to go through complex codebase and logs. With this diagram, any new developer can easily understand the flow of data and jump start with what they are interested in.

@codecov-commenter
Copy link

codecov-commenter commented Oct 23, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.53%. Comparing base (ef725a6) to head (77b4fea).
Report is 79 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (ef725a6) and HEAD (77b4fea). Click for more details.

HEAD has 40 uploads less than BASE
Flag BASE (ef725a6) HEAD (77b4fea)
45 5
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5340      +/-   ##
==========================================
- Coverage   81.66%   76.53%   -5.13%     
==========================================
  Files         240      240              
  Lines       14313    14313              
  Branches      610      610              
==========================================
- Hits        11689    10955     -734     
- Misses       2624     3358     +734     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

README.md Outdated

This diagram depicts the steps which take place within Openwhisk when an action is invoked by the user:

![component/repo mapping](docs/images/Openwhisk-diagram.drawio.png)
Copy link
Member

Choose a reason for hiding this comment

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

After an invocation on the invoker side, there is another process for controllers to receive an activation ack.
It would be great to include that part for the blocking invocation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@style95 Please check now.

@style95
Copy link
Member

style95 commented Oct 24, 2022

Hi, @Rajiv2605.
Thank you for your first contribution 🎉 .

README.md Outdated

This diagram depicts the steps which take place within Openwhisk when an action is invoked by the user:

![component/repo mapping](docs/images/Openwhisk-flow.png)
Copy link
Member

Choose a reason for hiding this comment

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

An ack is also sent via Kafka.

Copy link
Contributor

@ningyougang ningyougang Oct 25, 2022

Choose a reason for hiding this comment

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

image
Seems pre-warm container available? repeated? if prewarm container is not available, it should do cold start

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Please check now.

Copy link
Contributor

Choose a reason for hiding this comment

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

@Rajiv2605 , i saw you fixed 👍

README.md Outdated

This diagram depicts the steps which take place within Openwhisk when an action is invoked by the user:

![component/repo mapping](docs/images/Openwhisk-diagram.png)
Copy link
Member

Choose a reason for hiding this comment

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

It might be a little picky, but could you update the step 20?
It would be great to denote that it sends both acknowledgment and results.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Please check now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why is the Travis CI check failing?

Copy link
Member

Choose a reason for hiding this comment

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

Not sure the reason but I retriggered the unit test.

Copy link
Member

@style95 style95 left a comment

Choose a reason for hiding this comment

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

LGTM

@Rajiv2605
Copy link
Contributor Author

@ningyougang Can you approve the PR?

@Rajiv2605
Copy link
Contributor Author

What next?

@style95
Copy link
Member

style95 commented Oct 31, 2022

@Rajiv2605
BTW, have you submitted an iCLA form?

@Rajiv2605
Copy link
Contributor Author

No I haven’t. What is that?

@style95
Copy link
Member

style95 commented Oct 31, 2022

You need to fill out this form and submit it to the Apache secretary according to this guide.

This is a mandatory process for us to accept your contribution work.

@Rajiv2605
Copy link
Contributor Author

Thanks I have mailed them the form, the .asc file and added public key to Ubuntu keyserver.

@style95 style95 merged commit 74ca61c into apache:master Nov 1, 2022
@style95
Copy link
Member

style95 commented Nov 1, 2022

@Rajiv2605
Your iCLA has been filed.
Thanks.

msciabarra pushed a commit to nuvolaris/openwhisk that referenced this pull request Nov 23, 2022
* Openwhisk invocation flow diagram

* Update README.md

* Delete Openwhisk-diagram.drawio.png

* Updated Openwhisk invocation flow diagram

* Delete Openwhisk-diagram.drawio.png

* Added ack from invoker controller

* Delete Openwhisk-diagram.drawio.png

* Add files via upload

* Update README.md

* Delete Openwhisk-flow.png

* Add files via upload

* Update README.md

* Delete Openwhisk-diagram.png

* Add files via upload

* Update README.md
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.

4 participants