feat: new kubernetes resource check

api/v1/canary_types.go

@@ -43,47 +43,48 @@ type CanarySpec struct {
 	//+optional
 	Replicas int `yaml:"replicas,omitempty" json:"replicas,omitempty"`
 
-	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"`
-	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"`
-	Mysql          []MysqlCheck          `yaml:"mysql,omitempty" json:"mysql,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"`
-	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"`
-	CloudWatch     []CloudWatchCheck     `yaml:"cloudwatch,omitempty" json:"cloudwatch,omitempty"`
-	GitHub         []GitHubCheck         `yaml:"github,omitempty" json:"github,omitempty"`
-	GitProtocol    []GitProtocolCheck    `yaml:"gitProtocol,omitempty" json:"gitProtocol,omitempty"`
-	Kubernetes     []KubernetesCheck     `yaml:"kubernetes,omitempty" json:"kubernetes,omitempty"`
-	Folder         []FolderCheck         `yaml:"folder,omitempty" json:"folder,omitempty"`
-	Exec           []ExecCheck           `yaml:"exec,omitempty" json:"exec,omitempty"`
-	AwsConfig      []AwsConfigCheck      `yaml:"awsConfig,omitempty" json:"awsConfig,omitempty"`
-	AwsConfigRule  []AwsConfigRuleCheck  `yaml:"awsConfigRule,omitempty" json:"awsConfigRule,omitempty"`
-	DatabaseBackup []DatabaseBackupCheck `yaml:"databaseBackup,omitempty" json:"databaseBackup,omitempty"`
-	ConfigDB       []ConfigDBCheck       `yaml:"configDB,omitempty" json:"configDB,omitempty"`
-	Catalog        []CatalogCheck        `yaml:"catalog,omitempty" json:"catalog,omitempty"`
-	Opensearch     []OpenSearchCheck     `yaml:"opensearch,omitempty" json:"opensearch,omitempty"`
-	Elasticsearch  []ElasticsearchCheck  `yaml:"elasticsearch,omitempty" json:"elasticsearch,omitempty"`
-	AlertManager   []AlertManagerCheck   `yaml:"alertmanager,omitempty" json:"alertmanager,omitempty"`
-	Dynatrace      []DynatraceCheck      `yaml:"dynatrace,omitempty" json:"dynatrace,omitempty"`
-	AzureDevops    []AzureDevopsCheck    `yaml:"azureDevops,omitempty" json:"azureDevops,omitempty"`
-	Webhook        *WebhookCheck         `yaml:"webhook,omitempty" json:"webhook,omitempty"`
+	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"`
+	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"`
+	Mysql              []MysqlCheck              `yaml:"mysql,omitempty" json:"mysql,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"`
+	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"`
+	CloudWatch         []CloudWatchCheck         `yaml:"cloudwatch,omitempty" json:"cloudwatch,omitempty"`
+	GitHub             []GitHubCheck             `yaml:"github,omitempty" json:"github,omitempty"`
+	GitProtocol        []GitProtocolCheck        `yaml:"gitProtocol,omitempty" json:"gitProtocol,omitempty"`
+	Kubernetes         []KubernetesCheck         `yaml:"kubernetes,omitempty" json:"kubernetes,omitempty"`
+	KubernetesResource []KubernetesResourceCheck `yaml:"kubernetesResource,omitempty" json:"kubernetesResource,omitempty"`
+	Folder             []FolderCheck             `yaml:"folder,omitempty" json:"folder,omitempty"`
+	Exec               []ExecCheck               `yaml:"exec,omitempty" json:"exec,omitempty"`
+	AwsConfig          []AwsConfigCheck          `yaml:"awsConfig,omitempty" json:"awsConfig,omitempty"`
+	AwsConfigRule      []AwsConfigRuleCheck      `yaml:"awsConfigRule,omitempty" json:"awsConfigRule,omitempty"`
+	DatabaseBackup     []DatabaseBackupCheck     `yaml:"databaseBackup,omitempty" json:"databaseBackup,omitempty"`
+	ConfigDB           []ConfigDBCheck           `yaml:"configDB,omitempty" json:"configDB,omitempty"`
+	Catalog            []CatalogCheck            `yaml:"catalog,omitempty" json:"catalog,omitempty"`
+	Opensearch         []OpenSearchCheck         `yaml:"opensearch,omitempty" json:"opensearch,omitempty"`
+	Elasticsearch      []ElasticsearchCheck      `yaml:"elasticsearch,omitempty" json:"elasticsearch,omitempty"`
+	AlertManager       []AlertManagerCheck       `yaml:"alertmanager,omitempty" json:"alertmanager,omitempty"`
+	Dynatrace          []DynatraceCheck          `yaml:"dynatrace,omitempty" json:"dynatrace,omitempty"`
+	AzureDevops        []AzureDevopsCheck        `yaml:"azureDevops,omitempty" json:"azureDevops,omitempty"`
+	Webhook            *WebhookCheck             `yaml:"webhook,omitempty" json:"webhook,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
@@ -178,6 +179,9 @@ func (spec CanarySpec) GetAllChecks() []external.Check {
 	for _, check := range spec.Kubernetes {
 		checks = append(checks, check)
 	}
+	for _, check := range spec.KubernetesResource {
+		checks = append(checks, check)
+	}
 	for _, check := range spec.Folder {
 		checks = append(checks, check)
 	}

api/v1/checks.go

@@ -5,13 +5,17 @@ import (
 	"encoding/json"
 	"fmt"
 	"strings"
+	"time"
 
 	"github.com/flanksource/canary-checker/api/external"
+	"github.com/flanksource/commons/duration"
 	"github.com/flanksource/duty"
 	"github.com/flanksource/duty/connection"
 	"github.com/flanksource/duty/models"
 	"github.com/flanksource/duty/types"
+	"github.com/samber/lo"
 	v1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 )
 
 const (
@@ -776,6 +780,180 @@ func (c ConfigDBCheck) GetEndpoint() string {
 	return c.Query
 }
 
+// KubernetesResourceChecks is the canary spec.
+// NOTE: It's only created to make crd generation possible.
+// embedding CanarySpec into KubernetesResourceCheck.checks
+// directly generates an invalid crd.
+type KubernetesResourceChecks struct {
+	CanarySpec `yaml:",inline" json:",inline"`
+}
+
+type KubernetesResourceCheckRetries struct {
+	// Delay is the initial delay
+	Delay      string `json:"delay,omitempty"`
+	Timeout    string `json:"timeout,omitempty"`
+	Interval   string `json:"interval,omitempty"`
+	MaxRetries int    `json:"maxRetries,omitempty"`
+
+	parsedDelay    *time.Duration `json:"-"`
+	parsedTimeout  *time.Duration `json:"-"`
+	parsedInterval *time.Duration `json:"-"`
+}
+
+func (t *KubernetesResourceCheckRetries) GetDelay() (time.Duration, error) {
+	if t.parsedDelay != nil {
+		return *t.parsedDelay, nil
+	}
+
+	if t.Delay == "" {
+		return time.Duration(0), nil
+	}
+
+	tt, err := duration.ParseDuration(t.Delay)
+	if err != nil {
+		return time.Duration(0), err
+	}
+	t.parsedDelay = lo.ToPtr(time.Duration(tt))
+
+	return *t.parsedDelay, nil
+}
+
+func (t *KubernetesResourceCheckRetries) GetTimeout() (time.Duration, error) {
+	if t.parsedTimeout != nil {
+		return *t.parsedTimeout, nil
+	}
+
+	if t.Timeout == "" {
+		return time.Duration(0), nil
+	}
+
+	tt, err := duration.ParseDuration(t.Timeout)
+	if err != nil {
+		return time.Duration(0), err
+	}
+	t.parsedTimeout = lo.ToPtr(time.Duration(tt))
+
+	return *t.parsedTimeout, nil
+}
+
+func (t *KubernetesResourceCheckRetries) GetInterval() (time.Duration, error) {
+	if t.parsedInterval != nil {
+		return *t.parsedInterval, nil
+	}
+
+	if t.Interval == "" {
+		return time.Duration(0), nil
+	}
+
+	tt, err := duration.ParseDuration(t.Interval)
+	if err != nil {
+		return time.Duration(0), err
+	}
+	t.parsedInterval = lo.ToPtr(time.Duration(tt))
+
+	return *t.parsedInterval, nil
+}
+
+type KubernetesResourceCheckWaitFor struct {
+	// Expr is a cel expression that determines whether all the resources
+	// are in their desired state before running checks on them.
+	// 	Default: `dyn(resources).all(r, k8s.isHealthy(r))`
+	Expr string `json:"expr,omitempty"`
+
+	// Disable waiting for resources to get to their desired state.
+	Disable bool `json:"disable,omitempty"`
+
+	// Timeout to wait for all static & non-static resources to be ready.
+	// 	Default: 10m
+	Timeout string `json:"timeout,omitempty"`
+
+	// Interval to check if all static & non-static resources are ready.
+	// 	Default: 30s
+	Interval string `json:"interval,omitempty"`
+
+	MaxRetries int `json:"maxRetries,omitempty"`
+
+	parsedTimeout  *time.Duration `json:"-"`
+	parsedInterval *time.Duration `json:"-"`
+}
+
+func (t *KubernetesResourceCheckWaitFor) GetTimeout() (time.Duration, error) {
+	if t.parsedTimeout != nil {
+		return *t.parsedTimeout, nil
+	}
+
+	if t.Timeout == "" {
+		return time.Duration(0), nil
+	}
+
+	tt, err := duration.ParseDuration(t.Timeout)
+	if err != nil {
+		return time.Duration(0), err
+	}
+	t.parsedTimeout = lo.ToPtr(time.Duration(tt))
+
+	return *t.parsedTimeout, nil
+}
+
+func (t *KubernetesResourceCheckWaitFor) GetInterval() (time.Duration, error) {
+	if t.parsedInterval != nil {
+		return *t.parsedInterval, nil
+	}
+
+	if t.Interval == "" {
+		return time.Duration(0), nil
+	}
+
+	tt, err := duration.ParseDuration(t.Interval)
+	if err != nil {
+		return time.Duration(0), err
+	}
+	t.parsedInterval = lo.ToPtr(time.Duration(tt))
+
+	return *t.parsedInterval, nil
+}
+
+type KubernetesResourceCheck struct {
+	Description `yaml:",inline" json:",inline"`
+	Templatable `yaml:",inline" json:",inline"`
+
+	// StaticResources are kubernetes resources that are created & only
+	// cleared when the canary is deleted
+	// +kubebuilder:validation:Schemaless
+	// +kubebuilder:pruning:PreserveUnknownFields
+	StaticResources []unstructured.Unstructured `json:"staticResources,omitempty"`
+
+	// Resources are kubernetes resources that are created & cleared
+	// after every check run.
+	// +kubebuilder:validation:Schemaless
+	// +kubebuilder:pruning:PreserveUnknownFields
+	Resources []unstructured.Unstructured `json:"resources"`
+
+	// Checks to run against the kubernetes resources.
+	// +kubebuilder:validation:XPreserveUnknownFields
+	Checks []KubernetesResourceChecks `json:"checks,omitempty"`
+
+	// Set initial delays and retry intervals for checks.
+	CheckRetries KubernetesResourceCheckRetries `json:"checkRetries,omitempty"`
+
+	// Kubeconfig is the kubeconfig or the path to the kubeconfig file.
+	Kubeconfig *types.EnvVar `yaml:"kubeconfig,omitempty" json:"kubeconfig,omitempty"`
+
+	WaitFor KubernetesResourceCheckWaitFor `json:"waitFor,omitempty"`
+}
+
+func (c KubernetesResourceCheck) TotalResources() int {
+	return len(c.Resources) + len(c.StaticResources)
+}
+
+func (c KubernetesResourceCheck) GetType() string {
+	return "kubernetes_resource"
+}
+
+func (c KubernetesResourceCheck) GetEndpoint() string {
+	return c.Name
+}
+
 type ResourceSelector struct {
 	Name          string `yaml:"name,omitempty" json:"name,omitempty"`
 	LabelSelector string `json:"labelSelector,omitempty" yaml:"labelSelector,omitempty"`