v1alpha1

package
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 22, 2020 License: Apache-2.0 Imports: 12 Imported by: 6

Documentation

Overview

Package v1alpha1 contains API types that extend the Crossplane API. +kubebuilder:object:generate=true +groupName=apiextensions.crossplane.io +versionName=v1alpha1

Index

Constants

View Source 
const (
	ReasonStarting runtimev1alpha1.ConditionReason = "Creating CRD and starting controller"
	ReasonStarted  runtimev1alpha1.ConditionReason = "Created CRD and started controller"
	ReasonDeleting runtimev1alpha1.ConditionReason = "Definition is being deleted"
)

Reasons a resource is or is not ready.

View Source 
const (
	Group   = "apiextensions.crossplane.io"
	Version = "v1alpha1"
)

Package type metadata.

View Source 
const (
	// TypeReady resources are believed to be ready to handle work.
	TypeEstablished runtimev1alpha1.ConditionType = "Established"
)

Condition types.

Variables

View Source 
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}
)
View Source 
var (
	InfrastructureDefinitionKind             = reflect.TypeOf(InfrastructureDefinition{}).Name()
	InfrastructureDefinitionGroupKind        = schema.GroupKind{Group: Group, Kind: InfrastructureDefinitionKind}.String()
	InfrastructureDefinitionKindAPIVersion   = InfrastructureDefinitionKind + "." + SchemeGroupVersion.String()
	InfrastructureDefinitionGroupVersionKind = SchemeGroupVersion.WithKind(InfrastructureDefinitionKind)
)

InInfrastructureDefinition type metadata.

View Source 
var (
	InfrastructurePublicationKind             = reflect.TypeOf(InfrastructurePublication{}).Name()
	InfrastructurePublicationGroupKind        = schema.GroupKind{Group: Group, Kind: InfrastructurePublicationKind}.String()
	InfrastructurePublicationKindAPIVersion   = InfrastructurePublicationKind + "." + SchemeGroupVersion.String()
	InfrastructurePublicationGroupVersionKind = SchemeGroupVersion.WithKind(InfrastructurePublicationKind)
)

InInfrastructurePublication type metadata.

View Source 
var (
	CompositionKind             = reflect.TypeOf(Composition{}).Name()
	CompositionGroupKind        = schema.GroupKind{Group: Group, Kind: CompositionKind}.String()
	CompositionKindAPIVersion   = CompositionKind + "." + SchemeGroupVersion.String()
	CompositionGroupVersionKind = SchemeGroupVersion.WithKind(CompositionKind)
)

Composition type metadata.

Functions

func Deleting 

func Deleting() runtimev1alpha1.Condition

Deleting returns a condition that indicates a definition or publication is being deleted.

func Started 

func Started() runtimev1alpha1.Condition

Started returns a condition that indicates a definition or publication has established its CustomResourceDefinition and started its controller.

func Starting 

func Starting() runtimev1alpha1.Condition

Starting returns a condition that indicates a definition or publication is establishing its CustomResourceDefinition and starting its controller.

Types

type CRDSpecTemplate 

type CRDSpecTemplate struct {
	// group is the API group of the defined custom resource.
	// The custom resources are served under `/apis/<group>/...`.
	// Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`).
	Group string `json:"group"`

	// version is the API version of the defined custom resource.
	// The custom resources are served under `/apis/<group>/<version>/...`.
	// Must match the name of the first item in the `versions` list if `version` and `versions` are both specified.
	// Optional if `versions` is specified.
	// Deprecated: use `versions` instead.
	// +optional
	Version string `json:"version,omitempty"`

	// names specify the resource and kind names for the custom resource.
	Names v1beta1.CustomResourceDefinitionNames `json:"names"`

	// validation describes the schema used for validation and pruning of the custom resource.
	// If present, this validation schema is used to validate all versions.
	// Top-level and per-version schemas are mutually exclusive.
	// +optional
	Validation *CustomResourceValidation `json:"validation,omitempty"`

	// additionalPrinterColumns specifies additional columns returned in Table output.
	// See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details.
	// If present, this field configures columns for all versions.
	// Top-level and per-version columns are mutually exclusive.
	// If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.
	// +optional
	AdditionalPrinterColumns []v1beta1.CustomResourceColumnDefinition `json:"additionalPrinterColumns,omitempty"`
}

