Deploying Orbital

​

Production concepts

When deploying to production, there are common tasks you may wish to perform:

• Enable authentication and authorization in Orbital
• Use a git-backed workspace.conf file, to align with IAC
• Understand how secrets are handled in Orbital
• Understand how to configure Orbital via application properties or environment variables

​

Deploying using Docker Compose

A sample docker-compose.yml is maintained by the Orbital team and published at start.orbitalhq.com.

It contains reasonable defaults for getting a local environment running. Note that by default, Orbital does not enable authentication or role-based authorization, and you’ll need to enable these.

​

Deploying with Terraform

Orbital maintains deployment scripts for production configurations of Orbital in Terraform.

These are available here

​

Networking between components

Orbital is packaged as a collection of container images, which need to be able to communicate between each other.

The addresses used are configured in a file, which be default is loaded from config/services.conf.

The location of the config file can be set by passing --vyne.services.config-file in the command line when starting Orbital.

If the config file doesn’t exist, then a default file with reasonable defaults is written on startup.

An example of the config file is shown below:

services {
    analytics-server {
        url="http://vyne-analytics-server"
    }
    orbital-server {
        url="http://orbital"
        rsocket-port=7655
    }
}

The following table outlines the components and, the default network addresses and ports that are expected to be exposed. If deploying in a network like Docker Swarm or Kubernetes, it is expected that services are available on the configured addresses.