Routing Release

This repository is a BOSH release for deploying Gorouter, TCP Routing, and other associated tasks that provide HTTP and TCP routing in Cloud Foundry foundations.

Downloads

Our BOSH release is available on bosh.io and on our GitHub Releases page.

Getting Help

If you have a concrete issue to report or a change to request, please create a Github issue on routing-release.

Issues with any related submodules (Gorouter, Routing API, Route Registrar, CF TCP Router) should be created here instead.

You can also reach us on Slack at cloudfoundry.slack.com in the #cf-for-vms-networking. channel.

Contributing

See the Routing Contributing Resources section for more information on how to contribute.

Table of Contents

1. Routing Operator Resources
2. Routing App Developer Resources
3. Routing Contributor Resources

Routing Operator Resources

High Availability

The TCP Router and Routing API are stateless and horizontally scalable. The TCP Routers must be fronted by a load balancer for high-availability. The Routing API depends on a database, that can be clustered for high-availability. For high availability, deploy multiple instances of each job, distributed across regions of your infrastructure.

Routing API

For details refer to Routing API.

Metrics

For documentation on metrics available for streaming from Routing components through the Loggregator Firehose, visit the CloudFoundry Documentation. You can use the NOAA Firehose sample app to quickly consume metrics from the Firehose.

Routing App Developer Resources

Session Affinity

For more information on how Routing release accomplishes session affinity, i.e. sticky sessions, refer to the Session Affinity document.

Headers

X-CF Headers describes the X-CF headers that are set on requests and responses inside of CF.

Routing Contributor Resources

CI Statuses

Job	Status
unit tests
performance tests
smoke tests

Developer Workflow

When working on individual components of the Routing Release, work out of the submodules under src/.

Run the appropriate unit tests (see Testing).

The release branch contains code that has been released. All development work happens on the develop branch.

Get the code

1. Clone the repository

mkdir -p ~/workspace
cd ~/workspace
git clone https://github.com/cloudfoundry/routing-release.git
cd routing-release/

1. Initialize and sync submodules.

./scripts/update

Running BOSH Job Templating Tests

From the root of the repo, run:

Run the specs

rspec ./spec/

Lint the specs

rubocop ./spec/

If you do not have rspec or rubocop installed locally, run ./scripts/start-docker-for-testing.sh and execute the commands in the docker container. Prepend "sudo" to the script if you are an unprivileged user.

Running Unit and Integration Tests

In a Docker container

• Run tests using the script provided. This script pulls a docker image and runs the tests within a container because integration tests require Linux specific features.

  Notice/warning: the script is called run-unit-tests-in-docker but it really runs unit and integration tests, that's why they need to run in a container.

  ./scripts/run-unit-tests-in-docker #sudo for unprivileged users

• If you'd like to run a specific component's tests in a Docker container, the run-unit-tests script also takes a package name as an argument:

  ./scripts/run-unit-tests-in-docker gorouter

Locally

• If you'd like to run the unit and integration tests for an individual component locally, we recommend you run bin/test in that component's directory. Please make sure it's a component that doesn't require a Linux operating system.

Running Acceptance tests

The Routing Acceptance Tests must run against a full Cloud Foundry deployment. One method is to deploy Cloud Foundry on a BOSH lite with cf-deployment.

To run the Routing Acceptance Tests, see the README.md.