A CRDSpecTemplate is a template for a v1beta1.CustomResourceDefinitionSpec.

func (*CRDSpecTemplate) DeepCopy 

func (in *CRDSpecTemplate) DeepCopy() *CRDSpecTemplate

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

func (*CRDSpecTemplate) DeepCopyInto 

func (in *CRDSpecTemplate) DeepCopyInto(out *CRDSpecTemplate)

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

type ComposedTemplate 

type ComposedTemplate struct {
	// Base is the target resource that the patches will be applied on.
	Base runtime.RawExtension `json:"base"`

	// Patches will be applied as overlay to the base resource.
	// +optional
	Patches []Patch `json:"patches,omitempty"`

	// ConnectionDetails lists the propagation secret keys from this target
	// resource to the composition instance connection secret.
	// +optional
	ConnectionDetails []ConnectionDetail `json:"connectionDetails,omitempty"`
}

ComposedTemplate is used to provide information about how the composed resource should be processed.

func (*ComposedTemplate) DeepCopy 

func (in *ComposedTemplate) DeepCopy() *ComposedTemplate

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

func (*ComposedTemplate) DeepCopyInto 

func (in *ComposedTemplate) DeepCopyInto(out *ComposedTemplate)

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

type Composition 

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

	Spec   CompositionSpec   `json:"spec,omitempty"`
	Status CompositionStatus `json:"status,omitempty"`
}

Composition defines the group of resources to be created when a compatible type is created with reference to the composition. +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories=crossplane

func (*Composition) DeepCopy 

func (in *Composition) DeepCopy() *Composition

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

func (*Composition) DeepCopyInto 

func (in *Composition) DeepCopyInto(out *Composition)

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

func (*Composition) DeepCopyObject 

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

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

type CompositionList 

type CompositionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Composition `json:"items"`
}

CompositionList contains a list of Compositions.

func (*CompositionList) DeepCopy 

func (in *CompositionList) DeepCopy() *CompositionList

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

func (*CompositionList) DeepCopyInto 

func (in *CompositionList) DeepCopyInto(out *CompositionList)

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

func (*CompositionList) DeepCopyObject 

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

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

type CompositionSpec 

type CompositionSpec struct {
	// From refers to the type that this composition is compatible. The values
	// for the underlying resources will be fetched from the instances of the
	// From.
	// +immutable
	From TypeReference `json:"from"`

	// To is the list of target resources that make up the composition.
	To []ComposedTemplate `json:"to"`

	// ReclaimPolicy specifies what will happen to composite resource dynamically
	// provisioned using this composition when their namespaced referrer is deleted.
	// The "Delete" policy causes the composite resource to be deleted
	// when its namespaced referrer is deleted. The "Retain" policy causes
	// the composite resource to be retained, in binding phase
	// "Released", when its namespaced referrer is deleted.
	// The "Retain" policy is used when no policy is specified, however the
	// "Delete" policy is set at dynamic provisioning time if no policy is set.
	// +optional
	// +kubebuilder:validation:Enum=Retain;Delete
	ReclaimPolicy v1alpha1.ReclaimPolicy `json:"reclaimPolicy,omitempty"`

	// WriteConnectionSecretsToNamespace specifies the namespace in which the
	// connection secrets of composite resource dynamically provisioned using
	// this composition will be created.
	WriteConnectionSecretsToNamespace string `json:"writeConnectionSecretsToNamespace"`
}

CompositionSpec specifies the desired state of the definition.

func (*CompositionSpec) DeepCopy 

