Odyssey

KentikLabs synthetic Kubernetes operator. This operator can be used to create Kentik synthetic tests on a Kubernetes cluster. The data can then be viewed in the Kentik Portal.

Build

To build the operator:

make

This will build the protos and binary.

Run Locally

To build and run the Go binary from your host outside of the cluster (for development):

make KENTIK_EMAIL=<your-kentik-email> KENTIK_API_TOKEN=<your-api-token> install run

Image

To build a Docker image of the controller:

docker build -t <name> .

Deploy

To deploy to a Kubernetes cluster:

make IMG=
   
     deploy

   

Usage

To create and deploy a synth server to run tests, use the following example:

apiVersion: synthetics.kentiklabs.com/v1
kind: SyntheticTask
metadata:
  name: demo
spec:
  fetch:
    - service: demo
      target: /
      port: 8080
      method: GET
      period: 30s
      expiry: 5s
  tls_handshake:
    - ingress: demo
      period: 30s
      expiry: 5s
  trace:
    - kind: deployment
      name: demo
      period: 30s
      expiry: 5s

Note: you can optionally specify server_image and agent_image to override the default images for the components. This is useful for development.

This will inform the operator to launch a synth server and agent in the desired namespace and configure the server with three tasks (fetch, tls_handshake, ping, and trace). These will then be sent to the agent to perform at the specified intervals.

Tasks

The following tasks are supported.

Fetch

Fetch performs an HTTP operation on the specified Kubernetes service. The connection info (IP, etc) will be automatically resolved by the operator.

TLS Handshake

The tls_handshake test performs a TLS handshake and reports info. This check requires a Kubernetes Ingress object. The connection info will be automatically resolved by the operator.

Ping

Ping performs a network ping and latency, etc. This check can be used with a Kubernetes Pod, Deployment, Service, or Ingress. The connection info will be automatically resolved by the operator.

Trace

Trace performs a network trace and reports hops, latency, etc. This check can be used with a Kubernetes Pod, Deployment, Service, or Ingress. The connection info will be automatically resolved by the operator.