Revision 375969eb man/hspace.rst

b/man/hspace.rst
10 10 
--------
11 11 

  		





  12
  12
  
    
**hspace** {backend options...} [algorithm options...] [request options...]


  		





  13
  
  
    
[ -p [*fields*] ] [-v... | -q]


  		





  
  13
  
    
[output options...] [-v... | -q]


  		





  14
  14
  
    

  		





  15
  15
  
    
**hspace** --version


  		





  16
  16
  
    

  		





  ......




  35
  35
  
    
**[--vcpus** *vcpus* **]**


  		





  36
  36
  
    
**[--tiered-alloc** *spec* **]**


  		





  37
  37
  
    

  		





  
  38
  
    
Output options:


  		





  
  39
  
    

  		





  
  40
  
    
**[--machine-readable**[=*CHOICE*] **]**


  		





  
  41
  
    
**[-p**[*fields*]**]**


  		





  
  42
  
    

  		





  38
  43
  
    

  		





  39
  44
  
    
DESCRIPTION


  		





  40
  45
  
    
-----------


  		





  ......




  48
  53
  
    
allocation. It uses the exact same allocation algorithm as the hail


  		





  49
  54
  
    
iallocator plugin in *allocate* mode.


  		





  50
  55
  
    

  		





  51
  
  
    
The output of the program is designed to interpreted as a shell


  		





  52
  
  
    
fragment (or parsed as a *key=value* file). Options which extend the


  		





  53
  
  
    
output (e.g. -p, -v) will output the additional information on stderr


  		





  54
  
  
    
(such that the stdout is still parseable).


  		





  
  56
  
    
The output of the program is designed either for human consumption (the


  		





  
  57
  
    
default) or, when enabled with the ``--machine-readable`` option


  		





  
  58
  
    
(described further below), for machine consumption. In the latter case,


  		





  
  59
  
    
it is intended to interpreted as a shell fragment (or parsed as a


  		





  
  60
  
    
*key=value* file). Options which extend the output (e.g. -p, -v) will


  		





  
  61
  
    
output the additional information on stderr (such that the stdout is


  		





  
  62
  
    
still parseable).


  		





  55
  63
  
    

  		





  56
  
  
    
The following keys are available in the output of the script (all


  		





  57
  
  
    
prefixed with *HTS_*):


  		





  
  64
  
    
The following keys are available in the machine-readable output of the


  		





  
  65
  
    
script (all prefixed with *HTS_*):


  		





  58
  66
  
    

  		





  59
  67
  
    
SPEC_MEM, SPEC_DSK, SPEC_CPU, SPEC_RQN, SPEC_DISK_TEMPLATE


  		





  60
  68
  
    
  These represent the specifications of the instance model used for


  		





  61
  69
  
    
  allocation (the memory, disk, cpu, requested nodes, disk template).


  		





  62
  70
  
    

  		





  63
  
  
    
TSPEC_INI_MEM, TSPEC_INI_DSK, TSPEC_INI_CPU


  		





  
  71
  
    
TSPEC_INI_MEM, TSPEC_INI_DSK, TSPEC_INI_CPU, ...


  		





  64
  72
  
    
  Only defined when the tiered mode allocation is enabled, these are


  		





  65
  73
  
    
  similar to the above specifications but show the initial starting spec


  		





  66
  74
  
    
  for tiered allocation.


  		





  ......




  185
  193
  
    
metrics will be also displayed with a TRL_ prefix, and denote the


  		





  186
  194
  
    
cluster status at the end of the tiered allocation run.


  		





  187
  195
  
    

  		





  
  196
  
    
The human output format should be self-explanatory, so it is not


  		





  
  197
  
    
described further.


  		





  
  198
  
    

  		





  188
  199
  
    
OPTIONS


  		





  189
  200
  
    
-------


  		





  190
  201
  
    

  		





  ......




  308
  319
  
    
  the instance count for these two modes are not related one to


  		





  309
  320
  
    
  another.


  		





  310
  321
  
    

  		





  
  322
  
    
--machines-readable[=*choice*]


  		





  
  323
  
    
  By default, the output of the program is in "human-readable" format,


  		





  
  324
  
    
  i.e. text descriptions. By passing this flag you can either enable


  		





  
  325
  
    
  (``--machine-readable`` or ``--machine-readable=yes``) or explicitly


  		





  
  326
  
    
  disable (``--machine-readable=no``) the machine readable format


  		





  
  327
  
    
  described above.


  		





  
  328
  
    

  		





  311
  329
  
    
-v, --verbose


  		





  312
  330
  
    
  Increase the output verbosity. Each usage of this option will


  		





  313
  331
  
    
  increase the verbosity (currently more than 2 doesn't make sense)


  		












Also available in:
  Unified diff