func (in *CompositionSpec) DeepCopy() *CompositionSpec

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

func (*CompositionSpec) DeepCopyInto 

func (in *CompositionSpec) DeepCopyInto(out *CompositionSpec)

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

type CompositionStatus 

type CompositionStatus struct {
	v1alpha1.ConditionedStatus `json:",inline"`
}

CompositionStatus shows the observed state of the composition.

func (*CompositionStatus) DeepCopy 

func (in *CompositionStatus) DeepCopy() *CompositionStatus

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

func (*CompositionStatus) DeepCopyInto 

func (in *CompositionStatus) DeepCopyInto(out *CompositionStatus)

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

type ConnectionDetail 

type ConnectionDetail struct {
	// Name of the connection secret key that will be propagated to the
	// connection secret of the composition instance. Leave empty if you'd like
	// to use the same key name.
	// +optional
	Name *string `json:"name,omitempty"`

	// FromConnectionSecretKey is the key that will be used to fetch the value
	// from the given target resource.
	// +optional
	FromConnectionSecretKey *string `json:"fromConnectionSecretKey,omitempty"`

	// Value that will be propagated to the connection secret of the composition
	// instance. Typically you should use FromConnectionSecretKey instead, but
	// an explicit value may be set to inject a fixed, non-sensitive connection
	// secret values, for example a well-known port. Supercedes
	// FromConnectionSecretKey when set.
	// +optional
	Value *string `json:"value,omitempty"`
}

ConnectionDetail includes the information about the propagation of the connection information from one secret to another.

func (*ConnectionDetail) DeepCopy 

func (in *ConnectionDetail) DeepCopy() *ConnectionDetail

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

func (*ConnectionDetail) DeepCopyInto 

func (in *ConnectionDetail) DeepCopyInto(out *ConnectionDetail)

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

type CustomResourceDefinitionVersion 

type CustomResourceDefinitionVersion struct {
	// name is the version name, e.g. “v1”, “v2beta1”, etc.
	// The custom resources are served under this version at `/apis/<group>/<version>/...` if `served` is true.
	Name string `json:"name"`

	// served is a flag enabling/disabling this version from being served via REST APIs
	Served bool `json:"served"`

	// storage indicates this version should be used when persisting custom resources to storage.
	// There must be exactly one version with storage=true.
	Storage bool `json:"storage"`

	// schema describes the schema used for validation and pruning of this version of the custom resource.
	// Top-level and per-version schemas are mutually exclusive.
	// Per-version schemas must not all be set to identical values (top-level validation schema should be used instead).
	// +optional
	Schema *CustomResourceValidation `json:"schema,omitempty"`

	// additionalPrinterColumns specifies additional columns returned in Table output.
	// See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details.
	// Top-level and per-version columns are mutually exclusive.
	// Per-version columns must not all be set to identical values (top-level columns should be used instead).
	// If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.
	// +optional
	AdditionalPrinterColumns []v1beta1.CustomResourceColumnDefinition `json:"additionalPrinterColumns,omitempty"`
}

CustomResourceDefinitionVersion describes a version for CRD.

func (*CustomResourceDefinitionVersion) DeepCopy 

func (in *CustomResourceDefinitionVersion) DeepCopy() *CustomResourceDefinitionVersion

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

func (*CustomResourceDefinitionVersion) DeepCopyInto 

func (in *CustomResourceDefinitionVersion) DeepCopyInto(out *CustomResourceDefinitionVersion)

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

type CustomResourceValidation 

type CustomResourceValidation struct {
	// openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
	// +optional
	OpenAPIV3Schema runtime.RawExtension `json:"openAPIV3Schema,omitempty"`
}

CustomResourceValidation is a list of validation methods for CustomResources.

func (*CustomResourceValidation) DeepCopy 

func (in *CustomResourceValidation) DeepCopy() *CustomResourceValidation

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

func (*CustomResourceValidation) DeepCopyInto 

