Merge pull request #63358 from ShaunaDiaz/OSDOCS-6617

sjhala-ccs · web-flow · commit dd38cb19ce69 · 2023-08-16T10:15:52.000-04:00
OSDOCS-6617: update version-specific info MicroShift
diff --git a/_attributes/attributes-microshift.adoc b/_attributes/attributes-microshift.adoc
@@ -4,16 +4,19 @@
 :experimental:
 :imagesdir: images
 :OCP: OpenShift Container Platform
-:ocp-version: 4.13
+:ocp-version: 4.14
 :oc-first: pass:quotes[OpenShift CLI (`oc`)]
 :product-registry: OpenShift image registry
+:product-version: 4.14
 :rhel-major: rhel-9
 :op-system-base-full: Red Hat Enterprise Linux (RHEL)
 :op-system: RHEL
 :op-system-ostree-first: Red Hat Enterprise Linux (RHEL) for Edge
 :op-system-ostree: RHEL for Edge
 :op-system-version: 9.2
 :op-system-version-major: 9
+:op-system-version-major-short: rhel9
 :op-system-bundle: Red Hat Device Edge
 :op-system-bundle-short: RHDE
+:rpm-repo-version: rhocp-4.14
 :VirtProductName: OpenShift Virtualization
diff --git a/microshift_install/microshift-embed-in-rpm-ostree.adoc b/microshift_install/microshift-embed-in-rpm-ostree.adoc
@@ -8,7 +8,7 @@ toc::[]
 
 You can embed {product-title} into a {op-system-ostree-first} {op-system-version} image. Use this guide to build a {op-system} image containing {product-title}.
 
-include::snippets/microshift-tech-preview-snip.adoc[leveloffset=+1]
+//include::snippets/microshift-tech-preview-snip.adoc[leveloffset=+1]
 
 include::modules/microshift-preparing-for-image-building.adoc[leveloffset=+1]
 
diff --git a/microshift_install/microshift-install-rpm.adoc b/microshift_install/microshift-install-rpm.adoc
@@ -8,14 +8,15 @@ toc::[]
 
 You can install {product-title} from an RPM package on a machine with {op-system-base-full} {op-system-version}.
 
-include::snippets/microshift-tech-preview-snip.adoc[leveloffset=+1]
+//include::snippets/microshift-tech-preview-snip.adoc[leveloffset=+1]
 
 include::modules/microshift-install-system-requirements.adoc[leveloffset=+1]
 
 include::modules/microshift-install-rpm-before.adoc[leveloffset=+1]
 
 include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1]
 
+//additional resources for install rpm prep module
 [role="_additional-resources"]
 .Additional resources
 * Download the link:https://console.redhat.com/openshift/install/pull-secret[pull secret] from the Red Hat Hybrid Cloud Console.
@@ -26,6 +27,7 @@ include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1]
 
 include::modules/microshift-install-rpms.adoc[leveloffset=+1]
 
+//additional resources for install rpms module
 [role="_additional-resources"]
 .Additional resources
 * xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-system-requirements_microshift-install-rpm[System requirements for installing MicroShift].
@@ -37,6 +39,7 @@ include::modules/microshift-service-stopping.adoc[leveloffset=+1]
 
 include::modules/microshift-accessing.adoc[leveloffset=+1]
 
+//additional resources for accessing module
 [role="_additional-resources"]
 .Additional resources
 * xref:../microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Installing the OpenShift CLI tool].
@@ -45,6 +48,4 @@ include::modules/microshift-accessing-cluster-locally.adoc[leveloffset=+2]
 
 include::modules/microshift-accessing-cluster-open-firewall.adoc[leveloffset=+2]
 
