Specify configuration overrides

An override is a way for you to customize or modify certain aspects of the score.yaml file. With score-compose can be achieved using either:

• Overrides file
• Overrides CLI flag

Overrides file

If an overrides.score.yaml file is found, the score-compose and score-k8s CLIs apply overrides on the output. This occurs whether a flag is provided or not.

How to override a command

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

1. Create a score.yaml file.

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

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

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

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

3. Run the following command to override the default arguments with the contents of the overrides.score.yaml file.

• score-compose
• score-k8s

score-compose generate score.yaml --overrides-file overrides.score.yaml

score-k8s generate score.yaml --overrides-file overrides.score.yaml

Overrides CLI flag

You can override the declared values in your command line arguments with the --override-property flag. This is an alternative approach to using a overrides.score.yaml file.

How to override a property

Use the --override-property flag and specify the path to the property and the new value.

For example, the following looks for the containers.my-service.image property and overrides the default image name with a value of python3.

• score-compose
• score-k8s

score-compose generate -f score.yaml --override-property containers.my-service.image=python3

score-k8s generate -f score.yaml --override-property containers.my-service.image=python3

How to remove a property

Set the path of the property to an empty value to remove the property.

• score-compose
• score-k8s

score-compose generate -f score.yaml --override-property metadata.my-service=

score-k8s generate -f score.yaml --override-property metadata.my-service=

Build or supply a container image

When you run score-compose generate or score-k8s generate, each workload needs a container image. You can supply a pre-built image, or, with score-compose, build one from local source.

How to supply a pre-built image

The value provided to the --image flag overrides the image field of any workload that lacks an explicit image definition in its Score file. To handle different images for multiple workloads, use the --override-property flag shown in How to override a property.

• score-compose
• score-k8s

score-compose generate score.yaml --image my-registry/hello-world:1.0.0

score-k8s generate score.yaml --image my-registry/hello-world:1.0.0

How to build a container image

Specific to score-compose generate, the --build flag specifies an optional build context to use for the given container. The format is either --build=CONTAINER=./dir or --build=CONTAINER={"context":"./dir"}.

The following example builds the hello-world container from the current directory:

score-compose generate score.yaml --build 'hello-world={"context":"."}'

Run docker compose up with the --build flag so Docker builds the image before it starts the containers:

docker compose up --build -d