Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit info about rollback support for EC #2838

Merged
merged 4 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/custom-resource-application.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ spec:
</tr>
<tr>
<th>Supported for <a href="/vendor/embedded-overview">Embedded Cluster</a>?</th>
<td>No. <code>allowRollback</code> is not supported because Embedded Cluster does not support rolling back or downgrading.</td>
<td>Embedded Cluster 1.17.0 and later supports _partial_ rollbacks of the application version. 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.</td>
</tr>
</table>

Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/rn-embedded-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Released on November 4, 2024
</table>

### 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_.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ copied over the same language used elsewhere and then added a link to the Application custom resource topic for more info about enabling rollbacks

* Introduces a new landing page and guided installation workflow for the Admin Console.

### Improvements {#improvements-1-17-0}
Expand Down
2 changes: 1 addition & 1 deletion docs/vendor/embedded-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Embedded Cluster has the following limitations:

* **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_.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ 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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also clarified the version


* **Changing node hostnames is not supported**: After a host is added to a Kubernetes cluster, Kubernetes assumes that the hostname and IP address of the host will not change. If you need to change the hostname or IP address of a node, you must first remove the node from the cluster. For more information about the requirements for naming nodes, see [Node name uniqueness](https://kubernetes.io/docs/concepts/architecture/nodes/#node-name-uniqueness) in the Kubernetes documentation.

Expand Down