feat: use proto streams to increase maximum module files payload #18268
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this does
Protobuf has a maximum message size, configured to 4mb.
Dynamic parameters requires the remotely fetched module files located in
~/.terraform/modulesfor evaluation. These can exceed the maximum message size. To allow for templates with larger modules, this PR adds a proto stream to stream over the file in chunks. The resulting file is inserted to the database, and then referenced by filehash.Note every template version for a given template will have the same module_files (assuming no provider changes). So most module files are deduplicated per version. In the future, it might be even more advantageous to upload individual modules to reuse across various templates.
Implementation
Coderd <-> Provisionerd
If the
module_filesare too large, it uses a new protobuf stream to send and upload the file before theCompleteJobfires:coder/provisionerd/proto/provisionerd.proto
Lines 220 to 222 in e880894
The
CompleteJobreferences the file uploaded by itshashand its type.Provisionerd <-> Provisioner
This communication all happens in memory today right? No actual networks?
Since a
streamis already used,DataUploadandChunkPieceare added to the existing stream.