ingress.md

ingress

We also support kubernetes native ingress resources. See official docs for more details on what they are and what they do.

We pull out information with the use of annotations. The information from the annotations is used to create ApiCheck resources, we make use of ownerReferences to link ingress resources to ApiCheck resources.

Warning We currently only support one API check / ingress resource.

Configuration options

The name of the API Check derives from the metadata.name of the ingress resource and the corresponding API Check is created in the same namespace where the ingress object resides.

Annotation	Details	Default
k8s.checklyhq.com/enabled	Bool; Should the operator read the annotations or not	false (*required)
k8s.checklyhq.com/path	String; The URI to put after the endpoint, for example /path	"" (*required)
k8s.checklyhq.com/endpoint	String; The host of the URL, for example /	Value of spec.rules[0].Host, defaults to https:// (*required)
k8s.checklyhq.com/group	String; Name of the group to which the check belongs; Kubernetes Group resource name`	none (*required)
k8s.checklyhq.com/muted	String; Is the check muted or not	true
k8s.checklyhq.com/success	String; The expected success code	200

Example

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: checkly-operator-ingress
  annotations:
    k8s.checklyhq.com/enabled: "true"
    k8s.checklyhq.com/path: "/baz"
    # k8s.checklyhq.com/endpoint: "foo.baaz" - Default read from spec.rules[0].host
    # k8s.checklyhq.com/success: "200" - Default "200"
    k8s.checklyhq.com/group: "group-sample"
    # k8s.checklyhq.com/muted: "false" # If not set, default "true"
spec:
  rules:
    - host: "foo.bar"
      http:
        paths:
          - path: /
            pathType: ImplementationSpecific
            backend:
              service:
                name: test-service
                port:
                  number: 8080