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

OSDOCS-8023: adds short attribute for MicroShift

Browse Source
This commit is contained in:
“Shauna Diaz”
2023-10-04 14:23:25 -04:00
committed by openshift-cherrypick-robot
parent 13cd893f8b
commit fd69e5be9c
3 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
_attributes/attributes-microshift.adoc
View File

@@ -7,6 +7,7 @@
:ocp-version: 4.14
:oc-first: pass:quotes[OpenShift CLI (`oc`)]
:product-title-first: Red Hat build of MicroShift (MicroShift)
:microshift-short: MicroShift
:product-registry: OpenShift image registry
:product-version: 4.14
:rhel-major: rhel-9

14
microshift_getting_started/microshift-architecture.adoc
View File

@@ -11,38 +11,38 @@ Learn the specifics of {product-title} architecture including design intent, how
[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. 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.
{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 {microshift-short} 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} contains only the following Kubernetes cluster capabilities:
For example, {microshift-short} contains only the following Kubernetes cluster capabilities:
* Networking
* Ingress
* Storage
* Helm
{product-title} also provides the following Kubernetes functions:
{microshift-short} 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.
To optimize your deployments, use {microshift-short} with a compatible operating system, such as {op-system-ostree-first}. Using {microshift-short} and {op-system-ostree-first} together forms {op-system-bundle}. Virtual machines are handled by the operating system in {microshift-short} 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:
The following operational differences from {oke} can help you understand where {microshift-short} can be deployed:
[id="microshift-differences-oke_{context}"]
== Key differences from {oke}
* Devices with {product-title} installed are self-managing
* Devices with {microshift-short} 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
.{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.>]
image::311_RHDevice_Edge_Overview_0223_2.png[<{microshift-short} 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:

4
modules/microshift-about.adoc
View File

@@ -5,7 +5,7 @@
[id="con-about-microshift_{context}"]
= About {product-title}
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:
Working with resource-constrained field environments and hardware presents many challenges not experienced with cloud computing. {microshift-short} enables you to solve problems for edge devices by:
* Running the same Kubernetes workloads you run in the cloud, but at the edge.
* Overcoming the operational challenge of minimal system resources.
@@ -13,4 +13,4 @@ Working with resource-constrained field environments and hardware presents many
* 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-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.
{microshift-short} 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.