Dual Storage Architecture #767
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,8 +2,9 @@ package rest | |
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "time" | ||
|
|
||
| metainternalversion "k8s.io/apimachinery/pkg/apis/meta/internalversion" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
|
|
@@ -21,114 +22,151 @@ type DualWriterMode3 struct { | |
| // newDualWriterMode3 returns a new DualWriter in mode 3. | ||
| // Mode 3 represents writing to LegacyStorage and Storage and reading from Storage. | ||
| func newDualWriterMode3(legacy LegacyStorage, storage Storage, dwm *dualWriterMetrics) *DualWriterMode3 { | ||
| return &DualWriterMode3{Legacy: legacy, Storage: storage, Log: klog.NewKlogr().WithName("DualWriterMode3").WithValues("mode", mode3Str), dualWriterMetrics: dwm} | ||
| } | ||
|
|
||
| // Mode returns the mode of the dual writer. | ||
| func (d *DualWriterMode3) Mode() DualWriterMode { | ||
| return Mode3 | ||
| } | ||
|
|
||
| const mode3Str = "3" | ||
|
|
||
| // Create overrides the behavior of the generic DualWriter and writes to LegacyStorage and Storage. | ||
| func (d *DualWriterMode3) Create(ctx context.Context, obj runtime.Object, createValidation rest.ValidateObjectFunc, options *metav1.CreateOptions) (runtime.Object, error) { | ||
| var method = "create" | ||
| log := d.Log.WithValues("kind", options.Kind, "method", method) | ||
| ctx = klog.NewContext(ctx, log) | ||
|
|
||
| startStorage := time.Now() | ||
| created, err := d.Storage.Create(ctx, obj, createValidation, options) | ||
| if err != nil { | ||
| log.Error(err, "unable to create object in storage") | ||
| d.recordLegacyDuration(true, mode3Str, options.Kind, method, startStorage) | ||
| return created, err | ||
| } | ||
| d.recordStorageDuration(false, mode3Str, options.Kind, method, startStorage) | ||
|
|
||
| go func() { | ||
| ctx, cancel := context.WithTimeoutCause(ctx, time.Second*10, errors.New("legacy create timeout")) | ||
| defer cancel() | ||
|
|
||
| startLegacy := time.Now() | ||
| _, errObjectSt := d.Legacy.Create(ctx, obj, createValidation, options) | ||
| d.recordLegacyDuration(errObjectSt != nil, mode3Str, options.Kind, method, startLegacy) | ||
| }() | ||
|
Comment on lines
+50
to
+57
Author
There was a problem hiding this comment.
Context cancellation aborts background legacy storage operations in Create, Update, Delete, and DeleteCollection because the parent HTTP request ctx is passed directly to goroutines that outlive the handler. Use context.WithoutCancel(ctx) to detach these operations from the parent request lifecycle. go func() {
// Use context.WithoutCancel to prevent immediate cancellation when the parent HTTP handler returns.
ctx, cancel := context.WithTimeoutCause(context.WithoutCancel(ctx), time.Second*10, errors.New("legacy create timeout"))
defer cancel()
startLegacy := time.Now()
_, errObjectSt := d.Legacy.Create(ctx, obj, createValidation, options)
d.recordLegacyDuration(errObjectSt != nil, mode3Str, options.Kind, method, startLegacy)
}()Prompt for LLMTalk to Kody by mentioning @kody Was this suggestion helpful? React with 👍 or 👎 to help Kody learn from this interaction. |
||
|
|
||
| return created, err | ||
| } | ||
|
|
||
| // Get overrides the behavior of the generic DualWriter and retrieves an object from Storage. | ||
| func (d *DualWriterMode3) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error) { | ||
| var method = "get" | ||
| log := d.Log.WithValues("kind", options.Kind, "name", name, "method", method) | ||
| ctx = klog.NewContext(ctx, log) | ||
|
|
||
| startStorage := time.Now() | ||
| res, err := d.Storage.Get(ctx, name, options) | ||
| if err != nil { | ||
| log.Error(err, "unable to get object in storage") | ||
| } | ||
| d.recordStorageDuration(err != nil, mode3Str, options.Kind, method, startStorage) | ||
|
|
||
| return res, err | ||
| } | ||
|
|
||
| // List overrides the behavior of the generic DualWriter and reads only from Unified Store. | ||
| func (d *DualWriterMode3) List(ctx context.Context, options *metainternalversion.ListOptions) (runtime.Object, error) { | ||
| var method = "list" | ||
| log := d.Log.WithValues("kind", options.Kind, "resourceVersion", options.ResourceVersion, "method", method) | ||
| ctx = klog.NewContext(ctx, log) | ||
|
|
||
| startStorage := time.Now() | ||
| res, err := d.Storage.List(ctx, options) | ||
| if err != nil { | ||
| log.Error(err, "unable to list object in storage") | ||
| } | ||
| d.recordStorageDuration(err != nil, mode3Str, options.Kind, method, startStorage) | ||
|
|
||
| return res, err | ||
| } | ||
|
|
||
| func (d *DualWriterMode3) Delete(ctx context.Context, name string, deleteValidation rest.ValidateObjectFunc, options *metav1.DeleteOptions) (runtime.Object, bool, error) { | ||
| var method = "delete" | ||
| log := d.Log.WithValues("name", name, "kind", options.Kind, "method", method) | ||
| ctx = klog.NewContext(ctx, d.Log) | ||
|
|
||
| startStorage := time.Now() | ||
| res, async, err := d.Storage.Delete(ctx, name, deleteValidation, options) | ||
| if err != nil { | ||
| log.Error(err, "unable to delete object in storage") | ||
| d.recordStorageDuration(true, mode3Str, options.Kind, method, startStorage) | ||
| return res, async, err | ||
| } | ||
| d.recordStorageDuration(false, mode3Str, name, method, startStorage) | ||
|
Author
There was a problem hiding this comment.
Cardinality explosion in d.recordStorageDuration occurs because unique object names are used as metric labels instead of options.Kind, exhausting memory and crashing the metrics pipeline. Replace name with options.Kind here and in pkg/apiserver/rest/dualwriter_mode3.go:101-106. d.recordStorageDuration(false, mode3Str, options.Kind, method, startStorage)Prompt for LLMTalk to Kody by mentioning @kody Was this suggestion helpful? React with 👍 or 👎 to help Kody learn from this interaction. |
||
|
|
||
| go func() { | ||
| startLegacy := time.Now() | ||
| ctx, cancel := context.WithTimeoutCause(ctx, time.Second*10, errors.New("legacy delete timeout")) | ||
| defer cancel() | ||
| _, _, err := d.Legacy.Delete(ctx, name, deleteValidation, options) | ||
| d.recordLegacyDuration(err != nil, mode3Str, options.Kind, method, startLegacy) | ||
| }() | ||
|
|
||
| return res, async, err | ||
| } | ||
|
|
||
| // Update overrides the behavior of the generic DualWriter and writes first to Storage and then to LegacyStorage. | ||
| func (d *DualWriterMode3) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, createValidation rest.ValidateObjectFunc, updateValidation rest.ValidateObjectUpdateFunc, forceAllowCreate bool, options *metav1.UpdateOptions) (runtime.Object, bool, error) { | ||
| var method = "update" | ||
| log := d.Log.WithValues("name", name, "kind", options.Kind, "method", method) | ||
| ctx = klog.NewContext(ctx, log) | ||
|
|
||
| startStorage := time.Now() | ||
| res, async, err := d.Storage.Update(ctx, name, objInfo, createValidation, updateValidation, forceAllowCreate, options) | ||
| if err != nil { | ||
| log.Error(err, "unable to update in storage") | ||
| d.recordLegacyDuration(true, mode3Str, options.Kind, method, startStorage) | ||
| return res, async, err | ||
| } | ||
| d.recordStorageDuration(false, mode3Str, options.Kind, method, startStorage) | ||
|
|
||
| go func() { | ||
| ctx, cancel := context.WithTimeoutCause(ctx, time.Second*10, errors.New("legacy update timeout")) | ||
|
|
||
| startLegacy := time.Now() | ||
| defer cancel() | ||
| _, _, errObjectSt := d.Legacy.Update(ctx, name, objInfo, createValidation, updateValidation, forceAllowCreate, options) | ||
| d.recordLegacyDuration(errObjectSt != nil, mode3Str, options.Kind, method, startLegacy) | ||
| }() | ||
|
|
||
| return res, async, err | ||
| } | ||
|
|
||
| // DeleteCollection overrides the behavior of the generic DualWriter and deletes from both LegacyStorage and Storage. | ||
| func (d *DualWriterMode3) DeleteCollection(ctx context.Context, deleteValidation rest.ValidateObjectFunc, options *metav1.DeleteOptions, listOptions *metainternalversion.ListOptions) (runtime.Object, error) { | ||
| var method = "delete-collection" | ||
| log := d.Log.WithValues("kind", options.Kind, "resourceVersion", listOptions.ResourceVersion, "method", method) | ||
| ctx = klog.NewContext(ctx, log) | ||
|
|
||
| startStorage := time.Now() | ||
| res, err := d.Storage.DeleteCollection(ctx, deleteValidation, options, listOptions) | ||
| if err != nil { | ||
| log.Error(err, "unable to delete collection in storage") | ||
| d.recordStorageDuration(true, mode3Str, options.Kind, method, startStorage) | ||
| return res, err | ||
| } | ||
| d.recordStorageDuration(false, mode3Str, options.Kind, method, startStorage) | ||
|
|
||
| go func() { | ||
| startLegacy := time.Now() | ||
| ctx, cancel := context.WithTimeoutCause(ctx, time.Second*10, errors.New("legacy deletecollection timeout")) | ||
| defer cancel() | ||
| _, err := d.Legacy.DeleteCollection(ctx, deleteValidation, options, listOptions) | ||
| d.recordStorageDuration(err != nil, mode3Str, options.Kind, method, startLegacy) | ||
| }() | ||
|
|
||
| return res, err | ||
| } | ||
|
|
||
| func (d *DualWriterMode3) Destroy() { | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Data race occurs in legacy Create because the obj pointer is shared concurrently between the background goroutine and the main serialization goroutine. Perform a deep copy using obj.DeepCopyObject() to prevent crashes from in-place mutations common in k8s.io/apiserver storage layers.
Prompt for LLM
Talk to Kody by mentioning @kody
Was this suggestion helpful? React with 👍 or 👎 to help Kody learn from this interaction.