This is a work in progress Terraform Provider to manage NATS JetStream.

Installation

When using Terraform 0.13 or newer adding the provider and running terraform init will download the provider from the Terraform Registry.

Credentials

The provider supports NATS 2.0 credentials either in a file or as a Terraform Variable or Data, for local use you would set the credentials as in the examples later, but if you use something like Terraform Cloud or wish to store the credentials in a credential store you can use Terraform Variables:

variable "ngs_credential_data" {
  type = string
  description = "Text of the NATS credentials to use to manage JetStream"
}

provider "jetstream" {
  servers = "connect.ngs.global"
  credential_data = var.ngs_credential_data
}

A locked down user that can only admin JetStream but not retrieve any data stored in JetStream looks like this:

╭─────────────────────────────────────────────────────────────────────────────────╮
│                                      User                                       │
├──────────────────────┬──────────────────────────────────────────────────────────┤
│ Name                 │ ngs_jetstream_admin                                      │
│ User ID              │ UBI3V7PXXQHJ67C4G2W2D7ICX3NK4S2RJCBUPNLWGGV6W34HYFUSD57M │
│ Issuer ID            │ AARRII4JZYJB3WYECBTMU6WSST2SUZ7SN7PWNSDWQTYVPMXQHDA3WXZ7 │
│ Issued               │ 2020-03-11 10:37:29 UTC                                  │
│ Expires              │ 2020-04-11 10:37:29 UTC                                  │
├──────────────────────┼──────────────────────────────────────────────────────────┤
│ Pub Allow            │ $JS.API.STREAM.CREATE.*                                  │
│                      │ $JS.API.STREAM.UPDATE.*                                  │
│                      │ $JS.API.STREAM.DELETE.*                                  │
│                      │ $JS.API.STREAM.INFO.*                                    │
│                      │ $JS.API.STREAM.LIST                                      |
│                      │ $JS.API.STREAM.NAMES                                     |
│                      │ $JS.API.CONSUMER.DURABLE.CREATE.*.*                      |
│                      │ $JS.API.CONSUMER.DELETE.*.*                              |
│                      │ $JS.API.CONSUMER.INFO.*.*                                |
|                      | $JS.API.CONSUMER.LIST.*                                  |
|                      | $JS.API.CONSUMER.NAMES.*                                 |
│                      │ $JS.API.STREAM.TEMPLATE.>                                │
│ Sub Allow            │ _INBOX.>                                                 │
├──────────────────────┼──────────────────────────────────────────────────────────┤
│ Response Permissions │ Not Set                                                  │
├──────────────────────┼──────────────────────────────────────────────────────────┤
│ Max Messages         │ Unlimited                                                │
│ Max Msg Payload      │ Unlimited                                                │
│ Network Src          │ Any                                                      │
│ Time                 │ Any                                                      │
╰──────────────────────┴──────────────────────────────────────────────────────────╯

Here's a command to create this using nsc, note replace the DemoAccount and 1M strings with your account name and desired expiry time:

$ nsc add user -a DemoAccount
--expiry 1M \
--name ngs_jetstream_admin \
--allow-pub '$JS.API.STREAM.CREATE.*' \
--allow-pub '$JS.API.STREAM.UPDATE.*' \
--allow-pub '$JS.API.STREAM.DELETE.*' \
--allow-pub '$JS.API.STREAM.INFO.*' \
--allow-pub '$JS.API.STREAM.LIST' \
--allow-pub '$JS.API.STREAM.NAMES' \
--allow-pub '$JS.API.CONSUMER.DURABLE.CREATE.*.*' \
--allow-pub '$JS.API.CONSUMER.DELETE.*.*' \
--allow-pub '$JS.API.CONSUMER.INFO.*.*' \
--allow-pub '$JS.API.CONSUMER.LIST.*' \
--allow-pub '$JS.API.CONSUMER.NAMES.*' \
--allow-pub '$JS.API.STREAM.TEMPLATE.>' \
--allow-sub '_INBOX.>'

This will create the credential in ~/.nkeys/creds/synadia/MyAccount/ngs_jetstream_admin.creds

Provider

Terraform Provider that connects to any NATS JetStream server

Example

provider "jetstream" {
  servers     = "connect.ngs.global:4222"
  credentials = "/home/you/ngs_stream_admin.creds"
}

Argument Reference

servers - The list of servers to connect to in a comma seperated list
credentials - (optional) Fully Qualified Path to a file holding NATS credentials.
credential_data - (optional) The NATS credentials as a string, intended to use with data providers.
user - (optional) Connects using a username, when no password is set this is assumed to be a Token.
password - (optional) Connects using a password
nkey - (optional) Connects using an nkey stored in a file
tls.ca_file - (optional) Fully Qualified Path to a file containing Root CA (PEM format). Use when the server has certs signed by an unknown authority.
tls.ca_file_data - (optional) The Root CA PEM as a string, intended to use with data providers. Use when the server has certs signed by an unknown authority.

jetstream_stream

