Skip to content

Latest commit

 

History

History
301 lines (192 loc) · 24.3 KB

CHANGELOG.md

File metadata and controls

301 lines (192 loc) · 24.3 KB
Raw

Changelog

All notable changes to this project's source code will be documented in this file. Items under Unreleased are upcoming features that will be out in the next version.

Contributors

Please follow the recommendations outlined at keepachangelog.com. Please use the existing headings and styling as a guide, and add a link for the version diff at the bottom of the file. Also, please update the Unreleased link to compare it to the latest release version.

Versions

Unreleased

Changes since the last non-beta release.

Please add entries here for your pull requests that have not yet been released.

4.1.0 - 2024-12-17

Fixed

  • Fixed issue where run command fails when runner workload has ENV but original workload does not. PR 227 by Rafael Gomes.
  • Fixed potential infinite loop that could occur for a command if one of the execution steps fails and gets stuck. PR 217 by Zakir Dzhamaliddinov.
  • Fixed issue where app cannot be deleted because one of the workloads has a volumeset in-use. PR 245 by Zakir Dzhamaliddinov.
  • Fixed resolv may be not properly required PR 250 by Sergey Tarasov.

Added

4.0.0 - 2024-08-21

Fixed

3.0.1 - 2024-06-26

Fixed

3.0.0 - 2024-06-21

First release of cpflow.

2.2.4 - 2024-06-21

Deprecated cpl gem. New gem is cpflow.

2.2.1 - 2024-06-17

Fixed

  • Fixed issue where latest image may be incorrect. PR 201 by Rafael Gomes.
  • Fixed issue where build-image command hangs forever waiting for image to be available. PR 201 by Rafael Gomes.

2.2.0 - 2024-06-07

Fixed

  • Fixed issue where ps:wait command hangs forever if workloads are suspended. PR 198 by Rafael Gomes.

Added

  • Added a timeout for run jobs (6 hours by default, but configurable through runner_job_timeout in controlplane.yml). PR 194 by Rafael Gomes.

Changed

  • run command now overrides the --image, --cpu, and --memory for each job separately, which completely removes any race conditions when running simultaneous jobs with different overrides. PR 182 by Rafael Gomes.
  • run jobs now use a CPU size of 1 (1 core) and a memory size of 2Gi (2 gibibytes) by default (configurable through runner_job_default_cpu and runner_job_default_memory in controlplane.yml). PR 182 by Rafael Gomes.
  • run command now keeps ENV values synced between original and runner workloads. PR 196 by Rafael Gomes.

2.1.0 - 2024-05-27

Fixed

Added

  • Added post-creation hook to setup-app command (configurable through hooks.post_creation in controlplane.yml). PR 183 by Rafael Gomes.
  • Added pre-deletion hook to delete command (configurable through hooks.pre_deletion in controlplane.yml). PR 183 by Rafael Gomes.
  • Added doctor command to run validations. PR 185 by Rafael Gomes.

Changed

  • cpflow now sets CPLN_SKIP_UPDATE_CHECK to true for all internal cpln calls, which disables the version check and prevents cluttering the logs. PR 180 by Rafael Gomes.
  • setup-app command now automatically creates a secret, policy, and identity for the app if they do not exist. The --skip-secrets-setup option prevents this behavior. PR 181 by Rafael Gomes. PR 190 by Rafael Gomes.
  • Specific validations are now run before commands, and the command will exit with a non-zero code if any validation fails. Can be disabled by setting DISABLE_VALIDATIONS env var to true. PR 185 by Rafael Gomes.
  • Deprecated the --skip-secret-access-binding option in favor of --skip-secrets-setup. This can also now be configured through skip_secrets_setup in controlplane.yml PR 190 by Rafael Gomes.

2.0.2 - 2024-05-18

  • Fixed issue with improper handling of job statuses. Fixed issue with interactive magic string showing and exit code. PR 177 by Sergey Tarasov.

2.0.1 - 2024-05-16

Fixed

  • Fixed issue where cleanup-stale-apps command fails to delete apps with volumesets. PR 175 by Rafael Gomes.

