add notes for usage of object storage as cache

Signed-off-by: zhangyifei <[email protected]>
koderover · Mar 8, 2022 · c1a7aef · c1a7aef
1 parent 4e837f2
commit c1a7aef
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/pkg/types/cache.go b/pkg/types/cache.go
@@ -30,6 +30,11 @@ const (
 	StaticProvision  ProvisionType = "static"
 )
 
+// Note:
+// In the current design, when the object storage is used as the cache medium, the default object storage
+// will be used as the cache medium, but in the near future users may be allowed to select different object storage
+// as the cache medium according to the cluster.
+// So it is temporarily reserved in `v1.10.0`, but do not use.
 type ObjectProperties struct {
 	ID string `json:"id" bson:"id"`
 }