func (in *CustomResourceValidation) DeepCopyInto(out *CustomResourceValidation)

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

type InfrastructureDefinition 

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

	Spec   InfrastructureDefinitionSpec   `json:"spec,omitempty"`
	Status InfrastructureDefinitionStatus `json:"status,omitempty"`
}

An InfrastructureDefinition defines a new kind of composite infrastructure resource. The new resource is composed of other composite or managed infrastructure resources. +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories=crossplane

func (*InfrastructureDefinition) DeepCopy 

func (in *InfrastructureDefinition) DeepCopy() *InfrastructureDefinition

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

func (*InfrastructureDefinition) DeepCopyInto 

func (in *InfrastructureDefinition) DeepCopyInto(out *InfrastructureDefinition)

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

func (*InfrastructureDefinition) DeepCopyObject 

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

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

func (*InfrastructureDefinition) GetConnectionSecretKeys 

func (in *InfrastructureDefinition) GetConnectionSecretKeys() []string

GetConnectionSecretKeys returns the set of allowed keys to filter the connection secret.

func (InfrastructureDefinition) GetDefinedGroupVersionKind 

func (in InfrastructureDefinition) GetDefinedGroupVersionKind() schema.GroupVersionKind

GetDefinedGroupVersionKind returns the schema.GroupVersionKind of the CRD that this InfrastructureDefinition instance will define.

type InfrastructureDefinitionList 

type InfrastructureDefinitionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []InfrastructureDefinition `json:"items"`
}

InfrastructureDefinitionList contains a list of InfrastructureDefinitions.

func (*InfrastructureDefinitionList) DeepCopy 

func (in *InfrastructureDefinitionList) DeepCopy() *InfrastructureDefinitionList

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

func (*InfrastructureDefinitionList) DeepCopyInto 

func (in *InfrastructureDefinitionList) DeepCopyInto(out *InfrastructureDefinitionList)

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

func (*InfrastructureDefinitionList) DeepCopyObject 

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

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

type InfrastructureDefinitionSpec 

type InfrastructureDefinitionSpec struct {

	// ConnectionSecretKeys is the list of keys that will be exposed to the end
	// user of the defined kind.
	ConnectionSecretKeys []string `json:"connectionSecretKeys,omitempty"`

	// DefaultCompositionRef refers to the Composition resource that will be used
	// in case no composition selector is given.
	// +optional
	DefaultCompositionRef *v1alpha1.Reference `json:"defaultCompositionRef,omitempty"`

	// EnforcedCompositionRef refers to the Composition resource that will be used
	// by all composite instances whose schema is defined by this definition.
	// +optional
	// +immutable
	EnforcedCompositionRef *v1alpha1.Reference `json:"enforcedCompositionRef,omitempty"`

	// CRDSpecTemplate is the base CRD template. The final CRD will have additional
	// fields to the base template to accommodate Crossplane machinery.
	CRDSpecTemplate CRDSpecTemplate `json:"crdSpecTemplate,omitempty"`
}

InfrastructureDefinitionSpec specifies the desired state of the definition.

func (*InfrastructureDefinitionSpec) DeepCopy 

func (in *InfrastructureDefinitionSpec) DeepCopy() *InfrastructureDefinitionSpec

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

func (*InfrastructureDefinitionSpec) DeepCopyInto 

func (in *InfrastructureDefinitionSpec) DeepCopyInto(out *InfrastructureDefinitionSpec)

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

type InfrastructureDefinitionStatus 

type InfrastructureDefinitionStatus struct {
	v1alpha1.ConditionedStatus `json:",inline"`
}

InfrastructureDefinitionStatus shows the observed state of the definition.

func (*InfrastructureDefinitionStatus) DeepCopy 

func (in *InfrastructureDefinitionStatus) DeepCopy() *InfrastructureDefinitionStatus

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

func (*InfrastructureDefinitionStatus) DeepCopyInto 

