Getting started
Guides and examples
Reference documentation
Background concepts
Frequently Asked Questions
Integrations
Adding and Removing Services
How to add or remove services based on templates or for particular environments
The
services stanza in either the default environment configuration or the environment-specific configuration defines the services that will be deployed for your application. However you may want different services per template or by environment, for example, if you use RDS for staging and production and Postgres for your ephemeral environments. Let's take a look at two ways to add or remove services.Remove service from template
If the service
postgres is included in your default environment configuration and you want to remove it from your permanent template, find the environment_templates section and include remove: true, as shown in the code sample below. If you do not use the remove directive, the parser will assume you just want to override parts of the service instead.1
environment_templates:
2
- name: ephemeral
3
datasets:
4
- name: release-prod
5
- name: permanent
6
services:
7
- name: 'postgres'
8
remove: true
9
auto_deploy: false
10
hostnames:
11
- frontend: frontend-staging-${domain}
12
- docs: docs-staging-${domain}
13
- backend: backend-staging-${domain}
14
tracking_branch: maste
Copied!
Add service to template
Alternatively, you can choose not to include
postgres in your default services, and only create the service in the ephemeral section of the template using the syntax add: true, as illustrated in the sample below. If you don't include the add directive, the parser will assume you are trying to override an aspect of an existing service and give you an error, since the service name postgres won't exist.1
environment_templates:
2
- name: ephemeral
3
services:
4
- name: postgres
5
add: true
6
image: postgres:11.4-alpine
7
registry: public
8
volumes:
9
- type: persistent
10
name: postgres
11
mount_path: "/var/lib/postgresql/data"
12
ports:
13
- type: container_port
14
port: '5432'
15
storage:
16
size: 100Gi
17
datasets:
18
- name: release-prod
19
- name: permanent
20
auto_deploy: false
21
hostnames:
22
- frontend: frontend-staging-${domain}
23
- docs: docs-staging-${domain}
24
- backend: backend-staging-${domain}
25
tracking_branch: master
Copied!
Manually deleting a service
You can also manually delete a service from the environment-specific configuration. In our Postgres example, the
postgres service would appear in your default services section. When you create a permanent environment, you can remove postgres from the configuration and save it before deploying and your new environment will not include the service.Last modified 1mo ago