Skip to content

Commit

Permalink
docs: custom health check resource group wildcard (#4212)
Browse files Browse the repository at this point in the history
Signed-off-by: reggie <reginakagan@gmail.com>

Signed-off-by: reggie <reginakagan@gmail.com>
Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
  • Loading branch information
reggie-k and crenshaw-dev committed Jan 11, 2023
1 parent 57d01a4 commit 913ac50
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/operator-manual/health.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ data:
hs.message = "Waiting for certificate"
return hs
```
In order to prevent duplication of the same custom health check for potentially multiple resources, it is also possible to specify a wildcard in the resource kind, like this:
In order to prevent duplication of the custom health check for potentially multiple resources, it is also possible to specify a wildcard in the resource kind, and anywhere in the resource group, like this:

```yaml
resource.customizations: |
Expand All @@ -112,6 +112,15 @@ In order to prevent duplication of the same custom health check for potentially
...
```

```yaml
resource.customizations: |
*.aws.crossplane.io/*:
health.lua: |
...
```



The `obj` is a global variable which contains the resource. The script must return an object with status and optional message field.
The custom health check might return one of the following health statuses:

Expand Down

0 comments on commit 913ac50

Please sign in to comment.