Documentation ¶
Overview ¶
Package v1 contains API Schema definitions for the canaries v1 API group +kubebuilder:object:generate=true +groupName=canaries.flanksource.com
Index ¶
- Variables
- func GetEnvVarRefValue(kc kubernetes.Interface, ns string, from *VarSource, obj runtime.Object) (string, error)
- type AWSConnection
- type Authentication
- type Bucket
- type Canary
- func (in *Canary) DeepCopy() *Canary
- func (in *Canary) DeepCopyInto(out *Canary)
- func (in *Canary) DeepCopyObject() runtime.Object
- func (c Canary) GetAllLabels(extra map[string]string) map[string]string
- func (c Canary) GetDescription(check external.Check) string
- func (c Canary) GetKey(check external.Check) string
- func (c Canary) ID() string
- type CanaryList
- type CanarySpec
- type CanaryStatus
- type CanaryStatusCondition
- type Check
- type CheckStatus
- type Condition
- type ConditionStatus
- type ContainerdPullCheck
- type ContainerdPushCheck
- type DNS
- type DNSCheck
- type Description
- type Display
- type DisplayTemplate
- type DockerPull
- type DockerPullCheck
- type DockerPush
- type DockerPushCheck
- type Duration
- type EC2Check
- type FolderFilter
- type FolderFilterContext
- type FolderTest
- type HTTP
- type HTTPCheck
- type Helm
- type HelmCheck
- type ICMP
- type ICMPCheck
- type JSONCheck
- type Jmeter
- type JmeterCheck
- type Junit
- type JunitCheck
- type LDAP
- type LDAPCheck
- type MongoDBCheck
- type MongoDBCrendentials
- type MsSQL
- type MssqlCheck
- type Namespace
- type NamespaceCheck
- type Pod
- type PodCheck
- type Postgres
- type PostgresCheck
- type PrometheusCheck
- type Redis
- type RedisCheck
- type Restic
- type ResticCheck
- type S3
- type S3Bucket
- type S3BucketCheck
- type S3Check
- type SQLCheck
- func (in *SQLCheck) DeepCopy() *SQLCheck
- func (in *SQLCheck) DeepCopyInto(out *SQLCheck)
- func (c *SQLCheck) GetConnection() string
- func (c SQLCheck) GetDisplayTemplate() string
- func (c SQLCheck) GetDriver() string
- func (c SQLCheck) GetEndpoint() string
- func (c *SQLCheck) GetQuery() string
- func (c SQLCheck) GetType() string
- func (c *SQLCheck) SetDriver(driver string)
- type Size
- type Smb
- type SmbCheck
- type SrvReply
- type TCP
- type TCPCheck
- type Templatable
- type Template
- type Test
- type TestFunction
- type VarSource
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "canaries.flanksource.com", Version: "v1"} // 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 )
var AllChecks = []external.Check{ HTTPCheck{}, TCPCheck{}, ICMPCheck{}, S3Check{}, S3BucketCheck{}, DockerPullCheck{}, DockerPushCheck{}, ContainerdPullCheck{}, ContainerdPushCheck{}, PostgresCheck{}, MssqlCheck{}, RedisCheck{}, PodCheck{}, LDAPCheck{}, ResticCheck{}, NamespaceCheck{}, DNSCheck{}, HelmCheck{}, JmeterCheck{}, JunitCheck{}, SmbCheck{}, EC2Check{}, PrometheusCheck{}, MongoDBCheck{}, }
Functions ¶
func GetEnvVarRefValue ¶
func GetEnvVarRefValue(kc kubernetes.Interface, ns string, from *VarSource, obj runtime.Object) (string, error)
GetEnvVarRefValue returns the value referenced by the supplied EnvVarSource given the other supplied information.
Types ¶
type AWSConnection ¶ added in v0.38.4
type AWSConnection struct { AccessKey kommons.EnvVar `yaml:"accessKey" json:"accessKey"` SecretKey kommons.EnvVar `yaml:"secretKey" json:"secretKey"` Region string `yaml:"region" json:"region"` Endpoint string `yaml:"endpoint" json:"endpoint,omitempty"` // Skip TLS verify when connecting to aws SkipTLSVerify bool `yaml:"skipTLSVerify" json:"skipTLSVerify,omitempty"` }
func (*AWSConnection) DeepCopy ¶ added in v0.38.4
func (in *AWSConnection) DeepCopy() *AWSConnection
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AWSConnection.
func (*AWSConnection) DeepCopyInto ¶ added in v0.38.4
func (in *AWSConnection) DeepCopyInto(out *AWSConnection)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Authentication ¶ added in v0.17.0
type Authentication struct { Username kommons.EnvVar `yaml:"username" json:"username"` Password kommons.EnvVar `yaml:"password" json:"password"` }
func (*Authentication) DeepCopy ¶ added in v0.17.0
func (in *Authentication) DeepCopy() *Authentication
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Authentication.
func (*Authentication) DeepCopyInto ¶ added in v0.17.0
func (in *Authentication) DeepCopyInto(out *Authentication)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Authentication) GetDomain ¶ added in v0.38.4
func (auth Authentication) GetDomain() string
func (Authentication) GetPassword ¶ added in v0.38.4
func (auth Authentication) GetPassword() string
func (Authentication) GetUsername ¶ added in v0.38.4
func (auth Authentication) GetUsername() string
type Bucket ¶
type Bucket struct { Name string `yaml:"name" json:"name,omitempty"` Region string `yaml:"region" json:"region,omitempty"` Endpoint string `yaml:"endpoint" json:"endpoint,omitempty"` }
func (*Bucket) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Bucket.
func (*Bucket) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Canary ¶
type Canary struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec CanarySpec `json:"spec,omitempty"` Status CanaryStatus `json:"status,omitempty"` }
Canary is the Schema for the canaries API +kubebuilder:printcolumn:name="Interval",type=string,JSONPath=`.spec.interval` +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.status` +kubebuilder:printcolumn:name="Last Check",type=date,JSONPath=`.status.lastCheck` +kubebuilder:printcolumn:name="Uptime 1H",type=string,JSONPath=`.status.uptime1h` +kubebuilder:printcolumn:name="Latency 1H",type=string,JSONPath=`.status.latency1h` +kubebuilder:printcolumn:name="Last Transitioned",type=date,JSONPath=`.status.lastTransitionedTime` +kubebuilder:printcolumn:name="Message",type=string,priority=1,JSONPath=`.status.message` +kubebuilder:printcolumn:name="Error",type=string,priority=1,JSONPath=`.status.errorMessage` +kubebuilder:subresource:status
func (*Canary) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Canary.
func (*Canary) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Canary) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Canary) GetAllLabels ¶ added in v0.36.0
func (Canary) GetDescription ¶ added in v0.11.4
type CanaryList ¶
type CanaryList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Canary `json:"items"` }
CanaryList contains a list of Canary
func (*CanaryList) DeepCopy ¶
func (in *CanaryList) DeepCopy() *CanaryList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CanaryList.
func (*CanaryList) DeepCopyInto ¶
func (in *CanaryList) DeepCopyInto(out *CanaryList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CanaryList) DeepCopyObject ¶
func (in *CanaryList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CanarySpec ¶
type CanarySpec struct { Env map[string]VarSource `yaml:"env,omitempty" json:"env,omitempty"` HTTP []HTTPCheck `yaml:"http,omitempty" json:"http,omitempty"` DNS []DNSCheck `yaml:"dns,omitempty" json:"dns,omitempty"` DockerPull []DockerPullCheck `yaml:"docker,omitempty" json:"docker,omitempty"` DockerPush []DockerPushCheck `yaml:"dockerPush,omitempty" json:"dockerPush,omitempty"` ContainerdPull []ContainerdPullCheck `yaml:"containerd,omitempty" json:"containerd,omitempty"` ContainerdPush []ContainerdPushCheck `yaml:"containerdPush,omitempty" json:"containerdPush,omitempty"` S3 []S3Check `yaml:"s3,omitempty" json:"s3,omitempty"` S3Bucket []S3BucketCheck `yaml:"s3Bucket,omitempty" json:"s3Bucket,omitempty"` TCP []TCPCheck `yaml:"tcp,omitempty" json:"tcp,omitempty"` Pod []PodCheck `yaml:"pod,omitempty" json:"pod,omitempty"` LDAP []LDAPCheck `yaml:"ldap,omitempty" json:"ldap,omitempty"` ICMP []ICMPCheck `yaml:"icmp,omitempty" json:"icmp,omitempty"` Postgres []PostgresCheck `yaml:"postgres,omitempty" json:"postgres,omitempty"` Mssql []MssqlCheck `yaml:"mssql,omitempty" json:"mssql,omitempty"` Restic []ResticCheck `yaml:"restic,omitempty" json:"restic,omitempty"` Jmeter []JmeterCheck `yaml:"jmeter,omitempty" json:"jmeter,omitempty"` Junit []JunitCheck `yaml:"junit,omitempty" json:"junit,omitempty"` Smb []SmbCheck `yaml:"smb,omitempty" json:"smb,omitempty"` Helm []HelmCheck `yaml:"helm,omitempty" json:"helm,omitempty"` Namespace []NamespaceCheck `yaml:"namespace,omitempty" json:"namespace,omitempty"` Redis []RedisCheck `yaml:"redis,omitempty" json:"redis,omitempty"` EC2 []EC2Check `yaml:"ec2,omitempty" json:"ec2,omitempty"` Prometheus []PrometheusCheck `yaml:"prometheus,omitempty" json:"prometheus,omitempty"` MongoDB []MongoDBCheck `yaml:"mongodb,omitempty" json:"mongodb,omitempty"` // interval (in seconds) to run checks on // Deprecated in favor of Schedule Interval uint64 `yaml:"interval,omitempty" json:"interval,omitempty"` // Schedule to run checks on. Supports all cron expression, example: '30 3-6,20-23 * * *'. For more info about cron expression syntax see https://en.wikipedia.org/wiki/Cron // Also supports golang duration, can be set as '@every 1m30s' which runs the check every 1 minute and 30 seconds. Schedule string `yaml:"schedule,omitempty" json:"schedule,omitempty"` Icon string `yaml:"icon,omitempty" json:"icon,omitempty"` Severity string `yaml:"severity,omitempty" json:"severity,omitempty"` Owner string `yaml:"owner,omitempty" json:"owner,omitempty"` }
CanarySpec defines the desired state of Canary
func (*CanarySpec) DeepCopy ¶
func (in *CanarySpec) DeepCopy() *CanarySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CanarySpec.
func (*CanarySpec) DeepCopyInto ¶
func (in *CanarySpec) DeepCopyInto(out *CanarySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (CanarySpec) GetAllChecks ¶ added in v0.11.4
func (spec CanarySpec) GetAllChecks() []external.Check
func (CanarySpec) SetSQLDrivers ¶ added in v0.22.1
func (spec CanarySpec) SetSQLDrivers()
type CanaryStatus ¶
type CanaryStatus struct { // +optional LastTransitionedTime *metav1.Time `json:"lastTransitionedTime,omitempty"` // +optional LastCheck *metav1.Time `json:"lastCheck,omitempty"` // +optional Message *string `json:"message,omitempty"` // +optional ErrorMessage *string `json:"errorMessage,omitempty"` // +optional Status *CanaryStatusCondition `json:"status,omitempty"` // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,3,opt,name=observedGeneration"` // +optional ChecksStatus map[string]*CheckStatus `json:"checkStatus,omitempty"` // Availibility over a rolling 1h period Uptime1H string `json:"uptime1h,omitempty"` // Average latency to complete all checks Latency1H string `json:"latency1h,omitempty"` }
CanaryStatus defines the observed state of Canary
func (*CanaryStatus) DeepCopy ¶
func (in *CanaryStatus) DeepCopy() *CanaryStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CanaryStatus.
func (*CanaryStatus) DeepCopyInto ¶
func (in *CanaryStatus) DeepCopyInto(out *CanaryStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CanaryStatusCondition ¶
type CanaryStatusCondition string
var ( Passed CanaryStatusCondition = "Passed" Failed CanaryStatusCondition = "Failed" Invalid CanaryStatusCondition = "Invalid" )
type Check ¶ added in v0.38.11
type Check struct {
Type, Endpoint, Description, Icon string
}
func (*Check) DeepCopy ¶ added in v0.38.12
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Check.
func (*Check) DeepCopyInto ¶ added in v0.38.12
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Check) GetDescription ¶ added in v0.38.11
func (Check) GetEndpoint ¶ added in v0.38.11
type CheckStatus ¶ added in v0.38.11
type CheckStatus struct { // +optional LastTransitionedTime *metav1.Time `json:"lastTransitionedTime,omitempty"` // +optionals LastCheck *metav1.Time `json:"lastCheck,omitempty"` // +optional Message *string `json:"message,omitempty"` // +optional ErrorMessage *string `json:"errorMessage,omitempty"` // Availibility over a rolling 1h period Uptime1H string `json:"uptime1h,omitempty"` // Average latency to complete all checks Latency1H string `json:"latency1h,omitempty"` }
func (*CheckStatus) DeepCopy ¶ added in v0.38.11
func (in *CheckStatus) DeepCopy() *CheckStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheckStatus.
func (*CheckStatus) DeepCopyInto ¶ added in v0.38.11
func (in *CheckStatus) DeepCopyInto(out *CheckStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Condition ¶
type Condition struct { // Type of condition in CamelCase or in foo.example.com/CamelCase. // Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be // useful (see .node.status.conditions), the ability to deconflict is important. // +required Type string `json:"type" protobuf:"bytes,1,opt,name=type"` // Status of the condition, one of True, False, Unknown. // +required Status ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status"` // If set, this represents the .metadata.generation that the condition was set based upon. // For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date // with respect to the current state of the instance. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,3,opt,name=observedGeneration"` // Last time the condition transitioned from one status to another. // This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. // +required LastTransitionTime metav1.Time `json:"lastTransitionTime" protobuf:"bytes,4,opt,name=lastTransitionTime"` // The reason for the condition's last transition in CamelCase. // The specific API may choose whether or not this field is considered a guaranteed API. // This field may not be empty. // +required Reason string `json:"reason" protobuf:"bytes,5,opt,name=reason"` // A human readable message indicating details about the transition. // This field may be empty. // +required Message string `json:"message" protobuf:"bytes,6,opt,name=message"` }
func (*Condition) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Condition.
func (*Condition) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConditionStatus ¶
type ConditionStatus string
const ( ConditionStatusTrue ConditionStatus = "True" ConditionStatusFalse ConditionStatus = "False" ConditionStatusUnknown ConditionStatus = "Unknown" )
type ContainerdPullCheck ¶ added in v0.12.0
type ContainerdPullCheck struct { Description `yaml:",inline" json:",inline"` Image string `yaml:"image" json:"image,omitempty"` Auth Authentication `yaml:"auth,omitempty" json:"auth,omitempty"` ExpectedDigest string `yaml:"expectedDigest" json:"expectedDigest,omitempty"` ExpectedSize int64 `yaml:"expectedSize" json:"expectedSize,omitempty"` }
func (*ContainerdPullCheck) DeepCopy ¶ added in v0.15.1
func (in *ContainerdPullCheck) DeepCopy() *ContainerdPullCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ContainerdPullCheck.
func (*ContainerdPullCheck) DeepCopyInto ¶ added in v0.15.1
func (in *ContainerdPullCheck) DeepCopyInto(out *ContainerdPullCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ContainerdPullCheck) GetEndpoint ¶ added in v0.12.0
func (c ContainerdPullCheck) GetEndpoint() string
func (ContainerdPullCheck) GetType ¶ added in v0.12.0
func (c ContainerdPullCheck) GetType() string
type ContainerdPushCheck ¶ added in v0.12.0
type ContainerdPushCheck struct { Description `yaml:",inline" json:",inline"` Image string `yaml:"image" json:"image,omitempty"` Username string `yaml:"username" json:"username,omitempty"` Password string `yaml:"password" json:"password,omitempty"` }
func (*ContainerdPushCheck) DeepCopy ¶ added in v0.15.1
func (in *ContainerdPushCheck) DeepCopy() *ContainerdPushCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ContainerdPushCheck.
func (*ContainerdPushCheck) DeepCopyInto ¶ added in v0.15.1
func (in *ContainerdPushCheck) DeepCopyInto(out *ContainerdPushCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ContainerdPushCheck) GetEndpoint ¶ added in v0.12.0
func (c ContainerdPushCheck) GetEndpoint() string
func (ContainerdPushCheck) GetType ¶ added in v0.12.0
func (c ContainerdPushCheck) GetType() string
type DNS ¶
type DNS struct {
DNSCheck `yaml:",inline" json:"inline"`
}
```yaml dns:
- server: 8.8.8.8 port: 53 query: "flanksource.com" querytype: "A" minrecords: 1 exactreply: ["34.65.228.161"] timeout: 10
```
func (*DNS) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNS.
func (*DNS) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DNSCheck ¶
type DNSCheck struct { Description `yaml:",inline" json:",inline"` Server string `yaml:"server" json:"server,omitempty"` Port int `yaml:"port" json:"port,omitempty"` Query string `yaml:"query,omitempty" json:"query,omitempty"` QueryType string `yaml:"querytype" json:"querytype,omitempty"` MinRecords int `yaml:"minrecords,omitempty" json:"minrecords,omitempty"` ExactReply []string `yaml:"exactreply,omitempty" json:"exactreply,omitempty"` Timeout int `yaml:"timeout" json:"timeout,omitempty"` ThresholdMillis int `yaml:"thresholdMillis" json:"thresholdMillis,omitempty"` }
func (*DNSCheck) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DNSCheck.
func (*DNSCheck) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DNSCheck) GetEndpoint ¶
type Description ¶ added in v0.30.0
type Description struct { // Description for the check Description string `yaml:"description,omitempty" json:"description,omitempty"` // Name of the check Name string `yaml:"name,omitempty" json:"name,omitempty"` // Icon for overwriting default icon on the dashboard Icon string `yaml:"icon,omitempty" json:"icon,omitempty"` }
func (*Description) DeepCopy ¶ added in v0.30.0
func (in *Description) DeepCopy() *Description
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Description.
func (*Description) DeepCopyInto ¶ added in v0.30.0
func (in *Description) DeepCopyInto(out *Description)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Description) GetDescription ¶ added in v0.30.0
func (d Description) GetDescription() string
func (Description) GetIcon ¶ added in v0.33.1
func (d Description) GetIcon() string
type Display ¶ added in v0.38.4
type Display struct {
Template `yaml:",inline" json:",inline"`
}
func (*Display) DeepCopy ¶ added in v0.38.4
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Display.
func (*Display) DeepCopyInto ¶ added in v0.38.4
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Display) GetDisplayTemplate ¶ added in v0.38.4
type DisplayTemplate ¶ added in v0.38.4
type DisplayTemplate interface {
GetDisplayTemplate() Template
}
+k8s:deepcopy-gen=false
type DockerPull ¶
type DockerPull struct {
DockerPullCheck `yaml:",inline" json:"inline"`
}
DockerPull check will try to pull a Docker image from specified registry, verify it's checksum and size.
```yaml
docker:
- image: docker.io/library/busybox:1.31.1 auth: username: value: some-user password: value: some-password expectedDigest: 6915be4043561d64e0ab0f8f098dc2ac48e077fe23f488ac24b665166898115a expectedSize: 1219782
```
func (*DockerPull) DeepCopy ¶
func (in *DockerPull) DeepCopy() *DockerPull
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DockerPull.
func (*DockerPull) DeepCopyInto ¶
func (in *DockerPull) DeepCopyInto(out *DockerPull)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DockerPullCheck ¶
type DockerPullCheck struct { Description `yaml:",inline" json:",inline"` Image string `yaml:"image" json:"image,omitempty"` Auth *Authentication `yaml:"auth,omitempty" json:"auth,omitempty"` ExpectedDigest string `yaml:"expectedDigest" json:"expectedDigest,omitempty"` ExpectedSize int64 `yaml:"expectedSize" json:"expectedSize,omitempty"` }
func (*DockerPullCheck) DeepCopy ¶
func (in *DockerPullCheck) DeepCopy() *DockerPullCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DockerPullCheck.
func (*DockerPullCheck) DeepCopyInto ¶
func (in *DockerPullCheck) DeepCopyInto(out *DockerPullCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DockerPullCheck) GetEndpoint ¶
func (c DockerPullCheck) GetEndpoint() string
func (DockerPullCheck) GetType ¶
func (c DockerPullCheck) GetType() string
type DockerPush ¶
type DockerPush struct {
DockerPushCheck `yaml:",inline" json:"inline"`
}
DockerPush check will try to push a Docker image to specified registry.
```yaml
dockerPush:
- image: ttl.sh/flanksource-busybox:1.30 auth: username: value: $DOCKER_USERNAME password: value: $DOCKER_PASSWORD
```
func (*DockerPush) DeepCopy ¶
func (in *DockerPush) DeepCopy() *DockerPush
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DockerPush.
func (*DockerPush) DeepCopyInto ¶
func (in *DockerPush) DeepCopyInto(out *DockerPush)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DockerPushCheck ¶
type DockerPushCheck struct { Description `yaml:",inline" json:",inline"` Image string `yaml:"image" json:"image,omitempty"` Auth *Authentication `yaml:"auth" json:"auth"` }
func (*DockerPushCheck) DeepCopy ¶
func (in *DockerPushCheck) DeepCopy() *DockerPushCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DockerPushCheck.
func (*DockerPushCheck) DeepCopyInto ¶
func (in *DockerPushCheck) DeepCopyInto(out *DockerPushCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (DockerPushCheck) GetEndpoint ¶
func (c DockerPushCheck) GetEndpoint() string
func (DockerPushCheck) GetType ¶
func (c DockerPushCheck) GetType() string
type EC2Check ¶ added in v0.33.0
type EC2Check struct { Description `yaml:",inline" json:",inline"` AWSConnection `yaml:",inline" json:",inline"` AMI string `yaml:"ami,omitempty" json:"ami,omitempty"` UserData string `yaml:"userData,omitempty" json:"userData,omitempty"` SecurityGroup string `yaml:"securityGroup,omitempty" json:"securityGroup,omitempty"` KeepAlive bool `yaml:"keepAlive,omitempty" json:"keepAlive,omitempty"` WaitTime int `yaml:"waitTime,omitempty" json:"waitTime,omitempty"` TimeOut int `yaml:"timeOut,omitempty" json:"timeOut,omitempty"` CanaryRef []v1.LocalObjectReference `yaml:"canaryRef,omitempty" json:"canaryRef,omitempty"` }
func (*EC2Check) DeepCopy ¶ added in v0.33.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EC2Check.
func (*EC2Check) DeepCopyInto ¶ added in v0.33.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (EC2Check) GetEndpoint ¶ added in v0.33.0
type FolderFilter ¶ added in v0.38.16
type FolderFilter struct { MinAge Duration `json:"minAge,omitempty"` MaxAge Duration `json:"maxAge,omitempty"` MinSize Size `json:"minSize,omitempty"` MaxSize Size `json:"maxSize,omitempty"` Regex string `json:"regex,omitempty"` }
func (*FolderFilter) DeepCopy ¶ added in v0.38.16
func (in *FolderFilter) DeepCopy() *FolderFilter
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FolderFilter.
func (*FolderFilter) DeepCopyInto ¶ added in v0.38.16
func (in *FolderFilter) DeepCopyInto(out *FolderFilter)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (FolderFilter) New ¶ added in v0.38.16
func (f FolderFilter) New() (*FolderFilterContext, error)
type FolderFilterContext ¶ added in v0.38.16
type FolderFilterContext struct { FolderFilter // contains filtered or unexported fields }
+k8s:deepcopy-gen=false
type FolderTest ¶ added in v0.38.4
type FolderTest struct { //MinAge the latest object should be older than defined age MinAge Duration `yaml:"minAge,omitempty" json:"minAge,omitempty"` //MaxAge the latest object should be younger than defined age MaxAge Duration `yaml:"maxAge,omitempty" json:"maxAge,omitempty"` //MinCount the minimum number of files inside the searchPath MinCount *int `yaml:"minCount,omitempty" json:"minCount,omitempty"` //MinCount the minimum number of files inside the searchPath MaxCount *int `yaml:"maxCount,omitempty" json:"maxCount,omitempty"` //MinSize of the files inside the searchPath MinSize Size `yaml:"minSize,omitempty" json:"minSize,omitempty"` //MaxSize of the files inside the searchPath MaxSize Size `yaml:"maxSize,omitempty" json:"maxSize,omitempty"` }
func (*FolderTest) DeepCopy ¶ added in v0.38.4
func (in *FolderTest) DeepCopy() *FolderTest
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FolderTest.
func (*FolderTest) DeepCopyInto ¶ added in v0.38.4
func (in *FolderTest) DeepCopyInto(out *FolderTest)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTP ¶
type HTTP struct {
HTTPCheck `yaml:",inline" json:"inline"`
}
```yaml http:
- endpoints:
- https://httpstat.us/200
- https://httpstat.us/301 thresholdMillis: 3000 responseCodes: [201,200,301] responseContent: "" maxSSLExpiry: 60
- endpoints:
- https://httpstat.us/500 thresholdMillis: 3000 responseCodes: [500] responseContent: "" maxSSLExpiry: 60
- endpoints:
- https://httpstat.us/500 thresholdMillis: 3000 responseCodes: [302] responseContent: "" maxSSLExpiry: 60
```
func (*HTTP) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTP.
func (*HTTP) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPCheck ¶
type HTTPCheck struct { Description `yaml:",inline" json:",inline"` Templatable `yaml:",inline" json:",inline"` // HTTP endpoint to check. Mutually exclusive with Namespace Endpoint string `yaml:"endpoint" json:"endpoint,omitempty"` // Namespace to crawl for TLS endpoints. Mutually exclusive with Endpoint Namespace string `yaml:"namespace" json:"namespace,omitempty"` // Maximum duration in milliseconds for the HTTP request. It will fail the check if it takes longer. ThresholdMillis int `yaml:"thresholdMillis" json:"thresholdMillis,omitempty"` // Expected response codes for the HTTP Request. ResponseCodes []int `yaml:"responseCodes" json:"responseCodes,omitempty"` // Exact response content expected to be returned by the endpoint. ResponseContent string `yaml:"responseContent" json:"responseContent,omitempty"` // Path and value to of expect JSON response by the endpoint ResponseJSONContent JSONCheck `yaml:"responseJSONContent,omitempty" json:"responseJSONContent,omitempty"` // Maximum number of days until the SSL Certificate expires. MaxSSLExpiry int `yaml:"maxSSLExpiry" json:"maxSSLExpiry,omitempty"` // HTTP method to call - defaults to GET Method string `yaml:"method,omitempty" json:"method,omitempty"` //NTLM when set to true will do authentication using NTLM v1 protocol NTLM bool `yaml:"ntlm,omitempty" json:"ntlm,omitempty"` //NTLM when set to true will do authentication using NTLM v2 protocol NTLMv2 bool `yaml:"ntlmv2,omitempty" json:"ntlmv2,omitempty"` // HTTP request body contents Body string `yaml:"body,omitempty" json:"body,omitempty"` // HTTP Header fields to be used in the query Headers []kommons.EnvVar `yaml:"headers,omitempty" json:"headers,omitempty"` // Credentials for authentication headers: Authentication *Authentication `yaml:"authentication,omitempty" json:"authentication,omitempty"` }
func (*HTTPCheck) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPCheck.
func (*HTTPCheck) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (HTTPCheck) GetEndpoint ¶
type Helm ¶
type Helm struct {
HelmCheck `yaml:",inline" json:"inline"`
}
func (*Helm) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Helm.
func (*Helm) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmCheck ¶
type HelmCheck struct { Description `yaml:",inline" json:",inline"` Chartmuseum string `yaml:"chartmuseum" json:"chartmuseum,omitempty"` Project string `yaml:"project,omitempty" json:"project,omitempty"` Auth *Authentication `yaml:"auth,omitempty" json:"auth,omitempty"` CaFile *string `yaml:"cafile,omitempty" json:"cafile,omitempty"` }
func (*HelmCheck) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmCheck.
func (*HelmCheck) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (HelmCheck) GetEndpoint ¶
type ICMP ¶
type ICMP struct {
ICMPCheck `yaml:",inline" json:"inline"`
}
This test will check ICMP packet loss and duration.
```yaml
icmp:
- endpoints:
- https://google.com
- https://yahoo.com thresholdMillis: 400 packetLossThreshold: 0.5 packetCount: 2
```
func (*ICMP) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ICMP.
func (*ICMP) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ICMPCheck ¶
type ICMPCheck struct { Description `yaml:",inline" json:",inline"` Endpoint string `yaml:"endpoint" json:"endpoint,omitempty"` ThresholdMillis int64 `yaml:"thresholdMillis" json:"thresholdMillis,omitempty"` PacketLossThreshold int64 `yaml:"packetLossThreshold" json:"packetLossThreshold,omitempty"` PacketCount int `yaml:"packetCount" json:"packetCount,omitempty"` }
func (*ICMPCheck) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ICMPCheck.
func (*ICMPCheck) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ICMPCheck) GetEndpoint ¶
type JSONCheck ¶ added in v0.17.0
type JSONCheck struct { Path string `yaml:"path" json:"path"` Value string `yaml:"value" json:"value"` }
func (*JSONCheck) DeepCopy ¶ added in v0.17.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JSONCheck.
func (*JSONCheck) DeepCopyInto ¶ added in v0.17.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Jmeter ¶ added in v0.19.1
type Jmeter struct {
JmeterCheck `yaml:",inline" json:",inline"`
}
Jmeter check will run jmeter cli against the supplied host ```yaml jmeter:
- jmx: name: jmx-test-plan valueFrom: configMapKeyRef: key: jmeter-test.xml name: jmeter host: "some-host" port: 8080 properties:
- remote_hosts=127.0.0.1 systemProperties:
- user.dir=/home/mstover/jmeter_stuff description: The Jmeter test
```
func (*Jmeter) DeepCopy ¶ added in v0.19.1
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Jmeter.
func (*Jmeter) DeepCopyInto ¶ added in v0.19.1
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JmeterCheck ¶ added in v0.19.1
type JmeterCheck struct { // Jmx defines tge ConfigMap or Secret reference to get the JMX test plan Jmx kommons.EnvVar `yaml:"jmx" json:"jmx"` // Host is the server against which test plan needs to be executed Host string `yaml:"host,omitempty" json:"host,omitempty"` // Port on which the server is running Port int32 `yaml:"port,omitempty" json:"port,omitempty"` // Properties defines the local Jmeter properties Properties []string `yaml:"properties,omitempty" json:"properties,omitempty"` // SystemProperties defines the java system property SystemProperties []string `yaml:"systemProperties,omitempty" json:"systemProperties,omitempty"` Description `yaml:",inline" json:",inline"` // ResponseDuration under which the all the test should pass ResponseDuration string `yaml:"responseDuration,omitempty" json:"responseDuration,omitempty"` }
func (*JmeterCheck) DeepCopy ¶ added in v0.19.1
func (in *JmeterCheck) DeepCopy() *JmeterCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JmeterCheck.
func (*JmeterCheck) DeepCopyInto ¶ added in v0.19.1
func (in *JmeterCheck) DeepCopyInto(out *JmeterCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (JmeterCheck) GetEndpoint ¶ added in v0.19.1
func (c JmeterCheck) GetEndpoint() string
func (JmeterCheck) GetType ¶ added in v0.19.1
func (c JmeterCheck) GetType() string
type Junit ¶ added in v0.21.0
type Junit struct {
JunitCheck `yaml:",inline" json:",inline"`
}
Junit check will wait for the given pod to be completed than parses all the xml files present in the defined testResults directory ```yaml junit:
- testResults: "/tmp/junit-results/" description: "junit demo test" spec: containers:
- name: jes image: docker.io/tarun18/junit-test-pass command: ["/start.sh"]
```
func (*Junit) DeepCopy ¶ added in v0.21.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Junit.
func (*Junit) DeepCopyInto ¶ added in v0.21.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JunitCheck ¶ added in v0.21.0
type JunitCheck struct { Description `yaml:",inline" json:",inline"` TestResults string `yaml:"testResults" json:"testResults"` //timeout in minutes to wait for specified container to finish its job. // Defaults to 5 minutes Timeout int `yaml:"timeout,omitempty" json:"timeout,omitempty"` Spec v1.PodSpec `yaml:"spec" json:"spec"` // DisplayTemplate displays testResults results in text // Default: 'Passed: [[.passed]], Failed: [[.failed]]' DisplayTemplate string `yaml:"displayTemplate,omitempty" json:"displayTemplate,omitempty"` }
func (*JunitCheck) DeepCopy ¶ added in v0.21.0
func (in *JunitCheck) DeepCopy() *JunitCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JunitCheck.
func (*JunitCheck) DeepCopyInto ¶ added in v0.21.0
func (in *JunitCheck) DeepCopyInto(out *JunitCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (JunitCheck) GetDisplayTemplate ¶ added in v0.21.0
func (c JunitCheck) GetDisplayTemplate() string
func (JunitCheck) GetEndpoint ¶ added in v0.21.0
func (c JunitCheck) GetEndpoint() string
func (JunitCheck) GetTimeout ¶ added in v0.30.0
func (c JunitCheck) GetTimeout() int
func (JunitCheck) GetType ¶ added in v0.21.0
func (c JunitCheck) GetType() string
type LDAP ¶
type LDAP struct {
LDAPCheck `yaml:",inline" json:"inline"`
}
The LDAP check will:
* bind using provided user/password to the ldap host. Supports ldap/ldaps protocols. * search an object type in the provided bind DN.s
```yaml
ldap:
- host: ldap://127.0.0.1:10389 auth: username: value: uid=admin,ou=system password: value: secret bindDN: ou=users,dc=example,dc=com userSearch: "(&(objectClass=organizationalPerson))"
- host: ldap://127.0.0.1:10389 auth: username: value: uid=admin,ou=system password: value: secret bindDN: ou=groups,dc=example,dc=com userSearch: "(&(objectClass=groupOfNames))"
```
func (*LDAP) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAP.
func (*LDAP) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LDAPCheck ¶
type LDAPCheck struct { Description `yaml:",inline" json:",inline"` Host string `yaml:"host" json:"host,omitempty"` Auth *Authentication `yaml:"auth" json:"auth,omitempty"` BindDN string `yaml:"bindDN" json:"bindDN,omitempty"` UserSearch string `yaml:"userSearch" json:"userSearch,omitempty"` SkipTLSVerify bool `yaml:"skipTLSVerify" json:"skipTLSVerify,omitempty"` }
func (*LDAPCheck) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAPCheck.
func (*LDAPCheck) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (LDAPCheck) GetEndpoint ¶
type MongoDBCheck ¶ added in v0.38.4
type MongoDBCheck struct { Description `yaml:",inline" json:",inline"` // Address of the mongodb server URL string `yaml:"url" json:"url"` // Port of the mongodb server. Defaults to 27017 Port int `yaml:"port,omitempty" json:"port,omitempty"` Credentials *MongoDBCrendentials `yaml:"credentials,omitempty" json:"credentials,omitempty"` }
func (*MongoDBCheck) DeepCopy ¶ added in v0.38.4
func (in *MongoDBCheck) DeepCopy() *MongoDBCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MongoDBCheck.
func (*MongoDBCheck) DeepCopyInto ¶ added in v0.38.4
func (in *MongoDBCheck) DeepCopyInto(out *MongoDBCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (MongoDBCheck) GetEndpoint ¶ added in v0.38.4
func (c MongoDBCheck) GetEndpoint() string
func (MongoDBCheck) GetPort ¶ added in v0.38.4
func (c MongoDBCheck) GetPort() int
func (MongoDBCheck) GetType ¶ added in v0.38.4
func (c MongoDBCheck) GetType() string
type MongoDBCrendentials ¶ added in v0.38.4
type MongoDBCrendentials struct { AuthMechanism string `yaml:"authMechanism,omitempty" json:"authMechanism,omitempty"` AuthMechanismProperties map[string]string `yaml:"authMechanismProperties,omitempty" json:"authMechanismProperties,omitempty"` AuthSource string `yaml:"authSource,omitempty" json:"authSource,omitempty"` *Authentication `yaml:",inline" json:",inline"` PasswordSet bool `yaml:"passswordSet,omitempty" json:"passwordSet,omitempty"` }
func (*MongoDBCrendentials) DeepCopy ¶ added in v0.38.4
func (in *MongoDBCrendentials) DeepCopy() *MongoDBCrendentials
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MongoDBCrendentials.
func (*MongoDBCrendentials) DeepCopyInto ¶ added in v0.38.4
func (in *MongoDBCrendentials) DeepCopyInto(out *MongoDBCrendentials)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MsSQL ¶ added in v0.19.2
type MsSQL struct {
MssqlCheck `yaml:",inline" json:"inline"`
}
This check will try to connect to a specified MsSQL database, run a query against it and verify the results.
```yaml
mssql:
- connection: 'server=localhost;user id=sa;password=Some_S3cure_p@sswd;port=1433;database=test' query: "SELECT 1" results: 1
```
func (*MsSQL) DeepCopy ¶ added in v0.19.2
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MsSQL.
func (*MsSQL) DeepCopyInto ¶ added in v0.19.2
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MssqlCheck ¶ added in v0.18.0
type MssqlCheck struct {
SQLCheck `yaml:",inline" json:",inline"`
}
func (*MssqlCheck) DeepCopy ¶ added in v0.18.0
func (in *MssqlCheck) DeepCopy() *MssqlCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MssqlCheck.
func (*MssqlCheck) DeepCopyInto ¶ added in v0.18.0
func (in *MssqlCheck) DeepCopyInto(out *MssqlCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Namespace ¶
type Namespace struct {
NamespaceCheck `yaml:",inline" json:"inline"`
}
The Namespace check will:
* create a new namespace using the labels/annotations provided
```yaml
namespace:
- namePrefix: "test-name-prefix-" labels: team: test annotations: "foo.baz.com/foo": "bar"
```
func (*Namespace) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Namespace.
func (*Namespace) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NamespaceCheck ¶
type NamespaceCheck struct { Description `yaml:",inline" json:",inline"` CheckName string `yaml:"checkName" json:"checkName,omitempty"` NamespaceNamePrefix string `yaml:"namespaceNamePrefix" json:"namespaceNamePrefix,omitempty"` NamespaceLabels map[string]string `yaml:"namespaceLabels" json:"namespaceLabels,omitempty"` NamespaceAnnotations map[string]string `yaml:"namespaceAnnotations" json:"namespaceAnnotations,omitempty"` PodSpec string `yaml:"podSpec" json:"podSpec,omitempty"` ScheduleTimeout int64 `yaml:"scheduleTimeout" json:"schedule_timeout,omitempty"` ReadyTimeout int64 `yaml:"readyTimeout" json:"readyTimeout,omitempty"` HTTPTimeout int64 `yaml:"httpTimeout" json:"httpTimeout,omitempty"` DeleteTimeout int64 `yaml:"deleteTimeout" json:"deleteTimeout,omitempty"` IngressTimeout int64 `yaml:"ingressTimeout" json:"ingressTimeout,omitempty"` HTTPRetryInterval int64 `yaml:"httpRetryInterval" json:"httpRetryInterval,omitempty"` Deadline int64 `yaml:"deadline" json:"deadline,omitempty"` Port int64 `yaml:"port" json:"port,omitempty"` Path string `yaml:"path" json:"path,omitempty"` IngressName string `yaml:"ingressName" json:"ingressName,omitempty"` IngressHost string `yaml:"ingressHost" json:"ingressHost,omitempty"` ExpectedContent string `yaml:"expectedContent" json:"expectedContent,omitempty"` ExpectedHTTPStatuses []int64 `yaml:"expectedHttpStatuses" json:"expectedHttpStatuses,omitempty"` PriorityClass string `yaml:"priorityClass" json:"priorityClass,omitempty"` }
func (*NamespaceCheck) DeepCopy ¶
func (in *NamespaceCheck) DeepCopy() *NamespaceCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamespaceCheck.
func (*NamespaceCheck) DeepCopyInto ¶
func (in *NamespaceCheck) DeepCopyInto(out *NamespaceCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (NamespaceCheck) GetEndpoint ¶
func (c NamespaceCheck) GetEndpoint() string
func (NamespaceCheck) GetType ¶
func (c NamespaceCheck) GetType() string
func (NamespaceCheck) String ¶
func (c NamespaceCheck) String() string
type Pod ¶
type Pod struct {
PodCheck `yaml:",inline" json:"inline"`
}
```yaml pod:
- name: golang namespace: default spec: | apiVersion: v1 kind: Pod metadata: name: hello-world-golang namespace: default labels: app: hello-world-golang spec: containers:
- name: hello image: quay.io/toni0/hello-webserver-golang:latest port: 8080 path: /foo/bar ingressName: hello-world-golang ingressHost: "hello-world-golang.127.0.0.1.nip.io" scheduleTimeout: 2000 readyTimeout: 5000 httpTimeout: 2000 deleteTimeout: 12000 ingressTimeout: 5000 deadline: 29000 httpRetryInterval: 200 expectedContent: bar expectedHttpStatuses: [200, 201, 202]
```
func (*Pod) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Pod.
func (*Pod) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PodCheck ¶
type PodCheck struct { Description `yaml:",inline" json:",inline"` Namespace string `yaml:"namespace" json:"namespace,omitempty"` Spec string `yaml:"spec" json:"spec,omitempty"` ScheduleTimeout int64 `yaml:"scheduleTimeout" json:"scheduleTimeout,omitempty"` ReadyTimeout int64 `yaml:"readyTimeout" json:"readyTimeout,omitempty"` HTTPTimeout int64 `yaml:"httpTimeout" json:"httpTimeout,omitempty"` DeleteTimeout int64 `yaml:"deleteTimeout" json:"deleteTimeout,omitempty"` IngressTimeout int64 `yaml:"ingressTimeout" json:"ingressTimeout,omitempty"` HTTPRetryInterval int64 `yaml:"httpRetryInterval" json:"httpRetryInterval,omitempty"` Deadline int64 `yaml:"deadline" json:"deadline,omitempty"` Port int64 `yaml:"port" json:"port,omitempty"` Path string `yaml:"path" json:"path,omitempty"` IngressName string `yaml:"ingressName" json:"ingressName,omitempty"` IngressHost string `yaml:"ingressHost" json:"ingressHost,omitempty"` ExpectedContent string `yaml:"expectedContent" json:"expectedContent,omitempty"` ExpectedHTTPStatuses []int `yaml:"expectedHttpStatuses" json:"expectedHttpStatuses,omitempty"` PriorityClass string `yaml:"priorityClass" json:"priorityClass,omitempty"` }
func (*PodCheck) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodCheck.
func (*PodCheck) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PodCheck) GetEndpoint ¶
type Postgres ¶
type Postgres struct {
PostgresCheck `yaml:",inline" json:"inline"`
}
This check will try to connect to a specified Postgresql database, run a query against it and verify the results.
```yaml
postgres:
- connection: "user=postgres password=mysecretpassword host=192.168.0.103 port=15432 dbname=postgres sslmode=disable" query: "SELECT 1" results: 1
```
func (*Postgres) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Postgres.
func (*Postgres) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PostgresCheck ¶
type PostgresCheck struct {
SQLCheck `yaml:",inline" json:",inline"`
}
func (*PostgresCheck) DeepCopy ¶
func (in *PostgresCheck) DeepCopy() *PostgresCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PostgresCheck.
func (*PostgresCheck) DeepCopyInto ¶
func (in *PostgresCheck) DeepCopyInto(out *PostgresCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PrometheusCheck ¶ added in v0.35.0
type PrometheusCheck struct { Description `yaml:",inline" json:",inline"` Templatable `yaml:",inline" json:",inline"` // Address of the prometheus server Host string `yaml:"host" json:"host"` // PromQL query Query string `yaml:"query" json:"query"` }
func (*PrometheusCheck) DeepCopy ¶ added in v0.35.0
func (in *PrometheusCheck) DeepCopy() *PrometheusCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PrometheusCheck.
func (*PrometheusCheck) DeepCopyInto ¶ added in v0.35.0
func (in *PrometheusCheck) DeepCopyInto(out *PrometheusCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (PrometheusCheck) GetEndpoint ¶ added in v0.35.0
func (c PrometheusCheck) GetEndpoint() string
func (PrometheusCheck) GetType ¶ added in v0.35.0
func (c PrometheusCheck) GetType() string
type Redis ¶ added in v0.18.0
type Redis struct {
RedisCheck `yaml:",inline" json:"inline"`
}
func (*Redis) DeepCopy ¶ added in v0.18.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Redis.
func (*Redis) DeepCopyInto ¶ added in v0.18.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RedisCheck ¶ added in v0.18.0
type RedisCheck struct { Description `yaml:",inline" json:",inline"` Addr string `yaml:"addr" json:"addr"` Auth *Authentication `yaml:"auth,omitempty" json:"auth,omitempty"` DB int `yaml:"db" json:"db"` }
func (*RedisCheck) DeepCopy ¶ added in v0.18.0
func (in *RedisCheck) DeepCopy() *RedisCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RedisCheck.
func (*RedisCheck) DeepCopyInto ¶ added in v0.18.0
func (in *RedisCheck) DeepCopyInto(out *RedisCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (RedisCheck) GetEndpoint ¶ added in v0.18.0
func (c RedisCheck) GetEndpoint() string
func (RedisCheck) GetType ¶ added in v0.18.0
func (c RedisCheck) GetType() string
type Restic ¶ added in v0.19.0
type Restic struct {
ResticCheck `yaml:",inline" json:"inline"`
}
func (*Restic) DeepCopy ¶ added in v0.19.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Restic.
func (*Restic) DeepCopyInto ¶ added in v0.19.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResticCheck ¶ added in v0.19.0
type ResticCheck struct { Description `yaml:",inline" json:",inline"` // Repository The restic repository path eg: rest:https://user:pass@host:8000/ or rest:https://host:8000/ or s3:s3.amazonaws.com/bucket_name Repository string `yaml:"repository" json:"repository"` // Password for the restic repository Password *kommons.EnvVar `yaml:"password" json:"password"` // MaxAge for backup freshness MaxAge string `yaml:"maxAge" json:"maxAge"` // CheckIntegrity when enabled will check the Integrity and consistency of the restic reposiotry CheckIntegrity bool `yaml:"checkIntegrity,omitempty" json:"checkIntegrity,omitempty"` // AccessKey access key id for connection with aws s3, minio, wasabi, alibaba oss AccessKey *kommons.EnvVar `yaml:"accessKey,omitempty" json:"accessKey,omitempty"` // SecretKey secret access key for connection with aws s3, minio, wasabi, alibaba oss SecretKey *kommons.EnvVar `yaml:"secretKey,omitempty" json:"secretKey,omitempty"` // CaCert path to the root cert. In case of self-signed certificates CaCert string `yaml:"caCert,omitempty" json:"caCert,omitempty"` }
func (*ResticCheck) DeepCopy ¶ added in v0.19.0
func (in *ResticCheck) DeepCopy() *ResticCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResticCheck.
func (*ResticCheck) DeepCopyInto ¶ added in v0.19.0
func (in *ResticCheck) DeepCopyInto(out *ResticCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ResticCheck) GetEndpoint ¶ added in v0.19.0
func (c ResticCheck) GetEndpoint() string
func (ResticCheck) GetType ¶ added in v0.19.0
func (c ResticCheck) GetType() string
type S3 ¶
type S3 struct {
S3Check `yaml:",inline" json:"inline"`
}
S3 check will:
* list objects in the bucket to check for Read permissions * PUT an object into the bucket for Write permissions * download previous uploaded object to check for Get permissions
```yaml
s3:
- buckets:
- name: "test-bucket" region: "us-east-1" endpoint: "https://test-bucket.s3.us-east-1.amazonaws.com" secretKey: "<access-key>" accessKey: "<secret-key>" objectPath: "path/to/object"
```
func (*S3) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new S3.
func (*S3) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type S3Bucket ¶
type S3Bucket struct {
S3BucketCheck `yaml:",inline" json:"inline"`
}
This check will
- search objects matching the provided object path pattern - check that latest object is no older than provided MaxAge value in seconds - check that latest object size is not smaller than provided MinSize value in bytes.
```yaml s3Bucket:
- bucket: foo accessKey: "<access-key>" secretKey: "<secret-key>" region: "us-east-2" endpoint: "https://s3.us-east-2.amazonaws.com" objectPath: "(.*)archive.zip$" readWrite: true maxAge: 5000000 minSize: 50000
```
func (*S3Bucket) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new S3Bucket.
func (*S3Bucket) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type S3BucketCheck ¶
type S3BucketCheck struct { Description `yaml:",inline" json:",inline"` Templatable `yaml:",inline" json:",inline"` AWSConnection `yaml:",inline" json:",inline"` FolderTest `yaml:",inline" json:",inline"` Filter FolderFilter `yaml:"filter,omitempty" json:"filter,omitempty"` Bucket string `yaml:"bucket" json:"bucket"` // glob path to restrict matches to a subset ObjectPath string `yaml:"objectPath" json:"objectPath,omitempty"` // Use path style path: http://s3.amazonaws.com/BUCKET/KEY instead of http://BUCKET.s3.amazonaws.com/KEY UsePathStyle bool `yaml:"usePathStyle" json:"usePathStyle,omitempty"` }
func (*S3BucketCheck) DeepCopy ¶
func (in *S3BucketCheck) DeepCopy() *S3BucketCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new S3BucketCheck.
func (*S3BucketCheck) DeepCopyInto ¶
func (in *S3BucketCheck) DeepCopyInto(out *S3BucketCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (S3BucketCheck) GetEndpoint ¶
func (c S3BucketCheck) GetEndpoint() string
func (S3BucketCheck) GetType ¶
func (c S3BucketCheck) GetType() string
type S3Check ¶
type S3Check struct { Description `yaml:",inline" json:",inline"` Bucket Bucket `yaml:"bucket" json:"bucket,omitempty"` AccessKey string `yaml:"accessKey" json:"accessKey,omitempty"` SecretKey string `yaml:"secretKey" json:"secretKey,omitempty"` ObjectPath string `yaml:"objectPath" json:"objectPath,omitempty"` // Skip TLS verify when connecting to s3 SkipTLSVerify bool `yaml:"skipTLSVerify" json:"skipTLSVerify,omitempty"` }
func (*S3Check) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new S3Check.
func (*S3Check) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (S3Check) GetEndpoint ¶
type SQLCheck ¶ added in v0.19.2
type SQLCheck struct { Description `yaml:",inline" json:",inline"` Connection string `yaml:"connection" json:"connection,omitempty"` Query string `yaml:"query" json:"query,omitempty"` // Number rows to check for Result int `yaml:"results" json:"results,omitempty"` // ResultsFunction tests query output for pass/fail (must return boolean) // Example: '[[ if index .results 0 "surname" | eq "khandelwal" ]]true[[else]]false[[end]]' ResultsFunction string `yaml:"resultsFunction,omitempty" json:"resultsFunction,omitempty"` // DisplayTemplate displays query results in text (overrides default bar format for UI) // Example: '[[index .results 0]]' DisplayTemplate string `yaml:"displayTemplate,omitempty" json:"displayTemplate,omitempty"` // contains filtered or unexported fields }
func (*SQLCheck) DeepCopy ¶ added in v0.19.2
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SQLCheck.
func (*SQLCheck) DeepCopyInto ¶ added in v0.19.2
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SQLCheck) GetConnection ¶ added in v0.19.2
func (SQLCheck) GetDisplayTemplate ¶ added in v0.21.0
func (SQLCheck) GetEndpoint ¶ added in v0.19.2
type Smb ¶ added in v0.21.0
type Smb struct {
SmbCheck `yaml:",inline" json:",inline"`
}
Smb check will connect to the given samba server with given credentials find the age of the latest updated file and compare it with minAge count the number of file present and compare with minCount if defined ```yaml smb:
- server: 192.168.1.9 auth: username: value: samba password: value: password sharename: "Some Public Folder" minAge: 10h maxAge: 20h searchPath: a/b/c description: "Success SMB server"
```
User can define server in `\\server\e$\a\b\c` format where `server` is the host `e$` is the sharename and `a/b/c` represent the sub-dir inside mount location where the test will run to verify ```yaml smb:
- server: '\\192.168.1.5\Some Public Folder\somedir' auth: username: value: samba password: valueFrom: secretKeyRef: key: smb-password name: smb sharename: "Tarun Khandelwal’s Public Folder" minAge: 10h maxAge: 100h description: "Success SMB server"
```
func (*Smb) DeepCopy ¶ added in v0.21.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Smb.
func (*Smb) DeepCopyInto ¶ added in v0.21.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SmbCheck ¶ added in v0.21.0
type SmbCheck struct { Description `yaml:",inline" json:",inline"` Templatable `yaml:",inline" json:",inline"` Filter FolderFilter `yaml:"filter,omitempty" json:"filter,omitempty"` FolderTest `yaml:",inline" json:",inline"` //Server location of smb server. Can be hostname/ip or in '\\server\e$\a\b\c' syntax //Where server is the hostname e$ is the sharename and a/b/c is the searchPath location Server string `yaml:"server" json:"server"` //Port on which smb server is running. Defaults to 445 Port int `yaml:"port,omitempty" json:"port,omitempty"` Auth *Authentication `yaml:"auth" json:"auth"` //Domain... Domain string `yaml:"domain,omitempty" json:"domain,omitempty"` // Workstation... Workstation string `yaml:"workstation,omitempty" json:"workstation,omitempty"` Sharename string `yaml:"sharename,omitempty" json:"sharename,omitempty"` //SearchPath sub-path inside the mount location SearchPath string `yaml:"searchPath,omitempty" json:"searchPath,omitempty" ` }
func (*SmbCheck) DeepCopy ¶ added in v0.21.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SmbCheck.
func (*SmbCheck) DeepCopyInto ¶ added in v0.21.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (SmbCheck) GetEndpoint ¶ added in v0.21.0
type SrvReply ¶
type SrvReply struct { Target string `yaml:"target,omitempty"` Port int `yaml:"port,omitempty"` Priority int `yaml:"priority,omitempty"` Weight int `yaml:"wight,omitempty"` }
func (*SrvReply) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SrvReply.
func (*SrvReply) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TCP ¶
type TCP struct {
TCPCheck `yaml:",inline" json:"inline"`
}
func (*TCP) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TCP.
func (*TCP) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TCPCheck ¶
type TCPCheck struct { Description `yaml:",inline" json:",inline"` Endpoint string `yaml:"endpoint" json:"endpoint,omitempty"` ThresholdMillis int64 `yaml:"thresholdMillis" json:"thresholdMillis,omitempty"` }
func (*TCPCheck) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TCPCheck.
func (*TCPCheck) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (TCPCheck) GetEndpoint ¶ added in v0.11.4
type Templatable ¶ added in v0.38.4
type Templatable struct { Test Template `yaml:"test,omitempty" json:"test,omitempty"` Display Template `yaml:"display,omitempty" json:"display,omitempty"` }
func (*Templatable) DeepCopy ¶ added in v0.38.4
func (in *Templatable) DeepCopy() *Templatable
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Templatable.
func (*Templatable) DeepCopyInto ¶ added in v0.38.4
func (in *Templatable) DeepCopyInto(out *Templatable)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Templatable) GetDisplayTemplate ¶ added in v0.38.4
func (t Templatable) GetDisplayTemplate() Template
func (Templatable) GetTestFunction ¶ added in v0.38.4
func (t Templatable) GetTestFunction() Template
type Template ¶ added in v0.38.4
type Template struct { Template string `yaml:"template,omitempty" json:"template,omitempty"` JSONPath string `yaml:"jsonPath,omitempty" json:"jsonPath,omitempty"` }
func (*Template) DeepCopy ¶ added in v0.38.4
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Template.
func (*Template) DeepCopyInto ¶ added in v0.38.4
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Test ¶ added in v0.38.4
type Test struct {
Template `yaml:",inline" json:",inline"`
}
func (*Test) DeepCopy ¶ added in v0.38.4
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Test.
func (*Test) DeepCopyInto ¶ added in v0.38.4
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Test) GetTestTemplate ¶ added in v0.38.4
type TestFunction ¶ added in v0.38.4
type TestFunction interface {
GetTestFunction() Template
}
+k8s:deepcopy-gen=false
type VarSource ¶
type VarSource struct { // Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, // spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. // +optional FieldRef *corev1.ObjectFieldSelector `json:"fieldRef,omitempty" protobuf:"bytes,1,opt,name=fieldRef"` // +optional Value string `json:"value,omitempty" protobuf:"bytes,2,opt,name=value"` // Selects a key of a ConfigMap. // +optional ConfigMapKeyRef *corev1.ConfigMapKeySelector `json:"configMapKeyRef,omitempty" protobuf:"bytes,3,opt,name=configMapKeyRef"` // Selects a key of a secret in the pod's namespace // +optional SecretKeyRef *corev1.SecretKeySelector `json:"secretKeyRef,omitempty" protobuf:"bytes,4,opt,name=secretKeyRef"` }
VarSource represents a source for a value
func (*VarSource) DeepCopy ¶ added in v0.11.4
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VarSource.
func (*VarSource) DeepCopyInto ¶ added in v0.11.4
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.