add soci to nerdctl image convert [DO NOT MERGE] #4300
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
coderbirju
changed the title
Signed-off-by: Arjun Raja Yogidas <[email protected]>
coderbirju
force-pushed
the
add-soci-convert
branch
from
c40ca4c to
dda79d3
Compare
| @@ -45,3 +45,18 @@ For images that already have SOCI indices, see https://gallery.ecr.aws/soci-work | |||
| nerdctl push --snapshotter=soci --soci-span-size=2097152 --soci-min-layer-size=20971520 public.ecr.aws/my-registry/my-repo:latest | |||
| ``` | |||
| --soci-span-size and --soci-min-layer-size are two properties to customize the SOCI index. See [Command Reference](https://github.com/containerd/nerdctl/blob/377b2077bb616194a8ef1e19ccde32aa1ffd6c84/docs/command-reference.md?plain=1#L773) for further details. | |||
|
|
|||
|
|
|||
| ## Enable SOCI for `nerdctl image convert` | |||
There was a problem hiding this comment.
Needs documentation to distinguish soci option with push vs convert and some details about v1, v2 indexes
| @@ -960,6 +960,11 @@ Flags: | |||
| - `--oci` : convert Docker media types to OCI media types | |||
| - `--platform=<PLATFORM>` : convert content for a specific platform | |||
| - `--all-platforms` : convert content for all platforms (default: false) | |||
| - `--soci`: generate SOCI v2 Indices to oci images. | |||
| @@ -960,6 +960,11 @@ Flags: | |||
| - `--oci` : convert Docker media types to OCI media types | |||
| - `--platform=<PLATFORM>` : convert content for a specific platform | |||
| - `--all-platforms` : convert content for all platforms (default: false) | |||
| - `--soci`: generate SOCI v2 Indices to oci images. | |||
| *[**Note**: content is converted for all platforms by default when using this flag, use the `--platorm` flag to limit this behavior]* | |||
| - `--soci-min-layer-size` : Span size in bytes that soci index uses to segment layer data. Default is 4 MiB. | |||
| @@ -89,6 +89,12 @@ func convertCommand() *cobra.Command { | |||
| cmd.Flags().String("overlaybd-dbstr", "", "Database config string for overlaybd") | |||
| // #endregion | |||
|
|
|||
| // #region soci flags | |||
| cmd.Flags().Bool("soci", false, "Convert image to SOCI Index V2 format.") | |||
| cmd.Flags().Int64("soci-min-layer-size", -1, "The minimum size of layers that will be converted to SOCI Index V2 format") | |||
There was a problem hiding this comment.
Should we set the default explicitly instead of passing -1? If we simply want to use SOCI defined defaults, can we simply not pass these options if not set?
|
|
||
| // ConvertSociIndexV2 converts an image to SOCI format and returns the converted image reference with digest | ||
| func ConvertSociIndexV2(ctx context.Context, client *client.Client, srcRef string, destRef string, gOpts types.GlobalCommandOptions, platforms []string, sOpts types.SociOptions) (string, error) { | ||
| sociCmd, err := setupSociCommand(gOpts) |
There was a problem hiding this comment.
This will rely on the platform SOCI version to support the convert option as well. For compatibility, should we check the SOCI cli version first, before making the soci call. We should throw an appropriate error/warn message if the platform soci version does not support convert option.
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.
This PR adds functionality to support
nerdctl image convertusing soci.This follows the new soci convert feature.
Note: the tests currently skip if the soci version is <0.10.0 (which is the expected version that will contain the convert feature) and this PR will be marked DO NOT MERGE till then.
cc: @Shubhranshu153 @swagatbora90 @AkihiroSuda