You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/ingress.md
+20-7
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,17 @@
1
1
# ingress
2
2
3
-
We also support kubernetes native `ingress` resources. See [official docs](https://kubernetes.io/docs/concepts/services-networking/ingress/) for more details on what they are and what they do.
3
+
Support for kubernetes native `ingress` resources. See [official docs](https://kubernetes.io/docs/concepts/services-networking/ingress/) for more details on what they are and what they do.
4
4
5
-
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](https://kubernetes.io/docs/concepts/overview/working-with-objects/owners-dependents/) to link ingress resources to ApiCheck resources.
5
+
We pull out information with the use of `annotations` and use the built in spec. The information from the annotations is used to create `ApiCheck` resources, we make use of [ownerReferences](https://kubernetes.io/docs/concepts/overview/working-with-objects/owners-dependents/) to link ingress resources to ApiCheck resources.
6
6
7
7
> ***Warning***
8
-
> We currently only support one API check / ingress resource.
8
+
> We currently only support API checks for ingress resources.
9
+
10
+
## Logic of discovery
11
+
12
+
We iterate over the ingress resource's specifications to work out what needs to be created. The operator creates one ApiCheck resource for each `host` + `path`, if in your ingress resource you have 2 hosts with 3 paths each, you'll end up with 6 ApiChecks created.
13
+
14
+
Specific annotations are optional, as we can't automatically discover the group you want the Checkly APIChecks to be deployd in.
9
15
10
16
## Configuration options
11
17
@@ -14,10 +20,10 @@ The name of the API Check derives from the `metadata.name` of the `ingress` reso
14
20
| Annotation | Details | Default |
15
21
|--------------------|-------------|---------|
16
22
|`k8s.checklyhq.com/enabled`| Bool; Should the operator read the annotations or not |`false` (*required) |
17
-
|`k8s.checklyhq.com/path`| String; The URI to put after the `endpoint`, for example `/path`| "" (*required) |
18
-
|`k8s.checklyhq.com/endpoint`| String; The host of the URL, for example `/`| Value of `spec.rules[0].Host`, defaults to `https://` (*required) |
23
+
|`k8s.checklyhq.com/endpoint`| String; The host of the URL, for example `/`| Value of `spec.rules[0].Host`, defaults to `https://`|
19
24
|`k8s.checklyhq.com/group`| String; Name of the group to which the check belongs; Kubernetes `Group` resource name` | none (*required)|
20
25
|`k8s.checklyhq.com/muted`| String; Is the check muted or not |`true`|
26
+
|`k8s.checklyhq.com/path`| String; The URI to put after the `endpoint`, for example `/path`| ""|
21
27
|`k8s.checklyhq.com/success`| String; The expected success code |`200`|
22
28
23
29
### Example
@@ -29,7 +35,7 @@ metadata:
29
35
name: checkly-operator-ingress
30
36
annotations:
31
37
k8s.checklyhq.com/enabled: "true"
32
-
k8s.checklyhq.com/path: "/baz"
38
+
#k8s.checklyhq.com/path: "/baz" - Default read from spec.rules[0].http.paths[*].path
33
39
# k8s.checklyhq.com/endpoint: "foo.baaz" - Default read from spec.rules[0].host
0 commit comments