-include::modules/microshift-accessing-cluster-remotely.adoc[leveloffset=+2]
-
-//note: additional resources are deliberately set without ID and context so that they trail modules; these are not intended to appear as assembly-level additional resources
+include::modules/microshift-accessing-cluster-remotely.adoc[leveloffset=+2]
diff --git a/microshift_networking/microshift-firewall.adoc b/microshift_networking/microshift-firewall.adoc
@@ -18,10 +18,15 @@ include::modules/microshift-firewall-about.adoc[leveloffset=+1]
 * xref:..//microshift_networking/microshift-firewall.adoc#microshift-firewall-allow-traffic_microshift-firewall[Allowing network traffic through the firewall]
 
 include::modules/microshift-firewalld-install.adoc[leveloffset=+1]
+
 include::modules/microshift-firewall-req-settings.adoc[leveloffset=+1]
+
 include::modules/microshift-firewall-opt-settings.adoc[leveloffset=+1]
+
 include::modules/microshift-firewall-allow-traffic.adoc[leveloffset=+1]
+
 include::modules/microshift-firewall-apply-settings.adoc[leveloffset=+1]
+
 include::modules/microshift-firewall-verify-settings.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
diff --git a/microshift_rest_api/_attributes b/microshift_rest_api/_attributes
@@ -0,0 +1 @@
+../_attributes
diff --git a/microshift_rest_api/images b/microshift_rest_api/images
@@ -0,0 +1 @@
+../images
diff --git a/microshift_rest_api/snippets b/microshift_rest_api/snippets
diff --git a/microshift_rest_api/understanding-api-support-tiers.adoc b/microshift_rest_api/understanding-api-support-tiers.adoc
@@ -11,7 +11,7 @@ toc::[]
 This guidance does not cover layered {product-title} offerings.
 ====
 
-Red Hat requests that application developers validate that any behavior they depend on is explicitly defined in the formal API documentation to prevent introducing dependencies on unspecified implementation-specific behavior or dependencies on bugs in a particular implementation of an API.  For example, new releases of an ingress router may not be compatible with older releases if an application uses an undocumented API or relies on undefined behavior.
+Red Hat requests that application developers validate that any behavior they depend on is explicitly defined in the formal API documentation to prevent introducing dependencies on unspecified implementation-specific behavior or dependencies on bugs in a particular implementation of an API. For example, new releases of an ingress router may not be compatible with older releases if an application uses an undocumented API or relies on undefined behavior.
 
 include::modules/api-support-tiers.adoc[leveloffset=+1]
 
diff --git a/microshift_running_apps/microshift-applications.adoc b/microshift_running_apps/microshift-applications.adoc
@@ -9,4 +9,5 @@ toc::[]
 You can use the `kustomize` configuration management tool to deploy applications. Read through the following procedure for an example of how this tool works in {product-title}.
 
 include::modules/microshift-manifests-overview.adoc[leveloffset=+1]
+
 include::modules/microshift-applying-manifests-example.adoc[leveloffset=+1]
diff --git a/microshift_storage/dynamic-provisioning-microshift.adoc b/microshift_storage/dynamic-provisioning-microshift.adoc
@@ -6,6 +6,8 @@ include::_attributes/attributes-microshift.adoc[]
 
 toc::[]
 
+Learn about dynamic provisioning for {product-title}, including setting storage classes and other configuration options.
+
 include::modules/dynamic-provisioning-about.adoc[leveloffset=+1]
 
 include::modules/dynamic-provisioning-defining-storage-class.adoc[leveloffset=+1]
diff --git a/microshift_storage/generic-ephemeral-volumes-microshift.adoc b/microshift_storage/generic-ephemeral-volumes-microshift.adoc
@@ -6,6 +6,8 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
+Learn about ephemeral volumes for {product-title}, including their lifecycles, security, and naming.
+
 include::modules/storage-ephemeral-vols-overview.adoc[leveloffset=+1]
 
 include::modules/storage-ephemeral-vols-lifecycle.adoc[leveloffset=+1]
diff --git a/microshift_storage/microshift-storage-plugin-overview.adoc b/microshift_storage/microshift-storage-plugin-overview.adoc
@@ -6,12 +6,16 @@ include::_attributes/attributes-microshift.adoc[]
 
 toc::[]
 
