v1alpha1

Documentation

Index

• Constants
• Variables
• func ValidatePackageType(pt string) error
• type Info
• type KformFile
  • func BuildKptFile(meta metav1.ObjectMeta, spec KformFileSpec) *KformFile
• type KformFileSpec
• type Maintainer
• type PkgKind
• type Provider
  • func (r Provider) Validate() error

Constants

const (
	Group         = "meta.pkg.kform.io"
	Version       = "v1alpha1"
	APIVersion    = Group + "/" + Version
	KformFileName = "KformFile.yaml"
)

Variables

var (
	KformFileKind = reflect.TypeOf(KformFile{}).Name()
)

Functions

func ValidatePackageType

func ValidatePackageType(pt string) error

Types

type Info

type Info struct {
	Description string       `json:"description,omitempty" yaml:"description,omitempty"`
	Maintainers []Maintainer `json:"maintainers,omitempty" yaml:"maintainers,omitempty"`
}

type KformFile

type KformFile struct {
	metav1.TypeMeta   `json:",inline" yaml:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`

	Spec KformFileSpec `json:"spec,omitempty" yaml:"spec,omitempty"`
}

func BuildKptFile

func BuildKptFile(meta metav1.ObjectMeta, spec KformFileSpec) *KformFile

BuildVXLANClaim returns a VXLANClaim from a client Object a crName and an VXLANClaim Spec/Status

type KformFileSpec

type KformFileSpec struct {
	// +kubebuilder:validation:Enum=provider;module
	Kind                 PkgKind             `json:"kind" yaml:"kind"`
	ProviderRequirements map[string]Provider `json:"providerRequirements" yaml:"providerRequirements"`
	Info                 Info                `json:"info,omitempty" yaml:"info,omitempty"`
}

type Maintainer

type Maintainer struct {
	Name  string `json:"name,omitempty" yaml:"name,omitempty"`
	Email string `json:"email,omitempty" yaml:"email,omitempty"`
}

type PkgKind

type PkgKind string

const (
	PkgKindProvider PkgKind = "provider"
	PkgKindModule   PkgKind = "module"
)

type Provider

type Provider struct {
	Source  string `json:"source" yaml:"source"`
	Version string `json:"version" yaml:"version"`
}

func (Provider) Validate

func (r Provider) Validate() error