Documentation ¶
Overview ¶
Package v1alpha2 contains API Schema definitions for the integration v1alpha2 API group +kubebuilder:object:generate=true +groupName=integration.siliconhills.dev
Index ¶
- Constants
- Variables
- type CoupledPlug
- type CoupledSocket
- type Do
- type Interface
- type InterfaceList
- type InterfaceSpec
- type InterfaceSpecSchema
- type InterfaceStatus
- type NamespacedName
- type Phase
- type Plug
- type PlugList
- type PlugSpec
- type PlugStatus
- type Resource
- type SchemaDefinition
- type SchemaProperty
- type Socket
- type SocketList
- type SocketSpec
- type SocketStatus
- type SpecApparatus
- type When
Constants ¶
const PlugFinalizer = "integration.siliconhills.dev/finalizer"
const SocketFinalizer = "integration.siliconhills.dev/finalizer"
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "integration.siliconhills.dev", Version: "v1alpha2"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type CoupledPlug ¶
type CoupledPlug struct { // API version of the plug APIVersion string `json:"apiVersion"` // Kind of the plug Kind string `json:"kind"` // Name of the plug Name string `json:"name"` // Namespace of the plug Namespace string `json:"namespace"` // UID of the plug UID types.UID `json:"uid"` }
func (*CoupledPlug) DeepCopy ¶
func (in *CoupledPlug) DeepCopy() *CoupledPlug
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CoupledPlug.
func (*CoupledPlug) DeepCopyInto ¶
func (in *CoupledPlug) DeepCopyInto(out *CoupledPlug)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CoupledSocket ¶
type CoupledSocket struct { // API version of the socket APIVersion string `json:"apiVersion,omitempty"` // Kind of the socket Kind string `json:"kind,omitempty"` // Name of the socket Name string `json:"name,omitempty"` // Namespace of the socket Namespace string `json:"namespace,omitempty"` // UID of the socket UID types.UID `json:"uid,omitempty"` }
func (*CoupledSocket) DeepCopy ¶
func (in *CoupledSocket) DeepCopy() *CoupledSocket
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CoupledSocket.
func (*CoupledSocket) DeepCopyInto ¶
func (in *CoupledSocket) DeepCopyInto(out *CoupledSocket)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Interface ¶
type Interface struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec InterfaceSpec `json:"spec,omitempty"` Status InterfaceStatus `json:"status,omitempty"` }
Interface is the Schema for the interfaces API
func (*Interface) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Interface.
func (*Interface) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Interface) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type InterfaceList ¶
type InterfaceList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Interface `json:"items"` }
InterfaceList contains a list of Interface
func (*InterfaceList) DeepCopy ¶
func (in *InterfaceList) DeepCopy() *InterfaceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InterfaceList.
func (*InterfaceList) DeepCopyInto ¶
func (in *InterfaceList) DeepCopyInto(out *InterfaceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*InterfaceList) DeepCopyObject ¶
func (in *InterfaceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type InterfaceSpec ¶
type InterfaceSpec struct { // schemas Schemas []*InterfaceSpecSchema `json:"schemas,omitempty"` }
InterfaceSpec defines the desired state of Interface
func (*InterfaceSpec) DeepCopy ¶
func (in *InterfaceSpec) DeepCopy() *InterfaceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InterfaceSpec.
func (*InterfaceSpec) DeepCopyInto ¶
func (in *InterfaceSpec) DeepCopyInto(out *InterfaceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type InterfaceSpecSchema ¶
type InterfaceSpecSchema struct { // version Version string `json:"version,omitempty"` // plug definition PlugDefinition *SchemaDefinition `json:"plugDefinition,omitempty"` // socket definition SocketDefinition *SchemaDefinition `json:"socketDefinition,omitempty"` }
func (*InterfaceSpecSchema) DeepCopy ¶
func (in *InterfaceSpecSchema) DeepCopy() *InterfaceSpecSchema
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InterfaceSpecSchema.
func (*InterfaceSpecSchema) DeepCopyInto ¶
func (in *InterfaceSpecSchema) DeepCopyInto(out *InterfaceSpecSchema)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type InterfaceStatus ¶
type InterfaceStatus struct { }
InterfaceStatus defines the observed state of Interface
func (*InterfaceStatus) DeepCopy ¶
func (in *InterfaceStatus) DeepCopy() *InterfaceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InterfaceStatus.
func (*InterfaceStatus) DeepCopyInto ¶
func (in *InterfaceStatus) DeepCopyInto(out *InterfaceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NamespacedName ¶
type NamespacedName struct { // name Name string `json:"name"` // namespace Namespace string `json:"namespace,omitempty"` }
func (*NamespacedName) DeepCopy ¶
func (in *NamespacedName) DeepCopy() *NamespacedName
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamespacedName.
func (*NamespacedName) DeepCopyInto ¶
func (in *NamespacedName) DeepCopyInto(out *NamespacedName)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Plug ¶
type Plug struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec PlugSpec `json:"spec,omitempty"` Status PlugStatus `json:"status,omitempty"` }
Plug is the Schema for the plugs API
func (*Plug) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Plug.
func (*Plug) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Plug) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PlugList ¶
type PlugList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Plug `json:"items"` }
PlugList contains a list of Plug
func (*PlugList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlugList.
func (*PlugList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PlugList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PlugSpec ¶
type PlugSpec struct { // socket Socket NamespacedName `json:"socket,omitempty"` // interface Interface NamespacedName `json:"interface,omitempty"` // interface versions InterfaceVersions string `json:"interfaceVersions,omitempty"` // A var is a name (e.g. FOO) associated // with a field in a specific resource instance. The field must // contain a value of type string/bool/int/float, and defaults to the name field // of the instance. Any appearance of "$(FOO)" in the object // spec will be replaced, after the final // value of the specified field has been determined. Vars []*kustomizeTypes.Var `json:"vars,omitempty" yaml:"vars,omitempty"` // data Data map[string]string `json:"data,omitempty"` // data config map name DataConfigMapName string `json:"dataConfigMapName,omitempty"` // data secret name DataSecretName string `json:"dataSecretName,omitempty"` // config Config map[string]string `json:"config,omitempty"` // config config map name ConfigConfigMapName string `json:"configConfigMapName,omitempty"` // config secret name ConfigSecretName string `json:"configSecretName,omitempty"` // config mapper ConfigMapper map[string]string `json:"configMapper,omitempty"` // apparatus Apparatus *SpecApparatus `json:"apparatus,omitempty"` // resources Resources []*Resource `json:"resources,omitempty"` // change epoch to force an update Epoch string `json:"epoch,omitempty"` }
PlugSpec defines the desired state of Plug
func (*PlugSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlugSpec.
func (*PlugSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlugStatus ¶
type PlugStatus struct { // Conditions represent the latest available observations of an object's state Conditions []metav1.Condition `json:"conditions,omitempty"` // integration plug phase (Pending, Succeeded, Failed, Unknown) Phase Phase `json:"phase,omitempty"` // last update time LastUpdate metav1.Time `json:"lastUpdate,omitempty"` // status message Message string `json:"message,omitempty"` // socket coupled to plug CoupledSocket *CoupledSocket `json:"coupledSocket,omitempty"` // requeued Requeued bool `json:"requeued,omitempty"` }
PlugStatus defines the observed state of Plug
func (*PlugStatus) DeepCopy ¶
func (in *PlugStatus) DeepCopy() *PlugStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlugStatus.
func (*PlugStatus) DeepCopyInto ¶
func (in *PlugStatus) DeepCopyInto(out *PlugStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Resource ¶
type Resource struct { Do Do `json:"do,omitempty"` Resource string `json:"resource,omitempty"` When *[]When `json:"when,omitempty"` }
func (*Resource) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resource.
func (*Resource) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SchemaDefinition ¶
type SchemaDefinition struct { Description string `json:"description,omitempty"` Properties map[string]*SchemaProperty `json:"properties,omitempty"` }
func (*SchemaDefinition) DeepCopy ¶
func (in *SchemaDefinition) DeepCopy() *SchemaDefinition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SchemaDefinition.
func (*SchemaDefinition) DeepCopyInto ¶
func (in *SchemaDefinition) DeepCopyInto(out *SchemaDefinition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SchemaProperty ¶
type SchemaProperty struct { Default string `json:"default,omitempty"` Description string `json:"description,omitempty"` Required bool `json:"required,omitempty"` }
func (*SchemaProperty) DeepCopy ¶
func (in *SchemaProperty) DeepCopy() *SchemaProperty
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SchemaProperty.
func (*SchemaProperty) DeepCopyInto ¶
func (in *SchemaProperty) DeepCopyInto(out *SchemaProperty)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Socket ¶
type Socket struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec SocketSpec `json:"spec,omitempty"` Status SocketStatus `json:"status,omitempty"` }
Socket is the Schema for the sockets API
func (*Socket) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Socket.
func (*Socket) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Socket) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SocketList ¶
type SocketList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Socket `json:"items"` }
SocketList contains a list of Socket
func (*SocketList) DeepCopy ¶
func (in *SocketList) DeepCopy() *SocketList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SocketList.
func (*SocketList) DeepCopyInto ¶
func (in *SocketList) DeepCopyInto(out *SocketList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SocketList) DeepCopyObject ¶
func (in *SocketList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SocketSpec ¶
type SocketSpec struct { // interface Interface NamespacedName `json:"interface,omitempty"` // interface versions InterfaceVersions string `json:"interfaceVersions,omitempty"` // limit Limit int32 `json:"limit,omitempty"` // A var is a name (e.g. FOO) associated // with a field in a specific resource instance. The field must // contain a value of type string/bool/int/float, and defaults to the name field // of the instance. Any appearance of "$(FOO)" in the object // spec will be replaced, after the final // value of the specified field has been determined. Vars []*kustomizeTypes.Var `json:"vars,omitempty" yaml:"vars,omitempty"` // data Data map[string]string `json:"data,omitempty"` // data config map name DataConfigMapName string `json:"dataConfigMapName,omitempty"` // data secret name DataSecretName string `json:"dataSecretName,omitempty"` // config Config map[string]string `json:"config,omitempty"` // config config map name ConfigConfigMapName string `json:"configConfigMapName,omitempty"` // config secret name ConfigSecretName string `json:"configSecretName,omitempty"` // config mapper ConfigMapper map[string]string `json:"configMapper,omitempty"` // apparatus Apparatus *SpecApparatus `json:"apparatus,omitempty"` // resources Resources []*Resource `json:"resources,omitempty"` // change epoch to force an update Epoch string `json:"epoch,omitempty"` }
SocketSpec defines the desired state of Socket
func (*SocketSpec) DeepCopy ¶
func (in *SocketSpec) DeepCopy() *SocketSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SocketSpec.
func (*SocketSpec) DeepCopyInto ¶
func (in *SocketSpec) DeepCopyInto(out *SocketSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SocketStatus ¶
type SocketStatus struct { // Conditions represent the latest available observations of an object's state Conditions []metav1.Condition `json:"conditions,omitempty"` // integration socket phase (Pending, Succeeded, Failed, Unknown) Phase Phase `json:"phase,omitempty"` // socket is ready for coupling Ready bool `json:"ready,omitempty"` // last update time LastUpdate metav1.Time `json:"lastUpdate,omitempty"` // status message Message string `json:"message,omitempty"` // plugs coupled to socket CoupledPlugs []*CoupledPlug `json:"coupledPlugs,omitempty"` // requeued Requeued bool `json:"requeued,omitempty"` }
SocketStatus defines the observed state of Socket
func (*SocketStatus) DeepCopy ¶
func (in *SocketStatus) DeepCopy() *SocketStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SocketStatus.
func (*SocketStatus) DeepCopyInto ¶
func (in *SocketStatus) DeepCopyInto(out *SocketStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SpecApparatus ¶
type SpecApparatus struct { // endpoint Endpoint string `json:"endpoint,omitempty"` // terminate apparatus after idle for timeout in milliseconds IdleTimeout uint `json:"idleTimeout,omitempty"` // containers Containers *[]v1.Container `json:"containers,omitempty"` }
func (*SpecApparatus) DeepCopy ¶
func (in *SpecApparatus) DeepCopy() *SpecApparatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SpecApparatus.
func (*SpecApparatus) DeepCopyInto ¶
func (in *SpecApparatus) DeepCopyInto(out *SpecApparatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.