2.0.0 - 2024-05-15

BREAKING CHANGES

  • Commands that finished with a failure now exit with code 64 instead of 1. PR 132 by Rafael Gomes.
  • Bumped minimum cpln version to 2.0.1 (cpln workload cron get is required). PR 171 by Rafael Gomes.
  • run:cleanup command has been removed. PR 151 by Rafael Gomes.
  • deploy-image command now runs the release script in the context of the run command. PR 151 by Rafael Gomes.

Fixed

Added

  • Added options to run command to override the workload container's --cpu, --memory, and --entrypoint. PR 151 by Rafael Gomes.
  • Added --workload option to delete command to delete a specific workload. PR 151 by Rafael Gomes.
  • Added --replica option to logs command to see logs from a specific replica. PR 151 by Rafael Gomes.
  • Added --replica option to ps:stop command to stop a specific replica. PR 151 by Rafael Gomes.
  • Added option to set custom names for secrets and secrets policy, using secrets_name and secrets_policy_name in controlplane.yml. PR 159 by Rafael Gomes.

Changed

  • An error is now raised if the org does not exist. PR 167 by Rafael Gomes.
  • Common options are now shown in help. PR 169 by Rafael Gomes.
  • run command now uses a single reusable cron workload and works for both interactive and non-interactive jobs. PR 151 by Rafael Gomes.
  • run:detached command has been deprecated in favor of run. PR 151 by Rafael Gomes.
  • deploy-image command now raises an error if image does not exist. PR 153 by Rafael Gomes.
  • delete command now unbinds identity from policy (if bound) when deleting app. PR 170 by Rafael Gomes.

1.4.0 - 2024-03-21

Added

  • Added new template substitution variables (used by apply-template and setup-app commands): {{APP_LOCATION_LINK}}, {{APP_IMAGE_LINK}}, {{APP_IDENTITY}}, {{APP_IDENTITY_LINK}}, {{APP_SECRETS}} and {{APP_SECRETS_POLICY}}. PR 146 by Rafael Gomes.
  • Added --run-release-phase option to deploy-image command to run release script before deploying (same step as in promote-app-from-upstream command). PR 146 by Rafael Gomes.

Changed

  • Template substitution (used by apply-template and setup-app commands) now uses double braces (e.g., APP_ORG -> {{APP_ORG}}). This change is backwards compatible. PR 146 by Rafael Gomes.
  • Renamed template substitution variable APP_GVC to {{APP_NAME}} (used by apply-template and setup-app commands). This change is backwards compatible. PR 146 by Rafael Gomes.
  • setup-app command now automatically binds the app to the secrets policy, as long as both the identity and the policy exist. Added --skip-secret-access-binding option to prevent this behavior. PR 146 by Rafael Gomes.
  • Local API token is now refreshed when it is about to expire. PR 146 by Rafael Gomes.
  • apply-template command now exits with non-zero code if failed to apply any templates. PR 146 by Rafael Gomes.

1.3.0 - 2024-03-19

Fixed

  • Fixed issue where cpln profile was not switched back to default if an error happened while running copy-image-from-upstream command. PR 135 by Rafael Gomes.
  • Fixed issue that didn't allow using upstream with match_if_app_name_starts_with set to true in copy-image-from-upstream command. PR 136 by Rafael Gomes.

Added

  • Added --no-clean-on-failure option to run:detached command to skip deletion of failed workload run. PR 133 by Justin Gordon and Rafael Gomes.
  • Added --domain option to maintenance, maintenance:on and maintenance:off commands. PR 131 by Rafael Gomes.
  • Added default_domain config to specify domain for maintenance, maintenance:on and maintenance:off commands. PR 131 by Rafael Gomes.
  • Added option to specify upstream for copy-image-from-upstream command through CPLN_UPSTREAM env var. PR 138 by Rafael Gomes.

