Configuring the Native Load Balancer

In the portal, the native load balancer is configured through the controllers page in the load balancer modal.

To get there:

1. Environments from the main, left-hand navigation.
2. Select the environment from the first column.
3. Scroll down to the services tile, and click on the manage tab of the load balancer.
4. Select the Controllers page.

Load Balancer Controller Ports

Each port, selectable from the first column, has 4 accessory pages to support it.

Overview

URLs

Routers

Config

In the portal, port configuration is done on the config page.

General

The general section has port specific general settings.

Routers

Routers are used to set specific functionality on internal ports, paths, or urls. These will execute in order they are defined if specificity is the same. Users can add a router by using the Add Router button and then adding to the configuration with more specific settings. To move routers up and down in priority use the ^ and v arrows, then save.

Each router has its own general settings, configuration, and extension settings.

General

So for the given router, the user is setting the type of routing to be done here as well as creating some constraints around what inbound traffic qualifies to be routed by this router.

Config

Sticky sessions are enabled by default, to turn this off find the controller -> router to change and update the checkbox.

Extensions

There are two types of extensions transport and router.

For Router type, the only configurable extension requires HTTP mode.

Router Extension

An HTTP router can have many extensions. Extensions are used to define specific behavior and are configured in the portal through a JSON blob.

If there are any matches to the optional Match Path field they can be assigned to domains or URLs as shown in the following sections examples.

In the below redirect example the url shows https://user-$$1.otherurl.com. This will take the first match from the Match Path field on this router and write it to $$1 as it is defined in the url field.

In the case where Match Domains is set to otherurl.com and Match Path is set to ^/users/([0-9]+), if someone were to visit https://otherurl.com/user/1234 they would be redirected to https://user-1234.otherurl.com.

Redirect

The redirect option allows a user to set incoming matches to redirect.

{
	"redirect": {
		"auto_https_redirect": true,
		"remove_www": true,
		"port": 34567,
		"scheme": "https",
		"url": "https://user-$$1.otherurl.com"
	}
}

Submitting a redirect config, Port, Scheme, and url are optional settings, but auto_https_redirect and remove_www need a boolean submitted.

Forward

The forward option exposes mechanics to change certain aspects of the request that is incoming for a container IN the environment.

{
	"forward": {
		"scheme": "https",
		"url": "/example/old/images/$$1"
	}
}

Proxy

The proxy setting allows for the router to act as a proxy to a specified domain. Using the content modification the content can be mutated before the proxy is passed through.

{
	"proxy": {
		"domain": "remote-domain.com",
		"content_mod": {
			"replace": [
				{
					"match": "remote-domain.com/main.js",
					"value": "current-domain.com/main.js"
				}
			]
		},
		"url": "/example/$$1"
	}
}

Cache

The cache configuration exposes a way for users to set caching of files up at the load balancer(s).

{
	"caching": {
		"files": [
			{
				"match": "(.*)\\.(js|css|png|svg)",
				"ttl": "5m"
			}
		]
	}
}

files array

Advanced

The advanced section holds configuration settings for TLS at the router level.

Client Auth: Values and Descriptions

Transport Extension

The other type of extension is transport extension. The main difference between transport and router extensions (other than what they actually do!) is the fact that a user can only define 1 transport level extension per controller.

In the portal, a user will describe the:

Telemetry UDP

Telemetry options if mode for the controller is UDP.

Telemetry HTTP

Telemetry options if mode for the controller is HTTP.

Telemetry TCP

Telemetry options if mode for the controller is HTTP.