mirror of
https://gitee.com/milvus-io/milvus.git
synced 2026-01-07 19:31:51 +08:00
issue: #44358 Implement complete snapshot management system including creation, deletion, listing, description, and restoration capabilities across all system components. Key features: - Create snapshots for entire collections - Drop snapshots by name with proper cleanup - List snapshots with collection filtering - Describe snapshot details and metadata Components added/modified: - Client SDK with full snapshot API support and options - DataCoord snapshot service with metadata management - Proxy layer with task-based snapshot operations - Protocol buffer definitions for snapshot RPCs - Comprehensive unit tests with mockey framework - Integration tests for end-to-end validation Technical implementation: - Snapshot metadata storage in etcd with proper indexing - File-based snapshot data persistence in object storage - Garbage collection integration for snapshot cleanup - Error handling and validation across all operations - Thread-safe operations with proper locking mechanisms <!-- This is an auto-generated comment: release notes by coderabbit.ai --> - Core invariant/assumption: snapshots are immutable point‑in‑time captures identified by (collection, snapshot name/ID); etcd snapshot metadata is authoritative for lifecycle (PENDING → COMMITTED → DELETING) and per‑segment manifests live in object storage (Avro / StorageV2). GC and restore logic must see snapshotRefIndex loaded (snapshotMeta.IsRefIndexLoaded) before reclaiming or relying on segment/index files. - New capability added: full end‑to‑end snapshot subsystem — client SDK APIs (Create/Drop/List/Describe/Restore + restore job queries), DataCoord SnapshotWriter/Reader (Avro + StorageV2 manifests), snapshotMeta in meta, SnapshotManager orchestration (create/drop/describe/list/restore), copy‑segment restore tasks/inspector/checker, proxy & RPC surface, GC integration, and docs/tests — enabling point‑in‑time collection snapshots persisted to object storage and restorations orchestrated across components. - Logic removed/simplified and why: duplicated recursive compaction/delta‑log traversal and ad‑hoc lookup code were consolidated behind two focused APIs/owners (Handler.GetDeltaLogFromCompactTo for delta traversal and SnapshotManager/SnapshotReader for snapshot I/O). MixCoord/coordinator broker paths were converted to thin RPC proxies. This eliminates multiple implementations of the same traversal/lookup, reducing divergence and simplifying responsibility boundaries. - Why this does NOT introduce data loss or regressions: snapshot create/drop use explicit two‑phase semantics (PENDING → COMMIT/DELETING) with SnapshotWriter writing manifests and metadata before commit; GC uses snapshotRefIndex guards and IsRefIndexLoaded/GetSnapshotBySegment/GetSnapshotByIndex checks to avoid removing referenced files; restore flow pre‑allocates job IDs, validates resources (partitions/indexes), performs rollback on failure (rollbackRestoreSnapshot), and converts/updates segment/index metadata only after successful copy tasks. Extensive unit and integration tests exercise pending/deleting/GC/restore/error paths to ensure idempotence and protection against premature deletion. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Wei Liu <wei.liu@zilliz.com>
120 lines
4.5 KiB
Go
120 lines
4.5 KiB
Go
// Licensed to the LF AI & Data foundation under one
|
|
// or more contributor license agreements. See the NOTICE file
|
|
// distributed with this work for additional information
|
|
// regarding copyright ownership. The ASF licenses this file
|
|
// to you under the Apache License, Version 2.0 (the
|
|
// "License"); you may not use this file except in compliance
|
|
// with the License. You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package datacoord
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"time"
|
|
|
|
"go.uber.org/zap"
|
|
|
|
"github.com/milvus-io/milvus/pkg/v2/log"
|
|
"github.com/milvus-io/milvus/pkg/v2/proto/datapb"
|
|
"github.com/milvus-io/milvus/pkg/v2/streaming/util/message"
|
|
)
|
|
|
|
// createSnapshotV2AckCallback handles the callback for CreateSnapshot DDL message.
|
|
// ID allocation happens inside SnapshotManager.CreateSnapshot.
|
|
func (s *DDLCallbacks) createSnapshotV2AckCallback(ctx context.Context, result message.BroadcastResultCreateSnapshotMessageV2) error {
|
|
header := result.Message.Header()
|
|
log := log.Ctx(ctx).With(
|
|
zap.Int64("collectionID", header.CollectionId),
|
|
zap.String("snapshotName", header.Name),
|
|
)
|
|
log.Info("createSnapshotV2AckCallback received")
|
|
|
|
// Create snapshot - ID is allocated inside CreateSnapshot
|
|
snapshotID, err := s.snapshotManager.CreateSnapshot(ctx, header.CollectionId, header.Name, header.Description)
|
|
if err != nil {
|
|
log.Error("failed to create snapshot via DDL callback", zap.Error(err))
|
|
return err
|
|
}
|
|
|
|
log.Info("snapshot created successfully via DDL callback", zap.Int64("snapshotID", snapshotID))
|
|
return nil
|
|
}
|
|
|
|
// dropSnapshotV2AckCallback handles the callback for DropSnapshot DDL message.
|
|
func (s *DDLCallbacks) dropSnapshotV2AckCallback(ctx context.Context, result message.BroadcastResultDropSnapshotMessageV2) error {
|
|
header := result.Message.Header()
|
|
log := log.Ctx(ctx).With(zap.String("snapshotName", header.Name))
|
|
log.Info("dropSnapshotV2AckCallback received")
|
|
|
|
// Delete snapshot using SnapshotManager interface (idempotent)
|
|
if err := s.snapshotManager.DropSnapshot(ctx, header.Name); err != nil {
|
|
log.Error("failed to drop snapshot via DDL callback", zap.Error(err))
|
|
return err
|
|
}
|
|
|
|
log.Info("snapshot dropped successfully via DDL callback")
|
|
return nil
|
|
}
|
|
|
|
// restoreSnapshotV2AckCallback handles the callback for RestoreSnapshot DDL message.
|
|
// It creates copy segment jobs for data restoration.
|
|
// NOTE: RestoreIndexes is now called synchronously in services.go before broadcast.
|
|
// NOTE: jobID is pre-allocated in RestoreSnapshot and passed via WAL message for idempotency.
|
|
func (s *DDLCallbacks) restoreSnapshotV2AckCallback(ctx context.Context, result message.BroadcastResultRestoreSnapshotMessageV2) error {
|
|
header := result.Message.Header()
|
|
log := log.Ctx(ctx).With(
|
|
zap.String("snapshotName", header.SnapshotName),
|
|
zap.Int64("collectionID", header.CollectionId),
|
|
zap.Int64("jobID", header.JobId),
|
|
)
|
|
log.Info("restoreSnapshotV2AckCallback received")
|
|
|
|
// Read snapshot data
|
|
snapshotData, err := s.snapshotManager.ReadSnapshotData(ctx, header.SnapshotName)
|
|
if err != nil {
|
|
log.Error("failed to read snapshot data", zap.Error(err))
|
|
return err
|
|
}
|
|
|
|
// Restore data (create copy segment job)
|
|
// Use the pre-allocated jobID from the WAL message for idempotency
|
|
jobID, err := s.snapshotManager.RestoreData(ctx, snapshotData, header.CollectionId, header.JobId)
|
|
if err != nil {
|
|
log.Error("failed to restore data", zap.Error(err))
|
|
return err
|
|
}
|
|
|
|
// Wait for restore to complete, checking for both success and failure states
|
|
for {
|
|
state, err := s.snapshotManager.GetRestoreState(ctx, jobID)
|
|
if err != nil {
|
|
log.Error("failed to get restore state", zap.Error(err))
|
|
return err
|
|
}
|
|
log.Info("restore snapshot state", zap.Any("state", state))
|
|
|
|
// Check for failure state to avoid infinite loop
|
|
if state.GetState() == datapb.RestoreSnapshotState_RestoreSnapshotFailed {
|
|
log.Error("restore snapshot failed", zap.String("reason", state.GetReason()))
|
|
return fmt.Errorf("restore snapshot failed: %s", state.GetReason())
|
|
}
|
|
|
|
if state.GetProgress() == 100 || state.GetState() == datapb.RestoreSnapshotState_RestoreSnapshotCompleted {
|
|
break
|
|
}
|
|
time.Sleep(1 * time.Second)
|
|
}
|
|
|
|
log.Info("restore snapshot callback completed", zap.Int64("jobID", jobID))
|
|
return nil
|
|
}
|