9. Server command line reference
The vipu-server
command line has the following syntax:
vipu-server [GlobalOptions]
$ vipu-server --storage /opt/vipu-server/vipu-server.json
9.1. Global options
Global options work with all vipu-server
commands. You can also pass global options
as environment variables or in a configuration file.
Option |
Description |
---|---|
|
A comma separated list of network interface names where the agent autodiscovery service will listen for multicast messages from the V-IPU agents (default: autodiscovery service disabled) |
|
Returns whether the storage needs to be migrated by running vipu-server –migrate-db |
|
Choose a configuration file explicitly; do not look in the default locations |
|
Provides a default user ID that will be used to administer the server when running in secure mode (default: admin) (default |
|
When using this option vipu-server will run the builtin V-IPU prometheus metrics exporter (default: exporter is disabled) |
|
Address and port where the prometheus metrics exporter will listen to. Metrics will be available over HTTP. (default: “:2113”) (default |
|
URL where the exporter metrics will be exposed from (default: “/metrics”) (default |
|
Initialise server storage and security |
|
The server listening address for the admin API (default “:8090”) (default |
|
The server listening address for the user-only API (default: disabled; both admin and user APIs are served by the address defined with the “–listen” option) |
|
Server only listens to the local unix socket ignoring the “–listen” / “–listen-user” options (default: server listens to both the addresses defined by “–listen” / “–listen-user” and a local socket) |
|
Specifies maximum partition mapping options to send (default 64) |
|
Specifies maximum partition option retries in the controller (default 10) |
|
Specifies maximum partition option retries without new allocation in the controller (default 2) |
|
Migrate storage to the next DB schema version. Please ensure you have a backup of your DB before migrating. This will look for the “vipu-server.json” file to update in the current directory, unless you specify a different location with “–storage” |
|
Specifies partition health check interval in seconds (default 60) |
|
Specifies partition operation retry interval in seconds (default 60) |
|
Points to a file where the server will write the V-IPU exporter entries associated with the managed V-IPU agents. This file is in a JSON format compatible with the prometheus file-based discovery service (https://prometheus.io/docs/guides/file-sd/) |
|
Specifies whether relocatable partitions will be used by default or not (default true) |
|
Run server in the secure mode |
|
The path where the server local unix socket will be created to (default: “./vipu-server.sock”) (default |
|
File for storing server state in (default “./vipu-server.json”) (default |
|
Initialise the server storage state. “vipu-server” must be called explicitly with this option the very first time to initialise the server storage |
|
Timeout for the agent calls (default 200) |
|
Generate server/client TLS certificates |
|
Show the version number |
9.1.1. Using a configuration file
All the options listed in Section 9.1, Global options can be overridden with a
vipu-server
configuration file. The option names in the configuration
file are identical but without the leading hyphens. For example, if you start vipu-server
with
the following command from the shell:
$ vipu-server --listen :8100 --exporter-activate --exporter-listen localhost:2113
The corresponding vipu-server
options can be overridden in a configuration file that looks
like this:
// Listens to the non-default port 8100
listen = ":8100"
// Activates the V-IPU exporter
exporter-activate = true
// V-IPU exporter only listens to localhost:2113
exporter-listen = "localhost:2113"
The server will look for a configuration file in the following ordered list of directories and will load the first configuration file found:
Configuration file provided with the
--config
option./.vipu-server-config.hcl
$HOME/.vipu-server-config.hcl
/etc/vipu/vipu-server-config.hcl
9.1.2. Using environment variables
All the options listed in Section 9.1, Global options can be overridden using
environment variables using the syntax: VIPU_SERVER_OPTION_NAME
.
Everything should be upper case and without the leading hyphens. The remaining
hyphens (-
) should be replaced by underscores (_
). For example, if you start
vipu-server
with the following command from the shell:
$ vipu-server --listen :8100 --exporter-activate --exporter-listen localhost:2113
The corresponding options can be specified with the following environment variables:
$ export VIPU_SERVER_LISTEN=":8100"
$ export VIPU_SERVER_EXPORTER_ACTIVATE="true"
$ export VIPU_SERVER_EXPORTER_LISTEN="localhost:2113"