Edit info about rollback support for EC #2838
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
paigecalvert
commented
Nov 19, 2024
|
|
||
| ### New Features {#new-features-1-17-0} | ||
| * Adds partial rollback support where you can roll back from one version to another as long as the Embedded Cluster Config doesn't change between the two. | ||
| * Adds support for partial rollbacks. Partial rollbacks are supported only when rolling back to a version where there is no change to the Embedded Cluster Config compared to the currently-installed version. For example, users can roll back to release version 1.0.0 after upgrading to 1.1.0 only if both 1.0.0 and 1.1.0 use the same Embedded Cluster Config. For more information about how to enable rollbacks for your application in the KOTS Application custom resource, see [allowRollback](/reference/custom-resource-application#allowrollback) in _Application_. |
Contributor
Author
There was a problem hiding this comment.
^ copied over the same language used elsewhere and then added a link to the Application custom resource topic for more info about enabling rollbacks
paigecalvert
commented
Nov 19, 2024
docs/vendor/embedded-overview.mdx
Outdated
| * **Disaster recovery is in alpha**: Disaster Recovery for Embedded Cluster installations is in alpha. For more information, see [Disaster Recovery for Embedded Cluster (Alpha)](/vendor/embedded-disaster-recovery). | ||
|
|
||
| * **Partial rollback support**: Rollbacks for Embedded Cluster installations are supported only when rolling back to a version where there is no change to the [Embedded Cluster Config](https://docs.replicated.com/reference/embedded-config) compared to the currently-installed version. For example, users can roll back to release version 1.0.0 after upgrading to 1.1.0 only if both 1.0.0 and 1.1.0 use the same Embedded Cluster Config. | ||
| * **Partial rollback support**: In Embedded Cluster 1.17.0 and later, rollbacks are supported only when rolling back to a version where there is no change to the [Embedded Cluster Config](https://docs.replicated.com/reference/embedded-config) compared to the currently-installed version. For example, users can roll back to release version 1.0.0 after upgrading to 1.1.0 only if both 1.0.0 and 1.1.0 use the same Embedded Cluster Config. For more information about how to enable rollbacks for your application in the KOTS Application custom resource, see [allowRollback](/reference/custom-resource-application#allowrollback) in _Application_. |
Contributor
Author
There was a problem hiding this comment.
^ Added a link to the Application custom resource topic since we weren't really telling people actual how to enable rollbacks in the first place
Contributor
Author
There was a problem hiding this comment.
Also clarified the version
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://deploy-preview-2838--replicated-docs.netlify.app/vendor/embedded-overview#limitations
https://deploy-preview-2838--replicated-docs.netlify.app/release-notes/rn-embedded-cluster#1170
https://deploy-preview-2838--replicated-docs.netlify.app/reference/custom-resource-application#allowrollback