v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the fleet v1alpha1 API group. +kubebuilder:object:generate=true +groupName=fleet.roboscale.io

Index

• Variables
• type AttachedRobot
  • func (in *AttachedRobot) DeepCopy() *AttachedRobot
  • func (in *AttachedRobot) DeepCopyInto(out *AttachedRobot)
• type Fleet
  • func (in *Fleet) DeepCopy() *Fleet
  • func (in *Fleet) DeepCopyInto(out *Fleet)
  • func (in *Fleet) DeepCopyObject() runtime.Object
  • func (r *Fleet) Default()
  • func (fleet *Fleet) GetDiscoveryServerMetadata() *types.NamespacedName
  • func (fleet *Fleet) GetNamespaceMetadata() *types.NamespacedName
  • func (r *Fleet) SetupWebhookWithManager(mgr ctrl.Manager) error
  • func (r *Fleet) ValidateCreate() error
  • func (r *Fleet) ValidateDelete() error
  • func (r *Fleet) ValidateUpdate(old runtime.Object) error
• type FleetCompatibilityStatus
  • func (in *FleetCompatibilityStatus) DeepCopy() *FleetCompatibilityStatus
  • func (in *FleetCompatibilityStatus) DeepCopyInto(out *FleetCompatibilityStatus)
• type FleetList
  • func (in *FleetList) DeepCopy() *FleetList
  • func (in *FleetList) DeepCopyInto(out *FleetList)
  • func (in *FleetList) DeepCopyObject() runtime.Object
• type FleetPhase
• type FleetSpec
  • func (in *FleetSpec) DeepCopy() *FleetSpec
  • func (in *FleetSpec) DeepCopyInto(out *FleetSpec)
• type FleetStatus
  • func (in *FleetStatus) DeepCopy() *FleetStatus
  • func (in *FleetStatus) DeepCopyInto(out *FleetStatus)
• type OwnedNamespaceStatus
  • func (in *OwnedNamespaceStatus) DeepCopy() *OwnedNamespaceStatus
  • func (in *OwnedNamespaceStatus) DeepCopyInto(out *OwnedNamespaceStatus)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "fleet.roboscale.io", Version: "v1alpha1"}

	// 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
)

Types

type AttachedRobot

type AttachedRobot struct {
	// Resource reference for attached robot.
	Reference corev1.ObjectReference `json:"reference,omitempty"`
	// Attached robot phase. For detailed information, refer the document for the API group `robot.roboscale.io`.
	Phase robotv1alpha1.RobotPhase `json:"phase,omitempty"`
	// Compatibility status of attached robot with the fleet.
	FleetCompatibility FleetCompatibilityStatus `json:"fleetCompatibility,omitempty"`
}

func (*AttachedRobot) DeepCopy

func (in *AttachedRobot) DeepCopy() *AttachedRobot

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

func (*AttachedRobot) DeepCopyInto

func (in *AttachedRobot) DeepCopyInto(out *AttachedRobot)

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

type Fleet

type Fleet struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Specification of the desired behavior of the Fleet.
	Spec FleetSpec `json:"spec,omitempty"`
	// Most recently observed status of the Fleet.
	Status FleetStatus `json:"status,omitempty"`
}

Fleet manages lifecycle and configuration of multiple robots and robot's connectivity layer that contains DDS Discovery Server and ROS bridge services.

func (*Fleet) DeepCopy

func (in *Fleet) DeepCopy() *Fleet

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

func (*Fleet) DeepCopyInto

func (in *Fleet) DeepCopyInto(out *Fleet)

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

func (*Fleet) DeepCopyObject

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

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

func (*Fleet) Default

func (r *Fleet) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*Fleet) GetDiscoveryServerMetadata

func (fleet *Fleet) GetDiscoveryServerMetadata() *types.NamespacedName

func (*Fleet) GetNamespaceMetadata

func (fleet *Fleet) GetNamespaceMetadata() *types.NamespacedName

func (*Fleet) SetupWebhookWithManager

func (r *Fleet) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*Fleet) ValidateCreate

func (r *Fleet) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*Fleet) ValidateDelete

