feat: adds --list-images arg to inspect #599

eFAILution · 2024-05-09T17:00:30Z

This PR introduces two major enhancements to the project:

inspect --list-images Option: This new command-line option allows users to list all the images contained in the packages of a bundle. This feature enhances the usability of the tool by providing a quick and easy way to inspect the images without having to manually parse the bundle or package metadata.
YAML Bundle Reading Capability: The tool can now read and parse bundle metadata directly from a YAML file as the tarball is not always available. The tool reads the YAML file, unmarshals the data into a Bundle struct, and then performs the same operations as it would if the bundle were loaded from an OCI registry.

Related Issue

Fixes #

Relates to #

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Other (security config, docs update, etc)

Checklist before merging

Test, docs, adr added or updated as needed
Contributor Guide Steps followed

UncleGedd · 2024-05-13T20:47:42Z

Aight fellas, finally got a chance to look through this PR. Based on our conversation last week, I think we need to rework the approach to this problem. Instead of grabbing a ref from the uds-bundle.yaml and following it to its OCI repo, we'll need to dig into the bundle itself to see what images are actually there (recalling that optional components are a thing)

Before this can be done cleanly, I think these 2 tickets to refactor the underlying OCI metadata will need to be completed. We'll be starting work on these in the next day or so.

…ability

UncleGedd · 2024-06-06T15:27:23Z

Paired with @eFAILution and refactored this PR to introduce the --list-images flag. Expected behavior is that users should be able to point uds inspect at a bundle YAML and get a list of images that will be included in the bundle before it gets created

decleaver

looks good. paired on a portion and tested different use cases locally.

TristanHoladay · 2024-06-06T18:04:16Z

README.md

@@ -107,6 +107,13 @@ Inspect the `uds-bundle.yaml` of a bundle
 1. From an OCI registry: `uds inspect oci:https://ghcr.io/defenseunicorns/dev/<name>:<tag>`
 1. From your local filesystem: `uds inspect uds-bundle-<name>.tar.zst`

+#### Viewing Images in a Bundle
+It is possible derive images from a `uds-bundle.yaml`. This can be useful for situations where you need to know what images will be bundled before you actually create the bundle. This is accomplished with the `--list-images`. For example:


Suggested change

It is possible derive images from a `uds-bundle.yaml`. This can be useful for situations where you need to know what images will be bundled before you actually create the bundle. This is accomplished with the `--list-images`. For example:

It is possible to derive images from a `uds-bundle.yaml`. This can be useful for situations where you need to know what images will be bundled before you actually create the bundle. This is accomplished with `--list-images`. For example:

TristanHoladay · 2024-06-06T18:05:32Z

README.md

+
+`uds inspect ./uds-bundle.yaml --list-images`
+
+This command will return a list of images derived from the bundle's packages and taking into account optional and required package components.


Suggested change

This command will return a list of images derived from the bundle's packages and taking into account optional and required package components.

This command will return a list of images derived from the bundle's packages, taking into account optional and required package components.

TristanHoladay · 2024-06-06T18:25:18Z

src/pkg/bundle/inspect.go

