Upgrade YAML configuration using CLI

Learn how to use the YAML configuration CLI to upgrade a YAML configuration.

2 minute read

The upgrade option is the centralized entry point to upgrade any kind of YAML configuration. It enables you to upgrade YAML configurations or YAML configuration fragments to their latest version.

The following are examples of different ways that you can use the upgrade option to update your YAML configuration.

Example 1:

  • Specify the directory for the YAML configuration to upgrade.
  • Add the upgraded YAML configuration to the /home/user/yaml-upgraded directory.
  • Create a .tar.gz file of the content of /home/user/yaml-upgraded.
./yamles upgrade --source /home/user/yaml --output-dir /home/user/yaml-upgraded --targz /home/user/archives/yaml-upgraded.tar.gz

Example 2:

  • Specify the URL for the YAML configuration to upgrade.
  • Add the upgraded YAML configuration to the /home/user/yaml-upgraded directory.
./yamles upgrade --source yaml:file:///home/user/yaml --output-dir /home/user/yaml-upgraded

Example 3:

  • Specify the .tar.gz file for the YAML configuration to upgrade.
  • Add the upgraded YAML configuration to the /home/user/yaml-upgraded directory.
  • Create a .tar.gz file of the content of /home/user/yaml-upgraded.
./yamles upgrade --source yaml-to-upgrade.tar.gz --output-dir /home/user/yaml-upgraded --targz /home/user/archives/yaml-upgraded.tar.gz

Example 4:

  • Specify the .tar.gz file for the YAML configuration to upgrade.
  • Upgrade the YAML configuration with a non-default passphrase.
  • Add the upgraded YAML configuration to the /home/user/yaml-upgraded directory.
  • Create a .tar.gz file of the content of /home/user/yaml-upgraded.
./yamles upgrade --source yaml-to-upgrade.tar.gz --passphrase secret --output-dir /home/user/yaml-upgraded --targz /home/user/archives/yaml-upgraded.tar.gz

You can run the following help command for more details on each parameter of the upgrade option:

yamles upgrade --help