Pod

The Pod check creates a new pod and verifies its reachability.

tcp.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: pod-pass
spec:
  interval: 900
  pod:
    - name: golang
      spec: |
        apiVersion: v1
        kind: Pod
        metadata:
          name: hello-world-golang
          labels:
            app: hello-world-golang
        spec:
          containers:
            - name: hello
              image: quay.io/toni0/hello-webserver-golang:latest
      port: 8080
      path: /foo/bar
      scheduleTimeout: 20000
      readyTimeout: 10000
      httpTimeout: 7000
      deleteTimeout: 12000
      ingressTimeout: 10000
      deadline: 60000
      httpRetryInterval: 1500
      expectedContent: bar
      expectedHttpStatuses: [200, 201, 202]

Field	Description	Scheme
name*	Name of the check, must be unique within the canary	string
spec*	Pod spec to create	Spec
deadline	Overall deadline for pod check	Duration
deleteTimeout	Timeout for pod deletion	Duration
expectedContent	Expected content in HTTP response	string
expectedHttpStatuses	Expected HTTP response statuses	[]int
httpRetryInterval	Interval between HTTP retries	Duration
httpTimeout	Timeout for HTTP requests	Duration
ingressHost	URL to be used by the ingress to expose the created pod	string
ingressName	Name to use for the ingress object that will expose the created pod	string
ingressTimeout	Timeout waiting for ingress creation	Duration
namespace	Namespace where pod will be created	string
path	Path on which the created pod will respond to requests	string
port	Port on which the created pod will serve traffic	integer
priorityClass	Priority class to assign to the created pod	string
readyTimeout	Timeout waiting for pod to become ready	Duration
scheduleTimeout	Timeout for pod creation	Duration
description	Description for the check	string
display	Expression to change the formatting of the display	Expression
icon	Icon for overwriting default icon on the dashboard	Icon
labels	Labels for check	map[string]string
metrics	Metrics to export from	[]Metrics
test	Evaluate whether a check is healthy	Expression
transform	Transform data from a check into multiple individual checks	Expression

Metrics

Metric
canary_check_histogram{metric = "creation_time"}	Histogram	Time for pod to be Pending
canary_check_histogram{metric = "delete_time"}	Histogram	Time to delete pod
canary_check_histogram{metric = "ingress_time"}	Histogram	Time until ingress is returning requests
canary_check_histogram{metric = "request_time"}	Histogram	Duration of http request once ingress is up
canary_check_histogram{metric = "schedule_time"}	Histogram	Time for pod to be Running