From 299d894dbbcab5783f2a7dbfddc92d66e83f312d Mon Sep 17 00:00:00 2001 From: Yu-Ju Hong Date: Tue, 17 Feb 2015 10:47:45 -0800 Subject: [PATCH] Add a brief description on how we handle defaults --- docs/api-conventions.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/api-conventions.md b/docs/api-conventions.md index 1b36c6880af..a7cbd4ea28c 100644 --- a/docs/api-conventions.md +++ b/docs/api-conventions.md @@ -137,6 +137,18 @@ All compatible Kubernetes APIs MUST support "name idempotency" and respond with TODO: name generation +Defaulting +---------- + +Default resource values are API version-specific, and they are applied during +the conversion from API-versioned declarative configuration to internal objects +representing the desired state (`Spec`) of the resource. + +Incorporating the default values into the `Spec` ensures that `Spec` depicts the +full desired state so that it is easier for the system to determine how to +achieve the state, and for the user to know what to anticipate. + + Concurrency Control and Consistency -----------------------------------