Add an override configuration

Use overrides as a method of sharing common configurations across environments.

2 minute read

An override is a way for you to customize or modify certain aspects of the score.yaml file. Overrides can be used to introduce changes directly to the Workload Definition without having to set up numerous files and Environment Profiles containing the same static values.

By default, the Score implementation tool looks for a score.yaml file and overrides the declared defaults within that file, if overrides.score.yaml exits.

The following Score implementation CLI’s support passing an override file as an argument.

score-compose
score-helm
score-humanitec

Alternatively, use the --property flag to specify individual properties to override. For more information, see Override properties.

Overview

If an overrides.score.yaml file is found, the Score implementation (CLI) applies overrides on the output. This occurs whether a flag is provided or not.

Any property of Score segment can be overridden.

For example, the score.yaml file contains a configuration, however, the overrides.score.yaml file contains configuration overrides for new and existing services.

If a configuration option is defined in both the default score.yaml file and the overrides.score.yaml file, the default values are replaced with the overrides.

Override a command

To override the defaults declared in your score.yaml file, create a overrides.score.yaml file and declare your overrides.

Create a score.yaml file.

apiVersion: score.dev/v1b1
metadata:
  name: run-python-app

containers:
  my-service:
    image: python3
    command:
      - python
      - --version

Create an overrides.score.yaml file and declare an override.

containers:
  my-service:
    command:
      - python
      - --help

Run the following command to override the default arguments by the overrides.score.yaml file.

score-compose run -f ./score.yaml \
  -o ./compose.yaml \
  --overrides ./overrides.score.yaml

The following is an example output of the previous command.

services:
  run-python-app:
    entrypoint:
      - python
      - --help
    image: python3

Results You’ve successfully overridden the default configuration file with a command described in your overrides.score.yaml file.

Override a property through the CLI

Override properties with the CLI.