mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-11946: adds MicroShift 4.18 relnotes file to branch
This commit is contained in:
“Shauna Diaz”
@@ -33,8 +33,8 @@ Name: Red Hat build of MicroShift release notes
|
||||
Dir: microshift_release_notes
|
||||
Distros: microshift
|
||||
Topics:
|
||||
- Name: Red Hat build of MicroShift 4.17 release notes
|
||||
File: microshift-4-17-release-notes
|
||||
- Name: Red Hat build of MicroShift 4.18 release notes
|
||||
File: microshift-4-18-release-notes
|
||||
---
|
||||
Name: Getting ready to install MicroShift
|
||||
Dir: microshift_install_get_ready
|
||||
|
||||
@@ -1,146 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="microshift-4-17-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-17-about-this-release_{context}"]
|
||||
== About this release
|
||||
Version 4.17 of {product-title} includes new features and enhancements. 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} 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-17-new-features-and-enhancements_{context}"]
|
||||
== 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-17-rhel_{context}"]
|
||||
=== {op-system-base-full}
|
||||
* {microshift-short} {product-version} runs on {op-system-base-full} 9.4.
|
||||
|
||||
[id="microshift-4-17-updating_{context}"]
|
||||
=== Updating
|
||||
Updating two minor versions in a single step is supported in 4.17. Updates for both single-version minor releases and patch releases are still supported.
|
||||
|
||||
//TODO add new features and enhancements as needed, L4 [discrete] headings
|
||||
|
||||
//[id="microshift-4-17-installation_{context}"]
|
||||
//=== Installation
|
||||
|
||||
//[id="microshift-4-17-configuring_{context}"]
|
||||
//=== Configuring
|
||||
|
||||
[id="microshift-4-17-networking_{context}"]
|
||||
=== Networking
|
||||
|
||||
[id="microshift-4-17-IPv6_{context}"]
|
||||
==== IPv6 single and dual-stack IPv6 networking now available
|
||||
With this release, you can run {microshift-short} and your workloads with either IPv6 only or IPv4 and IPv6 dual-stack networking protocols. Ingress and egress traffic can be on either IPv4 or IPv6 traffic, mixed or parallel. See xref:../microshift_configuring/microshift-nw-ipv6-config.adoc#microshift-nw-ipv6-config[Configuring IPv6 networking].
|
||||
|
||||
[id="microshift-4-17-storage_{context}"]
|
||||
=== Storage
|
||||
|
||||
[id="microshift-4-17-LVMS-resource-footprint-reduction_{context}"]
|
||||
==== Resource footprint reduction for LVM storage driver now available
|
||||
With this release, the resource footprint of the LVM storage driver is significantly reduced, particularly in terms of memory consumption.
|
||||
|
||||
[id="microshift-4-17-LVMS-volume-snapshot-deployment-optional_{context}"]
|
||||
==== Disabling and uninstalling LVM Storage CSI provider and CSI snapshot deployments now available
|
||||
With this release, {microshift-short} can now be configured to disable and uninstall the container storage interface (CSI) provider or the CSI snapshot capabilities which can reduce the use of runtime resources such as RAM, CPU, and storage. See xref:../microshift_storage/microshift-storage-plugin-overview.adoc#microshift-disabling-uninstalling-lvms-csi-snapshot_microshift-storage-plugin-overview[Disabling and uninstalling LVMS CSI provider and CSI snapshot deployments].
|
||||
|
||||
[id="microshift-4-17-running-apps_{context}"]
|
||||
=== Running applications
|
||||
|
||||
[id="microshift-4-17-low-latency_{context}"]
|
||||
==== Low-latency performance for applications now available
|
||||
You can now run a {microshift-short} cluster with low-latency response rates. Using a low-latency {microshift-short} configuration with operating system tuning results in reduced application response times and can include deterministic performance. Using workload partitioning is also recommended. See xref:../microshift_configuring/microshift_low_latency/microshift-low-latency.adoc#microshift-low-latency[Configuring low latency] for more information.
|
||||
|
||||
[id="microshift-4-17-workload-partitioning_{context}"]
|
||||
==== Support for workload partitioning
|
||||
With this release, workload partitioning is supported in {microshift-short}. See xref:../microshift_configuring/microshift_low_latency/microshift-workload-partitioning.adoc#microshift-workload-partitioning[Workload partitioning] for more information.
|
||||
|
||||
//[id="microshift-4-17-support_{context}"]
|
||||
//=== Support
|
||||
|
||||
[id="microshift-4-17-doc-enhancements_{context}"]
|
||||
=== 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.
|
||||
|
||||
[id="microshift-4-17-data-cleanup_{context}"]
|
||||
==== Data cleanup now documented
|
||||
With this release, the `microshift-cleanup-data` script is documented. See xref:../microshift_troubleshooting/microshift-cleanup-data.adoc#microshift-cleanup-data[Data cleanup] for more information.
|
||||
|
||||
[id="microshift-4-17-tech-preview_{context}"]
|
||||
== Technology preview features
|
||||
|
||||
Some features in this release are currently in Technology Preview. These experimental features are not intended for production use. Note the following scope of support on the Red{nbsp}Hat Customer Portal for these features:
|
||||
|
||||
link:https://access.redhat.com/support/offerings/techpreview[Technology Preview Features Support Scope]
|
||||
|
||||
[id="microshift-4-17-rhel-image-mode_{context}"]
|
||||
=== {op-system-base-full} image mode Technology Preview feature
|
||||
* You can now install {microshift-short} using a `bootc` container image. Image mode for {op-system} is a technology preview deployment method that uses a container-native approach to build, deploy and manage the operating system as a bootc container image.
|
||||
|
||||
See xref:../microshift_install_bootc/microshift-install-rhel-image-mode.adoc#microshift-install-rhel-image-mode[Using image mode for RHEL with {microshift-short}] for more information.
|
||||
|
||||
//NOTE: Do NOT repeat bug fixes already noted in previous version z-streams
|
||||
[id="microshift-4-17-bug-fixes_{context}"]
|
||||
== Bug fixes
|
||||
|
||||
//[discrete]
|
||||
//[id="microshift-4-17-installation-bug-fixes"]
|
||||
//=== Installation
|
||||
|
||||
//[discrete]
|
||||
//[id="microshift-4-17-networking-bug-fixes"]
|
||||
//=== Networking
|
||||
|
||||
//[discrete]
|
||||
//[id="microshift-4-17-support-bug-fixes"]
|
||||
//=== Support
|
||||
|
||||
//check status for next release+
|
||||
//[id="microshift-4-17-known-issues_{context}"]
|
||||
//== Known issues
|
||||
|
||||
//[id="microshift-4-17-pods-writing-files-excess-memory-limits-crash_{context}"]
|
||||
//=== Pods crash when writing files that exceed memory limits
|
||||
//Because of an issue with {op-system-base}, when a pod tries to write files that are larger than configured memory limits to a persistent volume claim, the pod might crash with an out-of-memory error. The pod status shows `OOMKilled` when this occurs. Use the following workarounds to avoid this issue: link:https://access.redhat.com/solutions/7076169[Pods writing files larger than memory limit to PVCs tend to OOM frequently running on MicroShift](Red Hat Knowledgebase).
|
||||
|
||||
[id="microshift-4-17-asynchronous-errata-updates_{context}"]
|
||||
== 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
|
||||
[id="microshift-4-17-1-dp_{context}"]
|
||||
=== RHEA-2024:XXXX - {microshift-short} 4.17.1 bug fix and security update advisory
|
||||
|
||||
Issued: DD Month 2024
|
||||
|
||||
{product-title} release 4.17.1 is now available. Bug fixes and enhancements are listed in the link:https://access.redhat.com/errata/RHEA-2024:XXXX[RHEA-2024:XXXX] advisory. Release notes for bug fixes and enhancements are provided in this documentation. The images that are included in the update are provided by the {OCP} link:https://access.redhat.com/errata/RHEA-2024:XXXX[RHEA-2024:XXXX] advisory.
|
||||
|
||||
See the latest images included with {microshift-short} by xref:../microshift_updating/microshift-list-update-contents.adoc#microshift-get-rpm-release-info_microshift-list-update-contents[listing the contents of the {microshift-short} RPM release package].
|
||||
130
microshift_release_notes/microshift-4-18-release-notes.adoc
Normal file
130
microshift_release_notes/microshift-4-18-release-notes.adoc
Normal file
@@ -0,0 +1,130 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="microshift-4-18-release-notes"]
|
||||
= {product-title} {product-version} release notes
|
||||
include::_attributes/attributes-microshift.adoc[]
|
||||
:context: release-notes
|
||||
|
||||
toc::[]
|
||||
|
||||
{product-title-first} 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-18-about-this-release_{context}"]
|
||||
== About this release
|
||||
Version {product-version} of {microshift-short} includes new features and enhancements. 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} 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-18-new-features-and-enhancements_{context}"]
|
||||
== 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-18-rhel_{context}"]
|
||||
=== {op-system-base-full}
|
||||
* {microshift-short} {product-version} runs on {op-system-base-full} 9.4.
|
||||
|
||||
[id="microshift-4-18-updating_{context}"]
|
||||
=== Updating
|
||||
Updating two minor versions in a single step is supported in 4.18. Updates for both single-version minor releases and patch releases are still supported.
|
||||
|
||||
//TODO add new features and enhancements as needed, L4 [discrete] headings
|
||||
|
||||
//[id="microshift-4-18-installation_{context}"]
|
||||
//=== Installation
|
||||
|
||||
//[id="microshift-4-18-configuring_{context}"]
|
||||
//=== Configuring
|
||||
|
||||
[id="microshift-4-18-networking_{context}"]
|
||||
=== Networking
|
||||
|
||||
//[id="microshift-4-18-ingress-controller_{context}"]
|
||||
//==== Ingress controller for the router included
|
||||
|
||||
//[id="microshift-4-18-storage_{context}"]
|
||||
//=== Storage
|
||||
|
||||
//[id="microshift-4-18-storage_{context}"]
|
||||
//==== tbd storage feature here
|
||||
|
||||
//[id="microshift-4-18-running-apps_{context}"]
|
||||
//=== Running applications
|
||||
|
||||
//[id="microshift-4-18-run-apps_{context}"]
|
||||
//==== tbd run apps feature here
|
||||
|
||||
//[id="microshift-4-18-support_{context}"]
|
||||
//=== Support
|
||||
|
||||
//[id="microshift-4-18-doc-enhancements_{context}"]
|
||||
//=== 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.
|
||||
|
||||
[id="microshift-4-18-tech-preview_{context}"]
|
||||
== Technology Preview features
|
||||
|
||||
Some features in this release are currently in Technology Preview. These experimental features are not intended for production use. Note the following scope of support on the Red{nbsp}Hat Customer Portal for these features:
|
||||
|
||||
link:https://access.redhat.com/support/offerings/techpreview[Technology Preview Features Support Scope]
|
||||
|
||||
//[id="microshift-4-18-rhel-image-mode_{context}"]
|
||||
//=== {op-system-base-full} image mode Technology Preview feature
|
||||
//* You can now install {microshift-short} using a `bootc` container image. Image mode for {op-system} is a technology preview deployment method that uses a container-native approach to build, deploy and manage the operating system as a bootc container image.
|
||||
|
||||
//See xref:../microshift_install_bootc/microshift-install-rhel-image-mode.adoc#microshift-install-rhel-image-mode[Using image mode for RHEL with {microshift-short}] for more information.
|
||||
|
||||
//NOTE: Do NOT repeat bug fixes already noted in previous version z-streams
|
||||
[id="microshift-4-18-bug-fixes_{context}"]
|
||||
== Bug fixes
|
||||
|
||||
//[discrete]
|
||||
//[id="microshift-4-18-installation-bug-fixes"]
|
||||
//=== Installation
|
||||
|
||||
//[discrete]
|
||||
//[id="microshift-4-18-networking-bug-fixes"]
|
||||
//=== Networking
|
||||
|
||||
//[discrete]
|
||||
//[id="microshift-4-18-support-bug-fixes"]
|
||||
//=== Support
|
||||
|
||||
//check status for next release+
|
||||
//[id="microshift-4-18-known-issues_{context}"]
|
||||
//== Known issues
|
||||
|
||||
//[id="microshift-4-18-pods-writing-files-excess-memory-limits-crash_{context}"]
|
||||
//=== tbd known issues
|
||||
|
||||
[id="microshift-4-18-asynchronous-errata-updates_{context}"]
|
||||
== 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
|
||||
[id="microshift-4-18-0-dp_{context}"]
|
||||
=== RHEA-2025:XXXX - {microshift-short} 4.18.0 bug fix and security update advisory
|
||||
|
||||
Issued: DD Month 2025
|
||||
|
||||
{product-title} release 4.18.0 is now available. Bug fixes and enhancements are listed in the link:https://access.redhat.com/errata/RHEA-2025:XXXX[RHEA-2025:XXXX] advisory. Release notes for bug fixes and enhancements are provided in this documentation. The images that are included in the update are provided by the {OCP} link:https://access.redhat.com/errata/RHEA-2025:XXXX[RHEA-2025:XXXX] advisory.
|
||||
|
||||
See the latest images included with {microshift-short} by xref:../microshift_updating/microshift-list-update-contents.adoc#microshift-get-rpm-release-info_microshift-list-update-contents[listing the contents of the {microshift-short} RPM release package].
|
||||
@@ -21,7 +21,7 @@ To browse the {microshift-short} {product-version} documentation, use one of the
|
||||
To get started with {microshift-short}, use the following links:
|
||||
|
||||
//text is in main assembly for the sake of cross references
|
||||
* xref:../microshift_release_notes/microshift-4-17-release-notes.adoc#microshift-4-17-release-notes[{product-title} release notes]
|
||||
* xref:../microshift_release_notes/microshift-4-18-release-notes.adoc#microshift-4-18-release-notes[{product-title} release notes]
|
||||
* xref:../microshift_install_rpm/microshift-install-rpm.adoc#microshift-install-rpm[Installing {product-title}]
|
||||
|
||||
For related information, use the following links:
|
||||
|
||||
Reference in New Issue
Block a user