/
volume.rb
148 lines (135 loc) · 3.47 KB
/
volume.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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
102
103
104
105
106
107
108
109
110
111
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
# frozen_string_literal: true
module HCloud
##
# Represents a volume
#
# == List all volumes
#
# HCloud::Volume.all
# # => [#<HCloud::Volume id: 1, ...>, ...]
#
# == Sort volumes
#
# HCloud::Volume.sort(name: :desc)
# # => [#<HCloud::Volume id: 1, ...>, ...]
#
# HCloud::Volume.sort(:id, name: :asc)
# # => [#<HCloud::Volume id: 1, ...>, ...]
#
# == Search volumes
#
# HCloud::Volume.where(name: "my_volume")
# # => #<HCloud::Volume id: 1, ...>
#
# HCloud::Volume.where(status: "available")
# # => #<HCloud::Volume id: 1, ...>
#
# HCloud::Volume.where(label_selector: { environment: "production" })
# # => #<HCloud::Volume id: 1, ...>
#
# == Find volume by ID
#
# HCloud::Volume.find(1)
# # => #<HCloud::Volume id: 1, ...>
#
# == Create volume
#
# volume = HCloud::Volume.new(name: "my_volume", size: 10, format: "ext4", automount: false, location: "fsn1")
# volume.create
# volume.created?
# # => true
#
# firewall = HCloud::Volume.create(name: "my_volume", size: 10, format: "ext4", automount: false, location: "fsn1")
# # => #<HCloud::Volume id: 1, ...>
#
# == Update volume
#
# volume = HCloud::Volume.find(1)
# volume.name = "another_volume"
# volume.update
#
# == Delete volume
#
# volume = HCloud::Volume.find(1)
# volume.delete
# volume.deleted?
# # => true
#
# = Actions
# == List actions
#
# actions = HCloud::Volume.find(1).actions
# # => [#<HCloud::Action id: 1, ...>, ...]
#
# == Sort actions
#
# HCloud::Volume.find(1).actions.sort(finished: :desc)
# # => [#<HCloud::Action id: 1, ...>, ...]
#
# HCloud::Volume.find(1).actions.sort(:command, finished: :asc)
# # => [#<HCloud::Actions id: 1, ...>, ...]
#
# == Search actions
#
# HCloud::Volume.find(1).actions.where(command: "create_volume")
# # => #<HCloud::Action id: 1, ...>
#
# HCloud::Volume.find(1).actions.where(status: "success")
# # => #<HCloud::Action id: 1, ...>
#
# == Find action by ID
#
# HCloud::Volume.find(1).actions.find(1)
# # => #<HCloud::Action id: 1, ...>
#
# = Resource-specific actions
# == Attach a volume to a server
#
# HCloud::Volume.find(1).attach(server: 1, automount: false)
# # => #<HCloud::Action id: 1, ...>
#
# == Detach a volume from a server
#
# HCloud::Volume.find(1).detach
# # => #<HCloud::Action id: 1, ...>
#
# == Resize volume
#
# HCloud::Volume.find(1).resize(size: 25)
# # => #<HCloud::Action id: 1, ...>
#
# == Change protection
#
# HCloud::Volume.find(1).change_protection(delete: true)
# # => #<HCloud::Action id: 1, ...>
#
class Volume < Resource
actionable
queryable
creatable
updatable
deletable
labelable
attribute :id, :integer
attribute :name
attribute :format
attribute :size, :integer
attribute :linux_device
attribute :status
attribute :automount, :boolean
attribute :location, :location
attribute :protection, :protection
attribute :server, :server
alias automount? automount
action :attach
action :detach
action :resize
action :change_protection
def creatable_attributes
[:name, :format, :size, :server, :automount, :labels, location: [:id, :name]]
end
def updatable_attributes
[:name, :labels]
end
end
end