dokku-nats

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #typescript #llm #golang #linux #docker #nodejs #java #vue #awesome-list #pytorch #security

(★ 28)

a nats plugin for dokku

dokku-nats Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# dokku nats [![Build Status](https://img.shields.io/github/actions/workflow/status/dokku/dokku-nats/ci.yml?branch=master&style=flat-square "Build Status")](https://github.com/dokku/dokku-nats/actions/workflows/ci.yml?query=branch%3Amaster) [![IRC Network](https://img.shields.io/badge/irc-libera-blue.svg?style=flat-square "IRC Libera")](https://webchat.libera.chat/?channels=dokku)

Official nats plugin for dokku. Currently defaults to installing [nats 2.14.0](https://hub.docker.com/_/nats/).

## Requirements

- dokku 0.19.x+
- docker 1.8.x

## Installation

```shell
# on 0.19.x+
sudo dokku plugin:install https://github.com/dokku/dokku-nats.git --name nats
```

## Commands

```
nats:app-links <app>                               # list all nats service links for a given app
nats:backup-set-public-key-encryption <service> <public-key-id> # set GPG Public Key encryption for all future backups of nats service
nats:backup-unset-public-key-encryption <service>  # unset GPG Public Key encryption for future backups of the nats service
nats:create <service> [--create-flags...]          # create a nats service
nats:destroy <service> [-f|--force]                # delete the nats service/data/container if there are no links left
nats:enter <service>                               # enter or run a command in a running nats service container
nats:exists <service>                              # check if the nats service exists
nats:expose <service> <ports...>                   # expose a nats service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)
nats:info <service> [--single-info-flag]           # print the service information
nats:link <service> <app> [--link-flags...]        # link the nats service to the app
nats:linked <service> <app>                        # check if the nats service is linked to an app
nats:links <service>                               # list all apps linked to the nats service
nats:list                                          # list all nats services
nats:logs <service> [-t|--tail] <tail-num-optional> # print the most recent log(s) for this service
nats:pause <service>                               # pause a running nats service
nats:promote <service> <app>                       # promote service <service> as NATS_URL in <app>
nats:restart <service>                             # graceful shutdown and restart of the nats service container
nats:set <service> <key> <value>                   # set or clear a property for a service
nats:start <service>                               # start a previously stopped nats service
nats:stop <service>                                # stop a running nats service
nats:unexpose <service>                            # unexpose a previously exposed nats service
nats:unlink <service> <app>                        # unlink the nats service from the app
nats:upgrade <service> [--upgrade-flags...]        # upgrade service <service> to the specified versions
```

## Usage

Help for any commands can be displayed by specifying the command as an argument to nats:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `nats:help` command for any undocumented commands.

### Basic Usage

### create a nats service

```shell
# usage
dokku nats:create <service> [--create-flags...]
```

flags:

- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
- `-i|--image IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
- `-p|--password PASSWORD`: override the user-level service password
- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
- `-r|--root-password PASSWORD`: override the root-level service password
- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
- `-s|--shm-size SHM_SIZE`: override shared memory size for nats docker container

Create a nats service named lollipop:

```shell
dokku nats:create lollipop
```

You can also specify the image and image version to use for the service. It *must* be compatible with the nats image.

```shell
export NATS_IMAGE="nats"
export NATS_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
dokku nats:create lollipop
```

You can also specify custom environment variables to start the nats service in semicolon-separated form.

```shell
export NATS_CUSTOM_ENV="USER=alpha;HOST=beta"
dokku nats:create lollipop
```

### print the service information

```shell
# usage
dokku nats:info <service> [--single-info-flag]
```

flags:

- `--config-dir`: show the service configuration directory
- `--data-dir`: show the service data directory
- `--dsn`: show the service DSN
- `--exposed-ports`: show service exposed ports
- `--id`: show the service container id
- `--internal-ip`: show the service internal ip
- `--initial-network`: show the initial network being connected to
- `--links`: show the service app links
- `--post-create-network`: show the networks to attach to after service container creation
- `--post-start-network`: show the networks to attach to after service container start
- `--service-root`: show the service root directory
- `--status`: show the service running status
- `--version`: show the service image version

Get connection information as follows:

```shell
dokku nats:info lollipop
```

You can also retrieve a specific piece of service info via flags:

```shell
dokku nats:info lollipop --config-dir
dokku nats:info lollipop --data-dir
dokku nats:info lollipop --dsn
dokku nats:info lollipop --exposed-ports
dokku nats:info lollipop --id
dokku nats:info lollipop --internal-ip
dokku nats:info lollipop --initial-network
dokku nats:info lollipop --links
dokku nats:info lollipop --post-create-network
dokku nats:info lollipop --post-start-network
dokku nats:info lollipop --service-root
dokku nats:info lollipop --status
dokku nats:info lollipop --version
```

### list all nats services

```shell
# usage
dokku nats:list
```

List all services:

```shell
dokku nats:list
```

### print the most recent log(s) for this service

```shell
# usage
dokku nats:logs <service> [-t|--tail] <tail-num-optional>
```

flags:

- `-t|--tail [<tail-num>]`: do not stop when end of the logs are reached and wait for additional output

You can tail logs for a particular service:

```shell
dokku nats:logs lollipop
```

By default, logs will not be tailed, but you can do this with the --tail flag:

```shell
dokku nats:logs lollipop --tail
```

The default tail setting is to show all logs, but an initial count can also be specified:

```shell
dokku nats:logs lollipop --tail 5
```

### link the nats service to the app

```shell
# usage
dokku nats:link <service> <app> [--link-flags...]
```

flags:

- `-a|--alias "BLUE_DATABASE"`: an alternative alias to use for linking to an app via environment variable
- `-q|--querystring "pool=5"`: ampersand delimited querystring arguments to append to the service link
- `-n|--no-restart "false"`: whether or not to restart the app on link (default: true)

A nats service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our `playground` app.

> NOTE: this will restart your app

```shell
dokku nats:link lollipop playground
```

The following environment variables will be set automatically by docker (not on the app itself, so they won’t be listed when calling dokku config):

```
DOKKU_NATS_LOLLIPOP_NAME=/lollipop/DATABASE
DOKKU_NATS_LOLLIPOP_PORT=tcp://172.17.0.1:4222
DOKKU_NATS_LOLLIPOP_PORT_4222_TCP=tcp://172.17.0.1:4222
DOKKU_NATS_LOLLIPOP_PORT_4222_TCP_PROTO=tcp
DOKKU_NATS_LOLLIPOP_PORT_4222_TCP_PORT=4222
DOKKU_NATS_LOLLIPOP_PORT_4222_TCP_ADDR=172.17.0.1
```

The following will be set on the linked application by default:

```
NATS_URL=nats://lollipop:SOME_PASSWORD@dokku-nats-lollipop:4222/lollipop
```

The host exposed here only works internally in docker containers. If you want your container to be reachable from outside, you should use the `expose` subcommand. Another service can be linked to your app:

```shell
dokku nats:link other_service playground
```

It is possible to change the protocol for `NATS_URL` by setting the environment variable `NATS_DATABASE_SCHEME` on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding.

```shell
dokku config:set playground NATS_DATABASE_SCHEME=nats2
dokku nats:link lollipop playground
```

This will cause `NATS_URL` to be set as:

```
nats2://lollipop:SOME_PASSWORD@dokku-nats-lollipop:4222/lollipop
```

### unlink the nats service from the app

```shell
# usage
dokku nats:unlink <service> <app>
```

flags:

- `-n|--no-restart "false"`: whether or not to restart the app on unlink (default: true)

You can unlink a nats service:

> NOTE: this will restart your app and unset related environment variables

```shell
dokku nats:unlink lollipop playground
```

### set or clear a property for a service

```shell
# usage
dokku nats:set <service> <key> <value>
```

Set the network to attach after the service container is started:

```shell
dokku nats:set lollipop post-create-network custom-network
```

Set multiple networks:

```shell
dokku nats:set lollipop post-create-network custom-network,other-network
```

Unset the post-create-network value:

```shell
dokku nats:set lollipop post-create-network
```

### Service Lifecycle

The lifecycle of each service can be managed through the following commands:

### enter or run a command in a running nats service container

```shell
# usage
dokku nats:enter <service>
```

A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk.

> NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098

```shell
dokku nats:enter lollipop
```

You may also run a command directly against the service. Filesystem changes will not be saved to disk.

```shell
dokku nats:enter lollipop touch /tmp/test
```

### expose a nats service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)

```shell
# usage
dokku nats:expose <service> <ports...>
```

Expose the service on the service's normal ports, allowing access to it from the public interface (`0.0.0.0`):

```shell
dokku nats:expose lollipop 4222
```

Expose the service on the service's normal ports, with the first on a specified ip address (127.0.0.1):

```shell
dokku nats:expose lollipop 127.0.0.1:4222
```

### unexpose a previously exposed nats service

```shell
# usage
dokku nats:unexpose <service>
```

Unexpose the service, removing access to it from the public interface (`0.0.0.0`):

```shell
dokku nats:unexpose lollipop
```

### promote service <service> as NATS_URL in <app>

```shell
# usage
dokku nats:promote <service> <app>
```

If you have a nats service linked to an app and try to link another nats service another link environment variable will be generated automatically:

```
DOKKU_NATS_BLUE_URL=nats://other_service:ANOTHER_PASSWORD@dokku-nats-other-service:4222/other_service
```

You can promote the new service to be the primary one:

> NOTE: this will restart your app

```shell
dokku nats:promote other_service playground
```

This will replace `NATS_URL` with the url from other_service and generate another environment variable to hold the previous value if necessary. You could end up with the following for example:

```
NATS_URL=nats://other_service:ANOTHER_PASSWORD@dokku-nats-other-service:4222/other_service
DOKKU_NATS_BLUE_URL=nats://other_service:ANOTHER_PASSWORD@dokku-nats-other-service:4222/other_service
DOKKU_NATS_SILVER_URL=nats://lollipop:SOME_PASSWORD@dokku-nats-lollipop:4222/lollipop
```

### start a previously stopped nats service

```shell
# usage
dokku nats:start <service>
```

Start the service:

```shell
dokku nats:start lollipop
```

### stop a running nats service

```shell
# usage
dokku nats:stop <service>
```

Stop the service and removes the running container:

```shell
dokku nats:stop lollipop
```

### pause a running nats service

```shell
# usage
dokku nats:pause <service>
```

Pause the running container for the service:

```shell
dokku nats:pause lollipop
```

### graceful shutdown and restart of the nats service container

```shell
# usage
dokku nats:restart <service>
```

Restart the service:

```shell
dokku nats:restart lollipop
```

### upgrade service <service> to the specified versions

```shell
# usage
dokku nats:upgrade <service> [--upgrade-flags...]
```

flags:

- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
- `-i|--image IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
- `-R|--restart-apps "true"`: whether or not to force an app restart (default: false)
- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
- `-s|--shm-size SHM_SIZE`: override shared memory size for nats docker container

You can upgrade an existing service to a new image or image-version:

```shell
dokku nats:upgrade lollipop
```

### Service Automation

Service scripting can be executed using the following commands:

### list all nats service links for a given app

```shell
# usage
dokku nats:app-links <app>
```

List all nats services that are linked to the `playground` app.

```shell
dokku nats:app-links playground
```

### check if the nats service exists

```shell
# usage
dokku nats:exists <service>
```

Here we check if the lollipop nats service exists.

```shell
dokku nats:exists lollipop
```

### check if the nats service is linked to an app

```shell
# usage
dokku nats:linked <service> <app>
```

Here we check if the lollipop nats service is linked to the `playground` app.

```shell
dokku nats:linked lollipop playground
```

### list all apps linked to the nats service

```shell
# usage
dokku nats:links <service>
```

List all apps linked to the `lollipop` nats service.

```shell
dokku nats:links lollipop
```
### Backups

Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/minio).

