datapackaging

Documentation

Overview

The internal version of the package api.

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type AppTemplateSpec
  • func (in *AppTemplateSpec) DeepCopy() *AppTemplateSpec
  • func (in *AppTemplateSpec) DeepCopyInto(out *AppTemplateSpec)
• type Maintainer
  • func (in *Maintainer) DeepCopy() *Maintainer
  • func (in *Maintainer) DeepCopyInto(out *Maintainer)
• type Package
  • func (in *Package) DeepCopy() *Package
  • func (in *Package) DeepCopyInto(out *Package)
  • func (in *Package) DeepCopyObject() runtime.Object
• type PackageList
  • func (in *PackageList) DeepCopy() *PackageList
  • func (in *PackageList) DeepCopyInto(out *PackageList)
  • func (in *PackageList) DeepCopyObject() runtime.Object
• type PackageMetadata
  • func (in *PackageMetadata) DeepCopy() *PackageMetadata
  • func (in *PackageMetadata) DeepCopyInto(out *PackageMetadata)
  • func (in *PackageMetadata) DeepCopyObject() runtime.Object
• type PackageMetadataList
  • func (in *PackageMetadataList) DeepCopy() *PackageMetadataList
  • func (in *PackageMetadataList) DeepCopyInto(out *PackageMetadataList)
  • func (in *PackageMetadataList) DeepCopyObject() runtime.Object
• type PackageMetadataSpec
  • func (in *PackageMetadataSpec) DeepCopy() *PackageMetadataSpec
  • func (in *PackageMetadataSpec) DeepCopyInto(out *PackageMetadataSpec)
• type PackageSpec
  • func (in *PackageSpec) DeepCopy() *PackageSpec
  • func (in *PackageSpec) DeepCopyInto(out *PackageSpec)
• type ValuesSchema
  • func (in *ValuesSchema) DeepCopy() *ValuesSchema
  • func (in *ValuesSchema) DeepCopyInto(out *ValuesSchema)

Constants

const GroupName = "data.packaging.carvel.dev"

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

Types

type AppTemplateSpec

type AppTemplateSpec struct {
	Spec *kcv1alpha1.AppSpec `json:"spec"`
}

func (*AppTemplateSpec) DeepCopy

func (in *AppTemplateSpec) DeepCopy() *AppTemplateSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppTemplateSpec.

func (*AppTemplateSpec) DeepCopyInto

func (in *AppTemplateSpec) DeepCopyInto(out *AppTemplateSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Maintainer

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

func (*Maintainer) DeepCopy

func (in *Maintainer) DeepCopy() *Maintainer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Maintainer.

func (*Maintainer) DeepCopyInto

func (in *Maintainer) DeepCopyInto(out *Maintainer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Package

type Package struct {
	metav1.TypeMeta `json:",inline"`

	// Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec PackageSpec `json:"spec"`
}

+genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Package) DeepCopy

func (in *Package) DeepCopy() *Package

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Package.

func (*Package) DeepCopyInto

func (in *Package) DeepCopyInto(out *Package)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Package) DeepCopyObject

func (in *Package) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PackageList

type PackageList struct {
	metav1.TypeMeta `json:",inline"`

	// Standard list metadata.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Package `json:"items"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*PackageList) DeepCopy

func (in *PackageList) DeepCopy() *PackageList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageList.

func (*PackageList) DeepCopyInto

func (in *PackageList) DeepCopyInto(out *PackageList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PackageList) DeepCopyObject

func (in *PackageList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PackageMetadata

type PackageMetadata struct {
	metav1.TypeMeta `json:",inline"`

	// Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec PackageMetadataSpec `json:"spec"`
}

+genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*PackageMetadata) DeepCopy

func (in *PackageMetadata) DeepCopy() *PackageMetadata

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageMetadata.

func (*PackageMetadata) DeepCopyInto

func (in *PackageMetadata) DeepCopyInto(out *PackageMetadata)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PackageMetadata) DeepCopyObject

func (in *PackageMetadata) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PackageMetadataList

type PackageMetadataList struct {
	metav1.TypeMeta `json:",inline"`

	// Standard list metadata.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []PackageMetadata `json:"items"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*PackageMetadataList) DeepCopy

func (in *PackageMetadataList) DeepCopy() *PackageMetadataList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageMetadataList.

func (*PackageMetadataList) DeepCopyInto

func (in *PackageMetadataList) DeepCopyInto(out *PackageMetadataList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PackageMetadataList) DeepCopyObject

func (in *PackageMetadataList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PackageMetadataSpec

type PackageMetadataSpec struct {
	DisplayName        string       `json:"displayName,omitempty"`
	LongDescription    string       `json:"longDescription,omitempty"`
	ShortDescription   string       `json:"shortDescription,omitempty"`
	IconSVGBase64      string       `json:"iconSVGBase64,omitempty"`
	ProviderName       string       `json:"providerName,omitempty"`
	Maintainers        []Maintainer `json:"maintainers,omitempty"`
	Categories         []string     `json:"categories,omitempty"`
	SupportDescription string       `json:"supportDescription,omitempty"`
}

func (*PackageMetadataSpec) DeepCopy

func (in *PackageMetadataSpec) DeepCopy() *PackageMetadataSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageMetadataSpec.

func (*PackageMetadataSpec) DeepCopyInto

func (in *PackageMetadataSpec) DeepCopyInto(out *PackageMetadataSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PackageSpec

type PackageSpec struct {
	RefName  string   `json:"refName,omitempty"`
	Version  string   `json:"version,omitempty"`
	Licenses []string `json:"licenses,omitempty"`
	// +optional
	// +nullable
	ReleasedAt                      metav1.Time `json:"releasedAt,omitempty"`
	CapactiyRequirementsDescription string      `json:"capacityRequirementsDescription,omitempty"`
	ReleaseNotes                    string      `json:"releaseNotes,omitempty"`

	Template AppTemplateSpec `json:"template,omitempty"`

	// valuesSchema can be used to show template values that
	// can be configured by users when a Package is installed
	// in an OpenAPI schema format.
	// +optional
	ValuesSchema ValuesSchema `json:"valuesSchema,omitempty"`
}

func (*PackageSpec) DeepCopy

func (in *PackageSpec) DeepCopy() *PackageSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSpec.

func (*PackageSpec) DeepCopyInto

func (in *PackageSpec) DeepCopyInto(out *PackageSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ValuesSchema

type ValuesSchema struct {
	// +optional
	// +nullable
	// +kubebuilder:pruning:PreserveUnknownFields
	OpenAPIv3 runtime.RawExtension `json:"openAPIv3,omitempty"`
}

func (*ValuesSchema) DeepCopy

func (in *ValuesSchema) DeepCopy() *ValuesSchema

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ValuesSchema.

func (*ValuesSchema) DeepCopyInto

func (in *ValuesSchema) DeepCopyInto(out *ValuesSchema)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.