Documentation
¶
Overview ¶
+groupName=packages.operators.coreos.com
Index ¶
- Constants
- Variables
- func Convert_operators_AppLink_To_v1_AppLink(in *operators.AppLink, out *AppLink, s conversion.Scope) error
- func Convert_operators_CSVDescription_To_v1_CSVDescription(in *operators.CSVDescription, out *CSVDescription, s conversion.Scope) error
- func Convert_operators_ChannelEntry_To_v1_ChannelEntry(in *operators.ChannelEntry, out *ChannelEntry, s conversion.Scope) error
- func Convert_operators_Deprecation_To_v1_Deprecation(in *operators.Deprecation, out *Deprecation, s conversion.Scope) error
- func Convert_operators_Icon_To_v1_Icon(in *operators.Icon, out *Icon, s conversion.Scope) error
- func Convert_operators_Maintainer_To_v1_Maintainer(in *operators.Maintainer, out *Maintainer, s conversion.Scope) error
- func Convert_operators_PackageChannel_To_v1_PackageChannel(in *operators.PackageChannel, out *PackageChannel, s conversion.Scope) error
- func Convert_operators_PackageManifestList_To_v1_PackageManifestList(in *operators.PackageManifestList, out *PackageManifestList, ...) error
- func Convert_operators_PackageManifestSpec_To_v1_PackageManifestSpec(in *operators.PackageManifestSpec, out *PackageManifestSpec, ...) error
- func Convert_operators_PackageManifestStatus_To_v1_PackageManifestStatus(in *operators.PackageManifestStatus, out *PackageManifestStatus, ...) error
- func Convert_operators_PackageManifest_To_v1_PackageManifest(in *operators.PackageManifest, out *PackageManifest, s conversion.Scope) error
- func Convert_v1_AppLink_To_operators_AppLink(in *AppLink, out *operators.AppLink, s conversion.Scope) error
- func Convert_v1_CSVDescription_To_operators_CSVDescription(in *CSVDescription, out *operators.CSVDescription, s conversion.Scope) error
- func Convert_v1_ChannelEntry_To_operators_ChannelEntry(in *ChannelEntry, out *operators.ChannelEntry, s conversion.Scope) error
- func Convert_v1_Deprecation_To_operators_Deprecation(in *Deprecation, out *operators.Deprecation, s conversion.Scope) error
- func Convert_v1_Icon_To_operators_Icon(in *Icon, out *operators.Icon, s conversion.Scope) error
- func Convert_v1_Maintainer_To_operators_Maintainer(in *Maintainer, out *operators.Maintainer, s conversion.Scope) error
- func Convert_v1_PackageChannel_To_operators_PackageChannel(in *PackageChannel, out *operators.PackageChannel, s conversion.Scope) error
- func Convert_v1_PackageManifestList_To_operators_PackageManifestList(in *PackageManifestList, out *operators.PackageManifestList, ...) error
- func Convert_v1_PackageManifestSpec_To_operators_PackageManifestSpec(in *PackageManifestSpec, out *operators.PackageManifestSpec, ...) error
- func Convert_v1_PackageManifestStatus_To_operators_PackageManifestStatus(in *PackageManifestStatus, out *operators.PackageManifestStatus, ...) error
- func Convert_v1_PackageManifest_To_operators_PackageManifest(in *PackageManifest, out *operators.PackageManifest, s conversion.Scope) error
- func GetImages(csvJSON string) []string
- func RegisterConversions(s *runtime.Scheme) error
- func RegisterDefaults(scheme *runtime.Scheme) error
- func Resource(resource string) schema.GroupResource
- type AppLink
- type CSVDescription
- type ChannelEntry
- type Deprecation
- type Icon
- type Maintainer
- type PackageChannel
- type PackageManifest
- type PackageManifestList
- type PackageManifestSpec
- type PackageManifestStatus
Constants ¶
const ( Group = "packages." + operators.GroupName Version = "v1" PackageManifestKind = "PackageManifest" PackageManifestListKind = "PackageManifestList" )
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = localSchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version}
SchemeGroupVersion is the group version used to register these objects.
Functions ¶
func Convert_operators_AppLink_To_v1_AppLink ¶
func Convert_operators_AppLink_To_v1_AppLink(in *operators.AppLink, out *AppLink, s conversion.Scope) error
Convert_operators_AppLink_To_v1_AppLink is an autogenerated conversion function.
func Convert_operators_CSVDescription_To_v1_CSVDescription ¶
func Convert_operators_CSVDescription_To_v1_CSVDescription(in *operators.CSVDescription, out *CSVDescription, s conversion.Scope) error
Convert_operators_CSVDescription_To_v1_CSVDescription is an autogenerated conversion function.
func Convert_operators_ChannelEntry_To_v1_ChannelEntry ¶ added in v0.23.0
func Convert_operators_ChannelEntry_To_v1_ChannelEntry(in *operators.ChannelEntry, out *ChannelEntry, s conversion.Scope) error
Convert_operators_ChannelEntry_To_v1_ChannelEntry is an autogenerated conversion function.
func Convert_operators_Deprecation_To_v1_Deprecation ¶ added in v0.27.0
func Convert_operators_Deprecation_To_v1_Deprecation(in *operators.Deprecation, out *Deprecation, s conversion.Scope) error
Convert_operators_Deprecation_To_v1_Deprecation is an autogenerated conversion function.
func Convert_operators_Icon_To_v1_Icon ¶
Convert_operators_Icon_To_v1_Icon is an autogenerated conversion function.
func Convert_operators_Maintainer_To_v1_Maintainer ¶
func Convert_operators_Maintainer_To_v1_Maintainer(in *operators.Maintainer, out *Maintainer, s conversion.Scope) error
Convert_operators_Maintainer_To_v1_Maintainer is an autogenerated conversion function.
func Convert_operators_PackageChannel_To_v1_PackageChannel ¶
func Convert_operators_PackageChannel_To_v1_PackageChannel(in *operators.PackageChannel, out *PackageChannel, s conversion.Scope) error
Convert_operators_PackageChannel_To_v1_PackageChannel is an autogenerated conversion function.
func Convert_operators_PackageManifestList_To_v1_PackageManifestList ¶
func Convert_operators_PackageManifestList_To_v1_PackageManifestList(in *operators.PackageManifestList, out *PackageManifestList, s conversion.Scope) error
Convert_operators_PackageManifestList_To_v1_PackageManifestList is an autogenerated conversion function.
func Convert_operators_PackageManifestSpec_To_v1_PackageManifestSpec ¶
func Convert_operators_PackageManifestSpec_To_v1_PackageManifestSpec(in *operators.PackageManifestSpec, out *PackageManifestSpec, s conversion.Scope) error
Convert_operators_PackageManifestSpec_To_v1_PackageManifestSpec is an autogenerated conversion function.
func Convert_operators_PackageManifestStatus_To_v1_PackageManifestStatus ¶
func Convert_operators_PackageManifestStatus_To_v1_PackageManifestStatus(in *operators.PackageManifestStatus, out *PackageManifestStatus, s conversion.Scope) error
Convert_operators_PackageManifestStatus_To_v1_PackageManifestStatus is an autogenerated conversion function.
func Convert_operators_PackageManifest_To_v1_PackageManifest ¶
func Convert_operators_PackageManifest_To_v1_PackageManifest(in *operators.PackageManifest, out *PackageManifest, s conversion.Scope) error
Convert_operators_PackageManifest_To_v1_PackageManifest is an autogenerated conversion function.
func Convert_v1_AppLink_To_operators_AppLink ¶
func Convert_v1_AppLink_To_operators_AppLink(in *AppLink, out *operators.AppLink, s conversion.Scope) error
Convert_v1_AppLink_To_operators_AppLink is an autogenerated conversion function.
func Convert_v1_CSVDescription_To_operators_CSVDescription ¶
func Convert_v1_CSVDescription_To_operators_CSVDescription(in *CSVDescription, out *operators.CSVDescription, s conversion.Scope) error
Convert_v1_CSVDescription_To_operators_CSVDescription is an autogenerated conversion function.
func Convert_v1_ChannelEntry_To_operators_ChannelEntry ¶ added in v0.23.0
func Convert_v1_ChannelEntry_To_operators_ChannelEntry(in *ChannelEntry, out *operators.ChannelEntry, s conversion.Scope) error
Convert_v1_ChannelEntry_To_operators_ChannelEntry is an autogenerated conversion function.
func Convert_v1_Deprecation_To_operators_Deprecation ¶ added in v0.27.0
func Convert_v1_Deprecation_To_operators_Deprecation(in *Deprecation, out *operators.Deprecation, s conversion.Scope) error
Convert_v1_Deprecation_To_operators_Deprecation is an autogenerated conversion function.
func Convert_v1_Icon_To_operators_Icon ¶
Convert_v1_Icon_To_operators_Icon is an autogenerated conversion function.
func Convert_v1_Maintainer_To_operators_Maintainer ¶
func Convert_v1_Maintainer_To_operators_Maintainer(in *Maintainer, out *operators.Maintainer, s conversion.Scope) error
Convert_v1_Maintainer_To_operators_Maintainer is an autogenerated conversion function.
func Convert_v1_PackageChannel_To_operators_PackageChannel ¶
func Convert_v1_PackageChannel_To_operators_PackageChannel(in *PackageChannel, out *operators.PackageChannel, s conversion.Scope) error
Convert_v1_PackageChannel_To_operators_PackageChannel is an autogenerated conversion function.
func Convert_v1_PackageManifestList_To_operators_PackageManifestList ¶
func Convert_v1_PackageManifestList_To_operators_PackageManifestList(in *PackageManifestList, out *operators.PackageManifestList, s conversion.Scope) error
Convert_v1_PackageManifestList_To_operators_PackageManifestList is an autogenerated conversion function.
func Convert_v1_PackageManifestSpec_To_operators_PackageManifestSpec ¶
func Convert_v1_PackageManifestSpec_To_operators_PackageManifestSpec(in *PackageManifestSpec, out *operators.PackageManifestSpec, s conversion.Scope) error
Convert_v1_PackageManifestSpec_To_operators_PackageManifestSpec is an autogenerated conversion function.
func Convert_v1_PackageManifestStatus_To_operators_PackageManifestStatus ¶
func Convert_v1_PackageManifestStatus_To_operators_PackageManifestStatus(in *PackageManifestStatus, out *operators.PackageManifestStatus, s conversion.Scope) error
Convert_v1_PackageManifestStatus_To_operators_PackageManifestStatus is an autogenerated conversion function.
func Convert_v1_PackageManifest_To_operators_PackageManifest ¶
func Convert_v1_PackageManifest_To_operators_PackageManifest(in *PackageManifest, out *operators.PackageManifest, s conversion.Scope) error
Convert_v1_PackageManifest_To_operators_PackageManifest is an autogenerated conversion function.
func RegisterConversions ¶
RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.
func RegisterDefaults ¶
RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group-qualified GroupResource.
Types ¶
type AppLink ¶
AppLink defines a link to an application
func (*AppLink) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppLink.
func (*AppLink) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CSVDescription ¶
type CSVDescription struct {
// DisplayName is the CSV's display name
DisplayName string `json:"displayName,omitempty"`
// Icon is the CSV's base64 encoded icon
// +listType=set
Icon []Icon `json:"icon,omitempty"`
// Version is the CSV's semantic version
Version version.OperatorVersion `json:"version,omitempty"`
// Provider is the CSV's provider
Provider AppLink `json:"provider,omitempty"`
// +listType=map
Annotations map[string]string `json:"annotations,omitempty"`
// +listType=set
Keywords []string `json:"keywords,omitempty"`
// +listType=set
Links []AppLink `json:"links,omitempty"`
// +listType=set
Maintainers []Maintainer `json:"maintainers,omitempty"`
Maturity string `json:"maturity,omitempty"`
// LongDescription is the CSV's description
LongDescription string `json:"description,omitempty"`
// InstallModes specify supported installation types
// +listType=set
InstallModes []operatorv1alpha1.InstallMode `json:"installModes,omitempty"`
CustomResourceDefinitions operatorv1alpha1.CustomResourceDefinitions `json:"customresourcedefinitions,omitempty"`
APIServiceDefinitions operatorv1alpha1.APIServiceDefinitions `json:"apiservicedefinitions,omitempty"`
NativeAPIs []metav1.GroupVersionKind `json:"nativeApis,omitempty"`
// Minimum Kubernetes version for operator installation
MinKubeVersion string `json:"minKubeVersion,omitempty"`
// List of related images
RelatedImages []string `json:"relatedImages,omitempty"`
}
CSVDescription defines a description of a CSV
func CreateCSVDescription ¶
func CreateCSVDescription(csv *operatorsv1alpha1.ClusterServiceVersion, csvJSON string) CSVDescription
CreateCSVDescription creates a CSVDescription from a given CSV
func (*CSVDescription) DeepCopy ¶
func (in *CSVDescription) DeepCopy() *CSVDescription
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSVDescription.
func (*CSVDescription) DeepCopyInto ¶
func (in *CSVDescription) DeepCopyInto(out *CSVDescription)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ChannelEntry ¶ added in v0.23.0
type ChannelEntry struct {
// Name is the name of the bundle for this entry.
Name string `json:"name"`
// Version is the version of the bundle for this entry.
Version string `json:"version,omitempty"`
// Deprecation is an optional field which contains information if the channel entry is deprecated.
Deprecation *Deprecation `json:"deprecation,omitempty"`
}
ChannelEntry defines a member of a package channel.
func (*ChannelEntry) DeepCopy ¶ added in v0.23.0
func (in *ChannelEntry) DeepCopy() *ChannelEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChannelEntry.
func (*ChannelEntry) DeepCopyInto ¶ added in v0.23.0
func (in *ChannelEntry) DeepCopyInto(out *ChannelEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Deprecation ¶ added in v0.27.0
type Deprecation struct {
// Message is a human readable message describing the deprecation.
Message string `json:"message"`
}
Deprecation conveys information regarding a deprecated resource.
func (*Deprecation) DeepCopy ¶ added in v0.27.0
func (in *Deprecation) DeepCopy() *Deprecation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Deprecation.
func (*Deprecation) DeepCopyInto ¶ added in v0.27.0
func (in *Deprecation) DeepCopyInto(out *Deprecation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Icon ¶
type Icon struct {
Base64Data string `json:"base64data,omitempty"`
Mediatype string `json:"mediatype,omitempty"`
}
Icon defines a base64 encoded icon and media type
func (*Icon) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Icon.
func (*Icon) DeepCopyInto ¶
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"`
Email string `json:"email,omitempty"`
}
Maintainer defines a project maintainer
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 PackageChannel ¶
type PackageChannel struct {
// Name is the name of the channel, e.g. `alpha` or `stable`
Name string `json:"name"`
// CurrentCSV defines a reference to the CSV holding the version of this package currently
// for the channel.
CurrentCSV string `json:"currentCSV"`
// CurrentCSVSpec holds the spec of the current CSV
CurrentCSVDesc CSVDescription `json:"currentCSVDesc,omitempty"`
// Deprecation is an optional field which contains information if the channel is deprecated.
Deprecation *Deprecation `json:"deprecation,omitempty"`
// Entries lists all CSVs in the channel, with their upgrade edges.
Entries []ChannelEntry `json:"entries"`
}
PackageChannel defines a single channel under a package, pointing to a version of that package.
func (*PackageChannel) DeepCopy ¶
func (in *PackageChannel) DeepCopy() *PackageChannel
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageChannel.
func (*PackageChannel) DeepCopyInto ¶
func (in *PackageChannel) DeepCopyInto(out *PackageChannel)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PackageChannel) IsDefaultChannel ¶
func (pc PackageChannel) IsDefaultChannel(pm PackageManifest) bool
IsDefaultChannel returns true if the PackageChannel is the default for the PackageManifest
type PackageManifest ¶
type PackageManifest struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec PackageManifestSpec `json:"spec,omitempty"`
Status PackageManifestStatus `json:"status,omitempty"`
}
PackageManifest holds information about a package, which is a reference to one (or more) channels under a single package. +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*PackageManifest) DeepCopy ¶
func (in *PackageManifest) DeepCopy() *PackageManifest
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageManifest.
func (*PackageManifest) DeepCopyInto ¶
func (in *PackageManifest) DeepCopyInto(out *PackageManifest)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PackageManifest) DeepCopyObject ¶
func (in *PackageManifest) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (PackageManifest) GetDefaultChannel ¶
func (m PackageManifest) GetDefaultChannel() string
GetDefaultChannel gets the default channel or returns the only one if there's only one. returns empty string if it can't determine the default
func (PackageManifest) OpenAPIModelName ¶ added in v0.40.0
func (PackageManifest) OpenAPIModelName() string
OpenAPIModelName returns the OpenAPI model name for this type. This is used by openapi-gen to register the GVK extension. The format matches what k8s.io/apimachinery/pkg/runtime.Scheme.ToOpenAPIDefinitionName would generate.
type PackageManifestList ¶
type PackageManifestList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
// +listType=set
Items []PackageManifest `json:"items"`
}
PackageManifestList is a list of PackageManifest objects. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*PackageManifestList) DeepCopy ¶
func (in *PackageManifestList) DeepCopy() *PackageManifestList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageManifestList.
func (*PackageManifestList) DeepCopyInto ¶
func (in *PackageManifestList) DeepCopyInto(out *PackageManifestList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PackageManifestList) DeepCopyObject ¶
func (in *PackageManifestList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (PackageManifestList) OpenAPIModelName ¶ added in v0.40.0
func (PackageManifestList) OpenAPIModelName() string
OpenAPIModelName returns the OpenAPI model name for this type. This is used by openapi-gen to register the GVK extension. The format matches what k8s.io/apimachinery/pkg/runtime.Scheme.ToOpenAPIDefinitionName would generate.
type PackageManifestSpec ¶
type PackageManifestSpec struct{}
PackageManifestSpec defines the desired state of PackageManifest
func (*PackageManifestSpec) DeepCopy ¶
func (in *PackageManifestSpec) DeepCopy() *PackageManifestSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageManifestSpec.
func (*PackageManifestSpec) DeepCopyInto ¶
func (in *PackageManifestSpec) DeepCopyInto(out *PackageManifestSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageManifestStatus ¶
type PackageManifestStatus struct {
// CatalogSource is the name of the CatalogSource this package belongs to
CatalogSource string `json:"catalogSource"`
CatalogSourceDisplayName string `json:"catalogSourceDisplayName"`
CatalogSourcePublisher string `json:"catalogSourcePublisher"`
// CatalogSourceNamespace is the namespace of the owning CatalogSource
CatalogSourceNamespace string `json:"catalogSourceNamespace"`
// Provider is the provider of the PackageManifest's default CSV
Provider AppLink `json:"provider,omitempty"`
// PackageName is the name of the overall package, ala `etcd`.
PackageName string `json:"packageName"`
// Deprecation is an optional field which contains information if the package is deprecated.
Deprecation *Deprecation `json:"deprecation,omitempty"`
// Channels are the declared channels for the package, ala `stable` or `alpha`.
// +listType=set
Channels []PackageChannel `json:"channels"`
// DefaultChannel is, if specified, the name of the default channel for the package. The
// default channel will be installed if no other channel is explicitly given. If the package
// has a single channel, then that channel is implicitly the default.
DefaultChannel string `json:"defaultChannel"`
}
PackageManifestStatus represents the current status of the PackageManifest
func (*PackageManifestStatus) DeepCopy ¶
func (in *PackageManifestStatus) DeepCopy() *PackageManifestStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageManifestStatus.
func (*PackageManifestStatus) DeepCopyInto ¶
func (in *PackageManifestStatus) DeepCopyInto(out *PackageManifestStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.