-
Notifications
You must be signed in to change notification settings - Fork 181
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: update existing index (index update) (#1476)
Signed-off-by: Xiaoxuan Wang <[email protected]>
- Loading branch information
1 parent
2808ea1
commit 071f060
Showing
7 changed files
with
633 additions
and
13 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,6 +25,7 @@ func Cmd() *cobra.Command { | |
|
|
||
| cmd.AddCommand( | ||
| createCmd(), | ||
| updateCmd(), | ||
| ) | ||
| return cmd | ||
| } | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,238 @@ | ||
| /* | ||
| Copyright The ORAS Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package index | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
|
|
||
| "github.com/opencontainers/go-digest" | ||
| ocispec "github.com/opencontainers/image-spec/specs-go/v1" | ||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/pflag" | ||
| "oras.land/oras-go/v2" | ||
| "oras.land/oras-go/v2/content" | ||
| "oras.land/oras/cmd/oras/internal/argument" | ||
| "oras.land/oras/cmd/oras/internal/command" | ||
| "oras.land/oras/cmd/oras/internal/display/status" | ||
| oerrors "oras.land/oras/cmd/oras/internal/errors" | ||
| "oras.land/oras/cmd/oras/internal/option" | ||
| "oras.land/oras/cmd/oras/internal/output" | ||
| "oras.land/oras/internal/contentutil" | ||
| "oras.land/oras/internal/descriptor" | ||
| ) | ||
|
|
||
| type updateOptions struct { | ||
| option.Common | ||
| option.Target | ||
|
|
||
| addArguments []string | ||
| mergeArguments []string | ||
| removeArguments []string | ||
| tags []string | ||
| } | ||
|
|
||
| func updateCmd() *cobra.Command { | ||
| var opts updateOptions | ||
| cmd := &cobra.Command{ | ||
| Use: "update <name>{:<tag>|@<digest>} [{--add|--merge|--remove} {<tag>|<digest>}] [...]", | ||
| Short: "[Experimental] Update and push an image index", | ||
| Long: `[Experimental] Update and push an image index. All manifests should be in the same repository | ||
| Example - Remove a manifest and add two manifests from an index tagged 'v1'. The tag will point to the updated index: | ||
| oras manifest index update localhost:5000/hello:v1 --add linux-amd64 --add linux-arm64 --remove sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 | ||
| Example - Create a new index by updating an existing index specified by its digest: | ||
| oras manifest index update localhost:5000/hello@sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 --add linux-amd64 --remove sha256:fd6ed2f36b5465244d5dc86cb4e7df0ab8a9d24adc57825099f522fe009a22bb | ||
| Example - Merge manifests from the index 'v2-windows' to the index 'v2': | ||
| oras manifest index update localhost:5000/hello:v2 --merge v2-windows | ||
| Example - Update an index and tag the updated index as 'v2.1.0' and 'v2': | ||
| oras manifest index update localhost:5000/hello@sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9 --add linux-amd64 --tag "v2.1.0" --tag "v2" | ||
| `, | ||
| Args: oerrors.CheckArgs(argument.Exactly(1), "the target index to update"), | ||
| PreRunE: func(cmd *cobra.Command, args []string) error { | ||
| opts.RawReference = args[0] | ||
| for _, manifestRef := range opts.removeArguments { | ||
| if !contentutil.IsDigest(manifestRef) { | ||
| return fmt.Errorf("remove: %s is not a digest", manifestRef) | ||
| } | ||
| } | ||
| return option.Parse(cmd, &opts) | ||
| }, | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| return updateIndex(cmd, opts) | ||
| }, | ||
| } | ||
| option.ApplyFlags(&opts, cmd.Flags()) | ||
| cmd.Flags().StringArrayVarP(&opts.addArguments, "add", "", nil, "manifests to add to the index") | ||
| cmd.Flags().StringArrayVarP(&opts.mergeArguments, "merge", "", nil, "indexes to be merged into the index") | ||
| cmd.Flags().StringArrayVarP(&opts.removeArguments, "remove", "", nil, "manifests to remove from the index, must be digests") | ||
| cmd.Flags().StringArrayVarP(&opts.tags, "tag", "", nil, "extra tags for the updated index") | ||
| return oerrors.Command(cmd, &opts.Target) | ||
| } | ||
|
|
||
| func updateIndex(cmd *cobra.Command, opts updateOptions) error { | ||
| // if no update flag is used, do nothing | ||
| if !updateFlagsUsed(cmd.Flags()) { | ||
| opts.Println("Nothing to update as no change is requested") | ||
| return nil | ||
| } | ||
| ctx, logger := command.GetLogger(cmd, &opts.Common) | ||
| target, err := opts.NewTarget(opts.Common, logger) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if err := opts.EnsureReferenceNotEmpty(cmd, true); err != nil { | ||
| return err | ||
| } | ||
| index, err := fetchIndex(ctx, target, opts) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| manifests, err := removeManifests(ctx, index.Manifests, target, opts) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| manifests, err = addManifests(ctx, manifests, target, opts) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| manifests, err = mergeIndexes(ctx, manifests, target, opts) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| index.Manifests = manifests | ||
| indexBytes, err := json.Marshal(index) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| desc := content.NewDescriptorFromBytes(index.MediaType, indexBytes) | ||
|
|
||
| printUpdateStatus(status.IndexPromptUpdated, string(desc.Digest), "", opts.Printer) | ||
| path := getPushPath(opts.RawReference, opts.Type, opts.Reference, opts.Path) | ||
| return pushIndex(ctx, target, desc, indexBytes, opts.Reference, opts.tags, path, opts.Printer) | ||
| } | ||
|
|
||
| func fetchIndex(ctx context.Context, target oras.ReadOnlyTarget, opts updateOptions) (ocispec.Index, error) { | ||
| printUpdateStatus(status.IndexPromptFetching, opts.Reference, "", opts.Printer) | ||
| desc, content, err := oras.FetchBytes(ctx, target, opts.Reference, oras.DefaultFetchBytesOptions) | ||
| if err != nil { | ||
| return ocispec.Index{}, fmt.Errorf("could not find the index %s: %w", opts.Reference, err) | ||
| } | ||
| if !descriptor.IsIndex(desc) { | ||
| return ocispec.Index{}, fmt.Errorf("%s is not an index", opts.Reference) | ||
| } | ||
| printUpdateStatus(status.IndexPromptFetched, opts.Reference, string(desc.Digest), opts.Printer) | ||
| var index ocispec.Index | ||
| if err := json.Unmarshal(content, &index); err != nil { | ||
| return ocispec.Index{}, err | ||
| } | ||
| return index, nil | ||
| } | ||
|
|
||
| func addManifests(ctx context.Context, manifests []ocispec.Descriptor, target oras.ReadOnlyTarget, opts updateOptions) ([]ocispec.Descriptor, error) { | ||
| for _, manifestRef := range opts.addArguments { | ||
| printUpdateStatus(status.IndexPromptFetching, manifestRef, "", opts.Printer) | ||
| desc, content, err := oras.FetchBytes(ctx, target, manifestRef, oras.DefaultFetchBytesOptions) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("could not find the manifest %s: %w", manifestRef, err) | ||
| } | ||
| if !descriptor.IsManifest(desc) { | ||
| return nil, fmt.Errorf("%s is not a manifest", manifestRef) | ||
| } | ||
| printUpdateStatus(status.IndexPromptFetched, manifestRef, string(desc.Digest), opts.Printer) | ||
| if descriptor.IsImageManifest(desc) { | ||
| desc.Platform, err = getPlatform(ctx, target, content) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| } | ||
| manifests = append(manifests, desc) | ||
| printUpdateStatus(status.IndexPromptAdded, manifestRef, string(desc.Digest), opts.Printer) | ||
| } | ||
| return manifests, nil | ||
| } | ||
|
|
||
| func mergeIndexes(ctx context.Context, manifests []ocispec.Descriptor, target oras.ReadOnlyTarget, opts updateOptions) ([]ocispec.Descriptor, error) { | ||
| for _, indexRef := range opts.mergeArguments { | ||
| printUpdateStatus(status.IndexPromptFetching, indexRef, "", opts.Printer) | ||
| desc, content, err := oras.FetchBytes(ctx, target, indexRef, oras.DefaultFetchBytesOptions) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("could not find the index %s: %w", indexRef, err) | ||
| } | ||
| if !descriptor.IsIndex(desc) { | ||
| return nil, fmt.Errorf("%s is not an index", indexRef) | ||
| } | ||
| printUpdateStatus(status.IndexPromptFetched, indexRef, string(desc.Digest), opts.Printer) | ||
| var index ocispec.Index | ||
| if err := json.Unmarshal(content, &index); err != nil { | ||
| return nil, err | ||
| } | ||
| manifests = append(manifests, index.Manifests...) | ||
| printUpdateStatus(status.IndexPromptMerged, indexRef, string(desc.Digest), opts.Printer) | ||
| } | ||
| return manifests, nil | ||
| } | ||
|
|
||
| func removeManifests(ctx context.Context, manifests []ocispec.Descriptor, target oras.ReadOnlyTarget, opts updateOptions) ([]ocispec.Descriptor, error) { | ||
| // create a set of digests to speed up the remove | ||
| digestToRemove := make(map[digest.Digest]bool) | ||
| for _, manifestRef := range opts.removeArguments { | ||
| digestToRemove[digest.Digest(manifestRef)] = false | ||
| } | ||
| return doRemoveManifests(manifests, digestToRemove, opts.Printer, opts.Reference) | ||
| } | ||
|
|
||
| func doRemoveManifests(originalManifests []ocispec.Descriptor, digestToRemove map[digest.Digest]bool, printer *output.Printer, indexRef string) ([]ocispec.Descriptor, error) { | ||
| manifests := []ocispec.Descriptor{} | ||
| for _, m := range originalManifests { | ||
| if _, exists := digestToRemove[m.Digest]; exists { | ||
| digestToRemove[m.Digest] = true | ||
| } else { | ||
| manifests = append(manifests, m) | ||
| } | ||
| } | ||
| for digest, removed := range digestToRemove { | ||
| if !removed { | ||
| return nil, fmt.Errorf("%s does not exist in the index %s", digest, indexRef) | ||
| } | ||
| printUpdateStatus(status.IndexPromptRemoved, string(digest), "", printer) | ||
| } | ||
| return manifests, nil | ||
| } | ||
|
|
||
| func updateFlagsUsed(flags *pflag.FlagSet) bool { | ||
| return flags.Changed("add") || flags.Changed("remove") || flags.Changed("merge") | ||
| } | ||
|
|
||
| func printUpdateStatus(verb string, reference string, resolvedDigest string, printer *output.Printer) { | ||
| if resolvedDigest == "" || contentutil.IsDigest(reference) { | ||
| printer.Println(verb, reference) | ||
| } else { | ||
| printer.Println(verb, resolvedDigest, reference) | ||
| } | ||
| } | ||
|
|
||
| func getPushPath(rawReference string, targetType string, reference string, path string) string { | ||
| if contentutil.IsDigest(reference) { | ||
| return fmt.Sprintf("[%s] %s", targetType, path) | ||
| } | ||
| return fmt.Sprintf("[%s] %s", targetType, rawReference) | ||
| } |
Oops, something went wrong.