Changed

  • build-image command now accepts extra options and passes them to docker build. PR 126 by Rafael Gomes.
  • CPLN_ORG_UPSTREAM env var now takes precedence over config from controlplane.yml in copy-image-from-upstream command. PR 137 by Rafael Gomes.
  • info command now works properly for apps with match_if_app_name_starts_with set to true.PR 139 by Rafael Gomes.
  • info command now lists workloads in the same order as controlplane.yml. PR 139 by Rafael Gomes.
  • Improved domain workload matching for maintenance, maintenance:on and maintenance:off commands (instead of matching only by workload, it now matches by org + app + workload, which is more accurate). PR 140 by Rafael Gomes.

1.2.0 - 2024-01-04

Fixed

  • Fixed issue where info command does not respect CPLN_ORG env var. PR 88 by Rafael Gomes.
  • Fixed issues with running cpflow --version and cpflow --help where no configuration file exists. PR 109 by Mostafa Ahangarha.
  • Fixed issue where delete command fails to delete apps with volumesets. PR 123 by Rafael Gomes.

Added

  • Added --org option to all commands. PR 88 by Rafael Gomes.
  • Added option to set the app with a CPLN_APP env var. PR 88 by Rafael Gomes.
  • Show org and app on every command excluding info, version, maintenance, env, ps, and latest_image. PR 94 by Mostafa Ahangarha.
  • Added option to only use CPLN_ORG and CPLN_APP env vars if allow_org_override_by_env and allow_app_override_by_env configs are set to true in controlplane.yml. PR 109 by Rafael Gomes.
  • Added CPLN_LOCATION env variable and --location option for apply-template, ps, run, run:detached. PR 105 by Mostafa Ahangarha.
  • Added generate command for creating basic Control Plane configuration directory. PR 116 by Mostafa Ahangarhga.
  • Added --trace option to all commands for more detailed logs. PR 124 by Justin Gordon.
  • Added better error message to check the org name in case of a 403 error. PR 124 by Justin Gordon.

Changed

  • --org option now takes precedence over CPLN_ORG env var, which takes precedence over cpln_org from controlplane.yml. PR 88 by Rafael Gomes.
  • Renamed setup config into setup_app_templates. PR 112 by Mostafa Ahangarha.

1.1.2 - 2023-10-25

Fixed

  • Fixed failed build on MacOS by adding platform flag and fixed multiple files in yaml document for template. PR 81 by Justin Gordon.

Added

  • Added open-console command to open the app console on Control Plane. PR 83 by Rafael Gomes.
  • Added option to set the org with a CPLN_ORG/CPLN_ORG_UPSTREAM env var. PR 83 by Rafael Gomes.
  • Added --verbose option to all commands for more detailed logs. PR 83 by Rafael Gomes.

Changed

1.1.1 - 2023-09-21

Fixed

  • Fixed issue where API token is not reset when switching profile. PR 77 by Rafael Gomes.

1.1.0 - 2023-09-20

Fixed

  • Fixed issue where copy-image-from-upstream command does not copy commit. PR 70 by Rafael Gomes.
  • Fixed issue where an error is not raised if the app is not defined. PR 73 by Rafael Gomes.
  • Fixed issue where CPLN_ENDPOINT is not used if available. PR 75 by Rafael Gomes.

Added

  • Added image_retention_max_qty config to clean up images based on max quantity with cleanup-images command. PR 72 by Rafael Gomes.

Changed

  • Updated docs for run commands regarding passing arguments at the end. PR 71 by Rafael Gomes.
  • Renamed cleanup-old-images command to cleanup-images. PR 72 by Rafael Gomes.
  • Renamed old_image_retention_days config to image_retention_days. PR 72 by Rafael Gomes.

1.0.4 - 2023-07-24

Fixed

  • Fixed issue where run commands fail when not providing image. PR 68 by Rafael Gomes.

1.0.3 - 2023-07-07

Fixed

Added

1.0.2 - 2023-07-02

Added

1.0.1 - 2023-06-28

Fixed

  • Fixed cleanup-stale-apps command when app does not have image. PR 55 by Rafael Gomes.

Changed

1.0.0 - 2023-05-29

First release.