Service Configuration

Example YAML Config

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27


# Autogenerated
# Filename: nats-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9234
  token: ""
  pprof: false
  zpages: false
nats:
  host: 127.0.0.1
  port: 9233
  clusterid: ocis-cluster
  store_dir: /var/lib/ocis/nats
  tls_cert: /var/lib/ocis/nats/tls.crt
  tls_key: /var/lib/ocis/nats/tls.key
  tls_skip_verify_client_cert: false
  enable_tls: false

Environment Variables

Name	Type	Default Value	Description
OCIS_TRACING_ENABLED NATS_TRACING_ENABLED	bool	false	Activates tracing.
OCIS_TRACING_TYPE NATS_TRACING_TYPE	string		The type of tracing. Defaults to ‘’, which is the same as ‘jaeger’. Allowed tracing types are ‘jaeger’ and ’’ as of now.
OCIS_TRACING_ENDPOINT NATS_TRACING_ENDPOINT	string		The endpoint of the tracing agent.
OCIS_TRACING_COLLECTOR NATS_TRACING_COLLECTOR	string		The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset.
OCIS_LOG_LEVEL NATS_LOG_LEVEL	string		The log level. Valid values are: ‘panic’, ‘fatal’, ’error’, ‘warn’, ‘info’, ‘debug’, ’trace’.
OCIS_LOG_PRETTY NATS_LOG_PRETTY	bool	false	Activates pretty log output.
OCIS_LOG_COLOR NATS_LOG_COLOR	bool	false	Activates colorized log output.
OCIS_LOG_FILE NATS_LOG_FILE	string		The path to the log file. Activates logging to this file if set.
NATS_DEBUG_ADDR	string	127.0.0.1:9234	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
NATS_DEBUG_TOKEN	string		Token to secure the metrics endpoint.
NATS_DEBUG_PPROF	bool	false	Enables pprof, which can be used for profiling.
NATS_DEBUG_ZPAGES	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
NATS_NATS_HOST	string	127.0.0.1	Bind address.
NATS_NATS_PORT	int	9233	Bind port.
NATS_NATS_CLUSTER_ID	string	ocis-cluster	ID of the NATS cluster.
NATS_NATS_STORE_DIR	string	/var/lib/ocis/nats	The directory where the filesystem storage will store NATS JetStream data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/nats.
NATS_TLS_CERT	string	/var/lib/ocis/nats/tls.crt	Path/File name of the TLS server certificate (in PEM format) for the NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/nats.
NATS_TLS_KEY	string	/var/lib/ocis/nats/tls.key	Path/File name for the TLS certificate key (in PEM format) for the NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH/nats.
OCIS_INSECURE NATS_TLS_SKIP_VERIFY_CLIENT_CERT	bool	false	Whether the NATS server should skip the client certificate verification during the TLS handshake.
OCIS_EVENTS_ENABLE_TLS NATS_EVENTS_ENABLE_TLS	bool	false	Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services.