func (r *Fleet) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*Fleet) ValidateUpdate

func (r *Fleet) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type FleetCompatibilityStatus

type FleetCompatibilityStatus struct {
	// Indicates the robot's compatibility with fleet.
	IsCompatible bool `json:"isCompatible"`
	// Indicates the possible incompatibility reason of an attached robot.
	Reason string `json:"reason,omitempty"`
}

func (*FleetCompatibilityStatus) DeepCopy

func (in *FleetCompatibilityStatus) DeepCopy() *FleetCompatibilityStatus

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

func (*FleetCompatibilityStatus) DeepCopyInto

func (in *FleetCompatibilityStatus) DeepCopyInto(out *FleetCompatibilityStatus)

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

type FleetList

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

FleetList contains a list of Fleet.

func (*FleetList) DeepCopy

func (in *FleetList) DeepCopy() *FleetList

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

func (*FleetList) DeepCopyInto

func (in *FleetList) DeepCopyInto(out *FleetList)

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

func (*FleetList) DeepCopyObject

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

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

type FleetPhase

type FleetPhase string

const (
	FleetPhaseCheckingRemoteNamespace FleetPhase = "CheckingRemoteNamespace"
	FleetPhaseCreatingNamespace       FleetPhase = "CreatingNamespace"
	FleetPhaseCreatingDiscoveryServer FleetPhase = "CreatingDiscoveryServer"
	FleetPhaseReady                   FleetPhase = "Ready"
)

type FleetSpec

type FleetSpec struct {
	// Discovery server configuration of fleet. For detailed information, refer the document for the API group `robot.roboscale.io`.
	DiscoveryServerTemplate robotv1alpha1.DiscoveryServerSpec `json:"discoveryServerTemplate,omitempty"`
	// Determines if the fleet should be federated across clusters or not.
	Hybrid bool `json:"hybrid,omitempty"`
	// If `.spec.hybrid` is true, this field includes Kubernetes cluster names which the fleet will be federated to.
	Instances []string `json:"instances,omitempty"`
}

func (*FleetSpec) DeepCopy

func (in *FleetSpec) DeepCopy() *FleetSpec

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

func (*FleetSpec) DeepCopyInto

func (in *FleetSpec) DeepCopyInto(out *FleetSpec)

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

type FleetStatus

type FleetStatus struct {
	// Fleet phase.
	Phase FleetPhase `json:"phase,omitempty"`
	// Namespace status. Fleet creates namespace if the `.spec.hybrid` is set to `true`. It creates `FederatedNamespace` if `false`.
	NamespaceStatus OwnedNamespaceStatus `json:"namespaceStatus,omitempty"`
	// Discovery server instance status. For detailed information, refer the document for the API group `robot.roboscale.io`.
	DiscoveryServerStatus robotv1alpha1.OwnedResourceStatus `json:"discoveryServerStatus,omitempty"`
	// Attached launch object information.
	AttachedRobots []AttachedRobot `json:"attachedRobots,omitempty"`
}

func (*FleetStatus) DeepCopy

func (in *FleetStatus) DeepCopy() *FleetStatus

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

func (*FleetStatus) DeepCopyInto

func (in *FleetStatus) DeepCopyInto(out *FleetStatus)

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

type OwnedNamespaceStatus

type OwnedNamespaceStatus struct {
	// Generic structure of the most recent status of an owned object. For detailed information, refer the document for the API group `robot.roboscale.io`.
	Resource robotv1alpha1.OwnedResourceStatus `json:"resource,omitempty"`
	// Sets to `true` if the owned namespace is federated.
	Federated bool `json:"federated,omitempty"`
	// Sets to `true` if the namespace is ready for the resources to be deployed such as robot.
	Ready bool `json:"ready,omitempty"`
}

func (*OwnedNamespaceStatus) DeepCopy

func (in *OwnedNamespaceStatus) DeepCopy() *OwnedNamespaceStatus

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

func (*OwnedNamespaceStatus) DeepCopyInto

func (in *OwnedNamespaceStatus) DeepCopyInto(out *OwnedNamespaceStatus)

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