Skip to content

Commit 8acaa7e

Browse files
committed
OSDOCS-8023: adds short attribute for MicroShift
1 parent e4b58a6 commit 8acaa7e

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

_attributes/attributes-microshift.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
:ocp-version: 4.14
88
:oc-first: pass:quotes[OpenShift CLI (`oc`)]
99
:product-title-first: Red Hat build of MicroShift (MicroShift)
10+
:microshift-short: MicroShift
1011
:product-registry: OpenShift image registry
1112
:product-version: 4.14
1213
:rhel-major: rhel-9

microshift_getting_started/microshift-architecture.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,38 +11,38 @@ Learn the specifics of {product-title} architecture including design intent, how
1111

1212
[id="microshift-architectural-design_{context}"]
1313
== Architectural design
14-
{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.
14+
{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.
1515

16-
For example, {product-title} contains only the following Kubernetes cluster capabilities:
16+
For example, {microshift-short} contains only the following Kubernetes cluster capabilities:
1717

1818
* Networking
1919
* Ingress
2020
* Storage
2121
* Helm
2222

23-
{product-title} also provides the following Kubernetes functions:
23+
{microshift-short} also provides the following Kubernetes functions:
2424

2525
* Orchestration
2626
* Security
2727

28-
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.
28+
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.
2929

3030
.{product-title} as part of {op-system-bundle}.
3131
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.>]
3232

33-
The following operational differences from {oke} can help you understand where {product-title} can be deployed:
33+
The following operational differences from {oke} can help you understand where {microshift-short} can be deployed:
3434

3535
[id="microshift-differences-oke_{context}"]
3636
== Key differences from {oke}
3737

38-
* Devices with {product-title} installed are self-managing
38+
* Devices with {microshift-short} installed are self-managing
3939
* Compatible with RPM-OStree-based systems
4040
* Uses only the APIs needed for essential functions, such as security and runtime controls
4141
* Enables a subset of commands from the OpenShift CLI (`oc`) tool
4242
* Does not support workload high availability (HA) or horizontal scalability with the addition of worker nodes
4343

4444
.{product-title} differences from {oke}.
45-
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.>]
45+
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.>]
4646

4747
Figure 2 shows that {oke} has the same cluster capabilities as {product-title}, and adds the following:
4848

modules/microshift-about.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
[id="con-about-microshift_{context}"]
66
= About {product-title}
77

8-
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:
8+
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:
99

1010
* Running the same Kubernetes workloads you run in the cloud, but at the edge.
1111
* Overcoming the operational challenge of minimal system resources.
1212
* Addressing the environmental challenges of severe networking constraints such as low or no connectivity.
1313
* Meeting the physical constraint of hard-to-access locations by installing your system images directly on edge devices.
1414
* Building on and integrating with edge-optimized operating systems such as {op-system-ostree-first}.
1515

16-
{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.
16+
{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.

0 commit comments

Comments
 (0)