code.vegaprotocol.io/vega@v0.79.0/visor/visor-config.md (about)

     1  
     2  
     3  
     4  
     5  
     6  
     7  ## *VisorConfigFile*
     8  Root of the config file
     9  
    10  
    11  ### Fields
    12  
    13  <dl>
    14  <dt>
    15  	<code>maxNumberOfFirstConnectionRetries</code>  <strong>int</strong>  - optional
    16  </dt>
    17  
    18  <dd>
    19  
    20  Visor communicates with the core node via RPC API.
    21  This variable allows a validator to specify how many times Visor should try to establish a connection to the core node before the Visor process fails.
    22  The `maxNumberOfFirstConnectionRetries` is only taken into account during the first start up of the Core node process - not restarts.
    23  
    24  
    25  
    26  Default value: <code>10</code>
    27  
    28  <blockquote>There is a 2 second delay between each attempt. Setting the max retry number to 5 means Visor will try to establish a connection 5 times in 10 seconds.
    29  </blockquote>
    30  </dd>
    31  
    32  <dt>
    33  	<code>maxNumberOfRestarts</code>  <strong>int</strong>  - optional
    34  </dt>
    35  
    36  <dd>
    37  
    38  Defines the maximum number of restarts in case any of
    39  the processes have failed before the Visor process fails.
    40  
    41  
    42  
    43  Default value: <code>3</code>
    44  
    45  <blockquote>The amount of time Visor waits between restarts can be set by `restartsDelaySeconds`.
    46  </blockquote>
    47  </dd>
    48  
    49  <dt>
    50  	<code>restartsDelaySeconds</code>  <strong>int</strong>  - optional
    51  </dt>
    52  
    53  <dd>
    54  
    55  Number of seconds that Visor waits before it tries to re-start the processes.
    56  
    57  
    58  
    59  Default value: <code>5</code>
    60  </dd>
    61  
    62  <dt>
    63  	<code>stopDelaySeconds</code>  <strong>int</strong>  - optional
    64  </dt>
    65  
    66  <dd>
    67  
    68  Number of seconds that Visor waits before it sends a termination signal (SIGTERM) to running processes
    69  that are ready for upgrade.
    70  After the time has elapsed Visor stops the running binaries (SIGTERM).
    71  
    72  
    73  
    74  Default value: <code>0</code>
    75  </dd>
    76  
    77  <dt>
    78  	<code>stopSignalTimeoutSeconds</code>  <strong>int</strong>  - optional
    79  </dt>
    80  
    81  <dd>
    82  
    83  Number of seconds that Visor waits after it sends termination signal (SIGTERM) to running processes.
    84  After the time has elapsed Visor force-kills (SIGKILL) any running processes.
    85  
    86  
    87  
    88  Default value: <code>15</code>
    89  </dd>
    90  
    91  <dt>
    92  	<code>upgradeFolders</code>  <strong>map[string]string</strong>  - optional
    93  </dt>
    94  
    95  <dd>
    96  
    97  During the upgrade, by default Visor looks for a folder with a name identical to the upgrade version.
    98  The default behaviour can be changed by providing mapping between `version` and `custom_folder_name`.
    99  If a custom mapping is provided, during the upgrade Visor uses the folder given in the mapping for specific version.
   100  
   101  
   102  </dd>
   103  
   104  <dt>
   105  	<code>autoInstall</code>  <strong><a href="#autoinstallconfig">AutoInstallConfig</a></strong>  - required
   106  </dt>
   107  
   108  <dd>
   109  
   110  Defines the assets that should be automatically downloaded from Github for a specific release.
   111  
   112  
   113  </dd>
   114  
   115  
   116  
   117  ### Complete example
   118  
   119  
   120  ```hcl
   121  maxNumberOfRestarts = 3
   122  restartsDelaySeconds = 5
   123  
   124  [upgradeFolders]
   125   "vX.X.X" = "vX.X.X"
   126  
   127  [autoInstall]
   128   enabled = false
   129  
   130  ```
   131  
   132  
   133  </dl>
   134  
   135  ---
   136  
   137  
   138  ## *AutoInstallConfig*
   139  Determines if the assets should be automatically downloaded and installed. If so this defines the assets that should be downloaded from GitHub for a specific release.
   140  
   141  
   142  ### Fields
   143  
   144  <dl>
   145  <dt>
   146  	<code>enabled</code>  <strong>bool</strong>  - required
   147  </dt>
   148  
   149  <dd>
   150  
   151  Auto Install flag
   152  
   153  
   154  Default value: <code>true</code>
   155  </dd>
   156  
   157  <dt>
   158  	<code>repositoryOwner</code>  <strong>string</strong>  - required
   159  </dt>
   160  
   161  <dd>
   162  
   163  Owner of the repository from where the assets should be downloaded.
   164  
   165  
   166  Default value: <code>vegaprotocol</code>
   167  </dd>
   168  
   169  <dt>
   170  	<code>repository</code>  <strong>string</strong>  - required
   171  </dt>
   172  
   173  <dd>
   174  
   175  Name of the repository from where the assets should be downloaded.
   176  
   177  
   178  Default value: <code>vega</code>
   179  </dd>
   180  
   181  <dt>
   182  	<code>asset</code>  <strong><a href="#assetsconfig">AssetsConfig</a></strong>  - required
   183  </dt>
   184  
   185  <dd>
   186  
   187  Definition of the asset that should be downloaded from the GitHub repository.
   188  If the asset is contained in a zip file, the name of the binary is given.
   189  
   190  
   191  </dd>
   192  
   193  
   194  
   195  ### Complete example
   196  
   197  
   198  ```hcl
   199  [autoInstall]
   200   enabled = true
   201   repositoryOwner = "vegaprotocol"
   202   repository = "vega"
   203   [autoInstall.asset]
   204    name = "vega-darwin-amd64.zip"
   205    binaryName = "vega"
   206  
   207  ```
   208  
   209  
   210  </dl>
   211  
   212  ---
   213  
   214  
   215  ## *AssetsConfig*
   216  Defines the name of the asset to be downloaded.
   217  
   218  
   219  ### Fields
   220  
   221  <dl>
   222  <dt>
   223  	<code>name</code>  <strong>string</strong>  - required
   224  </dt>
   225  
   226  <dd>
   227  
   228  Name of the asset file on Github.
   229  
   230  </dd>
   231  
   232  <dt>
   233  	<code>binaryName</code>  <strong>string</strong>  - optional
   234  </dt>
   235  
   236  <dd>
   237  
   238  Name of the binary if the asset is a zip file and the binary is included inside of it.
   239  
   240  
   241  </dd>
   242  
   243  
   244  
   245  </dl>
   246  
   247  ---
   248  
   249