Creates a JetStream Stream, supports editing resources in place.

Example

resource "jetstream_stream" "ORDERS" {
  name     = "ORDERS"
  subjects = ["ORDERS.*"]
  storage  = "file"
  max_age  = 60 * 60 * 24 * 365
}

Attribute Reference

ack - (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
max_age - (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
max_bytes - (optional) The maximum size of all messages that can be kept in the stream (number)
max_consumers - (optional) Number of consumers this stream allows (number)
max_msg_size - (optional) The maximum individual message size that the stream will accept (number)
max_msgs - (optional) The maximum amount of messages that can be kept in the stream (number)
max_msgs_per_subject (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
name - The name of the stream (string)
replicas - (optional) How many replicas of the data to keep in a clustered environment (number)
retention - (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string)
storage - (optional) The storage engine to use to back the stream (string)
subjects - The list of subjects that will be consumed by the Stream (["list", "string"])

jetstream_stream_template

Creates a JetStream Stream Template. Does not support editing in place, when a template gets deleted all it's managed Streams also get deleted

Example

resource "jetstream_stream_template" "ONE_HOUR" {
  name        = "JS_1H"
  subjects    = ["JS.1H.*"]
  storage     = "file"
  max_age     = 60 * 60
  max_streams = 60
}

Attribute Reference

ack - (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
max_age - (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
max_bytes - (optional) The maximum size of all messages that can be kept in the stream (number)
max_consumers - (optional) Number of consumers this stream allows (number)
max_msg_size - (optional) The maximum individual message size that the stream will accept (number)
max_msgs - (optional) The maximum amount of messages that can be kept in the stream (number)
max_streams - Maximum number of Streams this Template can manage (number)
name - The name of the Stream Template (string)
replicas - (optional) How many replicas of the data to keep in a clustered environment (number)
retention - (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string)
storage - (optional) The storage engine to use to back the stream (string)
subjects - The list of subjects that will be consumed by the Stream (["list", "string"])

jetstream_consumer

Create or Delete Consumers on any Terraform managed Stream. Does not support editing consumers in place

Example

resource "jetstream_stream" "ORDERS" {
  name     = "ORDERS"
  subjects = ["ORDERS.*"]
  storage  = "file"
  max_age  = 60 * 60 * 24 * 365
}

resource "jetstream_consumer" "ORDERS_NEW" {
  stream_id      = jetstream_stream.ORDERS.id
  durable_name   = "NEW"
  deliver_all    = true
  filter_subject = "ORDERS.received"
  sample_freq    = 100
}

Attribute Reference

ack_policy - (optional) The delivery acknowledgement policy to apply to the Consumer
ack_wait - (optional) Number of seconds to wait for acknowledgement
deliver_all - (optional) Starts at the first available message in the Stream
deliver_last - (optional) Starts at the latest available message in the Stream
delivery_subject - (optional) The subject where a Push-based consumer will deliver messages
delivery_group - (optional) When set Push consumers will only deliver messages to subscriptions with this group set
durable_name - The durable name of the Consumer
filter_subject - (optional) Only receive a subset of messages from the Stream based on the subject they entered the Stream on
max_delivery - (optional) Maximum deliveries to attempt for each message
replay_policy - (optional) The rate at which messages will be replayed from the stream
sample_freq - (optional) The percentage of acknowledgements that will be sampled for observability purposes
start_time - (optional) The timestamp of the first message that will be delivered by this Consumer
stream_id - The name of the Stream that this consumer consumes
stream_sequence - (optional) The Stream Sequence that will be the first message delivered by this Consumer
ratelimit - (optional) The rate limit for delivering messages to push consumers, expressed in bits per second
headers_only - (optional) When true no message bodies will be delivered only headers

jetstream_kv_bucket

Creates a JetStream based KV bucket

Example

resource "jetstream_kv_bucket" "test" {
  name = "TEST"
  ttl = 60
  history = 10
  max_value_size = 1024
  max_bucket_size = 10240
}

Attribute Reference

name - (required) The unique name of the KV bucket, must match \A[a-zA-Z0-9_-]+\z
history - (optional) Number of historic values to keep
ttl - (optional) How many seconds to keep values for, keeps forever when not set
placement - (optional) JetStream cluster name to place the KV bucket in
max_value_size - (optional) Maximum size of any value
max_bucket_size - (optional) The maximum size of all data in the bucket
replicas - (optional) How many replicas to keep on a JetStream cluster

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Installation

Credentials

Provider

Example

Argument Reference

jetstream_stream

Example

Attribute Reference

jetstream_stream_template

Example

Attribute Reference

jetstream_consumer

Example

Attribute Reference

jetstream_kv_bucket

Example

Attribute Reference

Files

README.md

Latest commit

History

README.md

File metadata and controls

Installation

Credentials

Provider

Example

Argument Reference

jetstream_stream

Example

Attribute Reference

jetstream_stream_template

Example

Attribute Reference

jetstream_consumer

Example

Attribute Reference

jetstream_kv_bucket

Example

Attribute Reference