Skip to main content

run

Run Spice - starts the Spice runtime, installing if necessary.

Usage​

spice run [flags]
spice run [flags] -- [spiced flags]

Flags​

  • -h, --help Print this help message.
  • --flight-endpoint Configure runtime Flight endpoint. Defaults to http://127.0.0.1:50051.
  • --http-endpoint Configure runtime HTTP endpoint. Defaults to http://127.0.0.1:8090.
  • --metrics-endpoint Configure runtime Prometheus metrics endpoint. Defaults to http://127.0.0.1:9090.
  • --open-telemetry-endpoint Configure runtime OpenTelemetry endpoint. Defaults to http://127.0.0.1:50052.
  • --captured-outputs Configure the captured output setting for task history. Defaults to truncated.

Spiced Flags​

Flags that are passed to the spiced runtime directly.

  • --http Configure runtime HTTP address [default: 127.0.0.1:8090]
  • --flight Configure runtime Flight address [default: 127.0.0.1:50051]
  • --open_telemetry Configure runtime OpenTelemetry address [default: 127.0.0.1:50052]
  • --tls-enabled Enable TLS
  • --tls-certificate The TLS PEM-encoded certificate
  • --tls-certificate-file Path to the TLS PEM-encoded certificate file
  • --tls-key The TLS PEM-encoded key
  • --tls-key-file Path to the TLS PEM-encoded key file
  • --set-runtime Override runtime configuration with a name/value pair specified as name=value. Multiple overrides can be specified by using the flag multiple times.

Examples​

--set-runtime​

The --set-runtime flag allows overriding runtime configuration values. It can be specified multiple times to set multiple values. It is used like this: --set-runtime name=value. The Spicepod YAML equivalent of that is:

runtime:
  name: value

Examples:

--set-runtime task_history.captured_output=none:

runtime:
  task_history:
    captured_output: none

--set-runtime results_cache.enabled=false:

runtime:
  results_cache:
    enabled: false

--set-runtime runtime.tls.enabled=true --set-runtime runtime.tls.certificate_file=/path/to/cert.pem --set-runtime runtime.tls.key_file=/path/to/key.pem:

runtime:
  tls:
    enabled: true
    certificate_file: /path/to/cert.pem
    key_file: /path/to/key.pem

No arguments​

spice run

--captured-outputs none​

# Set task history captured outputs to none
spice run -- --captured-outputs none

--http​

# Expose the HTTP server on all interfaces
spice run -- --http 0.0.0.0:8090

--flight​

# Expose the HTTP & Flight servers on all interfaces with TLS
spice run -- --http 0.0.0.0:8090 --flight 0.0.0.0:50051 --tls-enabled true --tls-certificate-file /path/to/cert.pem --tls-key-file /path/to/key.pem

--open_telemetry​

# Run Spice with OpenTelemetry enabled
spice run -- --open_telemetry 0.0.0.0:50052