Skip to content

Add documentation for gRPC message and memory limits #390 #391

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.

Sign up for GitHub

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

Jump to bottom
Merged
jeffngo merged 1 commit into from
Sep 13, 2021
Merged

Add documentation for gRPC message and memory limits #390 #391

jeffngo merged 1 commit into from
Sep 13, 2021

Conversation

@jeffngo
Copy link
Contributor

@jeffngo jeffngo commented Sep 9, 2021

Context: We added metadata and message size limits to two gRPC services (libs server and platform client) that communicate with a Python plugin.

We want to add documentation to describe:

  1. The metadata/message size limits
  2. What part of the plugin can contribute to these limits
  3. How to tell if the limit was exceeded
  4. What to do if the limit was exceeded

@jeffngo jeffngo added the documentation Improvements or additions to documentation label Sep 9, 2021
@jeffngo jeffngo self-assigned this Sep 9, 2021
mothslaw
mothslaw reviewed Sep 9, 2021
View reviewed changes
mothslaw
mothslaw approved these changes Sep 10, 2021
View reviewed changes
Copy link
Contributor

@mothslaw mothslaw left a comment

Choose a reason for hiding this comment

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

Looks good to me, provided we've double-checked the limits that apply to each of the five cases.

ankursarin
ankursarin reviewed Sep 10, 2021
View reviewed changes
@jeffngo jeffngo merged commit db2670c into delphix:develop Sep 13, 2021
jeffngo added a commit to jeffngo/virtualization-sdk that referenced this pull request Sep 13, 2021
@jeffngo
Add documentation for gRPC message and memory limits delphix#390 (del…
cea863b 
…phix#391)
mrburke pushed a commit that referenced this pull request Jan 12, 2022
@rasantel @Ranzo3
@jeffngo @ankursarin @kurthdelphix @mothslaw
Release (#418)
8b9899e 
* DOC-1074 Document password vault support for VSDK plugins (#347)

* Correct Typo in Example, it should be UNIX not WINDOWS (#360)

* Add documentation for gRPC message and memory limits #390 (#391)

* Fix version number in doc header (#358) (#397)

* Update Delphix Engine version required to 6.0.7.0. (#386) (#398)

* Update SDK Docs deployment to use a deploy_key (#392) (#399)

* CP-6005 Ensure vSDK test coverage (#403)

* CP-6006 Futurize vSDK - Stage 1 (#404)

* Add support for virtualCleanup decorator (#400) (#405)

Co-authored-by: Kurt Hutchison <[email protected]>

* Fixes #401 Networking capabilities should be documented (#402)

Fixes #401 Networking capabilities should be documented

* CP-6009 Add to_str and to_byte helpers (#407)

* CP-6621 bump sdk version to 4.0.0 (#409)

* CP-6694 Update docs for SDK 4.0.0 (#410)

* CP-7022 vSDK 4.0.0 release tasks

* Update VirtualDelete flow diagram to include the virtual.cleanup call. (#414)

Co-authored-by: Kurt Hutchison <[email protected]>

* Update documentation with new gRPC message limits (#415)

Co-authored-by: Raul Santelices <[email protected]>
Co-authored-by: Ranzo J Taylor, III <[email protected]>
Co-authored-by: Jeff Ngo <[email protected]>
Co-authored-by: Ankur <[email protected]>
Co-authored-by: kurthdelphix <[email protected]>
Co-authored-by: Kurt Hutchison <[email protected]>
Co-authored-by: Tom Walsh <[email protected]>
mrburke pushed a commit to mrburke/virtualization-sdk that referenced this pull request Jan 13, 2022
@rasantel @Ranzo3
@jeffngo @ankursarin @kurthdelphix @mothslaw
Release (delphix#418)
4b86e80 
* DOC-1074 Document password vault support for VSDK plugins (delphix#347)

* Correct Typo in Example, it should be UNIX not WINDOWS (delphix#360)

* Add documentation for gRPC message and memory limits delphix#390 (delphix#391)

* Fix version number in doc header (delphix#358) (delphix#397)

* Update Delphix Engine version required to 6.0.7.0. (delphix#386) (delphix#398)

* Update SDK Docs deployment to use a deploy_key (delphix#392) (delphix#399)

* CP-6005 Ensure vSDK test coverage (delphix#403)

* CP-6006 Futurize vSDK - Stage 1 (delphix#404)

* Add support for virtualCleanup decorator (delphix#400) (delphix#405)

Co-authored-by: Kurt Hutchison <[email protected]>

* Fixes delphix#401 Networking capabilities should be documented (delphix#402)

Fixes delphix#401 Networking capabilities should be documented

* CP-6009 Add to_str and to_byte helpers (delphix#407)

* CP-6621 bump sdk version to 4.0.0 (delphix#409)

* CP-6694 Update docs for SDK 4.0.0 (delphix#410)

* CP-7022 vSDK 4.0.0 release tasks

* Update VirtualDelete flow diagram to include the virtual.cleanup call. (delphix#414)

Co-authored-by: Kurt Hutchison <[email protected]>

* Update documentation with new gRPC message limits (delphix#415)

Co-authored-by: Raul Santelices <[email protected]>
Co-authored-by: Ranzo J Taylor, III <[email protected]>
Co-authored-by: Jeff Ngo <[email protected]>
Co-authored-by: Ankur <[email protected]>
Co-authored-by: kurthdelphix <[email protected]>
Co-authored-by: Kurt Hutchison <[email protected]>
Co-authored-by: Tom Walsh <[email protected]>
mrburke pushed a commit that referenced this pull request Jan 13, 2022
@rasantel @Ranzo3
@jeffngo @ankursarin @kurthdelphix @mothslaw
Release (#418) (#421)
681cc56 
* DOC-1074 Document password vault support for VSDK plugins (#347)

* Correct Typo in Example, it should be UNIX not WINDOWS (#360)

* Add documentation for gRPC message and memory limits #390 (#391)

* Fix version number in doc header (#358) (#397)

* Update Delphix Engine version required to 6.0.7.0. (#386) (#398)

* Update SDK Docs deployment to use a deploy_key (#392) (#399)

* CP-6005 Ensure vSDK test coverage (#403)

* CP-6006 Futurize vSDK - Stage 1 (#404)

* Add support for virtualCleanup decorator (#400) (#405)

Co-authored-by: Kurt Hutchison <[email protected]>

* Fixes #401 Networking capabilities should be documented (#402)

Fixes #401 Networking capabilities should be documented

* CP-6009 Add to_str and to_byte helpers (#407)

* CP-6621 bump sdk version to 4.0.0 (#409)

* CP-6694 Update docs for SDK 4.0.0 (#410)

* CP-7022 vSDK 4.0.0 release tasks

* Update VirtualDelete flow diagram to include the virtual.cleanup call. (#414)

Co-authored-by: Kurt Hutchison <[email protected]>

* Update documentation with new gRPC message limits (#415)

Co-authored-by: Raul Santelices <[email protected]>
Co-authored-by: Ranzo J Taylor, III <[email protected]>
Co-authored-by: Jeff Ngo <[email protected]>
Co-authored-by: Ankur <[email protected]>
Co-authored-by: kurthdelphix <[email protected]>
Co-authored-by: Kurt Hutchison <[email protected]>
Co-authored-by: Tom Walsh <[email protected]>

Co-authored-by: Raul Santelices <[email protected]>
Co-authored-by: Ranzo J Taylor, III <[email protected]>
Co-authored-by: Jeff Ngo <[email protected]>
Co-authored-by: Ankur <[email protected]>
Co-authored-by: kurthdelphix <[email protected]>
Co-authored-by: Kurt Hutchison <[email protected]>
Co-authored-by: Tom Walsh <[email protected]>
mrburke pushed a commit that referenced this pull request Jan 20, 2022
@rasantel @Ranzo3
@jeffngo @ankursarin @kurthdelphix @mothslaw
4.0.0 post-release tasks - merge release into develop (#425)
f2b9957 
* CP-7022 vSDK 4.0.0 release tasks (#416)

* Bumping sdk to 4.0.2 and dvp-api to 1.6.3 due to bad upload of dvp-api 1.6.1 to pypi (#419)

* Release (#418)

* DOC-1074 Document password vault support for VSDK plugins (#347)

* Correct Typo in Example, it should be UNIX not WINDOWS (#360)

* Add documentation for gRPC message and memory limits #390 (#391)

* Fix version number in doc header (#358) (#397)

* Update Delphix Engine version required to 6.0.7.0. (#386) (#398)

* Update SDK Docs deployment to use a deploy_key (#392) (#399)

* CP-6005 Ensure vSDK test coverage (#403)

* CP-6006 Futurize vSDK - Stage 1 (#404)

* Add support for virtualCleanup decorator (#400) (#405)

Co-authored-by: Kurt Hutchison <[email protected]>

* Fixes #401 Networking capabilities should be documented (#402)

Fixes #401 Networking capabilities should be documented

* CP-6009 Add to_str and to_byte helpers (#407)

* CP-6621 bump sdk version to 4.0.0 (#409)

* CP-6694 Update docs for SDK 4.0.0 (#410)

* CP-7022 vSDK 4.0.0 release tasks

* Update VirtualDelete flow diagram to include the virtual.cleanup call. (#414)

Co-authored-by: Kurt Hutchison <[email protected]>

* Update documentation with new gRPC message limits (#415)

Co-authored-by: Raul Santelices <[email protected]>
Co-authored-by: Ranzo J Taylor, III <[email protected]>
Co-authored-by: Jeff Ngo <[email protected]>
Co-authored-by: Ankur <[email protected]>
Co-authored-by: kurthdelphix <[email protected]>
Co-authored-by: Kurt Hutchison <[email protected]>
Co-authored-by: Tom Walsh <[email protected]>

* Release (#418) (#421)

* DOC-1074 Document password vault support for VSDK plugins (#347)

* Correct Typo in Example, it should be UNIX not WINDOWS (#360)

* Add documentation for gRPC message and memory limits #390 (#391)

* Fix version number in doc header (#358) (#397)

* Update Delphix Engine version required to 6.0.7.0. (#386) (#398)

* Update SDK Docs deployment to use a deploy_key (#392) (#399)

* CP-6005 Ensure vSDK test coverage (#403)

* CP-6006 Futurize vSDK - Stage 1 (#404)

* Add support for virtualCleanup decorator (#400) (#405)

Co-authored-by: Kurt Hutchison <[email protected]>

* Fixes #401 Networking capabilities should be documented (#402)

Fixes #401 Networking capabilities should be documented

* CP-6009 Add to_str and to_byte helpers (#407)

* CP-6621 bump sdk version to 4.0.0 (#409)

* CP-6694 Update docs for SDK 4.0.0 (#410)

* CP-7022 vSDK 4.0.0 release tasks

* Update VirtualDelete flow diagram to include the virtual.cleanup call. (#414)

Co-authored-by: Kurt Hutchison <[email protected]>

* Update documentation with new gRPC message limits (#415)

Co-authored-by: Raul Santelices <[email protected]>
Co-authored-by: Ranzo J Taylor, III <[email protected]>
Co-authored-by: Jeff Ngo <[email protected]>
Co-authored-by: Ankur <[email protected]>
Co-authored-by: kurthdelphix <[email protected]>
Co-authored-by: Kurt Hutchison <[email protected]>
Co-authored-by: Tom Walsh <[email protected]>

Co-authored-by: Raul Santelices <[email protected]>
Co-authored-by: Ranzo J Taylor, III <[email protected]>
Co-authored-by: Jeff Ngo <[email protected]>
Co-authored-by: Ankur <[email protected]>
Co-authored-by: kurthdelphix <[email protected]>
Co-authored-by: Kurt Hutchison <[email protected]>
Co-authored-by: Tom Walsh <[email protected]>

Co-authored-by: Raul Santelices <[email protected]>
Co-authored-by: Ranzo J Taylor, III <[email protected]>
Co-authored-by: Jeff Ngo <[email protected]>
Co-authored-by: Ankur <[email protected]>
Co-authored-by: kurthdelphix <[email protected]>
Co-authored-by: Kurt Hutchison <[email protected]>
Co-authored-by: Tom Walsh <[email protected]>
@vimleshmishra vimleshmishra mentioned this pull request Mar 16, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ravi-cm ravi-cm Awaiting requested review from ravi-cm

@kurthdelphix kurthdelphix Awaiting requested review from kurthdelphix

3 more reviewers

@ankursarin ankursarin ankursarin left review comments

@mothslaw mothslaw mothslaw approved these changes

@nhlien93 nhlien93 nhlien93 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@jeffngo jeffngo

Labels

documentation Improvements or additions to documentation

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jeffngo @ankursarin @nhlien93 @mothslaw