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.

Sign up for GitHub

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

[OCIRepository] Produce Helm chart artifacts #912

Closed
wants to merge 1 commit into from
Closed

[OCIRepository] Produce Helm chart artifacts #912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions api/v1beta2/ocirepository_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,11 @@ func (in *OCIRepository) GetLayerMediaType() string {
return in.Spec.LayerSelector.MediaType
}

// IsHelmMediaType returns true if the selector is set to 'application/vnd.cncf.helm.chart.content.v1.tar+gzip'
func (in *OCIRepository) IsHelmMediaType() bool {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make this accept a parameter instead of pulling "Helm" into the API.

return in.GetLayerMediaType() == "application/vnd.cncf.helm.chart.content.v1.tar+gzip"
}

// +genclient
// +genclient:Namespaced
// +kubebuilder:storageversion
Expand Down
129 changes: 108 additions & 21 deletions controllers/ocirepository_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ import (
"crypto/x509"
"errors"
"fmt"
"io"
"net/http"
"os"
"path/filepath"
"sort"
"strings"
"time"
Expand Down Expand Up @@ -407,6 +409,23 @@ func (r *OCIRepositoryReconciler) reconcileSource(ctx context.Context, obj *sour
Revision: revision,
Metadata: manifest.Annotations,
}

// If the artifact is a Helm chart, we set the revision to the image tag
// instead of using the image digest SHA
if obj.IsHelmMediaType() {
chartName, chartVersion, err := r.chartInfoFromURL(url)
if err != nil {
e := serror.NewGeneric(
fmt.Errorf("failed to parse Helm chart name: %w", err),
sourcev1.OCILayerOperationFailedReason,
)
conditions.MarkTrue(obj, sourcev1.FetchFailedCondition, e.Reason, e.Err.Error())
return sreconcile.ResultEmpty, e
}
m.Path = chartName
m.Revision = chartVersion
}

m.DeepCopyInto(metadata)

// Mark observations about the revision on the object
Expand Down Expand Up @@ -445,7 +464,6 @@ func (r *OCIRepositoryReconciler) reconcileSource(ctx context.Context, obj *sour
conditions.MarkTrue(obj, sourcev1.SourceVerifiedCondition, meta.SucceededReason, "verified signature of digest %s", revision)
}

// Extract the content of the first artifact layer
if !obj.GetArtifact().HasRevision(revision) {
layers, err := img.Layers()
if err != nil {
Expand Down Expand Up @@ -509,13 +527,38 @@ func (r *OCIRepositoryReconciler) reconcileSource(ctx context.Context, obj *sour
return sreconcile.ResultEmpty, e
}

if _, err = untar.Untar(blob, dir); err != nil {
e := serror.NewGeneric(
fmt.Errorf("failed to untar the first layer from artifact: %w", err),
sourcev1.OCILayerOperationFailedReason,
)
conditions.MarkTrue(obj, sourcev1.FetchFailedCondition, e.Reason, e.Err.Error())
return sreconcile.ResultEmpty, e
// If the artifact is a Helm chart, we write the blob as it is to the storage
if obj.IsHelmMediaType() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not make this behavior special to Helm. Instead, I would allow the user to decide if the layer blob should be copied as-is, or extracted first. This prevents the potential growth of having n solutions which require this special behavior.

file, err := os.Create(filepath.Join(dir, m.Path))
if err != nil {
e := serror.NewGeneric(
fmt.Errorf("failed to create Helm chart file: %w", err),
sourcev1.OCILayerOperationFailedReason,
)
conditions.MarkTrue(obj, sourcev1.FetchFailedCondition, e.Reason, e.Err.Error())
return sreconcile.ResultEmpty, e
}

defer file.Close()
_, err = io.Copy(file, blob)
if err != nil {
e := serror.NewGeneric(
fmt.Errorf("failed to extract Helm chart from artifact: %w", err),
sourcev1.OCILayerOperationFailedReason,
)
conditions.MarkTrue(obj, sourcev1.FetchFailedCondition, e.Reason, e.Err.Error())
return sreconcile.ResultEmpty, e
}
} else {
// Extract the content of the artifact layer to the storage
if _, err = untar.Untar(blob, dir); err != nil {
e := serror.NewGeneric(
fmt.Errorf("failed to untar the first layer from artifact: %w", err),
sourcev1.OCILayerOperationFailedReason,
)
conditions.MarkTrue(obj, sourcev1.FetchFailedCondition, e.Reason, e.Err.Error())
return sreconcile.ResultEmpty, e
}
}
}

Expand Down Expand Up @@ -623,6 +666,26 @@ func (r *OCIRepositoryReconciler) parseRepositoryURL(obj *sourcev1.OCIRepository
return ref.Context().Name(), nil
}

// chartInfoFromURL validates and extracts the Helm chart name and version from the OCI URL.
func (r *OCIRepositoryReconciler) chartInfoFromURL(url string) (string, string, error) {
ref, err := name.ParseReference(url)
if err != nil {
return "", "", err
}

imageName := strings.TrimPrefix(url, ref.Context().RegistryStr())
imageParts := strings.Split(imageName, ":")
if len(imageParts) != 2 {
return "", "", fmt.Errorf("invalid Helm chart address '%s', does not contain a tag", url)
}

chartVersion := imageParts[1]
nameParts := strings.Split(imageParts[0], "/")
chartName := nameParts[len(nameParts)-1]

return fmt.Sprintf("%s-%s.tgz", chartName, chartVersion), chartVersion, nil
}

// getArtifactURL determines which tag or digest should be used and returns the OCI artifact FQN.
func (r *OCIRepositoryReconciler) getArtifactURL(obj *sourcev1.OCIRepository, options []crane.Option) (string, error) {
url, err := r.parseRepositoryURL(obj)
Expand Down Expand Up @@ -862,21 +925,30 @@ func (r *OCIRepositoryReconciler) reconcileArtifact(ctx context.Context,
revision := metadata.Revision

// Create artifact
artifact := r.Storage.NewArtifactFor(obj.Kind, obj, revision, fmt.Sprintf("%s.tar.gz", revision))
artifact := r.Storage.NewArtifactFor(obj.Kind, obj.GetObjectMeta(), revision, fmt.Sprintf("%s.tar.gz", revision))
if obj.IsHelmMediaType() {
artifact = r.Storage.NewArtifactFor(obj.Kind, obj.GetObjectMeta(), revision, metadata.Path)
}

// Set the ArtifactInStorageCondition if there's no drift.
defer func() {
if obj.GetArtifact().HasRevision(artifact.Revision) {
msg := fmt.Sprintf("stored artifact for digest '%s'", artifact.Revision)
if obj.IsHelmMediaType() {
msg = fmt.Sprintf("stored chart with version '%s'", artifact.Revision)
}
conditions.Delete(obj, sourcev1.ArtifactOutdatedCondition)
conditions.MarkTrue(obj, sourcev1.ArtifactInStorageCondition, meta.SucceededReason,
"stored artifact for digest '%s'", artifact.Revision)
conditions.MarkTrue(obj, sourcev1.ArtifactInStorageCondition, meta.SucceededReason, msg)
}
}()

// The artifact is up-to-date
if obj.GetArtifact().HasRevision(artifact.Revision) {
r.eventLogf(ctx, obj, events.EventTypeTrace, sourcev1.ArtifactUpToDateReason,
"artifact up-to-date with remote digest: '%s'", artifact.Revision)
msg := fmt.Sprintf("artifact up-to-date with remote digest: '%s'", artifact.Revision)
if obj.IsHelmMediaType() {
msg = fmt.Sprintf("chart up-to-date with remote version: '%s'", artifact.Revision)
}
r.eventLogf(ctx, obj, events.EventTypeTrace, sourcev1.ArtifactUpToDateReason, msg)
return sreconcile.ResultSuccess, nil
}

Expand Down Expand Up @@ -915,14 +987,26 @@ func (r *OCIRepositoryReconciler) reconcileArtifact(ctx context.Context,
}
defer unlock()

// Archive directory to storage
if err := r.Storage.Archive(&artifact, dir, nil); err != nil {
e := serror.NewGeneric(
fmt.Errorf("unable to archive artifact to storage: %s", err),
sourcev1.ArchiveOperationFailedReason,
)
conditions.MarkTrue(obj, sourcev1.StorageOperationFailedCondition, e.Reason, e.Err.Error())
return sreconcile.ResultEmpty, e
if obj.IsHelmMediaType() {
// Copy the packaged chart to the artifact path
if err = r.Storage.CopyFromPath(&artifact, filepath.Join(dir, metadata.Path)); err != nil {
e := serror.NewGeneric(
fmt.Errorf("unable to copy Helm chart to storage: %w", err),
sourcev1.ArchiveOperationFailedReason,
)
conditions.MarkTrue(obj, sourcev1.StorageOperationFailedCondition, e.Reason, e.Err.Error())
return sreconcile.ResultEmpty, e
}
} else {
// Archive directory to storage
if err := r.Storage.Archive(&artifact, dir, nil); err != nil {
e := serror.NewGeneric(
fmt.Errorf("unable to archive artifact to storage: %s", err),
sourcev1.ArchiveOperationFailedReason,
)
conditions.MarkTrue(obj, sourcev1.StorageOperationFailedCondition, e.Reason, e.Err.Error())
return sreconcile.ResultEmpty, e
}
}

// Record it on the object
Expand Down Expand Up @@ -1029,6 +1113,9 @@ func (r *OCIRepositoryReconciler) notify(ctx context.Context,
}

message := fmt.Sprintf("stored artifact with digest '%s' from '%s'", newObj.Status.Artifact.Revision, newObj.Spec.URL)
if newObj.IsHelmMediaType() {
message = fmt.Sprintf("stored chart version '%s'", newObj.Status.Artifact.Revision)
}

// enrich message with upstream annotations if found
if info := newObj.GetArtifact().Metadata; info != nil {
Expand Down