Skip to main content

nats_stream

Publish to a NATS Stream subject.

# Common config fields, showing default values
output:
  label: ""
  nats_stream:
    urls: [] # No default (required)
    cluster_id: "" # No default (required)
    subject: "" # No default (required)
    client_id: ""
    max_in_flight: 64
Deprecation notice

The NATS Streaming Server is being deprecated. Critical bug fixes and security fixes will be applied until June of 2023. NATS-enabled applications requiring persistence should use JetStream.

Authentication​

There are several components within Expanso Edge which uses NATS services. You will find that each of these components support optional advanced authentication parameters for NKeys and User Credentials.

See an in-depth tutorial.

NKey file​

The NATS server can use these NKeys in several ways for authentication. The simplest is for the server to be configured with a list of known public keys and for the clients to respond to the challenge by signing it with its private NKey configured in the nkey_file or nkey field.

More details.

User credentials​

NATS server supports decentralized authentication based on JSON Web Tokens (JWT). Clients need an user JWT and a corresponding NKey secret when connecting to a server which is configured to use this authentication scheme.

The user_credentials_file field should point to a file containing both the private key and the JWT and can be generated with the nsc tool.

Alternatively, the user_jwt field can contain a plain text JWT and the user_nkey_seedcan contain the plain text NKey Seed.

More details.

Token​

The token field can contain a plain text token string for token-based authentication.

User and password​

The user and password fields can be used for username/password authentication.

Performance​

This output benefits from sending multiple messages in flight in parallel for improved performance. You can tune the max number of in flight messages (or message batches) with the field max_in_flight.

Fields​

urls​

A list of URLs to connect to. If an item of the list contains commas it will be expanded into multiple URLs.

Type: array of string

max_reconnects​

The maximum number of times to attempt to reconnect to the server. If negative, it will never stop trying to reconnect.

Type: int

cluster_id​

The cluster ID to publish to.

Type: string

subject​

The subject to publish to.

Type: string

client_id​

The client ID to connect with.

Type: string
Default: ""

max_in_flight​

The maximum number of messages to have in flight at a given time. Increase this to improve throughput.

Type: int
Default: 64

tls​

Custom TLS settings can be used to override system defaults.

Type: object

tls.enabled​

Whether custom TLS settings are enabled.

Type: bool
Default: false

tls.skip_cert_verify​

Whether to skip server side certificate verification.

Type: bool
Default: false

tls.enable_renegotiation​

Whether to allow the remote server to repeatedly request renegotiation. Enable this option if you're seeing the error message local error: tls: no renegotiation.

Type: bool
Default: false

tls.root_cas​

An optional root certificate authority to use. This is a string, representing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string
Default: ""

tls.root_cas_file​

An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.

Type: string
Default: ""

tls.client_certs​

A list of client certificates to use. For each certificate either the fields cert and key, or cert_file and key_file should be specified, but not both.

Type: array of object
Default: []

tls.client_certs[].cert​

A plain text certificate to use.

Type: string
Default: ""

tls.client_certs[].key​

A plain text certificate key to use.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string
Default: ""

tls.client_certs[].cert_file​

The path of a certificate to use.

Type: string
Default: ""

tls.client_certs[].key_file​

The path of a certificate key to use.

Type: string
Default: ""

tls.client_certs[].password​

A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete pbeWithMD5AndDES-CBC algorithm is not supported for the PKCS#8 format.

Because the obsolete pbeWithMD5AndDES-CBC algorithm does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string
Default: ""

tls_handshake_first​

Perform a TLS handshake before sending the INFO protocol message.

Type: bool
Default: false

auth​

Optional configuration of NATS authentication parameters.

Type: object

auth.nkey_file​

An optional file containing a NKey seed.

Type: string

auth.nkey​

The NKey seed.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string

auth.user_credentials_file​

An optional file containing user credentials which consist of an user JWT and corresponding NKey seed.

Type: string

auth.user_jwt​

An optional plain text user JWT (given along with the corresponding user NKey Seed).

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string

auth.user_nkey_seed​

An optional plain text user NKey Seed (given along with the corresponding user JWT).

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string

auth.user​

An optional plain text user name (given along with the corresponding user password).

Type: string

auth.password​

An optional plain text password (given along with the corresponding user name).

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string

auth.token​

An optional plain text token.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string

inject_tracing_map​

EXPERIMENTAL: A Bloblang mapping used to inject an object containing tracing propagation information into outbound messages. The specification of the injected fields will match the format used by the service wide tracer.

Type: string