Encode artifact image-name and container WORKDIR in container debug info #3564
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
`debug` annotates podspecs with debugging configuration information about its debuggable containers. This debug configuration information was being passed around as map, but it was becoming a bit unwieldy. This PR turns this map into an object (ContainerDebugConfiguration), and further encodes the corresponding artifact's image-name and the container working directory.
briandealwis
requested review from
balopat,
loosebazooka,
nkubala and
tejal29
as code owners
Codecov Report
|
dgageot
approved these changes
Jan 23, 2020
| @@ -114,14 +115,14 @@ func (t testTransformer) RuntimeSupportImage() string { | |||
| return "" | |||
| } | |||
|
|
|||
| func (t testTransformer) Apply(container *v1.Container, config imageConfiguration, portAlloc portAllocator) map[string]interface{} { | |||
| func (t testTransformer) Apply(container *v1.Container, config imageConfiguration, portAlloc portAllocator) *ContainerDebugConfiguration { | |||
There was a problem hiding this comment.
Can you return a value rather than a pointer?
There was a problem hiding this comment.
I think this is a vestige prior to introducing IsApplicable(). I'll do that as a separate PR if that's ok.
This was referenced Feb 3, 2020
Merged
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.
Relates to #3122
Should merge before: xxx
Description
debugannotates podspecs with debugging configuration information about its debuggable containers. This debug configuration information was being passed around as map, but it was becoming a bit unwieldy. This PR:ContainerDebugConfiguration).ContainerDebugConfiguration.One side-effect is that the serialized JSON doesn't sort the same.
The image-name and working-directory is information requested by the IDEs in #3122.
User facing changes
The pod annotation format for the debug configuration information has changed slightly. The IDEs do not currently use this information. Otherwise there should be no visible changes.
Next PRs.
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
Adds integration tests if needed.Reviewer Notes
Release Notes
I don't think this change is worth mentioning since there are no known consumers.