Revision 855f9bad man/ganeti-extstorage-interface.rst

b/man/ganeti-extstorage-interface.rst
21 21
REFERENCE
22 22
---------
23 23

  
24
There are seven required files: *create*, *attach*, *detach*, *remove*,
25
*grow*, *verify* (executables) and *parameters.list* (text file).
24
There are eight required files: *create*, *attach*, *detach*, *remove*,
25
*grow*, *setinfo*, *verify* (executables) and *parameters.list*
26
(text file).
26 27

  
27 28
Common environment
28 29
~~~~~~~~~~~~~~~~~~
......
57 58
    variable, prefixed with ``EXTP_``, and upper-cased. For example, a
58 59
    ``fromsnap`` parameter will be exported as ``EXTP_FROMSNAP``.
59 60

  
61
VOL_METADATA
62
    Available only to the **setinfo** script. A string containing
63
    metadata to be associated with the volume. Currently, Ganeti sets
64
    this value to ``originstname+X`` where ``X`` is the instance's name.
65

  
60 66
EXECUTABLE SCRIPTS
61 67
------------------
62 68

  
......
159 165

  
160 166
The script returns ``0`` on success.
161 167

  
168
setinfo
169
~~~~~~~
170

  
171
This script is used to add metadata to an existing volume. It is helpful
172
when we need to keep an external, Ganeti-independent mapping between
173
instances and volumes; primarily for recovery reasons. This is provider
174
specific and the author of the provider chooses whether/how to implement
175
this. You can just exit with ``0``, if you do not want to implement this
176
feature, without harming the overall functionality of the provider.
177

  
178
The ``VOL_METADATA`` variable contains the metadata of the volume.
179

  
180
Currently, Ganeti sets this value to ``originstname+X`` where ``X`` is
181
the instance's name.
182

  
183
The script returns ``0`` on success.
184

  
162 185
verify
163 186
~~~~~~
164 187

  
......
196 219
Backwards compatibility
197 220
~~~~~~~~~~~~~~~~~~~~~~~
198 221

  
199
The ExtStorage Interface was introduced in Ganeti 2.6.
200
Ganeti 2.6 and up is compatible with the ExtStorage Interface.
222
The ExtStorage Interface was introduced in Ganeti 2.7.
223
Ganeti 2.7 and up is compatible with the ExtStorage Interface.
201 224

  
202 225
Common behaviour
203 226
~~~~~~~~~~~~~~~~

Also available in: Unified diff