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

OSDOCS-4903v2: PM pre-release comments nits

This commit is contained in:
Shauna Diaz
2023-02-01 09:44:13 -05:00
committed by openshift-cherrypick-robot
parent ac32ccc3aa
commit 8e7d73d774
8 changed files with 57 additions and 25 deletions

View File

@@ -14,3 +14,6 @@
:op-system-version-major: 8
:op-system-ram: 2GB RAM
:op-system-chip: two-core AMD64 1.5GHz processor
:op-system-bundle: Red Hat Device Edge
:op-system-bundle-short: RHDE
:VirtProductName: OpenShift Virtualization

Binary file not shown.

After

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 194 KiB

View File

@@ -2,30 +2,63 @@
[id="microshift-architecture"]
= Architecture
include::_attributes/attributes-microshift.adoc[]
include::_attributes/common-attributes.adoc[]
:context: microshift-architecture
toc::[]
Learn the specifics of {product-title} architecture including design intent, how it differs from {OCP}, and API compatibility.
Learn the specifics of {product-title} architecture including design intent, how it differs from {oke}, and API compatibility.
[id="microshift-architectural-design_{context}"]
== Architectural design
{product-title} is a single-node container orchestration runtime designed to extend the benefits of using containers for running applications to low-resource edge environments. {product-title} contains only the APIs and features essential to operating in edge and small form factor computing environments. The following operational differences from {OCP} can help you understand where {product-title} can be deployed:
{product-title} is a single-node container orchestration runtime designed to extend the benefits of using containers for running applications to low-resource edge environments. Because {product-title} is primarily a platform for deploying applications, only the APIs and features essential to operating in edge and small form factor computing environments are included.
For example, {product-title} is contains only the following Kubernetes cluster capabilities:
* Networking
* Ingress
* Storage
* Helm
{product-title} also provides the following Kubernetes functions:
* Orchestration
* Security
To optimize your deployments, use {product-title} with a compatible operating system, such as {op-system-ostree-first}. Using {product-title} and {op-system-ostree-first} together forms {op-system-bundle}. Virtual machines are handled by the operating system in {product-title} deployments.
.{product-title} as part of {op-system-bundle}.
image::311_RHDevice_Edge_Overview_0223_1.png[<{product-title} is tasked with only the Kubernetes cluster services networking, ingress, storage, helm, with additional Kubernetes functions of orchestration and security, as the following diagram illustrates.>]
The following operational differences from {oke} can help you understand where {product-title} can be deployed:
[id="microshift-differences-oke_{context}"]
== Key differences from {oke}
[id="microshift-differences-ocp_{context}"]
== Key differences from {OCP}
* Application-level events and metrics are observation-only
* Devices with {product-title} installed are self-managing
* Compatible with RPM-OStree-based systems
* Uses only the APIs needed for essential functions, such as security and runtime controls
* Enables a subset of commands from the OpenShift CLI (`oc`) tool
* Does not support workload high availability (HA) or horizontal scalability with the addition of worker nodes
// * You can use in locations where full control is needed
// * Works offline and in low-connectivity environments
// * You do not need to perform external orchestration
// * Installs on top of {op-system-first}, an operating system especially for edge computing
// * Use several single-node deployments to ... (use case example)
// Bullets need more specific detail
.{product-title} differences from {oke}.
image::311_RHDevice_Edge_Overview_0223_2.png[<{product-title} is tasked with only the Kubernetes cluster capabilities of networking, ingress, storage, helm, with the additional Kubernetes functions of orchestration and security, as the following diagram illustrates.>]
Figure 2 shows that {oke} has the same cluster capabilities as {product-title}, and adds the following:
* Install
* Over-the-air updates
* Cluster Operators
* Operator Lifecycle Manager
* Monitoring
* Logging
* Registry
* Authorization
* Console
* Cloud Integration
* Virtual Machines (VMs) through {VirtProductName}
In {oke} and other {OCP} deployments, all of the components from the operating system through the cluster capabilities work as one comprehensive unit, with full cluster services for a multi-node Kubernetes workload. With {product-title}, functions such as over-the-air-updates, monitoring, and logging, are performed by the operating system.
[id="microshift-openshift-apis_{context}"]
== {product-title} OpenShift APIs

View File

@@ -6,6 +6,6 @@ include::_attributes/attributes-microshift.adoc[]
toc::[]
Get an overview of what you can do with {product-title}, based on {OCP}, but designed for optimizing small form factor devices and edge computing.
Get an overview of what you can do with {product-title}, a Kubernetes distribution derived from {OCP} that is designed for optimizing small form factor devices and edge computing.
include::modules/microshift-about.adoc[leveloffset=+1]

View File

@@ -6,19 +6,14 @@ include::_attributes/common-attributes.adoc[]
toc::[]
include::modules/storage-expanding-add-volume-expansion.adoc[leveloffset=+1]
//include::modules/storage-expanding-add-volume-expansion.adoc[leveloffset=+1]
include::modules/storage-expanding-csi-volumes.adoc[leveloffset=+1]
include::modules/storage-expanding-flexvolume.adoc[leveloffset=+1]
//include::modules/storage-expanding-flexvolume.adoc[leveloffset=+1]
include::modules/storage-expanding-local-volumes.adoc[leveloffset=+1]
include::modules/storage-expanding-filesystem-pvc.adoc[leveloffset=+1]
include::modules/storage-expanding-recovering-failure.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* The controlling `StorageClass` object has `allowVolumeExpansion` set to `true` (refer to xref:../microshift_storage/expanding-persistent-volumes-microshift.html#add-volume-expansion_expanding-persistent-volumes-microshift[Enabling volume expansion support]).
include::modules/storage-expanding-recovering-failure.adoc[leveloffset=+1]

View File

@@ -7,9 +7,10 @@
Working with resource-constrained field environments and hardware presents many challenges not experienced with cloud computing. {product-title} enables you to solve problems for edge devices by:
* Overcoming the operational challenge of minimal system resources, for example, a dual-core processor.
* Running the same Kubernetes workloads you run in the cloud, but at the edge.
* Overcoming the operational challenge of minimal system resources.
* Addressing the environmental challenges of severe networking constraints such as low or no connectivity.
* Meeting the physical constraint of hard-to-access locations by installing your system images directly on edge devices.
* Building on and integrating with edge-optimized operating systems such as {op-system-first}.
* Building on and integrating with edge-optimized operating systems such as {op-system-ostree-first}.
{product-title} has the simplicity of single-node deployment with the functions and services you need for computing in resource-constrained locations. You can have many deployments on different hosts, creating the specific system image needed for each of your applications. Installing {product-title} on top of your managed {op-system} devices in hard-to-service locations also allows for streamlined over-the-air updates.
{product-title} has the simplicity of single-node deployment with the functions and services you need for computing in resource-constrained locations. You can have many deployments on different hosts, creating the specific system image needed for each of your applications.

View File

@@ -10,14 +10,14 @@ Not all {OCP} CLI tool (`oc`) commands are relevant for {product-title} deployme
.Example output
For example, when the following `new-project` command is run:
+
[source, terminal]
----
$ oc new-project test
----
The error following error message can be generated:
+
[source, terminal]
----
Error from server (NotFound): the server could not find the requested resource (get projectrequests.project.openshift.io)