Update explanation of --enable-dependency-version-downgrades flag

Signed-off-by: Jared Watts <jbw976@gmail.com>
This commit is contained in:
Jared Watts 2025-05-14 17:02:05 +01:00
parent 2b6b6b1296
commit 18683f21c4
No known key found for this signature in database
GPG Key ID: 0467EEAE3B6EC0D2
2 changed files with 164 additions and 164 deletions

View File

@ -285,15 +285,15 @@ installations. Suppose configuration A, which depends on package X with the
constraint`>=v0.0.0`, is installed on the control plane. In this case, the package constraint`>=v0.0.0`, is installed on the control plane. In this case, the package
manager installs the latest version of package X, such as `v3.0.0`. Later, you decide manager installs the latest version of package X, such as `v3.0.0`. Later, you decide
to install configuration B, which depends on package X with the constraint `<=v2.0.0`. to install configuration B, which depends on package X with the constraint `<=v2.0.0`.
Since version `v2.0.0`satisfies both conditions, package X must be downgraded to Since version `v2.0.0` satisfies both conditions, package X must be downgraded to
allow the installation of configuration B which is disabled by default. allow the installation of configuration B which is disabled by default.
For enabling automatic dependency version downgrades, there is a configuration Automatic dependency version downgrades is also an alpha feature that can be
option as a helm value `packageManager.enableAutomaticDependencyDowngrade=true`. enabled with the `--enable-dependency-version-downgrades` flag. Downgrading a
Downgrading a package can cause unexpected behavior, therefore, this package can cause unexpected behavior, therefore, this option is disabled by
option is disabled by default. After enabling this option, the package manager will default. After enabling this option, the package manager will automatically
automatically downgrade a package's dependency version to the maximum valid version downgrade a package's dependency version to the maximum valid version that
that satisfies the constraints. satisfies the constraints.
{{<hint "note" >}} {{<hint "note" >}}
This configuration requires the `--enable-dependency-version-upgrades` flag. This configuration requires the `--enable-dependency-version-upgrades` flag.

View File

@ -308,15 +308,15 @@ installations. Suppose configuration A, which depends on package X with the
constraint`>=v0.0.0`, is installed on the control plane. In this case, the package constraint`>=v0.0.0`, is installed on the control plane. In this case, the package
manager installs the latest version of package X, such as `v3.0.0`. Later, you decide manager installs the latest version of package X, such as `v3.0.0`. Later, you decide
to install configuration B, which depends on package X with the constraint `<=v2.0.0`. to install configuration B, which depends on package X with the constraint `<=v2.0.0`.
Since version `v2.0.0`satisfies both conditions, package X must be downgraded to Since version `v2.0.0` satisfies both conditions, package X must be downgraded to
allow the installation of configuration B which is disabled by default. allow the installation of configuration B which is disabled by default.
For enabling automatic dependency version downgrades, there is a configuration Automatic dependency version downgrades is also an alpha feature that can be
option as a helm value `packageManager.enableAutomaticDependencyDowngrade=true`. enabled with the `--enable-dependency-version-downgrades` flag. Downgrading a
Downgrading a package can cause unexpected behavior, therefore, this package can cause unexpected behavior, therefore, this option is disabled by
option is disabled by default. After enabling this option, the package manager will default. After enabling this option, the package manager will automatically
automatically downgrade a package's dependency version to the maximum valid version downgrade a package's dependency version to the maximum valid version that
that satisfies the constraints. satisfies the constraints.
{{<hint "note" >}} {{<hint "note" >}}
This configuration requires the `--enable-dependency-version-upgrades` flag. This configuration requires the `--enable-dependency-version-upgrades` flag.