Documentation
¶
Overview ¶
Package v1 contains meta types used to configure Crossplane packages. +kubebuilder:object:generate=true +groupName=meta.pkg.crossplane.io +versionName=v1
Index ¶
- Constants
- Variables
- type Configuration
- func (in *Configuration) DeepCopy() *Configuration
- func (in *Configuration) DeepCopyInto(out *Configuration)
- func (in *Configuration) DeepCopyObject() runtime.Object
- func (c *Configuration) GetCrossplaneConstraints() *CrossplaneConstraints
- func (c *Configuration) GetDependencies() []Dependency
- func (c *Configuration) Hub()
- type ConfigurationSpec
- type ControllerSpec
- type CrossplaneConstraints
- type Dependency
- type MetaSpec
- type Pkg
- type Provider
- type ProviderSpec
Constants ¶
const ( Group = "meta.pkg.crossplane.io" Version = "v1" )
Package type metadata.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme adds all registered types to scheme AddToScheme = SchemeBuilder.AddToScheme )
var ( ProviderKind = reflect.TypeOf(Provider{}).Name() ProviderGroupKind = schema.GroupKind{Group: Group, Kind: ProviderKind}.String() ProviderKindAPIVersion = ProviderKind + "." + SchemeGroupVersion.String() ProviderGroupVersionKind = SchemeGroupVersion.WithKind(ProviderKind) )
Provider type metadata.
var ( ConfigurationKind = reflect.TypeOf(Configuration{}).Name() ConfigurationGroupKind = schema.GroupKind{Group: Group, Kind: ConfigurationKind}.String() ConfigurationKindAPIVersion = ConfigurationKind + "." + SchemeGroupVersion.String() ConfigurationGroupVersionKind = SchemeGroupVersion.WithKind(ConfigurationKind) )
Configuration type metadata.
Functions ¶
This section is empty.
Types ¶
type Configuration ¶
type Configuration struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ConfigurationSpec `json:"spec"`
}
A Configuration is the description of a Crossplane Configuration package.
func (*Configuration) DeepCopy ¶
func (in *Configuration) DeepCopy() *Configuration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Configuration.
func (*Configuration) DeepCopyInto ¶
func (in *Configuration) DeepCopyInto(out *Configuration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Configuration) DeepCopyObject ¶
func (in *Configuration) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Configuration) GetCrossplaneConstraints ¶
func (c *Configuration) GetCrossplaneConstraints() *CrossplaneConstraints
GetCrossplaneConstraints gets the Configuration package's Crossplane version constraints.
func (*Configuration) GetDependencies ¶
func (c *Configuration) GetDependencies() []Dependency
GetDependencies gets the Configuration package's dependencies.
func (*Configuration) Hub ¶
func (c *Configuration) Hub()
Hub marks this type as the conversion hub.
type ConfigurationSpec ¶
type ConfigurationSpec struct {
MetaSpec `json:",inline"`
}
ConfigurationSpec specifies the configuration of a Configuration.
func (*ConfigurationSpec) DeepCopy ¶
func (in *ConfigurationSpec) DeepCopy() *ConfigurationSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigurationSpec.
func (*ConfigurationSpec) DeepCopyInto ¶
func (in *ConfigurationSpec) DeepCopyInto(out *ConfigurationSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ControllerSpec ¶
type ControllerSpec struct {
// Image is the packaged Provider controller image.
Image *string `json:"image,omitempty"`
// PermissionRequests for RBAC rules required for this provider's controller
// to function. The RBAC manager is responsible for assessing the requested
// permissions.
// +optional
PermissionRequests []rbacv1.PolicyRule `json:"permissionRequests,omitempty"`
}
ControllerSpec specifies the configuration for the packaged Provider controller.
func (*ControllerSpec) DeepCopy ¶
func (in *ControllerSpec) DeepCopy() *ControllerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ControllerSpec.
func (*ControllerSpec) DeepCopyInto ¶
func (in *ControllerSpec) DeepCopyInto(out *ControllerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CrossplaneConstraints ¶
type CrossplaneConstraints struct {
// Semantic version constraints of Crossplane that package is compatible with.
Version string `json:"version"`
}
CrossplaneConstraints specifies a packages compatibility with Crossplane versions.
func (*CrossplaneConstraints) DeepCopy ¶
func (in *CrossplaneConstraints) DeepCopy() *CrossplaneConstraints
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CrossplaneConstraints.
func (*CrossplaneConstraints) DeepCopyInto ¶
func (in *CrossplaneConstraints) DeepCopyInto(out *CrossplaneConstraints)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Dependency ¶
type Dependency struct {
// Provider is the name of a Provider package image.
Provider *string `json:"provider,omitempty"`
// Configuration is the name of a Configuration package image.
Configuration *string `json:"configuration,omitempty"`
// Version is the semantic version constraints of the dependency image.
Version string `json:"version"`
}
Dependency is a dependency on another package. One of Provider or Configuration may be supplied.
func (*Dependency) DeepCopy ¶
func (in *Dependency) DeepCopy() *Dependency
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Dependency.
func (*Dependency) DeepCopyInto ¶
func (in *Dependency) DeepCopyInto(out *Dependency)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetaSpec ¶
type MetaSpec struct {
// Semantic version constraints of Crossplane that package is compatible with.
Crossplane *CrossplaneConstraints `json:"crossplane,omitempty"`
// Dependencies on other packages.
DependsOn []Dependency `json:"dependsOn,omitempty"`
}
MetaSpec are fields that every meta package type must implement.
func (*MetaSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetaSpec.
func (*MetaSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Pkg ¶
type Pkg interface {
GetCrossplaneConstraints() *CrossplaneConstraints
GetDependencies() []Dependency
}
Pkg is a description of a Crossplane package. +k8s:deepcopy-gen=false
type Provider ¶
type Provider struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ProviderSpec `json:"spec"`
}
A Provider is the description of a Crossplane Provider package.
func (*Provider) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Provider.
func (*Provider) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Provider) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Provider) GetCrossplaneConstraints ¶
func (c *Provider) GetCrossplaneConstraints() *CrossplaneConstraints
GetCrossplaneConstraints gets the Provider package's Crossplane version constraints.
func (*Provider) GetDependencies ¶
func (c *Provider) GetDependencies() []Dependency
GetDependencies gets the Provider package's dependencies.
type ProviderSpec ¶
type ProviderSpec struct {
// Configuration for the packaged Provider's controller.
Controller ControllerSpec `json:"controller"`
MetaSpec `json:",inline"`
}
ProviderSpec specifies the configuration of a Provider.
func (*ProviderSpec) DeepCopy ¶
func (in *ProviderSpec) DeepCopy() *ProviderSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderSpec.
func (*ProviderSpec) DeepCopyInto ¶
func (in *ProviderSpec) DeepCopyInto(out *ProviderSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.