Documentation
¶
Overview ¶
Package v3 contains API Schema definitions for the controlplanes v3 API group +kubebuilder:object:generate=true +groupName=iofog.org
Index ¶
- Variables
- type ControlPlane
- func (in *ControlPlane) DeepCopy() *ControlPlane
- func (in *ControlPlane) DeepCopyInto(out *ControlPlane)
- func (in *ControlPlane) DeepCopyObject() runtime.Object
- func (cp *ControlPlane) GetCondition() string
- func (cp *ControlPlane) IsDeploying() bool
- func (cp *ControlPlane) IsReady() bool
- func (cp *ControlPlane) SetConditionDeploying(log *logr.Logger)
- func (cp *ControlPlane) SetConditionReady(log *logr.Logger)
- type ControlPlaneList
- type ControlPlaneSpec
- type ControlPlaneStatus
- type Controller
- type Database
- type Images
- type Ingress
- type Ingresses
- type Replicas
- type RouterIngress
- type Service
- type Services
- type User
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects. GroupVersion = schema.GroupVersion{Group: "iofog.org", Version: "v3"} //nolint:gochecknoglobals // SchemeBuilder is used to add go types to the GroupVersionKind scheme. SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} //nolint:gochecknoglobals // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme //nolint:gochecknoglobals )
Functions ¶
This section is empty.
Types ¶
type ControlPlane ¶
type ControlPlane struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ControlPlaneSpec `json:"spec,omitempty"`
Status ControlPlaneStatus `json:"status,omitempty"`
}
+kubebuilder:object:root=true +kubebuilder:subresource:status ControlPlane is the Schema for the controlplanes API.
func (*ControlPlane) DeepCopy ¶
func (in *ControlPlane) DeepCopy() *ControlPlane
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ControlPlane.
func (*ControlPlane) DeepCopyInto ¶
func (in *ControlPlane) DeepCopyInto(out *ControlPlane)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ControlPlane) DeepCopyObject ¶
func (in *ControlPlane) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ControlPlane) GetCondition ¶
func (cp *ControlPlane) GetCondition() string
func (*ControlPlane) IsDeploying ¶
func (cp *ControlPlane) IsDeploying() bool
func (*ControlPlane) IsReady ¶
func (cp *ControlPlane) IsReady() bool
func (*ControlPlane) SetConditionDeploying ¶
func (cp *ControlPlane) SetConditionDeploying(log *logr.Logger)
func (*ControlPlane) SetConditionReady ¶
func (cp *ControlPlane) SetConditionReady(log *logr.Logger)
type ControlPlaneList ¶
type ControlPlaneList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ControlPlane `json:"items"`
}
ControlPlaneList contains a list of ControlPlane.
func (*ControlPlaneList) DeepCopy ¶
func (in *ControlPlaneList) DeepCopy() *ControlPlaneList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ControlPlaneList.
func (*ControlPlaneList) DeepCopyInto ¶
func (in *ControlPlaneList) DeepCopyInto(out *ControlPlaneList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ControlPlaneList) DeepCopyObject ¶
func (in *ControlPlaneList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ControlPlaneSpec ¶
type ControlPlaneSpec struct {
// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
// Add custom validation using kubebuilder tags: https://book-v1.book.kubebuilder.io/beyond_basics/generating_crd.html
// User contains credentials for ioFog Controller
User User `json:"user"`
// Database is only used when ioFog Controller is configured to connect to an external DB.
Database Database `json:"database,omitempty"`
// Ingresses allow Router and Port Manager to configure endpoint addresses correctly
Ingresses Ingresses `json:"ingresses,omitempty"`
// Services should be LoadBalancer unless Ingress is being configured
Services Services `json:"services,omitempty"`
// Replicas of ioFog Controller should be 1 unless an external DB is configured
Replicas Replicas `json:"replicas,omitempty"`
// Images specifies which containers to run for each component of the ControlPlane
Images Images `json:"images,omitempty"`
// Controller contains runtime configuration for ioFog Controller
Controller Controller `json:"controller,omitempty"`
}
ControlPlaneSpec defines the desired state of ControlPlane.
func (*ControlPlaneSpec) DeepCopy ¶
func (in *ControlPlaneSpec) DeepCopy() *ControlPlaneSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ControlPlaneSpec.
func (*ControlPlaneSpec) DeepCopyInto ¶
func (in *ControlPlaneSpec) DeepCopyInto(out *ControlPlaneSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ControlPlaneStatus ¶
type ControlPlaneStatus struct {
// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
// Important: Run "make" to regenerate code after modifying this file
Conditions []metav1.Condition `json:"conditions"`
}
ControlPlaneStatus defines the observed state of ControlPlane.
func (*ControlPlaneStatus) DeepCopy ¶
func (in *ControlPlaneStatus) DeepCopy() *ControlPlaneStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ControlPlaneStatus.
func (*ControlPlaneStatus) DeepCopyInto ¶
func (in *ControlPlaneStatus) DeepCopyInto(out *ControlPlaneStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Controller ¶
type Controller struct {
PidBaseDir string `json:"pidBaseDir,omitempty"`
EcnViewerPort int `json:"ecnViewerPort,omitempty"`
EcnViewerURL string `json:"ecnViewerUrl,omitempty"`
PortProvider string `json:"portProvider,omitempty"`
ECNName string `json:"ecn,omitempty"`
PortAllocatorHost string `json:"portAllocatorHost,omitempty"`
ProxyBrokerURL string `json:"proxyBrokerUrl,omitempty"`
ProxyBrokerToken string `json:"proxyBrokerToken,omitempty"`
}
func (*Controller) DeepCopy ¶
func (in *Controller) DeepCopy() *Controller
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Controller.
func (*Controller) DeepCopyInto ¶
func (in *Controller) DeepCopyInto(out *Controller)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Database ¶
type Database struct {
Provider string `json:"provider"`
Host string `json:"host"`
Port int `json:"port"`
User string `json:"user"`
Password string `json:"password"`
DatabaseName string `json:"databaseName"`
}
func (*Database) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Database.
func (*Database) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Images ¶
type Images struct {
PullSecret string `json:"pullSecret,omitempty"`
Controller string `json:"controller,omitempty"`
Router string `json:"router,omitempty"`
PortManager string `json:"portManager,omitempty"`
Proxy string `json:"proxy,omitempty"`
PortRouter string `json:"portRouter,omitempty"`
}
func (*Images) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Images.
func (*Images) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Ingress ¶
type Ingress struct {
Address string `json:"address,omitempty"`
}
func (*Ingress) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Ingress.
func (*Ingress) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Ingresses ¶
type Ingresses struct {
Router RouterIngress `json:"router,omitempty"`
HTTPProxy Ingress `json:"httpProxy,omitempty"`
TCPProxy Ingress `json:"tcpProxy,omitempty"`
}
func (*Ingresses) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Ingresses.
func (*Ingresses) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Replicas ¶
type Replicas struct {
Controller int32 `json:"controller,omitempty"`
}
func (*Replicas) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Replicas.
func (*Replicas) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RouterIngress ¶
type RouterIngress struct {
Address string `json:"address,omitempty"`
MessagePort int `json:"messagePort,omitempty"`
InteriorPort int `json:"interiorPort,omitempty"`
EdgePort int `json:"edgePort,omitempty"`
}
func (*RouterIngress) DeepCopy ¶
func (in *RouterIngress) DeepCopy() *RouterIngress
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouterIngress.
func (*RouterIngress) DeepCopyInto ¶
func (in *RouterIngress) DeepCopyInto(out *RouterIngress)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Service ¶
type Service struct {
Type string `json:"type,omitempty"`
Address string `json:"address,omitempty"`
}
func (*Service) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Service.
func (*Service) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Services ¶
type Services struct {
Controller Service `json:"controller,omitempty"`
Router Service `json:"router,omitempty"`
Proxy Service `json:"proxy,omitempty"`
}
func (*Services) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Services.
func (*Services) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type User ¶
type User struct {
Name string `json:"name"`
Surname string `json:"surname"`
Email string `json:"email"`
Password string `json:"password"`
}
func (*User) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new User.
func (*User) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.