You may skip the `backup-auth` step if your dokku install is running within EC2 and has access to the bucket via an IAM profile. In that case, use the `--use-iam` option with the `backup` command.

If both passphrase and public key forms of encryption are set, the public key encryption will take precedence.

The underlying core backup script is present [here](https://github.com/dokku/docker-s3backup/blob/main/backup.sh).

Backups can be performed using the backup commands:

### set GPG Public Key encryption for all future backups of nats service

```shell
# usage
dokku nats:backup-set-public-key-encryption <service> <public-key-id>
```

Set the `GPG` Public Key for encrypting backups:

```shell
dokku nats:backup-set-public-key-encryption lollipop
```

This method currently requires the <public-key-id> to be present on the keyserver `keyserver.ubuntu.com`:

### unset GPG Public Key encryption for future backups of the nats service

```shell
# usage
dokku nats:backup-unset-public-key-encryption <service>
```

Unset the `GPG` Public Key encryption for backups:

```shell
dokku nats:backup-unset-public-key-encryption lollipop
```

### Disabling `docker image pull` calls

If you wish to disable the `docker image pull` calls that the plugin triggers, you may set the `NATS_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.

Please ensure the proper images are in place when `docker image pull` is disabled.

dokku-nats

dokku-nats Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

dokku-nats

dokku-nats Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README