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

feature: Add ability for zarf to find oci artifacts for fluxcd ocirepo resource #3238

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion src/pkg/packager/prepare.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@ import (
"context"
"errors"
"fmt"
"github.com/zarf-dev/zarf/src/pkg/logger"
"os"
"path/filepath"
"regexp"
"sort"
"strings"
"time"

"github.com/zarf-dev/zarf/src/pkg/logger"

"github.com/defenseunicorns/pkg/helpers/v2"
sourcev1beta2 "github.com/fluxcd/source-controller/api/v1beta2"
"github.com/goccy/go-yaml"
"github.com/google/go-containerregistry/pkg/crane"
v1 "k8s.io/api/apps/v1"
Expand Down Expand Up @@ -412,6 +414,13 @@ func processUnstructuredImages(resource *unstructured.Unstructured, matchedImage
}
matchedImages = appendToImageMap(matchedImages, job.Spec.Template.Spec)

case "OCIRepository":
var ociRepo sourcev1beta2.OCIRepository
if err := runtime.DefaultUnstructuredConverter.FromUnstructured(contents, &ociRepo); err != nil {
return nil, nil, fmt.Errorf("could not parse ocirepo: %w", err)
}
matchedImages = appendToImageMapOCIRepo(matchedImages, ociRepo.Spec)

default:
// Capture any custom images
matches := imageCheck.FindAllStringSubmatch(string(b), -1)
Expand Down Expand Up @@ -465,6 +474,28 @@ func appendToImageMap(imgMap map[string]bool, pod corev1.PodSpec) map[string]boo
return imgMap
}

func appendToImageMapOCIRepo(imgMap map[string]bool, repo sourcev1beta2.OCIRepositorySpec) map[string]bool {
var regex = regexp.MustCompile(`oci://(.+)`)
var t = regex.FindStringSubmatch(repo.URL)

s := strings.Builder{}
// Pulls out just the url from the regex
s.Write([]byte(t[1]))

if repo.Reference.Tag != "" {
s.WriteString(":")
s.WriteString(repo.Reference.Tag)
} else if repo.Reference.Digest != "" {
s.WriteString("@")
s.WriteString(repo.Reference.Digest)
} else if repo.Reference.SemVer != "" || repo.Reference.SemverFilter != "" {
message.Warnf("Can not use semver or semverFilter with OCIRepository")
return imgMap
}
imgMap[s.String()] = true
return imgMap
}

func getSortedImages(matchedImages map[string]bool, maybeImages map[string]bool) ([]string, []string) {
sortedMatchedImages := sort.StringSlice{}
for image := range matchedImages {
Expand Down
16 changes: 16 additions & 0 deletions src/pkg/packager/prepare_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,22 @@ func TestFindImages(t *testing.T) {
},
},
},
{
name: "flux-oci-repo",
cfg: &types.PackagerConfig{
CreateOpts: types.ZarfCreateOptions{
BaseDir: "./testdata/find-images/flux-oci-repo",
},
},
expectedImages: map[string][]string{
"baseline": {
"ghcr.io/stefanprodan/manifests/podinfo:6.4.1",
"ghcr.io/stefanprodan/manifests/podinfo@sha256:fc60d367cc05bedae04d6030e270daa89c3d82fa18b1a155314102b2fca39652",
"ghcr.io/stefanprodan/manifests/podinfo:sha256-3f4327936dd3b1c3fa2ce98e7c9d286a5e433d2bcd0a86f759bc75da285ae78c.sig",
"ghcr.io/stefanprodan/manifests/podinfo:sha256-fc60d367cc05bedae04d6030e270daa89c3d82fa18b1a155314102b2fca39652.sig",
},
},
},
{
name: "image not found",
cfg: &types.PackagerConfig{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
apiVersion: source.toolkit.fluxcd.io/v1beta2
kind: OCIRepository
metadata:
name: podinfo-digest
spec:
interval: 30s
url: oci://ghcr.io/stefanprodan/manifests/podinfo
ref:
digest: sha256:fc60d367cc05bedae04d6030e270daa89c3d82fa18b1a155314102b2fca39652
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
apiVersion: source.toolkit.fluxcd.io/v1beta2
kind: OCIRepository
metadata:
name: podinfo-semver
spec:
interval: 30s
url: oci://ghcr.io/stefanprodan/manifests/podinfo
ref:
semver: ">= 6.1.x-0"
semverFilter: ".*-rc.*"
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
apiVersion: source.toolkit.fluxcd.io/v1beta2
kind: OCIRepository
metadata:
name: podinfo-tag
spec:
interval: 30s
url: oci://ghcr.io/stefanprodan/manifests/podinfo
ref:
tag: 6.4.1
14 changes: 14 additions & 0 deletions src/pkg/packager/testdata/find-images/flux-oci-repo/zarf.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
kind: ZarfPackageConfig
metadata:
name: agent
version: 1.0.0
components:
- name: baseline
required: true
manifests:
- name: agent
namespace: default
files:
- oci-repo-tag.yaml
- oci-repo-digest.yaml
- oci-repo-semver.yaml