-{product-title} enables dynamic storage provisioning that is ready for immediate use with the logical volume manager storage (LVMS) Container Storage Interface (CSI) provider. The LVMS plugin is the Red Hat downstream version of TopoLVM, a CSI plugin for managing LVM volumes for Kubernetes.
+{product-title} enables dynamic storage provisioning that is ready for immediate use with the logical volume manager storage (LVMS) Container Storage Interface (CSI) provider. The LVMS plugin is the Red Hat downstream version of TopoLVM, a CSI plugin for managing logical volume management (LVM) logical volumes (LVs) for Kubernetes.
 
-LVMS provisions new logical volume management (LVM) logical volumes (LVs) for container workloads with appropriately configured persistent volume claims (PVC). Each PVC references a storage class that represents an LVM Volume Group (VG) on the host node. LVs are only provisioned for scheduled pods.
+LVMS provisions new LVM logical volumes for container workloads with appropriately configured persistent volume claims (PVCs). Each PVC references a storage class that represents an LVM Volume Group (VG) on the host node. LVs are only provisioned for scheduled pods.
 
 include::modules/microshift-lvms-system-requirements.adoc[leveloffset=+1]
+
 include::modules/microshift-lvms-deployment.adoc[leveloffset=+1]
+
 include::modules/microshift-lvmd-yaml-creating.adoc[leveloffset=+1]
+
 include::modules/microshift-lvms-config-example-basic.adoc[leveloffset=+1]
+
 include::modules/microshift-lvms-using.adoc[leveloffset=+1]
diff --git a/microshift_support/microshift-etcd.adoc b/microshift_support/microshift-etcd.adoc
@@ -9,8 +9,9 @@ toc::[]
 [role="_abstract"]
 {product-title} etcd is delivered as part of the {product-title} RPM. The etcd service is run as a separate process and the lifecycle is managed automatically by {product-title}.
 
-:FeatureName: MicroShift
-include::snippets/microshift-tech-preview-snip.adoc[leveloffset=+1]
+//:FeatureName: MicroShift
+//include::snippets/microshift-tech-preview-snip.adoc[leveloffset=+1]
 
 include::modules/microshift-observe-debug-etcd-server.adoc[leveloffset=+1]
+
 include::modules/microshift-config-etcd.adoc[leveloffset=+1]
diff --git a/microshift_support/microshift-sos-report.adoc b/microshift_support/microshift-sos-report.adoc
@@ -9,10 +9,11 @@ toc::[]
 [role="_abstract"]
 `sos` is a tool you can use to collect troubleshooting information about a host. An `sos report` will generate a detailed report with all the enabled plugins and data from the different components and applications in a system.
 
-:FeatureName: MicroShift
-include::snippets/microshift-tech-preview-snip.adoc[leveloffset=+1]
+//:FeatureName: MicroShift
+//include::snippets/microshift-tech-preview-snip.adoc[leveloffset=+1]
 
 include::modules/microshift-about-sos-reports.adoc[leveloffset=+1]
+
 include::modules/microshift-gathering-sos-report.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
diff --git a/modules/api-compatibility-common-terminology.adoc b/modules/api-compatibility-common-terminology.adoc
@@ -32,10 +32,10 @@ Virtual environments emulate bare-metal environments such that unprivileged appl
 
 A Red Hat major release represents a significant step in the development of a product. Minor releases appear more frequently within the scope of a major release and represent deprecation boundaries that might impact future application compatibility. A z-stream release is an update to a minor release which provides a stream of continuous fixes to an associated minor release. API and AOE compatibility is never broken in a z-stream release except when this policy is explicitly overridden in order to respond to an unforeseen security impact.
 
-For example, in the release 4.3.2:
+For example, in the release 4.13.2:
 
 * 4 is the major release version
-* 3 is the minor release version
+* 13 is the minor release version
 * 2 is the z-stream release version
 
 [id="api-compatibility-common-terminology-eus_{context}"]
