1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-07 09:46:53 +01:00
Files
openshift-docs/microshift_release_notes/microshift-4-16-release-notes.adoc
Jeana Routh 78b150be00 Merge pull request #74115 from aravipra/OSDOCS-9809
OSDOCS-9809: Adding cluster ID notes in microshift releasenotes
2024-04-11 15:50:50 -04:00

167 lines
9.2 KiB
Plaintext

:_mod-docs-content-type: ASSEMBLY
[id="microshift-4-16-release-notes"]
= {product-title} {product-version} release notes
include::_attributes/attributes-microshift.adoc[]
:context: release-notes
toc::[]
{product-title} provides developers and IT organizations with small-form-factor and edge computing delivered as an application that customers can deploy on top of their managed {op-system-base-full} devices at the edge. Built on {OCP} and Kubernetes, {microshift-short} provides an efficient way to operate single-node clusters in low-resource edge environments.
{microshift-short} is designed to make control plane restarts economical and be lifecycle-managed as a single unit by the operating system. Updates, roll-backs, and configuration changes consist of simply staging another version in parallel and then - without relying on a network - flipping to and from that version and restarting.
//TODO verify K8s version and another other relevant notes
[id="microshift-4-16-about-this-release"]
== About this release
Version 4.16 of {product-title} includes new features and enhancements. {microshift-short} was introduced as Generally Available with {microshift-short} 4.14. Update to the latest version of {microshift-short} to receive all of the latest features, bug fixes, and security updates. {microshift-short} is derived from {OCP} {OCP-version} and uses the CRI-O container runtime. New features, changes, and known issues that pertain to {microshift-short} are included in this topic.
You can deploy {microshift-short} clusters to on-premise, cloud, disconnected, and offline environments.
//TODO: Update OP system versions
{microshift-short} {product-version} is supported on {op-system-base-full} or {op-system-ostree-first} 9.4.
For lifecycle information, see the link:https://access.redhat.com/product-life-cycles?product=Red%20Hat%20build%20of%20Microshift,Red%20Hat%20Device%20Edge[{product-title} Life Cycle Policy].
[id="microshift-4-16-new-features-and-enhancements"]
== New features and enhancements
This release adds improvements related to the following components and concepts.
//L3 major categories with features in each as L4s
[id="microshift-4-16-rhel"]
=== {op-system-base-full}
//* {microshift-short} now runs on {op-system-base-full} 9.4
// Some details of the next note are adapted from https://kubernetes.io/blog/2022/08/31/cgroupv2-ga-1-25/
* {microshift-short} uses crun and Control Group v2 (cgroup v2). If workloads rely on the cgroup file system layout, they might need to be updated to be compatible with cgroup v2.
** If you run third-party monitoring and security agents that depend on the cgroup file system, update the agents to versions that support cgroup v2.
** If you run cAdvisor as a standalone DaemonSet for monitoring pods and containers, update it to v0.43.0 or later.
** If you deploy Java applications with JDK, ensure you are using JDK 11.0.16 and later or JDK 15 and later, which fully support cgroup v2.
[id="microshift-4-16-updating"]
=== Updating
Updating two minor versions in a single step is now supported. Updates for both single-version minor releases and patch releases are still supported.
[id="microshift-4-16-updates-supported"]
==== Update two minor versions in a single step
See the following list for details:
* You can update from one long-life-cycle version of {microshift-short} directly to another, without applying the intermediate version. For example, you can update directly to 4.16 from 4.14. Updating 4.14 to 4.15 before updating to 4.16 is no longer required.
* Now, you can focus on developing applications for your devices in remote locations and with limited bandwidth, rather than planning for updates.
* {microshift-short} offers in-place updates on {op-system-ostree} systems with automatic system rollback capabilities and automatic back up and restore functions.
* Updates of the RPMs on a non-OSTree system such as {op-system} are also supported.
* See xref:../microshift_updating/microshift-update-options.adoc#microshift-update-options[Update options with {product-title} and {op-system-bundle}] for details.
//TODO add new features and enhancements as needed, L4 [discrete] headings
//[id="microshift-4-16-installation"]
//=== Installation
//[id="microshift-4-16-configuring"]
//===Configuring
//[id="microshift-4-16-networking"]
//=== Networking
//[id="microshift-4-16-storage"]
//=== Storage
//[id="microshift-4-16-updating"]
//=== Updating
[id="microshift-4-16-running-apps"]
=== Running applications
[id="microshift-4-16-gitops"]
==== GitOps with Argo CD now available
With this release, you can use the GitOps with Argo CD agent derived from GitOps 1.12 with {microshift-short}. Using GitOps means you can update a single Git repository and automate the deployment of new applications or updates to existing ones. You can also use your Git repository as an audit trail of changes so that you can create processes such as review and approval for merging pull requests that implement configuration changes.
See xref:../microshift_running_apps/microshift-gitops.adoc#microshift-gitops[Automating application management with the GitOps controller].
[id="microshift-4-16-support"]
=== Support
[id="microshift-4-16-support-updates"]
==== Getting a cluster ID
With this release, you can get the cluster ID of a {microshift-short} cluster. When opening a support case, you can provide the cluster ID to Red{nbsp}Hat Support to help in identifying issues with your cluster.
//[id="microshift-4-16-security"]
//=== Security and compliance
//[id="microshift-4-16-doc-enhancements"]
//=== Documentation enhancements
//Doc enhancements include additions for RFEs and other continuous improvement items that are substantial and are not tied to new features or bug fixes already listed here. These can also go under the relevant section as applicable.
//TODO: determine the guidelines for how long to maintain this table when nothing has been deprecated or removed in x number of releases
[id="microshift-4-16-deprecated-and-removed"]
== Deprecated and removed features
Some features available in previous releases of {microshift-short} have been deprecated or removed.
Deprecated functionality is still included in {microshift-short} and continues to be supported; however, it will be removed in a future release of this product and is not recommended for new deployments. For the most recent list of major functionality deprecated and removed within {microshift-short} {product-version}, see the following table.
In the following table, features are marked with the following statuses:
* _Available_
* _Deprecated_
* _Removed_
.{product-title} deprecated and removed features tracker
[cols="5,1,1,1",options="header"]
|====
|Feature |4.14 |4.15 |4.16
|Network configuration flags
|Removed
|-
|-
|CIDR notation
|Removed
|-
|-
|====
//NOTE: Current decision is to NOT repeat bug fixes already noted in previous z-streams
[id="microshift-4-16-bug-fixes"]
== Bug fixes
//[discrete]
//[id="microshift-4-16-installation-bug-fixes"]
//=== Installation
//[discrete]
//[id="microshift-4-16-networking-bug-fixes"]
//==== Networking
//[discrete]
//[id="microshift-4-16-support-bug-fixes"]
//==== Support
[id="microshift-4-16-asynchronous-errata-updates"]
== Asynchronous errata updates
Security, bug fix, and enhancement updates for {microshift-short} {product-version} are released as asynchronous errata through the Red Hat Network. All {microshift-short} {product-version} errata are https://access.redhat.com/downloads/content/290/[available on the Red Hat Customer Portal]. For more information about asynchronous errata, read the https://access.redhat.com/product-life-cycles?product=Red%20Hat%20build%20of%20Microshift,Red%20Hat%20Device%20Edge[{microshift-short} Life Cycle].
Red Hat Customer Portal users can enable errata notifications in the account settings for Red Hat Subscription Management (RHSM). When errata notifications are enabled, you are notified through email whenever new errata relevant to your registered systems are released.
[NOTE]
====
Red Hat Customer Portal user accounts must have systems registered and consuming {microshift-short} entitlements for {microshift-short} errata notification emails to generate.
====
This section is updated over time to provide notes on enhancements and bug fixes for future asynchronous errata releases of {microshift-short} {product-version}. Versioned asynchronous releases, for example with the form {microshift-short} {product-version}.z, are detailed in the following subsections.
//TODO verify info prior to merge freeze
[id="microshift-4-16-0-dp"]
=== RHEA-2024:0043 - {microshift-short} 4.16.0 bug fix and security update advisory
//Issued: 2024-MM-DD
{product-title} release 4.16.0 is now available. The list of bug fixes that are included in the update is documented in the link:https://access.redhat.com/errata/RHEA-2024:0043[RHEA-2024:0043] advisory. The images that are included in the update are provided by the link:https://access.redhat.com/errata/RHEA-2024:0041[RHEA-2024:0041] advisory.
For the latest images included with {microshift-short}, view the contents of the `microshift-release-info` RPM. See xref:../microshift_install/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-microshift-image-offline-deploy_microshift-embed-in-rpm-ostree-offline-use[Embedding {microshift-short} containers for offline deployments].