CopyContainer documentation

[peternied]

Description

Renamed the function from copyDockerImage to copyContainer that more appropriate fits the functionality
Add additional documentation for the copyContainer function to make it clear what source/destinations can be used.

Following up a comment that was made on the proof of concept about the limitations of container copying

Issues Resolved

• [POC] Universal Release Prototype for Data Prepper peternied/data-prepper#1 (comment)

Check List

• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[codecov-commenter]

Codecov Report

Merging #1609 (e52f089) into main (0a20ec1) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               main    #1609   +/-   ##
=========================================
  Coverage     94.66%   94.66%           
  Complexity       13       13           
=========================================
  Files           162      162           
  Lines          3433     3433           
  Branches         21       21           
=========================================
  Hits           3250     3250           
  Misses          180      180           
  Partials          3        3           

Impacted Files	Coverage Δ
...ests/jenkins/jobs/CopyContainer_docker_Jenkinsfile	100.00% <ø> (ø)

---

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 0a20ec1...e52f089. Read the comment docs.

[peternied]

@dlvenable FYI

[dlvenable]

@peternied , Thanks for tagging me and for improving the documentation. This will be helpful for Data Prepper.

I'm curious why renamed it to copyContainer. It is copying images, not containers, right?

[peternied]

@dlvenable The rename was to remove the docker centric nature of the previous name, so that callers would not look for a copyECRImage(...) function. copyContainerImage would be correct and I did not think of it when I picked the name. I think this will work.