diff --git a/modules/api-compatibility-guidelines.adoc b/modules/api-compatibility-guidelines.adoc
@@ -9,7 +9,7 @@ Red Hat recommends that application developers adopt the following principles in
 
 * Use APIs and components with support tiers that match the application's need.
 * Build applications using the published client libraries where possible.
-* Applications are only guaranteed to run correctly if they execute in an environment that is as new as the environment it was built to execute against. An application that was built for {product-title} 4.7 is not guaranteed to function properly on {product-title} 4.6.
+* Applications are only guaranteed to run correctly if they execute in an environment that is as new as the environment it was built to execute against. An application that was built for {product-title} 4.14 is not guaranteed to function properly on {product-title} 4.13.
 * Do not design applications that rely on configuration files provided by system packages or other components. These files can change between versions unless the upstream community is explicitly committed to preserving them. Where appropriate, depend on any Red Hat provided interface abstraction over those configuration files in order to maintain forward compatibility. Direct file system modification of configuration files is discouraged, and users are strongly encouraged to integrate with an Operator provided API where available to avoid dual-writer conflicts.
 * Do not depend on API fields prefixed with `unsupported<FieldName>` or annotations that are not explicitly mentioned in product documentation.
 * Do not depend on components with shorter compatibility guarantees than your application.
diff --git a/modules/images b/modules/images
diff --git a/modules/microshift-add-blueprint-build-iso.adoc b/modules/microshift-add-blueprint-build-iso.adoc
@@ -16,9 +16,9 @@ $ sudo composer-cli blueprints push microshift-installer.toml
 
 . Start the `ostree` ISO build by running the following command:
 +
-[source,terminal]
+[source,terminal,subs="attributes+"]
 ----