func (in *InfrastructureDefinitionStatus) DeepCopyInto(out *InfrastructureDefinitionStatus)

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

type InfrastructurePublication 

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

	Spec   InfrastructurePublicationSpec   `json:"spec,omitempty"`
	Status InfrastructurePublicationStatus `json:"status,omitempty"`
}

An InfrastructurePublication publishes a defined kind of composite infrastructure resource. Published infrastructure resources may be bound to an application via an infrastructure requirement. +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories=crossplane

func (*InfrastructurePublication) DeepCopy 

func (in *InfrastructurePublication) DeepCopy() *InfrastructurePublication

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

func (*InfrastructurePublication) DeepCopyInto 

func (in *InfrastructurePublication) DeepCopyInto(out *InfrastructurePublication)

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

func (*InfrastructurePublication) DeepCopyObject 

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

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

type InfrastructurePublicationList 

type InfrastructurePublicationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []InfrastructurePublication `json:"items"`
}

InfrastructurePublicationList contains a list of InfrastructurePublications.

func (*InfrastructurePublicationList) DeepCopy 

func (in *InfrastructurePublicationList) DeepCopy() *InfrastructurePublicationList

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

func (*InfrastructurePublicationList) DeepCopyInto 

func (in *InfrastructurePublicationList) DeepCopyInto(out *InfrastructurePublicationList)

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

func (*InfrastructurePublicationList) DeepCopyObject 

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

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

type InfrastructurePublicationSpec 

type InfrastructurePublicationSpec struct {
	// InfrastructureDefinitionReference references the InfrastructureDefinition
	// that should be published.
	InfrastructureDefinitionReference v1alpha1.Reference `json:"infrastructureDefinitionRef"`
}

InfrastructurePublicationSpec specifies the desired state of the definition.

func (*InfrastructurePublicationSpec) DeepCopy 

func (in *InfrastructurePublicationSpec) DeepCopy() *InfrastructurePublicationSpec

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

func (*InfrastructurePublicationSpec) DeepCopyInto 

func (in *InfrastructurePublicationSpec) DeepCopyInto(out *InfrastructurePublicationSpec)

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

type InfrastructurePublicationStatus 

type InfrastructurePublicationStatus struct {
	v1alpha1.ConditionedStatus `json:",inline"`
}

InfrastructurePublicationStatus shows the observed state of the definition.

func (*InfrastructurePublicationStatus) DeepCopy 

func (in *InfrastructurePublicationStatus) DeepCopy() *InfrastructurePublicationStatus

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

func (*InfrastructurePublicationStatus) DeepCopyInto 

func (in *InfrastructurePublicationStatus) DeepCopyInto(out *InfrastructurePublicationStatus)

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

type MapTransform 

type MapTransform struct {

	// Pairs is the map that will be used for transform.
	// +optional
	Pairs map[string]string `json:",inline"`
}

MapTransform returns a value for the input from the given map.

func (*MapTransform) DeepCopy 

func (in *MapTransform) DeepCopy() *MapTransform

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

func (*MapTransform) DeepCopyInto 

func (in *MapTransform) DeepCopyInto(out *MapTransform)

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

func (MapTransform) MarshalJSON added in v0.11.0 

func (m MapTransform) MarshalJSON() ([]byte, error)

MarshalJSON from this MapTransform.

func (*MapTransform) Resolve 

func (m *MapTransform) Resolve(input interface{}) (interface{}, error)

Resolve runs the Map transform.

func (*MapTransform) UnmarshalJSON added in v0.11.0 

func (m *MapTransform) UnmarshalJSON(b []byte) error

UnmarshalJSON into this MapTransform.

type MathTransform 

type MathTransform struct {
	// Multiply the value.
	// +optional
	Multiply *int64 `json:"multiply,omitempty"`
}

MathTransform conducts mathematical operations on the input with the given configuration in its properties.

func (*MathTransform) DeepCopy 

