openshift-docs/microshift_release_notes/microshift-4-14-release-notes.adoc

:_content-type: ASSEMBLY
[id="microshift-4-14-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, {product-title} provides an efficient way to operate single-node clusters in low-resource edge environments.

{product-title} 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.

[id="microshift-4-14-about-this-release"]
== About this release
// TODO: Update with the relevant information closer to release.
{product-title} was previously introduced as Technology Preview in {product-title} 4.13 and is now Generally Available with {product-title} 4.14. Support for {product-title} 4.13 is planned to end in a future {product-title} release. You should plan to update to the latest version of {product-title}. This release uses link:https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.27.md[Kubernetes 1.27] with CRI-O runtime. New features, changes, and known issues that pertain to {product-title} {product-version} are included in this topic.

You can deploy {product-title} clusters to either on-premise, cloud, or disconnected environments.

// Double check OP system versions
{product-title} {product-version} is supported on {op-system-ostree-first} and {op-system-base-full} 9.2.

//TODO: update link after GA; KCS article will not be live until then
//For lifecycle information, see the link:https://access.redhat.com/support/policy/updates/openshift[Red Hat {product-title} Life Cycle Policy].

[id="microshift-4-14-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, for example:
[id="microshift-4-14-rhel"]
=== {op-system-base-full} {op-system-version}
* {product-title} runs on {op-system-base-full} version 9.2.

// Some details of the next note are adapted from https://kubernetes.io/blog/2022/08/31/cgroupv2-ga-1-25/
* {product-title} uses crun and Control Group v2 (cgroup v2). {OCP} {ocp-version} defaults to Control Group v1. The divergence of control group versions is not anticipated to have a noticeable behavior difference on most workloads. If workloads rely on the cgroup file system layout, they may 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 the JDK, ensure you are using JDK 11.0.16 and later or JDK 15 and later, which fully support cgroup v2.

[id="microshift-4-14-updating"]
=== Updating

[id="microshift-4-14-updates-supported"]
==== Updates are supported on {product-version} and later
With this release, updates for both minor releases and patch releases are supported.

* {product-title} 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.
* Updates from preview versions such as {product-title} 4.13 and earlier are not supported.

//[id="microshift-4-14-new-feat-based-on-{op-system-ostree}"]
//==== Placeholder for new feat bases on RHEL Edge

//[id="microshift-4-14-installation"]
//=== Installation

//[id="microshift-4-14-new-feature-for-use-at-installation"]
//==== New feature for use during installation here
//can include a note about a change in base RHEL image

//[id="microshift-4-14-support"]
//=== Support

//[id="microshift-4-14-post-installation"]
//=== Post-installation configuration

//[id="microshift-4-14-administrator-perspective"]
//==== Administrator Perspective
//admin perspectives go here

//[id="ocp-4-14-security"]
//=== Security and compliance
//
// This content will be added post-GA, as it is asynchronous content.

//[id="microshift-4-14-networking"]
//=== Networking

//[id="microshift-4-14-load-balancer"]
//==== Deploying network load balancers on {product-title}

[id="microshift-4-14-storage"]
=== Storage

[id="microshift-backup-and-restore"]
=== Backup and restore
The capability to back up and restore the {product-title} database is now available. You can manually back up and restore data on all supported systems at any time. See the xref:../microshift_backup_and_restore/microshift-backup-and-restore.adoc#microshift-backup-and-restore[Backing up and restoring {product-title} data] documentation for more information.

//[id="microshift-4-14-running-apps"]
//=== Running Applications
//still need to add

//[id="microshift-4-14-lvms-system-requirements"]
//==== LVMS system requirements

[id="microshift-4-14-deprecated-and-removed"]
== Deprecated and removed features

Some features available in previous releases of {product-title} have been deprecated or removed.

Deprecated functionality is still included in {product-title} 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 {product-title} {product-version}, refer to the tables below. Additional details for more functionality that has been deprecated and removed are listed after the table.

In the following tables, features are marked with the following statuses:

* _Available_

* _Deprecated_

* _Removed_

.{product-title} deprecated and removed tracker
[cols="4,1,1,1",options="header"]
|====
|Feature |4.12 |4.13 | 4.14

|Network configuration flags
|-
|Depricated
|Removed

|CIDR notation
|-
|-
|Removed

|====
[discrete]
[id="microshift-4-14-network-config-flags-removed"]
==== Network configuration flags are removed

The gateway bridge flag, 'gatewayInterface', and the OVS flag, `disableOVSInit`, in the networking configuration file, `/etc/microshift/ovn.yaml`, are removed with this release. See the xref:../microshift_networking/microshift-networking-settings.adoc#microshift-config-OVN-K_microshift-networking[MicroShift OVN-K configuration] documentation for more information.

[discrete]
[id="microshift-4-14-cidr-removal"]
==== CIDR notation removed from configuration

The CIDR notation for grouping IP addresses was removed from the `clusterNetwork` configuration. For an example, see the xref:../microshift_configuring/microshift-using-config-tools.adoc#microshift-yaml-default_microshift-using-config-tools[Using configuration tools] documentation.

[id="microshift-4-14-bug-fixes"]
== Bug fixes

* Before this update, {product-title} automatically adjusted the maximum memory limit for etcd to match the minimum supported level if the value in the configuration file was too small. With this update, {product-title} enforces valid configuration by exiting with an error if the memory limit for etcd is set below the minimum allowed value of 128 MB. (link:https://issues.redhat.com/browse/OCPBUGS-11592[*OCPBUGS-11592*])

* Previously, certificate authorities generated `kubeconfig` files for {product-title}'s embedded components. With this update, certificate authorities are reconfigured to ensure the `kubeconfig` files are independent. (link:https://issues.redhat.com/browse/OCPBUGS-8301[*OCPBUGS-8301*])

[id="microshift-4-14-known-issues"]
== Known issues

* OVN-Kubernetes sets up an iptable chain in the network address translation (NAT) table to handle incoming traffic to the NodePort service. When the NodePort service is not reachable or the connection is refused, check the iptable rules on the host to make sure the relevant rules are properly inserted.
+
. View the iptable rules for the NodePort service by running the following command:
+
[source, terminal]
----
$ sudo iptables-save | grep NODEPORT
----
+
.Example output
[source, terminal]
----
-A OUTPUT -j OVN-KUBE-NODEPORT
-A OVN-KUBE-NODEPORT -p tcp -m addrtype --dst-type LOCAL -m tcp --dport 30326 -j DNAT --to-destination 10.43.95.170:80
----
OVN-Kubernetes configures the `OVN-KUBE-NODEPORT` iptable chain in the NAT table to match the packet with the destination port and Destination Network Address Translates (DNATs) the packet to the `clusterIP` service. The packet is then routed to the OVN network through the gateway bridge `br-ex` using routing rules on the host.
+
. View the hosts routing table by running the following command:
+
[source, terminal]
----
$ ip route
----
+
.Example output
[source, terminal]
----
10.43.0.0/16 via 192.168.122.1 dev br-ex mtu 1400
----
This routing rule matches the Kubernetes service IP address range and forwards the packet to the gateway bridge `br-ex`. You must enable `ip_forward` on the host. After the packet is forwarded to the OVS bridge `br-ex`, it is handled by OpenFlow rules in OVS. OpenFlow then steers the packet to the OVN network and eventually to the pod.

[id="microshift-4-14-notable-technical-changes"]
== Notable technical changes

{product-title} {product-version} introduces the following notable technical changes.
// Note: use [discrete] for these sub-headings.

[discrete]
[id="microshift-4-14-networking-changes"]
=== Networking changes

Networking updates to {product-title} {product-version} include traffic flow pattern, gateway, and custom configuration changes.

[discrete]
[id="microshift-4-14-traffic-flow-change"]
==== North-south traffic flow changed

The external gateway bridge and the physical device on the host are no longer connected. The north-south traffic between the network service and the OVN external switch flows from the host kernel to {product-title} through the external gateway bridge. See the xref:../microshift_networking/microshift-cni.adoc#microshift-network-topology_microshift-networking[About the OVN-Kubernetes network plugin] documentation for more information.

[id="microshift-4-14-asynchronous-errata-updates"]
== Asynchronous errata updates

Security, bug fix, and enhancement updates for {product-title} {product-version} are released as asynchronous errata through the Red Hat Network. All {product-title} {product-version} errata are https://access.redhat.com/downloads/content/290/[available on the Red Hat Customer Portal]. Read the https://access.redhat.com/support/policy/updates/openshift[{product-title} Life Cycle] for more information about asynchronous errata.

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 {product-title} entitlements for {product-title} 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 {product-title} {ocp-version}. Versioned asynchronous releases, for example with the form {product-title} {ocp-version}.z, will be detailed in the following subsections.

[id="microshift-4-14-0-dp"]
=== RHSA-2023:5008 - {product-title} 4.14.0 bug fix and security update advisory

Issued: 2023-10-31

{product-title} release 4.14.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/RHSA-2023:5008[RHSA-2023:5008] advisory. The images that are included in the update are provided by the link:https://access.redhat.com/errata/RHSA-2023:5006[RHSA-2023:5006] advisory.

For the `TopoLVM image`, see link:https://catalog.redhat.com/software/containers/lvms4/topolvm-rhel9/63972de3adcb55263891b983?container-tabs=dockerfile[lvms4/topolvm-rhel9].