Skip to content

nats job from nats/56.20.0

NATS server providing a publish-subscribe messaging system for Cloud Foundry components.

Github source: 72d28d2 or master branch

Properties

nats

authorization_timeout

After accepting a connection, wait up to this many seconds for credentials.

Default
15

cluster_host

Clustering listening interface, defaults to spec.address

cluster_port

The port for the NATS servers to communicate with other servers in the cluster.

Default
4223

debug

Enable debug logging output.

Default
false

disable

Disable this monit job. If this property is set to true, the nats process will not run. Connecting to nats (instead of nats-tls) is deprecated. This nats process will be removed soon. Please migrate to using nats-tls as soon as possible.

Default
false

fail_deployment_if_v1

Fail the deployment in post-start if nats instances are on v1.

Default
false

hostname

Hostname for nats cluster. Set this to the value of your bosh-dns-alias.

Example
nats.service.cf.internal

internal

tls
ca

Certificate of the CA for cluster-internal traffic. In PEM format.

certificate

Certificate for cluster-internal traffic. In PEM format.

enabled

Enable mutually authenticated TLS for NATS cluster-internal traffic.

Default
false
private_key

Private key for cluster-internal traffic. In PEM format.

machines

IP or Domain Name of each NATS cluster member.

migrate_client

tls
ca

Certificate of the CA for verifying the TLS connection to the migrate server. In PEM format.

certificate

The PEM-encoded certificate to use for verifying the TLS connection to the migrate server (used for local healthchecks).

private_key

The PEM-encoded private key to use for verifying the TLS connection to the migrate server (used for local healthchecks).

migrate_server

port

Port for endpoint to migrate nats job to nats-server v2. To be removed in a future release.

Default
4242
tls
ca

Certificate of the CA for migrate server. In PEM format.

certificate

Certificate for migrate server. In PEM format.

private_key

Private key for migrate server. In PEM format.

monitor_port

Port for varz and connz monitoring. 0 means disabled.

Default
0

net

Client listening interface, defaults to spec.address

no_advertise

When configured to true, this nats server will not be advertised to any nats clients. This is defaulted to false for backwards compatability.

Default
false

password

Password for server authentication.

port

The port for the NATS server to listen on.

Default
4222

prof_port

Port for pprof. 0 means disabled.

Default
0

tls_cluster_port

The port for the NATS servers to communicate with other servers in the cluster. No default but usually 4225.

trace

Enable trace logging output.

Default
false

user

Username for server authentication.

write_deadline

Maximum number of seconds the server will block when writing. Once this threshold is exceeded the connection will be closed and the client will be considered as Slow Consumer.

Default
2s

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/nats/ directory (learn more).

  • bin/post-start (from post-start.erb)
  • config/bpm.yml (from bpm.yml.erb)
  • config/internal_tls/ca.pem (from internal_tls/ca.pem.erb)
  • config/internal_tls/certificate.pem (from internal_tls/certificate.pem.erb)
  • config/internal_tls/private_key.pem (from internal_tls/private_key.pem.erb)
  • config/migrate_client_tls/ca.pem (from migrate_client_tls/ca.pem.erb)
  • config/migrate_client_tls/certificate.pem (from migrate_client_tls/certificate.pem.erb)
  • config/migrate_client_tls/private_key.pem (from migrate_client_tls/private_key.pem.erb)
  • config/migrate_server_tls/ca.pem (from migrate_server_tls/ca.pem.erb)
  • config/migrate_server_tls/certificate.pem (from migrate_server_tls/certificate.pem.erb)
  • config/migrate_server_tls/private_key.pem (from migrate_server_tls/private_key.pem.erb)
  • config/migrator-config.json (from migrator-config.json.erb)
  • config/nats.conf (from nats.conf.erb)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.