Skip to content
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

feat(daemon): generate config file from Docker Engine API #1130

Merged
merged 3 commits into from
Apr 20, 2023
Merged

feat(daemon): generate config file from Docker Engine API #1130

merged 3 commits into from
Apr 20, 2023

Conversation

knqyf263
Copy link
Contributor

Description

#1121 allows daemon.Image to get a config name without exporting a tar file. This PR also generates a config file from docker inspect and docker history without exporting. Note that RawConfigFile() cannot be emulated by Docker Engine API as far as I know.

I referred to this implementation.

func (i *image) compute() error {

In addition, I changed some value receivers to pointer receivers since we should not mix receiver types.

Don't mix receiver types. Choose either pointers or struct types for all available methods.

https://github.com/golang/go/wiki/CodeReviewComments#receiver-type

@knqyf263 knqyf263 changed the title feat(daemon): generate config file from Docker API feat(daemon): generate config file from Docker Engine API Sep 23, 2021
return nil, err
}
return i.tarballImage.ConfigFile()
return i.configFile.DeepCopy(), nil
Copy link
Collaborator

Choose a reason for hiding this comment

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

Interesting... so this lets you get the semantic image config cheaply, but if you want to actual config file docker would generate, we have to actually save the image and have docker do this serialization?

Somewhat confusing but it's nice that it's possible. What's the use case you have where you need quick access to the config file?

Copy link
Contributor Author

@knqyf263 knqyf263 Oct 11, 2021

Choose a reason for hiding this comment

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

but if you want to actual config file docker would generate, we have to actually save the image and have docker do this serialization?

As far as I know, it is the case. I didn't find Docker Engine API returning the actual config.

What's the use case you have where you need quick access to the config file?

Strictly speaking, we just need to get diff_id quickly so that we can check if the layer is already cached or not. Image ID doesn't meet our requirements. Let's say Image B is based on Image A like the following:

  • Image B
    • Layer 2
    • Layer 1
  • Image A
    • Layer 1

If we scan Image B, our cache should have image_id of Image B and diff_ids of Layer 1 and 2. Then, when we scan Image A, the image_id of Image A will be missed, while the diff_id of Layer 1 exists in the cache. In this case, we don't have to save Image A as we're actually interested in the layer content only.

Currently, we cannot skip saving Image A even though Layer 1 exists in our cache.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you add a test that compares the result of ConfigFile() with calling RawConfigFile() and parsing it?

I'm ok if they're not identical, but I'd like to see which fields are missing or different.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If I understand correctly, ConfigFile() and RawConfigFile() are already compared here.

if diff := cmp.Diff(pcf, cf); diff != "" {
errs = append(errs, fmt.Sprintf("mismatched config content: (-ParseConfigFile(RawConfigFile()) +ConfigFile()) %s", diff))
}

@github-actions
Copy link

github-actions bot commented Mar 2, 2022

This Pull Request is stale because it has been open for 90 days with
no activity. It will automatically close after 30 more days of
inactivity. Keep fresh with the 'lifecycle/frozen' label.

@jonjohnsonjr
Copy link
Collaborator

@knqyf263 still interested in this?

@knqyf263
Copy link
Contributor Author

knqyf263 commented Mar 3, 2022

Yes, but I don't have time recently. Hopefully, I will find some time next week.

@codecov-commenter
Copy link

codecov-commenter commented Mar 31, 2022

Codecov Report

Merging #1130 (5bce570) into main (efc62d8) will decrease coverage by 0.09%.
The diff coverage is 66.94%.

@@            Coverage Diff             @@
##             main    #1130      +/-   ##
==========================================
- Coverage   74.07%   73.97%   -0.10%     
==========================================
  Files         112      112              
  Lines        8385     8501     +116     
==========================================
+ Hits         6211     6289      +78     
- Misses       1570     1598      +28     
- Partials      604      614      +10     
Impacted Files Coverage Δ
pkg/v1/daemon/options.go 94.28% <ø> (ø)
pkg/v1/daemon/image.go 71.36% <66.94%> (-4.32%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update efc62d8...5bce570. Read the comment docs.

@github-actions
Copy link

This Pull Request is stale because it has been open for 90 days with
no activity. It will automatically close after 30 more days of
inactivity. Keep fresh with the 'lifecycle/frozen' label.

@jonjohnsonjr jonjohnsonjr merged commit 9f68710 into google:main Apr 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants