Welcome to NATS release

This repository contains the nats-release source code. This is NATS deployed as a BOSH release. See the BOSH documentation for more information on BOSH.

BOSH Jobs

NATS server

As part of a platform-wide initiative across Cloud Foundry we are working toward securing all internal traffic using TLS. NATS servers can support either TLS or plaint-text traffic, but not both at the same time. To give clients time to upgrade we are providing two NATS jobs that can be colocated: a plain-text one (nats) and a TLS one (nats-tls).

NOTE: NATS does not use a standard TLS over TCP handshake. There is an initial INFO handshake, which is via plain-text. If both the client and the server agree in this handshake to use TLS then the connection is upgraded. If either of the client or server expects to use TLS but its peer does not then they will refuse to connect to avoid downgrade attacks.

NATS

NATS serving plain-text traffic. This job will be removed when all Cloud Foundry NATS clients are upgraded to use TLS.

NATS-TLS

NATS serving TLS traffic.

smoke-tests

The smoke tests errand run a simple check that NATS is accessible and relaying messages properly. It will try to use all configured server connections.

Config Tests

If you add a spec value, please add a corresponding test to spec/nats/nats_config_spec.rb and spec/nats-tls/nats_tls_config_spec.rb

Developer Workflow

1. Clone CI repository (next to where nats-release is cloned)

mkdir -p ~/workspace
cd ~/workspace
git clone https://github.com/cloudfoundry/wg-app-platform-runtime-ci.git

Running Unit and Integration Tests

With Docker

Running tests for this release

• ./scripts/create-docker-container.bash: This will create a docker container with appropriate mounts.
• ./scripts/test-in-docker-locally.bash: Create docker container and run all tests and setup in a single script.
  • ./scripts/test-in-docker-locally.bash <package> <sub-package>: For running tests under a specific package and/or sub-package: e.g. ./scripts/test-in-docker-locally.bash nats-v2-migrate integration

When inside docker container:

• /repo/scripts/docker/test.bash: This will run all tests in this release
• /repo/scripts/docker/test.bash nats-v2-migration: This will only run nats-v2-migration tests
• /repo/scripts/docker/test.bash nats-v2-migration integration: This will only run integration sub-package tests for nats-v2-migration package
• /repo/scripts/docker/tests-templates.bash: This will run all of tests for bosh tempalates
• /repo/scripts/docker/lint.bash: This will run all of linting defined for this repo.

File a Bug

Bugs can be filed using GitHub Issues.