Services

Service Structure

The services field describes the different runtimes in your web application stack. The field accepts a map -like structure that describes each service, like so:

services:
foo:
port: {port}
image: {image_link}
path: {path}
build:
- {command}
- {command}
serve:
- {command}
bar:
ports:
- name: {port_name}
value: 5555
- name: {port_name}
value: 5554
runtime: {language_name}
path: {path}
do-not-expose: true
build:
- {command}
- {command}
serve:
- {command}
environment:
{KEY_1}:{value_1}
{KEY_2}:{value_2}

Fields

Field

Description

Default Value

port

Describes the port that the given service is running on. This port must be unique for each service.

Required

runtime

Describes the runtime that the service depends on (essentially a container). A list of these runtimes are provided during onboarding. If the image field is specified, the runtime field shouldn't be.

Either runtime or image required

image

Describes a custom docker image that can be pulled from a public container registry. If the image field is specified, the runtime field shouldn't be.

Either runtime or image required

build

A list of commands used to describe the build step of a service.

Required

serve

A list of commands used to describe the serve step of a service.

Required

do-not-expose

A directive that tells Reploy not to expose this service on a link. This also disables any health check on the service.

false

health

A directive used for overriding the default / route for checking the health of a service and outputing its success status.

/

environment

A map of environment variables used to describe the environment variables for the given service.

none