pub struct ValidationRule {
pub field_path: Option<String>,
pub message: Option<String>,
pub message_expression: Option<String>,
pub optional_old_self: Option<bool>,
pub reason: Option<String>,
pub rule: String,
}
Expand description
ValidationRule describes a validation rule written in the CEL expression language.
Fields§
§field_path: Option<String>
fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute foo
under a map testMap
, the fieldPath could be set to .testMap.foo
If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. .testList
It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to [JSONPath support in Kubernetes](https://kubernetes.io/docs/reference/kubectl/jsonpath/) for more info. Numeric index of array is not supported. For field name which contains special characters, use \['specialName'\]
to refer the field name. e.g. for attribute foo.34$
appears in a list testList
, the fieldPath could be set to .testList\['foo.34$'\]
message: Option<String>
Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is “failed rule: {Rule}”. e.g. “must be a URL with the host matching spec.host”
message_expression: Option<String>
MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: “x must be less than max (”+string(self.max)+“)”
optional_old_self: Option<bool>
optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value.
When enabled oldSelf
will be a CEL optional whose value will be None
if there is no old value, or when the object is initially created.
You may check for presence of oldSelf using oldSelf.hasValue()
and unwrap it after checking using oldSelf.value()
. Check the CEL documentation for Optional types for more information: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypes
May not be set unless oldSelf
is used in rule
.
reason: Option<String>
reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: “FieldValueInvalid”, “FieldValueForbidden”, “FieldValueRequired”, “FieldValueDuplicate”. If not set, default to use “FieldValueInvalid”. All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.
rule: String
Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The self
variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {“rule”: “self.status.actual <= self.spec.maxDesired”}
If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via self.field
and field presence can be checked via has(self.field)
. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible via self\[mapKey\]
, map containment can be checked via mapKey in self
and all entries of the map are accessible via CEL macros and functions such as self.all(...)
. If the Rule is scoped to an array, the elements of the array are accessible via self\[i\]
and also by macros and functions. If the Rule is scoped to a scalar, self
is bound to the scalar value. Examples: - Rule scoped to a map of objects: {“rule”: “self.components[‘Widget’].priority < 10”} - Rule scoped to a list of integers: {“rule”: “self.values.all(value, value >= 0 && value < 100)”} - Rule scoped to a string value: {“rule”: “self.startsWith(‘kube’)”}
The apiVersion
, kind
, metadata.name
and metadata.generateName
are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible.
Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an “unknown type”. An “unknown type” is recursively defined as:
- A schema with no type and x-kubernetes-preserve-unknown-fields set to true
- An array where the items schema is of an “unknown type”
- An object where the additionalProperties schema is of an “unknown type”
Only property names of the form \[a-zA-Z_.-/\]\[a-zA-Z0-9_.-/\]*
are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - ‘’ escapes to ‘underscores’ - ‘.’ escapes to ‘dot’ - ‘-’ escapes to ‘dash’ - ‘/’ escapes to ‘slash’ - Property names that exactly match a CEL RESERVED keyword escape to ‘{keyword}__’. The keywords are:
“true”, “false”, “null”, “in”, “as”, “break”, “const”, “continue”, “else”, “for”, “function”, “if”,
“import”, “let”, “loop”, “package”, “namespace”, “return”.
Examples:
- Rule accessing a property named “namespace”: {“rule”: “self.namespace > 0”}
- Rule accessing a property named “x-prop”: {“rule”: “self.x__dash__prop > 0”}
- Rule accessing a property named “redact__d”: {“rule”: “self.redact__underscores__d > 0”}
Equality on arrays with x-kubernetes-list-type of ‘set’ or ‘map’ ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- ‘set’:
X + Y
performs a union where the array positions of all elements inX
are preserved and non-intersecting elements inY
are appended, retaining their partial order. - ‘map’:
X + Y
performs a merge where the array positions of all keys inX
are preserved but the values are overwritten by values inY
when the key sets ofX
andY
intersect. Elements inY
with non-intersecting keys are appended, retaining their partial order.
If rule
makes use of the oldSelf
variable it is implicitly a transition rule
.
By default, the oldSelf
variable is the same type as self
. When optionalOldSelf
is true, the oldSelf
variable is a CEL optional
variable whose value() is the same type as self
.
See the documentation for the optionalOldSelf
field for details.
Transition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found. You can opt a transition rule into unconditional evaluation by setting optionalOldSelf
to true.
Trait Implementations§
Source§impl Clone for ValidationRule
impl Clone for ValidationRule
Source§fn clone(&self) -> ValidationRule
fn clone(&self) -> ValidationRule
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ValidationRule
impl Debug for ValidationRule
Source§impl DeepMerge for ValidationRule
impl DeepMerge for ValidationRule
Source§fn merge_from(&mut self, other: Self)
fn merge_from(&mut self, other: Self)
other
into self
.Source§impl Default for ValidationRule
impl Default for ValidationRule
Source§fn default() -> ValidationRule
fn default() -> ValidationRule
Source§impl<'de> Deserialize<'de> for ValidationRule
impl<'de> Deserialize<'de> for ValidationRule
Source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
Source§impl JsonSchema for ValidationRule
impl JsonSchema for ValidationRule
Source§fn schema_name() -> String
fn schema_name() -> String
Source§fn json_schema(__gen: &mut SchemaGenerator) -> Schema
fn json_schema(__gen: &mut SchemaGenerator) -> Schema
Source§fn is_referenceable() -> bool
fn is_referenceable() -> bool
$ref
keyword. Read moreSource§impl PartialEq for ValidationRule
impl PartialEq for ValidationRule
Source§impl Serialize for ValidationRule
impl Serialize for ValidationRule
impl StructuralPartialEq for ValidationRule
Auto Trait Implementations§
impl Freeze for ValidationRule
impl RefUnwindSafe for ValidationRule
impl Send for ValidationRule
impl Sync for ValidationRule
impl Unpin for ValidationRule
impl UnwindSafe for ValidationRule
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)