1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

OSDOCS-12016: update attributes and updates content

This commit is contained in:
“Shauna Diaz”
2024-10-04 10:23:20 -04:00
committed by openshift-cherrypick-robot
parent 03d1520e24
commit 7efbc9b26a
18 changed files with 43 additions and 87 deletions

View File

@@ -4,14 +4,14 @@
:experimental:
:imagesdir: images
:OCP: OpenShift Container Platform
:ocp-version: 4.17
:ocp-version: 4.18
:oc-first: pass:quotes[OpenShift CLI (`oc`)]
//OpenShift Kubernetes Engine
:oke: OpenShift Kubernetes Engine
:product-title-first: Red Hat build of MicroShift (MicroShift)
:microshift-short: MicroShift
:product-registry: OpenShift image registry
:product-version: 4.17
:product-version: 4.18
:rhel-major: rhel-9
:op-system-base-full: Red Hat Enterprise Linux (RHEL)
:op-system-base: RHEL
@@ -22,6 +22,6 @@
:op-system-version: 9.4
:op-system-version-major: 9
:op-system-bundle: Red Hat Device Edge
:rpm-repo-version: rhocp-4.17
:rpm-repo-version: rhocp-4.18
:rhde-version: 4
:VirtProductName: OpenShift Virtualization

View File

@@ -24,6 +24,6 @@ Commands for multi-node deployments, projects, and developer tooling are not sup
== Additional resources
* xref:..//microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Getting started with the OpenShift CLI]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/cli_tools/openshift-cli-oc#cli-about-cli_cli-developer-commands[About the OpenShift CLI] (OpenShift Container Platform documentation)
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9[Red Hat Enterprise Linux (RHEL) documentation for specific use cases]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/cli_tools/openshift-cli-oc#cli-about-cli_cli-developer-commands[About the OpenShift CLI] ({OCP} documentation)
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9[{op-system-base-full} documentation for specific use cases]
* xref:../microshift_configuring/microshift-cluster-access-kubeconfig.adoc#microshift-kubeconfig[Cluster access with kubeconfig]

View File

@@ -35,7 +35,7 @@ The additional command `oc new-app`, for example, makes it easier to get new app
If you installed an earlier version of `oc`, you might not be able use it to complete all of the commands in {microshift-short} {product-version}. If you want the latest features, you must download and install the latest version of `oc` that corresponds with your {microshift-short} version.
====
Using new capabilities often requires the latest `oc` binary. A 4.17 server might have additional capabilities that a 4.12 `oc` binary cannot use and a 4.17 `oc` binary might have additional capabilities that are unsupported by a 4.13 server.
Using new capabilities often requires the latest `oc` binary. A 4.18 server might have additional capabilities that a 4.16 `oc` binary cannot use and a 4.18 `oc` binary might have additional capabilities that are unsupported by a 4.15 server.
.Compatibility Matrix

View File

