Add services

Upsun includes many services, so you don’t have to subscribe to external cache or search engine services. Because the services are included in your project, you can manage them through Git and they’re backed up together with the rest of your project.

Your project defines the services configuration from a top-level key called services, which is placed in a unified configuration file like .upsun/config.yaml.

If you don’t need any services (such as for a static website), you don’t need to include this configuration. Read on to see how to add services.

Add a service

Adding a service is a two-step process.

1. Configure the service

All service configuration happens in the .upsun/config.yaml file in your Git repository.

Configure your service in the following pattern:

# The name of the service container. Must be unique within a project.
services:
  <SERVICE_NAME>:
    type: <SERVICE_TYPE>:<VERSION>
    # Other options...

An example service configuration for two databases might look like this:

services:
  # The name of the service container. Must be unique within a project.
  mariadb:
    type: mariadb:11.4
  # The name of the service container. Must be unique within a project.
  postgresql:
    type: postgresql:16

This YAML file contains a dictionary defining all of the services you want to use. The top-level key services defines an object of all of the services to be provisioned for the project. Below that, come custom service names (SERVICE_NAME; in the example, mariadb and postgresql), which you use to identify the service in step 2.

You can give it any name you want with lowercase alphanumeric characters, hyphens, and underscores.

Service options

The following table presents the keys you can define for each service:

Resources (CPU, RAM, disk)

Upsun allows you to configure resources (CPU, RAM, and disk) per environment for each of your services. For more information, see how to manage resources.

You configure the disk size in MB. Your actual available disk space is slightly smaller with some space used for formatting and the filesystem journal. When checking available space, note whether it’s reported in MB or MiB.

You can decrease the size of an existing disk for a service. If you do so, be aware that:

• You need to create new backups that the downsized disk can accommodate. Backups from before the downsize cannot be restored unless you increase the disk size again.
• The downsize fails if there’s more data on the disk than the desired size.

2. Define the relationship

To define the relationship, use the following configuration:

applications:
  # The name of the app container. Must be unique within a project.
  <APP_NAME>:
    # Other options...

    # Relationships enable an app container's access to a service.
    # The example below shows simplified configuration leveraging a default service (identified from the relationship name) and a default endpoint.
    # See the Application reference for all options for defining relationships and endpoints.
    relationships:
      <SERVICE_NAME>:

applications:
  # The name of the app container. Must be unique within a project.
  <APP_NAME>:
    # Other options...

    # Relationships enable an app container's access to a service.
    # The example below shows configuration with an explicitly set service name and endpoint.
    # See the Application reference for all options for defining relationships and endpoints.
    relationships:
      <RELATIONSHIP_NAME>:
        service: <SERVICE_NAME>
        endpoint: <ENDPOINT_NAME>

An example relationship to connect to the databases given in the example in step 1:

applications:
  # Relationships enable access from this app to a given service.
  # The example below shows simplified configuration leveraging a default service
  # (identified from the relationship name) and a default endpoint.
  # See the Application reference for all options for defining relationships and endpoints.
  <APP_NAME>:
    relationships:
      mariadb:
      postgresql:
services:
  mariadb:
    type: mariadb:11.4
  postgresql:
    type: postgresql:16

applications:
  # Relationships enable access from this app to a given service.
  # The example below shows configuration with explicitly set service names and endpoints.
  # See the Application reference for all options for defining relationships and endpoints.

  <APP_NAME>:
    relationships:
      database:
        service: mariadb
        endpoint: mysql
      postgresql:
        service: postgresql
        endpoint: postgresql
services:
  mariadb:
    type: mariadb:11.4
  postgresql:
    type: postgresql:16

Each service offers one or more endpoints for connections, depending on the service. An endpoint is a named set of credentials to give access to other apps and services in your project. If you don’t specify one in the service configuration, a default endpoint is created. The default endpoint varies by service, generally being its type (such as mysql or solr).

Available services

The following table presents the available service types and their versions. Add them to the type key of the service configuration in the format type:version.

Service versions

These services generally follow semantic versioning conventions. You can select the major version, but the latest compatible minor is applied automatically and can’t be overridden. Patch versions are applied periodically for bug fixes and the like. When you deploy your app, you always get the latest available patches.

Service timezones

All services have their system timezone set to UTC by default. For some services, you can change the timezone for the running service (this doesn’t affect the container itself and so logs are still in UTC).

• MySQL
• PostgreSQL

Connect to a service

For security reasons, you can’t access services directly through HTTP. You can connect through your app or by opening an SSH tunnel to access the service directly.

upsun relationships

mariadb:
  -
    username: user
    scheme: mysql
    service: mariadb
    fragment: null
    ip: 198.51.100.37
    hostname: abcdefghijklm1234567890123.mariadb.service._.eu.platformsh.site
    public: false
    cluster: abcdefgh1234567-main-abcd123
    host: mariadb.internal
    rel: mysql
    query:
        is_master: true
    path: main
    password: ''
    type: 'mariadb:10.6'
    port: 3306
    host_mapped: false
    url: 'mysql://user:@mariadb.internal:3306/main'

upsun tunnel:single --relationship RELATIONSHIP_NAME

Upgrading services

Upsun provides a large number of managed service versions. As new versions are made available, you will inevitably upgrade infrastructure to a more recent (or latest version).

When you do so, we would recommend:

1. Use preview environments. Leverage preview (non-production environments) to perform the upgrade, then merge the upgrade into production (promotion). This will give you an opportunity to test inherited production data in a safe, isolated environment first.
2. Upgrade progressively. For one reason or another, you may be more than a single version behind the upgrade you are trying to perform. To avoid data loss issues caused by large differences in versions, upgrade one version at a time.