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

     1  
     2  
     3  
     4  
     5  
     6  
     7  ## *RunConfig*
     8  Root of the config file
     9  
    10  
    11  ### Fields
    12  
    13  <dl>
    14  <dt>
    15  	<code>name</code>  <strong>string</strong>  - required
    16  </dt>
    17  
    18  <dd>
    19  
    20  Name of the upgrade.
    21  
    22  
    23  <blockquote>It is recommended to use the Vega version you wish to upgrade to as the name. These can be found in the releases list of the Vega Github repository
    24  (https://github.com/vegaprotocol/vega/releases).
    25  </blockquote>
    26  </dd>
    27  
    28  <dt>
    29  	<code>vega</code>  <strong><a href="#vegaconfig">VegaConfig</a></strong>  - required
    30  </dt>
    31  
    32  <dd>
    33  
    34  Configuration of a Vega node.
    35  
    36  </dd>
    37  
    38  <dt>
    39  	<code>data_node</code>  <strong><a href="#datanodeconfig">DataNodeConfig</a></strong>  - optional
    40  </dt>
    41  
    42  <dd>
    43  
    44  Configuration of a data node.
    45  
    46  </dd>
    47  
    48  
    49  
    50  ### Complete example
    51  
    52  
    53  ```hcl
    54  name = "v1.65.0"
    55  
    56  [vega]
    57   [vega.binary]
    58    path = "/path/vega-binary"
    59    args = ["--arg1", "val1", "--arg2"]
    60   [vega.rpc]
    61    socketPath = "/path/socket.sock"
    62    httpPath = "/rpc"
    63  
    64  ```
    65  
    66  
    67  </dl>
    68  
    69  ---
    70  
    71  
    72  ## *VegaConfig*
    73  Configuration options for the Vega binary and its arguments.
    74  
    75  
    76  ### Fields
    77  
    78  <dl>
    79  <dt>
    80  	<code>binary</code>  <strong><a href="#binaryconfig">BinaryConfig</a></strong>  - required
    81  </dt>
    82  
    83  <dd>
    84  
    85  Configuration of Vega binary and the arguments to run it.
    86  
    87  </dd>
    88  
    89  <dt>
    90  	<code>rpc</code>  <strong><a href="#rpcconfig">RPCConfig</a></strong>  - required
    91  </dt>
    92  
    93  <dd>
    94  
    95  Visor communicates with the core node via RPC API that runs over a UNIX socket.
    96  This parameter configures the UNIX socket to match the core node configuration.
    97  This value can be found in the config.toml file used by the core node under the heading [Admin.Server]
    98  
    99  
   100  </dd>
   101  
   102  
   103  
   104  ### Complete example
   105  
   106  
   107  ```hcl
   108  [vega]
   109   [vega.binary]
   110    path = "/path/vega-binary"
   111    args = ["--arg1", "val1", "--arg2"]
   112   [vega.rpc]
   113    socketPath = "/path/socket.sock"
   114    httpPath = "/rpc"
   115  
   116  ```
   117  
   118  
   119  </dl>
   120  
   121  ---
   122  
   123  
   124  ## *DataNodeConfig*
   125  Configures a data node binary and its arguments.
   126  
   127  
   128  ### Fields
   129  
   130  <dl>
   131  <dt>
   132  	<code>binary</code>  <strong><a href="#binaryconfig">BinaryConfig</a></strong>  - required
   133  </dt>
   134  
   135  <dd>
   136  
   137  
   138  
   139  </dd>
   140  
   141  
   142  
   143  ### Complete example
   144  
   145  
   146  ```hcl
   147  [data_node]
   148   [data_node.binary]
   149    path = "/path/data-node-binary"
   150    args = ["--arg1", "val1", "--arg2"]
   151  
   152  ```
   153  
   154  
   155  </dl>
   156  
   157  ---
   158  
   159  
   160  ## *BinaryConfig*
   161  Configuration options for the Vega binary and its arguments.
   162  
   163  
   164  ### Fields
   165  
   166  <dl>
   167  <dt>
   168  	<code>path</code>  <strong>string</strong>  - required
   169  </dt>
   170  
   171  <dd>
   172  
   173  Path to the Vega binary.
   174  
   175  
   176  <blockquote>The absolute or relative path can be used.
   177  Relative path is relative to a parent folder of this config file.
   178  </blockquote>
   179  </dd>
   180  
   181  <dt>
   182  	<code>args</code>  <strong>[]string</strong>  - required
   183  </dt>
   184  
   185  <dd>
   186  
   187  Arguments that will be applied to the binary.
   188  
   189  
   190  <blockquote>Each element the list represents one space separated argument.
   191  </blockquote>
   192  </dd>
   193  
   194  
   195  
   196  ### Complete example
   197  
   198  
   199  ```hcl
   200  path = "/path/binary"
   201  args = ["--arg1", "val1", "--arg2"]
   202  
   203  ```
   204  
   205  
   206  </dl>
   207  
   208  ---
   209  
   210  
   211  ## *RPCConfig*
   212  Configures a connection to a core nodes exposed UNIX socket RPC API.
   213  
   214  
   215  ### Fields
   216  
   217  <dl>
   218  <dt>
   219  	<code>socketPath</code>  <strong>string</strong>  - required
   220  </dt>
   221  
   222  <dd>
   223  
   224  Path of the mounted socket.
   225  
   226  
   227  <blockquote>This path can be configured in the Vega core node configuration and can be found in the [Admin.Server] section.</blockquote>
   228  </dd>
   229  
   230  <dt>
   231  	<code>httpPath</code>  <strong>string</strong>  - required
   232  </dt>
   233  
   234  <dd>
   235  
   236  HTTP path of the socket path.
   237  
   238  
   239  <blockquote>This path can be configured in the Vega core node configuration and can be found in the [Admin.Server] section.</blockquote>
   240  </dd>
   241  
   242  
   243  
   244  ### Complete example
   245  
   246  
   247  ```hcl
   248  [vega.rpc]
   249   socketPath = "/path/socket.sock"
   250   httpPath = "/rpc"
   251  
   252  ```
   253  
   254  
   255  </dl>
   256  
   257  ---
   258  
   259