api/v1alpha1/packagebundle_types.go

// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
//
// 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 v1alpha1

import (
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// +kubebuilder:object:root=true
// +kubebuilder:subresource:status
// +kubebuilder:webhook:path=/validate-packages-eks-amazonaws-com-v1alpha1-packagebundle,mutating=false,failurePolicy=fail,sideEffects=None,groups=packages.eks.amazonaws.com,resources=packagebundles,verbs=create;update,versions=v1alpha1,name=vpackagebundle.kb.io,admissionReviewVersions=v1
// +kubebuilder:printcolumn:name="State",type=string,JSONPath=`.status.state`
// PackageBundle is the Schema for the packagebundle API.
type PackageBundle struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PackageBundleSpec   `json:"spec,omitempty"`
	Status PackageBundleStatus `json:"status,omitempty"`
}

// PackageBundleSpec defines the desired state of PackageBundle.
type PackageBundleSpec struct {
	// +kubebuilder:validation:Required
	// Packages supported by this bundle.
	Packages []BundlePackage `json:"packages"`

	// +kubebuilder:validation:Optional
	// Minimum required packages controller version
	MinVersion string `json:"minControllerVersion"`
}

// BundlePackage specifies a package within a bundle.
type BundlePackage struct {
	// +kubebuilder:validation:Required
	// Name of the package.
	Name string `json:"name,omitempty"`

	// +kubebuilder:validation:Required
	// Source location for the package (probably a helm chart).
	Source BundlePackageSource `json:"source"`

	// WorkloadOnly specifies if the package should be installed
	// only on the workload cluster
	WorkloadOnly bool `json:"workloadonly,omitempty"`
}

// BundlePackageSource identifies the location of a package.
type BundlePackageSource struct {
	// +kubebuilder:validation:Optional
	// Registry in which the package is found.
	Registry string `json:"registry,omitempty"`

	// +kubebuilder:validation:Required
	// Repository within the Registry where the package is found.
	Repository string `json:"repository"`

	// +kubebuilder:validation:MinItems=1
	// Versions of the package supported by this bundle.
	Versions []SourceVersion `json:"versions"`
}

// SourceVersion describes a version of a package within a repository.
type SourceVersion struct {
	// +kubebuilder:validation:Required
	// Name is a human-friendly description of the version, e.g. "v1.0".
	Name string `json:"name"`

	// +kubebuilder:validation:Required
	// Digest is a checksum value identifying the version of the package and its contents.
	Digest string `json:"digest"`

	// Images is a list of images used by this version of the package.
	Images []VersionImages `json:"images,omitempty"`

	// Schema is a base64 encoded, gzipped json schema used to validate package configurations.
	Schema string `json:"schema,omitempty"`

	// +kubebuilder:validation:Optional
	// Dependencies to be installed before the package
	Dependencies []string `json:"dependencies,omitempty"`
}

// VersionImages is an image used by a version of a package.
type VersionImages struct {
	// +kubebuilder:validation:Required
	// Repository within the Registry where the package is found.
	Repository string `json:"repository"`

	// +kubebuilder:validation:Required
	// Digest is a checksum value identifying the version of the package and its contents.
	Digest string `json:"digest"`
}

// PackageBundleStatus defines the observed state of PackageBundle.
type PackageBundleStatus struct {
	Spec  PackageBundleSpec      `json:"spec,omitempty"`
	State PackageBundleStateEnum `json:"state"`
}

// +kubebuilder:validation:Enum={"available","ignored","invalid","controller upgrade required"}
// PackageBundleStateEnum defines the observed state of PackageBundle.
type PackageBundleStateEnum string

const (
	PackageBundleStateAvailable       PackageBundleStateEnum = "available"
	PackageBundleStateIgnored         PackageBundleStateEnum = "ignored"
	PackageBundleStateInvalid         PackageBundleStateEnum = "invalid"
	PackageBundleStateUpgradeRequired PackageBundleStateEnum = "controller upgrade required"
)

// +kubebuilder:object:root=true
// PackageBundleList contains a list of PackageBundle.
type PackageBundleList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []PackageBundle `json:"items"`
}

func init() {
	SchemeBuilder.Register(&PackageBundle{}, &PackageBundleList{})
}