Skip to content

vor serve

vor serve

Run the Super or SDK services

Synopsis

These commands start an instance of the Super API or SDK gRPC service. Config values are read with the following precedence: command-line flags, environment variables, config file. Environment variables are of the format: VOR_STREAM_ where "_" replaces "-". For example, the environment variable equivalent of --http-addr is VOR_STREAM_HTTP_ADDR. A config file skeleton with all defaults can be generated by running "vor serve --write-config-skeleton ".

vor serve [flags]

Options

      --cfg string                              Name of the configuration file for the server
      --django-cacert string                    Path to CA Certificate to trust when making Django HTTP requests
      --django-request-timeout duration         Timeout to use when making Django HTTP requests (default 10s)
      --email-host string                       Email host to use
      --email-port string                       Email port to use
      --email-sender string                     Email address used to send emails
      --email-vault-path string                 Path to email vault secrets
      --ha                                      Run the server in HA mode
  -h, --help                                    help for serve
      --http-addr string                        Host and port to listen on (schema is optional, defaults to TLS off)
      --log-level string                        Logging level to use: trace, debug, info, warn, error, or fatal (default "info")
      --oidc-callback-host string               Host and port to forward OIDC callbacks to (used for CLI auth) (default "localhost:8250")
      --oidc-config-vault-path string           Path to a location in Vault containing the OIDC configuration (default "kv/data/oidc-config")
      --rabbitmq-password string                RabbitMQ password to use
      --rabbitmq-user string                    RabbitMQ username to use
      --rabbitmq-vault-path string              Path to RabbitMQ vault secrets
      --sdk                                     Run the SDK API
      --sentry-dsn string                       Sentry DSN to send events to
      --sentry-environment string               Environment to attach to Sentry events
      --sentry-traces-sample-rate float         Sentry traces sample rate to use (0 disables tracing)
      --super-django-cache-ttl duration         Django user groups cache TTL (applicable to Super only) (default 1m0s)
      --super-docs-dir string                   Directory for playpen documentation (applicable to Super only) (default "/tmp/static")
      --super-logs-dir string                   Directory for storing operation logs (applicable to Super only) (default "/tmp/logs")
      --super-node-http-timeout duration        Request timeout for node REST calls to the Super API; 0 keeps the runtime defaults of 10s for Python nodes and no timeout for Go nodes (applicable to Super only)
      --super-persistent-store-path string      KV path in Consul for persistent storage (applicable to Super only) (default "vor/super/persistence")
      --super-playpen-upgrade-enabled           Enable upgrading outdated playpens (applicable to Super only) (default true)
      --super-pprof                             Enable debug profiling (applicable to Super only)
      --super-python-command-timeout duration   Inactivity timeout for the Python node command-queue consumer; 0 keeps the 1s default (applicable to Super only)
      --super-queue-buffer-length int           Queue buffer length (applicable to Super only) (default 50)
      --super-queue-history-length int          Length of ratio window for expected counts (applicable to Super only) (default 10)
      --super-queue-limit int                   The limit on the number of observations waiting in a queue. Limits resources consumed by the messaging system.
      --super-queue-limit-wait int              The number of milliseconds between polling for the remaining observations on a queue. (default 10)
      --super-queue-prefetch int                Queue prefetch (applicable to Super only) (default 10)
      --super-queue-threads int                 Queue threads (applicable to Super only) (defaults to number of CPUs)
      --super-request-log-exclude strings       Request paths to exclude from trace logging (applicable to Super only) (default [/rest/version])
      --tls                                     Secure the service using TLS (overrides schema from --http-addr)
      --tls-cert string                         Path to PEM-encoded certificate to use when serving TLS
      --tls-key string                          Path to PEM-encoded key to use when serving TLS
      --umask int                               The umask setting to run the server process as (default 2)
      --vault-cacert string                     Path to Vault CA Cert to trust when making Vault requests
      --vault-namespace string                  Vault namespace to use (Enterprise or HCP Vault required)
      --vault-token-path string                 Path to Vault token to use
      --vhost string                            RabbitMQ vhost to use
      --write-config string                     Write the application configuration to file specified
      --write-config-skeleton string            Write a skeleton configuration to the file specified

Options inherited from parent commands

      --play string   playpen path
      --renew-token   renew token (default true)

SEE ALSO

  • vor - Streaming Process Flow for Financial Risk