Class: Pvectl::Services::Backup

Inherits:
Object
  • Object
show all
Defined in:
lib/pvectl/services/backup.rb

Overview

Orchestrates backup operations.

Handles creating, listing, deleting, and restoring backups for VMs and containers with multi-ID support and error handling.

Examples:

Basic usage

service = Backup.new(
  backup_repo: backup_repo,
  resource_resolver: resolver,
  task_repo: task_repo
)
backups = service.list(vmid: 100)

Constant Summary collapse

DEFAULT_TIMEOUT =

5 minutes for backups

300

Instance Method Summary collapse

Constructor Details

#initialize(backup_repo:, resource_resolver:, task_repo:, options: {}) ⇒ Backup

Creates a new Backup service.

Parameters:



27
28
29
30
31
32
 
# File 'lib/pvectl/services/backup.rb', line 27

def initialize(backup_repo:, resource_resolver:, task_repo:, options: {})
  @backup_repo = backup_repo
  @resolver = resource_resolver
  @task_repo = task_repo
  @options = options
end

Instance Method Details

#create(vmids, storage:, mode: "snapshot", compress: "zstd", notes: nil, protected: false) ⇒ Array<Models::OperationResult>

Creates backups for multiple VMs.

Parameters:

  • vmids (Array<Integer>) —

    VM IDs

  • storage (String) —

    target storage

  • mode (String) (defaults to: "snapshot") —

    backup mode (snapshot/suspend/stop)

  • compress (String) (defaults to: "zstd") —

    compression (zstd/gzip/lzo/0)

  • notes (String, nil) (defaults to: nil) —

    backup notes

  • protected (Boolean) (defaults to: false) —

    protect backup

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/pvectl/services/backup.rb', line 52

def create(vmids, storage:, mode: "snapshot", compress: "zstd", notes: nil, protected: false)
  resources = @resolver.resolve_multiple(vmids)
  return [] if resources.empty?

  execute_multi(resources, :create) do |resource|
    @backup_repo.create(
      resource[:vmid],
      resource[:node],
      storage: storage,
      mode: mode,
      compress: compress,
      notes: notes,
      protected: protected
    )
  end
end

#delete(volid) ⇒ Models::OperationResult

Deletes a backup.

Parameters:

  • volid (String) —

    backup volume ID

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/pvectl/services/backup.rb', line 73

def delete(volid)
  node = find_node_for_volid(volid)

  upid = @backup_repo.delete(volid, node)

  if @options[:async]
    Models::OperationResult.new(
      resource: { volid: volid, node: node },
      operation: :delete,
      task_upid: upid,
      success: :pending
    )
  else
    task = @task_repo.wait(upid, timeout: timeout)
    Models::OperationResult.new(
      resource: { volid: volid, node: node },
      operation: :delete,
      task: task,
      success: task.successful?
    )
  end
rescue StandardError => e
  Models::OperationResult.new(
    resource: { volid: volid },
    operation: :delete,
    success: false,
    error: e.message
  )
end

#list(vmid: nil, storage: nil) ⇒ Array<Models::Backup>

Lists backups with optional filtering.

Parameters:

  • vmid (Integer, nil) (defaults to: nil) —

    filter by VM ID

  • storage (String, nil) (defaults to: nil) —

    filter by storage

Returns:



39
40
41
 
# File 'lib/pvectl/services/backup.rb', line 39

def list(vmid: nil, storage: nil)
  @backup_repo.list(vmid: vmid, storage: storage)
end

#restore(volid, vmid:, storage: nil, force: false, start: false, unique: false) ⇒ Models::OperationResult

Restores a backup to a VM/container.

Parameters:

  • volid (String) —

    backup volume ID

  • vmid (Integer) —

    target VM ID

  • storage (String, nil) (defaults to: nil) —

    target storage

  • force (Boolean) (defaults to: false) —

    overwrite existing

  • start (Boolean) (defaults to: false) —

    start after restore

  • unique (Boolean) (defaults to: false) —

    regenerate unique properties

Returns:



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/pvectl/services/backup.rb', line 112

def restore(volid, vmid:, storage: nil, force: false, start: false, unique: false)
  node = find_node_for_volid(volid)

  upid = @backup_repo.restore(
    volid,
    node,
    vmid: vmid,
    storage: storage,
    force: force,
    start: start,
    unique: unique
  )

  if @options[:async]
    Models::OperationResult.new(
      resource: { volid: volid, vmid: vmid, node: node },
      operation: :restore,
      task_upid: upid,
      success: :pending
    )
  else
    task = @task_repo.wait(upid, timeout: timeout)
    Models::OperationResult.new(
      resource: { volid: volid, vmid: vmid, node: node },
      operation: :restore,
      task: task,
      success: task.successful?
    )
  end
rescue StandardError => e
  Models::OperationResult.new(
    resource: { volid: volid, vmid: vmid },
    operation: :restore,
    success: false,
    error: e.message
  )
end