Documentation ¶
Overview ¶
+k8s:deepcopy-gen=package
Package v1alpha1 contains API Schema definitions for the octopinger.io v1alpha1 API group +kubebuilder:object:generate=true +groupName=octopinger.io
Index ¶
- Constants
- Variables
- type Config
- type DNS
- type ICMP
- type Octopinger
- type OctopingerList
- type OctopingerPhase
- type OctopingerSpec
- type OctopingerStatus
- func (cs *OctopingerStatus) Control()
- func (in *OctopingerStatus) DeepCopy() *OctopingerStatus
- func (in *OctopingerStatus) DeepCopyInto(out *OctopingerStatus)
- func (cs *OctopingerStatus) IsFailed() bool
- func (cs *OctopingerStatus) PauseControl()
- func (cs *OctopingerStatus) SetPhase(p OctopingerPhase)
- type Template
Constants ¶
const (
// CRDResourceKind ...
CRDResourceKind = "Octopinger"
)
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "octopinger.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 )
Functions ¶
This section is empty.
Types ¶
type Config ¶ added in v0.1.0
type Config struct { // ICMP is the configuration for the ICMP probe. ICMP ICMP `json:"icmp"` // DNS is the configuration for the DNS probe. DNS DNS `json:"dns"` }
Config is a wrapper to contain the configuration of Octopinger.
func (*Config) DeepCopy ¶ added in v0.1.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Config.
func (*Config) DeepCopyInto ¶ added in v0.1.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DNS ¶ added in v0.1.0
type DNS struct { // Enable is turning the DNS probe of for Octopinger. Enable bool `json:"enable"` // Names contains the list of domain names to query. Names []string `json:"names,omitempty"` // Server contains a domain name servers to use for the probe. By default the configured DNS servers are used. Server string `json:"server,omitempty"` // Timeout the time to wait for the probe to succeed. The default is "1m" (1 minute). Timeout string `json:"timeout,omitempty"` }
DNS configures this probe.
func (*DNS) DeepCopy ¶ added in v0.1.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNS.
func (*DNS) DeepCopyInto ¶ added in v0.1.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ICMP ¶ added in v0.1.0
type ICMP struct { // Enable is turning the ICMP probe on for Octopinger. By default all nodes are probed. Enable bool `json:"enable"` // ExcludeNodes allows to exclude specific nodes from probing. ExcludeNodes []string `json:"exclude_nodes,omitempty"` // AdditionalTargets this is a list of additional targets to probe via ICMP. AdditionalTargets []string ` json:"additionaltargets,omitempty"` // Timeout the time to wait for the probe to succeed. The default is "1m" (1 minute). Timeout string `json:"timeout,omitempty"` // Count is number of ICMP packets to send. Count int `json:"count,omitempty"` // NodePacketLossThreshold determines the threshold to report a node as available or not (Default: "0.05") NodePacketLossThreshold string `json:"node_packet_loss_treshold,omitempty"` }
ICMP configures this probe.
func (*ICMP) DeepCopy ¶ added in v0.1.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ICMP.
func (*ICMP) DeepCopyInto ¶ added in v0.1.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Octopinger ¶
type Octopinger struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec OctopingerSpec `json:"spec,omitempty"` Status OctopingerStatus `json:"status,omitempty"` }
Octopinger is the Schema for the octopinger API +k8s:openapi-gen=true +kubebuilder:subresource:status +operator-sdk:csv:customresourcedefinitions:resources={{Octopinger,v1alpha1,""}} +operator-sdk:csv:customresourcedefinitions:resources={{Pod,v1,""}} +operator-sdk:csv:customresourcedefinitions:resources={{ReplicaSet,v1,""}}
func (*Octopinger) DeepCopy ¶
func (in *Octopinger) DeepCopy() *Octopinger
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Octopinger.
func (*Octopinger) DeepCopyInto ¶
func (in *Octopinger) DeepCopyInto(out *Octopinger)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Octopinger) DeepCopyObject ¶
func (in *Octopinger) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type OctopingerList ¶
type OctopingerList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Octopinger `json:"items"` }
OctopingerList contains a list of Octopinger
func (*OctopingerList) DeepCopy ¶
func (in *OctopingerList) DeepCopy() *OctopingerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OctopingerList.
func (*OctopingerList) DeepCopyInto ¶
func (in *OctopingerList) DeepCopyInto(out *OctopingerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OctopingerList) DeepCopyObject ¶
func (in *OctopingerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type OctopingerPhase ¶ added in v0.0.3
type OctopingerPhase string
const ( OctopingerPhaseNone OctopingerPhase = "" OctopingerPhaseCreating OctopingerPhase = "Creating" OctopingerPhaseRunning OctopingerPhase = "Running" OctopingerPhaseFailed OctopingerPhase = "Failed" )
type OctopingerSpec ¶
type OctopingerSpec struct { // Label is the value of the 'octopinger=' label to set on a node that should run Octopinger. Label string `json:"label"` // Config is a wrapper to contain the configuration for Octopinger. Config Config `json:"config"` // Template specifies the options for the DaemonSet template. Template Template `json:"template"` }
OctopingerSpec defines the desired state of Octopinger +k8s:openapi-gen=true
func (*OctopingerSpec) DeepCopy ¶
func (in *OctopingerSpec) DeepCopy() *OctopingerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OctopingerSpec.
func (*OctopingerSpec) DeepCopyInto ¶
func (in *OctopingerSpec) DeepCopyInto(out *OctopingerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OctopingerStatus ¶
type OctopingerStatus struct { // Phase is the octopinger running phase. Phase OctopingerPhase `json:"phase"` // ControlPaused indicates the operator pauses the control of // Octopinger. ControlPaused bool `json:"controlPaused,omitempty"` }
OctopingerStatus defines the observed state of Octopinger +k8s:openapi-gen=true
func (*OctopingerStatus) Control ¶ added in v0.0.3
func (cs *OctopingerStatus) Control()
Control ...
func (*OctopingerStatus) DeepCopy ¶
func (in *OctopingerStatus) DeepCopy() *OctopingerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OctopingerStatus.
func (*OctopingerStatus) DeepCopyInto ¶
func (in *OctopingerStatus) DeepCopyInto(out *OctopingerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OctopingerStatus) IsFailed ¶ added in v0.0.3
func (cs *OctopingerStatus) IsFailed() bool
IsFailed ...
func (*OctopingerStatus) PauseControl ¶ added in v0.0.3
func (cs *OctopingerStatus) PauseControl()
PauseControl ...
func (*OctopingerStatus) SetPhase ¶ added in v0.0.3
func (cs *OctopingerStatus) SetPhase(p OctopingerPhase)
SetPhase ...
type Template ¶ added in v0.1.0
type Template struct { // Image is the Docker image to run for octopinger. Image string `json:"image"` // Tolerations ... Tolerations []corev1.Toleration `json:"tolerations,omitempty"` }
Template ...
func (*Template) DeepCopy ¶ added in v0.1.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Template.
func (*Template) DeepCopyInto ¶ added in v0.1.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.