Increase the maximum buffer size of the Kubernetes agent bootstrapRunner's stream readers #1055
Conversation
This file contains 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
flin-8
reviewed
Jan 10, 2025
docker/kubernetes-agent-tentacle/bootstrapRunner/bootstrapRunner.go
Outdated
Show resolved
Hide resolved
flin-8
reviewed
Jan 10, 2025
docker/kubernetes-agent-tentacle/bootstrapRunner/bootstrapRunner.go
Outdated
Show resolved
Hide resolved
flin-8
reviewed
Jan 12, 2025
| for scanner.Scan() { | ||
| Write(stream, scanner.Text(), counter, gcm) | ||
| } | ||
|
|
||
| err := readCloser.Close() | ||
| if scanner.Err() != nil { |
There was a problem hiding this comment.
QQ: is it worth printing the scanner error before closing the reader?
There was a problem hiding this comment.
The scanning error will be available even after closing the reader, because the error is associated with the scanner object itself, not the reader.
flin-8
reviewed
Jan 12, 2025
docker/kubernetes-agent-tentacle/bootstrapRunner/bootstrapRunner.go
Outdated
Show resolved
Hide resolved
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.
Background
Part of OctopusDeploy/Issues#9202
This PR addresses an issue where long text cannot be written to Octopus output variables when deploying via the Octopus Kubernetes Agent. The problem is caused by the default max buffer size of the
bufio.Scannerin the bootstrap runner, which is limited to 64 KiB. This causes large outputs (e.g., from Terraform plans) to not be written to service message logs.[sc-100196]
Results
The max buffer size for the Scanner has been increased to allow larger outputs, with the maximum size set to 10 MiB, which aligns with Kubernetes' default max container log size.
Ensures the reader is closed after scanning (regardless of error) to properly close the pipe, allowing the command process to terminate without hanging while waiting for the pipe to clear before writing stdout.