@@ -13,7 +13,7 @@ include::modules/microshift-low-latency-concept.adoc[leveloffset=+1]
//additional resources for the low latency concept
[role="_additional-resources"]
.Additional resources
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/scalability_and_performance/low-latency-tuning#cnf-understanding-low-latency_cnf-understanding-low-latency[About low latency] (OpenShift Container Platform documentation)
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/scalability_and_performance/low-latency-tuning#cnf-understanding-low-latency_cnf-understanding-low-latency[About low latency] ({OCP} documentation)
include::modules/microshift-install-rpms-low-latency.adoc[leveloffset=+1]
@@ -67,13 +67,13 @@ Complete the build process by starting with the following procedure to embed {mi
[role="_additional-resources"]
[id="additional-resources-rtk_{context}"]
.Additional resources
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_for_real_time/9[Red Hat Enterprise Linux for Real Time 9] (RHEL documentation)
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_for_real_time/9[Red Hat Enterprise Linux for Real Time 9] ({op-system-base} documentation)
* link:https://osbuild.org/docs/on-premises/installation/managing-repositories/#using-repositories-that-require-subscription[Using repositories that require subscription] (osbuild documentation)
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-command-line-interface_composing-a-customized-rhel-system-image#building-rhel-images-by-using-the-real-time-kernel_creating-system-images-with-composer-command-line-interface[Building RHEL images by using the real-time kernel] for more information.
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/creating-system-images-with-composer-command-line-interface_composing-a-customized-rhel-system-image#building-rhel-images-by-using-the-real-time-kernel_creating-system-images-with-composer-command-line-interface[Building {op-system-base} images by using the {op-system-rtk}] for more information.
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_for_real_time/9/html/installing_rhel_9_for_real_time/assembly_installing-rhel-for-real-time_installing-rhel-9-for-real-time#post-installation-instructions_assembly_installing-rhel-for-real-time[Post installation instructions] (RHEL for Real Time documentation)
* xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-embed-in-rpm-ostree[Embedding in a {op-system-ostree} image]
* link:https://access.redhat.com/solutions/4096521[FAQ about RHEL for Real Time (kernel-rt)]
* link:https://access.redhat.com/solutions/4096521[FAQ about {op-system-base} for Real Time (kernel-rt)]
//Can likely remove KCS after 2024 as it may go out of date
include::modules/microshift-low-latency-prepare-workload.adoc[leveloffset=+1]
@@ -83,11 +83,11 @@ include::modules/microshift-low-latency-prepare-workload.adoc[leveloffset=+1]
[id="additional-resources-prep-workload_{context}"]
.Additional resources
* link:https://docs.openshift.com/container-platform/4.17/scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.html#cnf-configuring-high-priority-workload-pods_cnf-provisioning-low-latency[Disabling power saving mode for high priority pods] (Red Hat OpenShift Container Platform documentation)
* link:https://docs.openshift.com/container-platform/{ocp-version}/scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.html#cnf-configuring-high-priority-workload-pods_cnf-provisioning-low-latency[Disabling power saving mode for high priority pods] ({OCP} documentation)
* link:https://docs.openshift.com/container-platform/4.17/scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.html#cnf-disabling-cpu-cfs-quota_cnf-provisioning-low-latency[Disabling CPU CFS quota] (Red Hat OpenShift Container Platform documentation)
* link:https://docs.openshift.com/container-platform/{ocp-version}/scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.html#cnf-disabling-cpu-cfs-quota_cnf-provisioning-low-latency[Disabling CPU CFS quota] ({OCP} documentation)
* link:https://docs.openshift.com/container-platform/4.17/scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.html#cnf-disabling-interrupt-processing-for-individual-pods_cnf-provisioning-low-latency[Disabling interrupt processing for CPUs where pinned containers are running] (Red Hat OpenShift Container Platform documentation)
* link:https://docs.openshift.com/container-platform/{ocp-version}/scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.html#cnf-disabling-interrupt-processing-for-individual-pods_cnf-provisioning-low-latency[Disabling interrupt processing for CPUs where pinned containers are running] ({OCP} documentation)
include::modules/microshift-low-latency-rhel-edge-blueprint-rtk.adoc[leveloffset=+1]

View File

@@ -26,4 +26,4 @@ include::modules/microshift-cni-multus-troubleshoot.adoc[leveloffset=+1]
== Additional resources
* xref:../../microshift_networking/microshift_multiple_networks/microshift-cni-multus.adoc#microshift-cni-multus[About using multiple networks]
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.17/html/networking/multiple-networks#nw-multus-ipam-object_configuring-additional-network[Configuration of IP address assignment for an additional network]
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.18/html/networking/multiple-networks#nw-multus-ipam-object_configuring-additional-network[Configuration of IP address assignment for an additional network]

View File

@@ -8,11 +8,6 @@ toc::[]
To troubleshoot {microshift-short} updates, use the following guide.
//[IMPORTANT]
//====
//You can only update {microshift-short} from one minor version to the next in sequence. For example, you must update 4.14 to 4.15.
//====
include::modules/microshift-updates-troubleshooting.adoc[leveloffset=+1]
//additional resources for troubleshooting module

View File

@@ -22,8 +22,6 @@ Consider the following when planning to update {microshift-short}:
* {op-system-base} or {op-system-ostree} updates are only required to update {microshift-short} if the existing operating system is not compatible with the new version of {microshift-short} that you want to use.
* {microshift-short} operates as an in-place update and does not require removal of the previous version. Data backups beyond those required for the usual functioning of your applications are also not required.
include::snippets/microshift-update-paths-snip.adoc[leveloffset=+1]
[NOTE]
====
Only `rpm-ostree` updates include automatic rollbacks.

View File

@@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]
toc::[]
Updating {product-title} for non-OSTree systems such as {op-system-base-full} requires updating the RPMs. For patch releases, such as 4.17.1 to 4.17.2, simply update the RPMs. For minor-version release updates, add the step of enabling the update repository using your subscription manager.
Updating {product-title} for non-OSTree systems such as {op-system-base-full} requires updating the RPMs. For patch releases, such as 4.18.1 to 4.18.2, simply update the RPMs. For minor-version release updates, add the step of enabling the update repository using your subscription manager.
[NOTE]
====