+	//  handle --list-images flag
+	if b.cfg.InspectOpts.ListImages {
+		err := utils.CheckYAMLSourcePath(b.cfg.InspectOpts.Source)
+		if err != nil {


nit, but is there a particular reason to have the err check separate on this one but "inlined" (if that's the right word) for the next call. just wondering if we can make them all look the same for consistency.

Also, do you think there's any value in extracting the list image functions into a separate function listImages() that gets called in Inspect(). Feels like it's getting a little long.

TristanHoladay · 2024-06-06T18:40:47Z

src/pkg/utils/utils.go

+		return fmt.Errorf("source must have .yaml or yml file extension")
+	}
+	// Check if the file exists
+	if _, err := os.Stat(source); os.IsNotExist(err) {


this looks good to me, but also wondering if we want to leverage the pkg/helpers more. there's a InvalidPath method i used for the FileValues handling.

TristanHoladay · 2024-06-06T18:46:14Z

src/types/bundle.go

@@ -32,6 +32,7 @@ type UDSBundle struct {
 type Package struct {
 	Name               string                                     `json:"name" jsonschema:"name=Name of the Zarf package"`
 	Description        string                                     `json:"description,omitempty" jsonschema:"description=Description of the Zarf package"`
+	Images             []string                                   `json:"images,omitempty" jsonschema:"description=List of images included in the Zarf package"`


is this getting used somewhere? having trouble understanding how it's being used / set.

eFAILution requested review from UncleGedd, jeff-mccoy, decleaver and mjnagel as code owners May 9, 2024 17:00

eFAILution changed the title ~~feat(inspect): Added --list-images option and YAML bundle reading cap…~~ feat(inspect): supports bundle.yaml and adds --list-images arg May 10, 2024

eFAILution force-pushed the feature/list-images branch from cabdaaa to cee3f39 Compare May 10, 2024 12:06

UncleGedd mentioned this pull request May 13, 2024

Refactor OCI #350

Closed

UncleGedd force-pushed the feature/list-images branch from cee3f39 to 0605b37 Compare June 4, 2024 19:10

UncleGedd requested a review from TristanHoladay as a code owner June 4, 2024 19:10

UncleGedd self-assigned this Jun 5, 2024

UncleGedd force-pushed the feature/list-images branch from 277681b to 6540cc6 Compare June 5, 2024 16:56

eFAILution and others added 5 commits June 6, 2024 08:31

feat(inspect): Added --list-images option and YAML bundle reading cap…

c0ea98d

…ability

chore(inspect.go): fix debugf style error

f51cd4b

chore(schema): update

0cdab7d

WIP: refactoring approach, still need local pkgs

c04cc55

WIP: empty zarf opts

4af54fe

UncleGedd force-pushed the feature/list-images branch from 595b32c to 4af54fe Compare June 6, 2024 13:31

feat: adds list images flag

6da643d

UncleGedd changed the title ~~feat(inspect): supports bundle.yaml and adds --list-images arg~~ feat: adds --list-images arg to inspect Jun 6, 2024

UncleGedd added 8 commits June 6, 2024 10:37

small refactor

9899da5

update schema

5b3e457

fix tests

3473982

fix workflow logs

6d88815

revert logs changes, will make follow up ticket

e374b0f

remove yaml from bundle picker

9533f3b

words

09439ee

docs

bc005b2

decleaver approved these changes Jun 6, 2024

View reviewed changes

TristanHoladay reviewed Jun 6, 2024

View reviewed changes

UncleGedd merged commit 1862f4f into main Jun 6, 2024
12 checks passed

UncleGedd deleted the feature/list-images branch June 6, 2024 18:47

This was referenced Jun 6, 2024

uds inspect --validate #600

Open

chore: small refactors and docs updates #671

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adds --list-images arg to inspect #599

feat: adds --list-images arg to inspect #599

eFAILution commented May 9, 2024 •

edited

Loading

UncleGedd commented May 13, 2024

UncleGedd commented Jun 6, 2024 •

edited

Loading

decleaver left a comment

TristanHoladay Jun 6, 2024

TristanHoladay Jun 6, 2024

TristanHoladay Jun 6, 2024

TristanHoladay Jun 6, 2024

TristanHoladay Jun 6, 2024

	It is possible derive images from a `uds-bundle.yaml`. This can be useful for situations where you need to know what images will be bundled before you actually create the bundle. This is accomplished with the `--list-images`. For example:
	It is possible to derive images from a `uds-bundle.yaml`. This can be useful for situations where you need to know what images will be bundled before you actually create the bundle. This is accomplished with `--list-images`. For example:


		`uds inspect ./uds-bundle.yaml --list-images`

		This command will return a list of images derived from the bundle's packages and taking into account optional and required package components.

feat: adds --list-images arg to inspect #599

feat: adds --list-images arg to inspect #599

Conversation

eFAILution commented May 9, 2024 • edited Loading

Related Issue

Type of change

Checklist before merging

UncleGedd commented May 13, 2024

UncleGedd commented Jun 6, 2024 • edited Loading

decleaver left a comment

Choose a reason for hiding this comment

TristanHoladay Jun 6, 2024

Choose a reason for hiding this comment

TristanHoladay Jun 6, 2024

Choose a reason for hiding this comment

TristanHoladay Jun 6, 2024

Choose a reason for hiding this comment

TristanHoladay Jun 6, 2024

Choose a reason for hiding this comment

TristanHoladay Jun 6, 2024

Choose a reason for hiding this comment

eFAILution commented May 9, 2024 •

edited

Loading

UncleGedd commented Jun 6, 2024 •

edited

Loading