From 015539eff15f5c057d229d01c0d7ea09328e711b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CShauna=20Diaz=E2=80=9D?= Date: Wed, 9 Aug 2023 09:18:48 -0400 Subject: [PATCH] OSDOCS-6617: update version-specific info MicroShift --- _attributes/attributes-microshift.adoc | 5 +++- .../microshift-embed-in-rpm-ostree.adoc | 2 +- .../microshift-install-rpm.adoc | 9 ++++--- .../microshift-firewall.adoc | 5 ++++ microshift_rest_api/_attributes | 1 + microshift_rest_api/images | 1 + {modules => microshift_rest_api}/snippets | 0 .../understanding-api-support-tiers.adoc | 2 +- .../microshift-applications.adoc | 1 + .../dynamic-provisioning-microshift.adoc | 2 ++ .../generic-ephemeral-volumes-microshift.adoc | 2 ++ .../microshift-storage-plugin-overview.adoc | 8 ++++-- microshift_support/microshift-etcd.adoc | 5 ++-- microshift_support/microshift-sos-report.adoc | 5 ++-- .../api-compatibility-common-terminology.adoc | 4 +-- modules/api-compatibility-guidelines.adoc | 2 +- modules/images | 1 - .../microshift-add-blueprint-build-iso.adoc | 4 +-- ...roshift-adding-repos-to-image-builder.adoc | 25 ++++++++++--------- ...icroshift-adding-service-to-blueprint.adoc | 4 +-- modules/microshift-creating-ostree-iso.adoc | 4 +-- modules/microshift-version-api.adoc | 7 +++--- 22 files changed, 61 insertions(+), 38 deletions(-) create mode 120000 microshift_rest_api/_attributes create mode 120000 microshift_rest_api/images rename {modules => microshift_rest_api}/snippets (100%) delete mode 120000 modules/images diff --git a/_attributes/attributes-microshift.adoc b/_attributes/attributes-microshift.adoc index fa6197dbd8..7f71c27099 100644 --- a/_attributes/attributes-microshift.adoc +++ b/_attributes/attributes-microshift.adoc @@ -4,9 +4,10 @@ :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 @@ -14,6 +15,8 @@ :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 index 202e38dc9b..90a6b644dd 100644 --- 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 index abd5e83764..023cb2ec73 100644 --- a/microshift_install/microshift-install-rpm.adoc +++ b/microshift_install/microshift-install-rpm.adoc @@ -8,7 +8,7 @@ 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] @@ -16,6 +16,7 @@ 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 \ No newline at end of file +include::modules/microshift-accessing-cluster-remotely.adoc[leveloffset=+2] \ No newline at end of file diff --git a/microshift_networking/microshift-firewall.adoc b/microshift_networking/microshift-firewall.adoc index ccd6d7bba0..ff98ccda44 100644 --- 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 new file mode 120000 index 0000000000..93957f0227 --- /dev/null +++ b/microshift_rest_api/_attributes @@ -0,0 +1 @@ +../_attributes \ No newline at end of file diff --git a/microshift_rest_api/images b/microshift_rest_api/images new file mode 120000 index 0000000000..5e67573196 --- /dev/null +++ b/microshift_rest_api/images @@ -0,0 +1 @@ +../images \ No newline at end of file diff --git a/modules/snippets b/microshift_rest_api/snippets similarity index 100% rename from modules/snippets rename to microshift_rest_api/snippets diff --git a/microshift_rest_api/understanding-api-support-tiers.adoc b/microshift_rest_api/understanding-api-support-tiers.adoc index 73a078930f..7ed0769dee 100644 --- 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 index aa25d0c153..296745e2d3 100644 --- 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] \ No newline at end of file diff --git a/microshift_storage/dynamic-provisioning-microshift.adoc b/microshift_storage/dynamic-provisioning-microshift.adoc index 62b80e93cf..8a988ed1df 100644 --- 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 index c28401c952..2ce5fa2a38 100644 --- 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 index 40cf9b624d..2fd7401cce 100644 --- 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] \ No newline at end of file diff --git a/microshift_support/microshift-etcd.adoc b/microshift_support/microshift-etcd.adoc index f8edbb6b69..09918dcbc0 100644 --- 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] \ No newline at end of file diff --git a/microshift_support/microshift-sos-report.adoc b/microshift_support/microshift-sos-report.adoc index 003f451db3..8ef8dcbb28 100644 --- 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 index 9862ede14c..53969cb617 100644 --- 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 index b165dd9bea..67292066ec 100644 --- 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` 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 deleted file mode 120000 index e4c5bd02a1..0000000000 --- a/modules/images +++ /dev/null @@ -1 +0,0 @@ -../images/ \ No newline at end of file diff --git a/modules/microshift-add-blueprint-build-iso.adoc b/modules/microshift-add-blueprint-build-iso.adoc index 3736e5735d..666552f9c7 100644 --- 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 index 2cfc47cbb1..796e640f90 100644 --- 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 < {rpm-repo-version}.toml < fast-datapath.toml <