View File

@@ -8,7 +8,7 @@ toc::[]
Updating {microshift-short} on an `rpm-ostree` system such as {op-system-ostree-first} requires building a new {op-system-ostree} image containing the new version of {microshift-short} and any associated optional RPMs. After you have the `rpm-ostree` image with {microshift-short} embedded, direct your system to boot into that operating system image.
The procedures are the same for minor-version and patch updates. For example, use the same steps to upgrade from 4.16 to 4.17 or from 4.17.2 to 4.17.3.
The procedures are the same for minor-version and patch updates. For example, use the same steps to upgrade from 4.17 to 4.18 or from 4.18.2 to 4.18.3.
[NOTE]
====

View File

@@ -37,7 +37,7 @@ groups = []
[[packages]]
name = "microshift"
version = "*"
version = "4.18.1" <3>
[customizations.services]
enabled = ["microshift"]
@@ -45,11 +45,7 @@ EOF
----
<1> The name of the TOML file.
<2> The name of the blueprint.
+
[NOTE]
====
The wildcard `*` in the commands uses the latest {microshift-short} RPMs. If you need a specific version, substitute the wildcard for the version you want. For example, insert `4.17.1` to download the {microshift-short} 4.17.1 RPMs.
====
<3> Substitute the value for the version you want. For example, insert `4.18.1` to download the {microshift-short} 4.18.1 RPMs.
. Optional. Use the blueprint installed in the `/usr/share/microshift/blueprint` directory that is specific to your platform architecture. See the following example snippet for an explanation of the blueprint sections:
+

View File