func (in *MathTransform) DeepCopy() *MathTransform

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

func (*MathTransform) DeepCopyInto 

func (in *MathTransform) DeepCopyInto(out *MathTransform)

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

func (*MathTransform) Resolve 

func (m *MathTransform) Resolve(input interface{}) (interface{}, error)

Resolve runs the Math transform.

type Patch 

type Patch struct {

	// FromFieldPath is the path of the field on the upstream resource whose value
	// to be used as input.
	FromFieldPath string `json:"fromFieldPath"`

	// ToFieldPath is the path of the field on the base resource whose value will
	// be changed with the result of transforms. Leave empty if you'd like to
	// propagate to the same path on the target resource.
	// +optional
	ToFieldPath string `json:"toFieldPath,omitempty"`

	// Transforms are the list of functions that are used as a FIFO pipe for the
	// input to be transformed.
	// +optional
	Transforms []Transform `json:"transforms,omitempty"`
}

Patch is used to patch the field on the base resource at ToFieldPath after piping the value that is at FromFieldPath of the target resource through transformers.

func (*Patch) Apply 

func (c *Patch) Apply(from, to runtime.Object) error

Apply runs transformers and patches the target resource.

func (*Patch) DeepCopy 

func (in *Patch) DeepCopy() *Patch

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

func (*Patch) DeepCopyInto 

func (in *Patch) DeepCopyInto(out *Patch)

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

type StringTransform 

type StringTransform struct {
	// Format the input using a Go format string. See
	// https://golang.org/pkg/fmt/ for details.
	Format string `json:"fmt"`
}

A StringTransform returns a string given the supplied input.

func (*StringTransform) DeepCopy 

func (in *StringTransform) DeepCopy() *StringTransform

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

func (*StringTransform) DeepCopyInto 

func (in *StringTransform) DeepCopyInto(out *StringTransform)

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

func (*StringTransform) Resolve 

func (s *StringTransform) Resolve(input interface{}) (interface{}, error)

Resolve runs the String transform.

type Transform 

type Transform struct {

	// Type of the transform to be run.
	Type TransformType `json:"type"`

	// Math is used to transform the input via mathematical operations such as
	// multiplication.
	// +optional
	Math *MathTransform `json:"math,omitempty"`

	// Map uses the input as a key in the given map and returns the value.
	// +optional
	Map *MapTransform `json:"map,omitempty"`

	// String is used to transform the input into a string or a different kind
	// of string. Note that the input does not necessarily need to be a string.
	// +optional
	String *StringTransform `json:"string,omitempty"`
}

Transform is a unit of process whose input is transformed into an output with the supplied configuration.

func (*Transform) DeepCopy 

func (in *Transform) DeepCopy() *Transform

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

func (*Transform) DeepCopyInto 

func (in *Transform) DeepCopyInto(out *Transform)

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

func (*Transform) Transform 

func (t *Transform) Transform(input interface{}) (interface{}, error)

Transform calls the appropriate Transformer.

type TransformType 

type TransformType string

TransformType is type of the transform function to be chosen. 

const (
	TransformTypeMap    TransformType = "map"
	TransformTypeMath   TransformType = "math"
	TransformTypeString TransformType = "string"
)

Accepted TransformTypes.

type TypeReference 

type TypeReference struct {
	// APIVersion of the type.
	APIVersion string `json:"apiVersion"`

	// Kind of the type.
	Kind string `json:"kind"`
}

TypeReference is used to refer to a type for declaring compatibility.

func (*TypeReference) DeepCopy 

func (in *TypeReference) DeepCopy() *TypeReference

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

func (*TypeReference) DeepCopyInto 

func (in *TypeReference) DeepCopyInto(out *TypeReference)

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

Source Files

View all Source files

Directories

Path Synopsis
Package ccrd generates CustomResourceDefinitions from Crossplane definitions.
 Package ccrd generates CustomResourceDefinitions from Crossplane definitions.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.