-$ BUILDID=$(sudo composer-cli compose start-ostree --url http://localhost:8085/repo/ --ref "rhel/9/$(uname -m)/edge" microshift-installer edge-installer | awk '{print $2}')
+$ BUILDID=$(sudo composer-cli compose start-ostree --url http://localhost:8085/repo/ --ref "rhel/{op-system-version-major}/$(uname -m)/edge" microshift-installer edge-installer | awk '{print $2}')
 ----
 +
 This command also returns the identification (ID) of the build for monitoring.
diff --git a/modules/microshift-adding-repos-to-image-builder.adoc b/modules/microshift-adding-repos-to-image-builder.adoc
@@ -9,21 +9,22 @@
 Use the following procedure to add the {product-title} repositories to Image Builder on your build host.
 
 .Prerequisites
+
 * Your build host meets the Image Builder system requirements.
 * You have installed and set up Image Builder and the `composer-cli` tool.
 * You have root-user access to your build host.
 
 .Procedure
 
-. Create an Image Builder configuration file for adding the `rhocp-4.13` RPM repository source required to pull {product-title} RPMs by running the following command:
+. Create an Image Builder configuration file for adding the `{rpm-repo-version}` RPM repository source required to pull {product-title} RPMs by running the following command:
 +
-[source,terminal]
+[source,terminal,subs="attributes+"]
 ----
-$ cat > rhocp-4.13.toml <<EOF
-id = "rhocp-4.13"
-name = "Red Hat OpenShift Container Platform 4.13 for RHEL 9"
+$ cat > {rpm-repo-version}.toml <<EOF
+id = "{rpm-repo-version}"
+name = "Red Hat OpenShift Container Platform {ocp-version} for RHEL {op-system-version-major}"
 type = "yum-baseurl"
-url = "https://cdn.redhat.com/content/dist/layered/rhel9/$(uname -m)/rhocp/4.13/os"
+url = "https://cdn.redhat.com/content/dist/layered/{op-system-version-major-short}/$(uname -m)/rhocp/{ocp-version}/os"
 check_gpg = true
 check_ssl = true
 system = false
@@ -33,13 +34,13 @@ EOF
 
 . Create an Image Builder configuration file for adding the `fast-datapath` RPM repository by running the following command:
 +
-[source,terminal]
+[source,terminal,subs="attributes+"]
 ----
 $ cat > fast-datapath.toml <<EOF
 id = "fast-datapath"
 name = "Fast Datapath for RHEL 9"
 type = "yum-baseurl"
-url = "https://cdn.redhat.com/content/dist/layered/rhel9/$(uname -m)/fast-datapath/os"
+url = "https://cdn.redhat.com/content/dist/layered/{op-system-version-major-short}/$(uname -m)/fast-datapath/os"
 check_gpg = true
 check_ssl = true
 system = false
@@ -49,9 +50,9 @@ EOF
 
 . Add the sources to the Image Builder by running the following commands:
 +
-[source,terminal]
+[source,terminal,subs="attributes+"]
 ----
-$ sudo composer-cli sources add rhocp-4.13.toml
+$ sudo composer-cli sources add {rpm-repo-version}.toml
 ----
 +
 [source,terminal]
@@ -70,10 +71,10 @@ $ sudo composer-cli sources list
 +
 .Example output
 +
-[source,terminal]
+[source,terminal,subs="attributes+"]
 ----
 appstream
 baseos
 fast-datapath
-rhocp-4.13
+{rpm-repo-version}
 ----
diff --git a/modules/microshift-adding-service-to-blueprint.adoc b/modules/microshift-adding-service-to-blueprint.adoc
@@ -35,7 +35,7 @@ EOF
 
 [NOTE]
 ====
-The wildcard `*` in the commands uses the latest {product-title} RPMs. If you need a specific version, substitute the wildcard for the version you want. For example, insert `4.13.1` to download the {product-title} 4.13.1 RPMs.
+The wildcard `*` in the commands uses the latest {product-title} RPMs. If you need a specific version, substitute the wildcard for the version you want. For example, insert `4.14.1` to download the {product-title} 4.14.1 RPMs.
 ====
 
 . Add the blueprint to the Image Builder by running the following command:
@@ -65,7 +65,7 @@ blueprint: minimal-microshift v0.0.1
     microshift-4.13.1-202305250827.p0.g4105d3b.assembly.4.13.1.el9.x86_64
     microshift-selinux-4.13.1-202305250827.p0.g4105d3b.assembly.4.13.1.el9.noarch
 ----
-
+//need updated example output
 . Optional: Verify the Image Builder configuration listing all components to be installed by running the following command:
 +
 [source,terminal]
diff --git a/modules/microshift-creating-ostree-iso.adoc b/modules/microshift-creating-ostree-iso.adoc
@@ -18,9 +18,9 @@ Use the following procedure to create the ISO. The {op-system-ostree} Installer
 
 . Start an `ostree` container image build by running the following command:
 +
-[source,terminal]
+[source,terminal,subs="attributes+"]
 ----
-$ BUILDID=$(sudo composer-cli compose start-ostree --ref "rhel/9/$(uname -m)/edge" minimal-microshift edge-container | awk '{print $2}')
+$ BUILDID=$(sudo composer-cli compose start-ostree --ref "rhel/{op-system-version-major}/$(uname -m)/edge" minimal-microshift edge-container | awk '{print $2}')
 ----
 +
 This command also returns the identification (ID) of the build for monitoring.
diff --git a/modules/microshift-version-api.adoc b/modules/microshift-version-api.adoc
@@ -23,11 +23,12 @@ $ oc get configmap -n kube-public microshift-version -o yaml
 apiVersion: v1
 data:
   major: "4"
-  minor: "10"
-  version: 4.10.0-0.microshift-e6980e25
+  minor: "13"
+  version: 4.13.8-0.microshift-fa441af87431
 kind: ConfigMap
 metadata:
-  creationTimestamp: "2022-08-08T21:06:11Z"
+  creationTimestamp: "2023-08-03T21:06:11Z"
   name: microshift-version
   namespace: kube-public
 ----
+//update output to 4.14