@@ -29,7 +29,7 @@ You can use image builder to create `rpm-ostree` system images with embedded {mi
----
$ sudo dnf install -y microshift-release-info-<release_version>
----
Replace `<release_version>` with the numerical value of the release you are deploying, using the entire version number, such as `4.17.1`.
Replace `<release_version>` with the numerical value of the release you are deploying, using the entire version number, such as `4.18.1`.
.. List the contents of the `/usr/share/microshift/release` directory to verify the presence of the release information files by running the following command:
+
@@ -55,14 +55,14 @@ If you installed the `microshift-release-info` RPM, you can proceed to step 4.
----
$ sudo dnf download microshift-release-info-<release_version>
----
Replace `<release_version>` with the numerical value of the release you are deploying, using the entire version number, such as `4.17.1`.
Replace `<release_version>` with the numerical value of the release you are deploying, using the entire version number, such as `4.18.1`.
+
.Example rpm
[source,terminal]
----
microshift-release-info-4.17.1.*.el9.noarch.rpm <1>
microshift-release-info-4.18.1.*.el9.noarch.rpm <1>
----
<1> The `*` represents the date and commit ID. Your output should contain both, for example `-202311101230.p0.g7dc6a00.assembly.4.17.1`.
<1> The `*` represents the date and commit ID. Your output should contain both, for example `-202511101230.p0.g7dc6a00.assembly.4.18.1`.
.. Unpack the RPM package without installing it by running the following command:
+

View File

@@ -19,9 +19,9 @@ To see the images included with a {microshift-short} release, you can list the c
+
[source,terminal]
----
$ sudo dnf repoquery microshift-release-info-0:4.17.* # <1>
$ sudo dnf repoquery microshift-release-info-0:4.17.1 # <1>
----
<1> Replace the example value `4.17.*` with the major and minor release numbers you are interested in.
<1> Replace the example value `4.17.1` with the major and minor release numbers you are interested in.
+
.Example output
[source,terminal]

View File

@@ -43,10 +43,10 @@ storageConfig:
mirror:
platform: # <1>
channels:
- name: stable-4.17
- name: stable-4.18
type: ocp
operators:
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.17
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.18
packages:
- name: serverless-operator
channels:
@@ -72,7 +72,7 @@ storageConfig: <1>
skipTLS: false
mirror:
operators:
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.17 <3>
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.18 <3>
packages:
- name: amq-broker-rhel8 <4>
channels:

View File

@@ -8,13 +8,9 @@
In some cases, {microshift-short} might fail to update. In these events, it is helpful to understand failure types and how to troubleshoot them.
//[id="microshift-update-path-blocked-by-version-sequence_{context}"]
//== Update path is blocked by {microshift-short} version sequence
//Certain versions of {microshift-short} require serial updates. Attempting to update {microshift-short} by skipping a minor version fails:
//* For example, if your current version is `4.14.5`, but you try to update from that version to `4.16.0`, the message, `executable (4.16.0) is too recent compared to existing data (4.14.5): version difference is 2, maximum allowed difference is 1` appears and {microshift-short} fails to start.
//In this example, you must first update `4.14.5` to a version of `4.15`, and then you can upgrade to `4.16.0`.
[id="microshift-update-path-blocked-by-version-sequence_{context}"]
== Update path is blocked by {microshift-short} version sequence
Non-EUS versions of {microshift-short} require serial updates. For example, if you attempt to update from {microshift-short} `4.15.5` directly to `4.17.1`, the update fails. You must first update `4.15.5` to `4.16.z`, and then you can update from `4.16.z` to `4.17.0`.
[id="microshift-update-path-blocked-by-version-incompatibility_{context}"]
== Update path is blocked by version incompatibility
@@ -32,7 +28,8 @@ Check the following update paths:
*{product-title} update paths*
* Generally Available Version 4.17.1 to 4.17.z on {op-system-ostree} 9.4
* Generally Available Version 4.18.0 to 4.18.z on {op-system-base} 9.4
* Generally Available Version 4.17.1 to 4.17.z on {op-system-base} 9.4
* Generally Available Version 4.15.0 from {op-system-base} 9.2 to 4.16.0 on {op-system-base} 9.4
* Generally Available Version 4.14.0 from {op-system-base} 9.2 to 4.15.0 on {op-system-base} 9.4

View File

@@ -6,7 +6,7 @@
[id="microshift-updating-rpms_{context}"]
= Applying minor-version updates with RPMs
Updating a {microshift-short} minor version on non `rpm-ostree` systems such as {op-system-base-full} requires downloading then updating the RPMs. For example, use the following procedure to update from 4.16 to 4.17.
Updating a {microshift-short} minor version on non `rpm-ostree` systems such as {op-system-base-full} requires downloading then updating the RPMs. For example, use the following procedure to update from 4.16 to 4.18.
.Prerequisites
* The system requirements for installing {microshift-short} have been met.

View File

@@ -6,7 +6,7 @@
[id="microshift-applying-patch-updates-rpms_{context}"]
= Applying patch updates using RPMs
Updating {microshift-short} on non `rpm-ostree` systems such as {op-system-base-full} requires downloading then updating the RPMs. For example, use the following procedure to upgrade from 4.17.1 to 4.17.2.
Updating {microshift-short} on non `rpm-ostree` systems such as {op-system-base-full} requires downloading then updating the RPMs. For example, use the following procedure to upgrade from 4.18.1 to 4.18.2.
.Prerequisites
* The system requirements for installing {microshift-short} have been met.

View File

@@ -9,30 +9,29 @@
{op-system-base-full} and {microshift-short} work together as a single solution for device-edge computing. You can update each component separately, but the product versions must be compatible. Supported configurations of {op-system-bundle} use verified releases for each together as listed in the following table:
[cols="4",cols="~,~,~,20h"]
[cols="3","20%,20%,60%",options="header"]
|===
^|*{op-system-base} Version(s)*
^|*{microshift-short} Version*
^|*{microshift-short} Release Status*
^|*Supported {microshift-short} Version{nbsp}&#8594;{nbsp}Version Updates*
^|9.4
^|4.18
^|4.18.1{nbsp}&#8594;{nbsp}4.18.z
^|9.4
^|4.17
^|Generally Available
^|4.17.1{nbsp}&#8594;{nbsp}4.17.z
^|4.17.1{nbsp}&#8594;{nbsp}4.17.z, 4.17{nbsp}&#8594;{nbsp}4.18
^|9.4
^|4.16
^|Generally Available
^|4.16.0{nbsp}&#8594;{nbsp}4.16.z, 4.16{nbsp}&#8594;{nbsp}4.17
^|4.16.0{nbsp}&#8594;{nbsp}4.16.z, 4.16{nbsp}&#8594;{nbsp}4.17, 4.16{nbsp}&#8594;{nbsp}4.18
^|9.2, 9.3
^|4.15
^|Generally Available
^|4.15.0{nbsp}&#8594;{nbsp}4.15.z, 4.15{nbsp}&#8594;{nbsp}4.16
^|4.15.0{nbsp}&#8594;{nbsp}4.15.z, 4.15{nbsp}&#8594;{nbsp}4.16 ({op-system-base} 9.4)
^|9.2, 9.3
^|4.14
^|Generally Available
^|4.14.0{nbsp}&#8594;{nbsp}4.14.z, 4.14{nbsp}&#8594;{nbsp}4.15, 4.14{nbsp}&#8594;{nbsp}4.16
^|4.14.0{nbsp}&#8594;{nbsp}4.14.z, 4.14{nbsp}&#8594;{nbsp}4.15, 4.14{nbsp}&#8594;{nbsp}4.16 ({op-system-base} 9.4)
|===

View File

@@ -1,29 +0,0 @@
//Snippet included in the following assemblies:
//
//* microshift_updating/microshift-about-updates.adoc
//* microshift_updating/microshift-update-options.adoc
:_mod-docs-content-type: SNIPPET
[id="microshift-about-updates-checking-version-update-path_{context}"]
= Checking the {microshift-short} version update path
Before updating {microshift-short} or {op-system-base}, determine the compatibilities. Plan for the versions of each that you intend to use.
*{product-title} update paths*
{microshift-short} version 4.17::
* Version 4.17{nbsp}&#8594;{nbsp}4.17.z on {op-system-base} 9.4
{microshift-short} version 4.16::
* Version 4.16{nbsp}&#8594;{nbsp}4.17 on {op-system-base} 9.4
* Version 4.16{nbsp}&#8594;{nbsp}4.16.z on {op-system-base} 9.4
{microshift-short} version 4.15::
* Version 4.15 on {op-system-base} 9.2 or 9.3{nbsp}&#8594;{nbsp}4.16 on {op-system-base} 9.4
* Version 4.15{nbsp}&#8594;{nbsp}4.15.z on {op-system-base} 9.2 or 9.3
{microshift-short} version 4.14::
* Version 4.14 on {op-system-base} 9.2 or 9.3{nbsp}&#8594;{nbsp}4.16 on {op-system-base} 9.4
* Version 4.14{nbsp}&#8594;{nbsp}4.15 on {op-system-base} 9.2 or 9.3
* Version 4.14{nbsp}&#8594;{nbsp}4.14.z on {op-system-base} 9.2 or 9.3