bundle/direct: record resource operations with DMS#5387
Draft
shreyas-goenka wants to merge 1 commit into
Draft
Conversation
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
changed the title
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
Collaborator
|
Commit: 2f36b2d |
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
force-pushed
the
shreyas-goenka/dms-version
branch
from
2fb2f59 to
2f36b2d
Compare
shreyas-goenka
changed the title
shreyas-goenka
changed the base branch from
shreyas-goenka/bundle-lock-abstraction
to
shreyas-goenka/cli-managed-state-flag
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
force-pushed
the
shreyas-goenka/dms-version
branch
from
2f36b2d to
d5f35f3
Compare
shreyas-goenka
changed the base branch from
shreyas-goenka/cli-managed-state-flag
to
main
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
When experimental.record_deployment_history is set, each successfully applied resource operation is reported to the deployment metadata service (DMS) via the CreateOperation API, in addition to the local state file. - opRecorder interface + sdkRecorder: record(action, id, state) maps a deployplan action to its SDK operation type and posts it under the deployment version. The serialized config is carried in Operation.State so DMS can serve it as resource state; it is omitted for deletes. - deployActionToSDK rejects non-mutating actions (Skip/Undefined) rather than coercing them, so an unmapped action surfaces as an error. - DeploymentBundle.OpRec is nil unless recording is enabled; the apply loop records after each create/update/recreate/resize/update_id/delete. - A failed recording fails the deploy, matching how local state writes (SaveState) are treated: a state-backend write must not be silently lost. The deployment ID and version that identify the DMS version are sourced from the CreateVersion flow, which lands separately; until then they are placeholders (record_deployment_history is experimental and off by default). Co-authored-by: Shreyas Goenka <shreyas.goenka@databricks.com>
shreyas-goenka
force-pushed
the
shreyas-goenka/dms-version
branch
from
d5f35f3 to
465bc4a
Compare
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
When
experimental.record_deployment_historyis set, each successfully applied resource operation in the direct engine is reported to the deployment metadata service (DMS) viaCreateOperation, in addition to the local state file. This is the first consumer of therecord_deployment_historyflag.What changed
bundle/direct/oprecorder.go—opRecorderinterface +sdkRecorder:deployplanaction to its SDKOperationActionType. Non-mutating actions (Skip/Undefined) are rejected with an error rather than silently coerced.Operation.Stateso DMS can serve it as resource state; it is omitted for deletes (per the SDK contract).deployments/{deployment_id}/versions/{version}.bundle/direct/pkg.go—DeploymentBundle.OpRec opRecorder, nil unless recording is enabled.bundle/direct/bundle_apply.go— records after each successfulcreate/update/recreate/resize/update_id/delete. Delete reads the resource ID beforeDestroyremoves it from state. Migration mode records nothing.bundle/phases/deploy.go— constructs the recorder indeployCorewhenb.Config.Experimental.RecordDeploymentHistory.Design notes
CreateOperationfails the deploy, matching how localSaveStatefailures are treated — a state-backend write must not be silently lost.CreateVersionflow, which lands separately. Until then they are placeholders;record_deployment_historyis experimental and off by default.Test plan
go test ./bundle/direct/... ./bundle/phases/...greengo vet+./task lint-qclean