From 9780de8ff50c2972afb1ae5157c2c2907b0ab39e Mon Sep 17 00:00:00 2001 From: Ken Finnigan Date: Tue, 21 Jun 2022 22:24:54 -0700 Subject: [PATCH] Clarify SLO AlertPolicy Fixes #133 --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a9e877d..ea2dfc9 100644 --- a/README.md +++ b/README.md @@ -210,7 +210,7 @@ spec: isRolling: false # if omitted assumed `false` if `calendar:` is present budgetingMethod: Occurrences | Timeslices objectives: # see objectives below for details - alertPolicies: # see alert policies below details + alertPolicies: # see alert policies below for details ``` ##### Notes (SLO) @@ -237,8 +237,10 @@ spec: section. If `thresholdMetric` has been defined, only one Threshold can be defined. However if using `ratioMetric` then any number of Thresholds can be defined. -- **alertPolicies\[ \]** *AlertPolicy*, optional field, described in [Alert Policies](#alertpolicy) - section. +- **alertPolicies\[ \]** *AlertPolicy*, optional field. + section. An alert policy can be defined inline or can refer to an [Alert Policies](#alertpolicy) object, + in which case the following are required: + - **alertPolicyRef** *string*: this is the name or path to the AlertPolicy ##### Objectives