Compose

Warning

This feature is still experimental, feedback are welcome.

Description

Updatecli compose feature allows to specify a list of Updatecli policies to enforce. This becomes handy when we want to apply the same policies on multiple repositories.

By default, it relies on a file named "update-compose.yaml" such as in the follow example:

update-compose.yaml

policies:
  - name: Local Updatecli Website Policies
    config:
      - updatecli/updatecli.d/

  - name: Handle Nodejs version in githubaction
    policy: ghcr.io/updatecli/policies/policies/nodejs/githubaction:latest
    values:
      - updatecli/values.d/scm.yaml
      - updatecli/values.d/nodejs.yaml

Running updatecli compose apply would enforce the state defined in each of the policies
Running updatecli compose diff would show the targeted state defined in each of the policies
Running updatecli compose show would show the manifest generated by each of the policies

Parameters

Name	Type	Description
env_files	array	Env_files contains a list of environment files
environments	object	Environment contains a list of environment variables
policies	array	Policies contains a list of policies
config	array	Config contains a list of Updatecli config file path
name	string	Name contains the policy name
policy	string	Policy contains the policy OCI name
secrets	array	Secrets contains a list of Updatecli secret file path
values	array	Values contains a list of Updatecli config file path

⚠ This table is generated from the Updatecli codebase and may contain inaccurate data. Feel free to report them on github.com/updatecli/updatecli

Important

Any value files or secrets file specified in the docker-compose.yaml overrides the default values specified by the policy. It’s also worth mentioning that deep merge is not supported.

Examples

Updatecli

The repository updatecli/policies contains a list of common Updatecli policies published on GitHub Registry.

Last modified on November 10, 2023

Edit this page on GitHub