Merge pull request #790 from theishshah/stale-cache-doc

📖: Add note about split client cache inconsistency

Author: k8s-ci-robot

doc.go

@@ -82,8 +82,11 @@ limitations under the License.
 // and writes directly to the API server, but clients can be constructed that
 // only talk to the API server, without a cache.  The Cache will auto-populate
 // with watched objects, as well as when other structured objects are
-// requested.  Caches may also have indexes, which can be created via a
-// FieldIndexer (pkg/client) obtained from the manager.  Indexes can used to
+// requested. The default split client does not promise to invalidate the cache
+// during writes (nor does it promise sequential create/get coherence), and code
+// should not assume a get immediately following a create/update will return
+// the updated resource. Caches may also have indexes, which can be created via
+// a FieldIndexer (pkg/client) obtained from the manager.  Indexes can used to
 // quickly and easily look up all objects with certain fields set.  Reconcilers
 // may retrieve event recorders (pkg/recorder) to emit events using the
 // manager.