Skip to content

Commit e14a6f2

Browse files
mburke5678mburke5678
authored
Merge pull request #55419 from ShaunaDiaz/OSDOCS-4903v2
OSDOCS-4903: v2 PM pre-release comments nits
2 parents b4af708 + 28c58a5 commit e14a6f2

8 files changed

+57
-25
lines changed

‎_attributes/attributes-microshift.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,6 @@
1414
:op-system-version-major: 8
1515
:op-system-ram: 2GB RAM
1616
:op-system-chip: two-core AMD64 1.5GHz processor
17+
:op-system-bundle: Red Hat Device Edge
18+
:op-system-bundle-short: RHDE
19+
:VirtProductName: OpenShift Virtualization

‎images/311_RHDevice_Edge_Overview_0223_1.png

126 KB
Loading

‎images/311_RHDevice_Edge_Overview_0223_2.png

194 KB
Loading

‎microshift_getting_started/microshift-architecture.adoc

Lines changed: 44 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,63 @@
22
[id="microshift-architecture"]
33
= Architecture
44
include::_attributes/attributes-microshift.adoc[]
5+
include::_attributes/common-attributes.adoc[]
56
:context: microshift-architecture
67

78
toc::[]
89

9-
Learn the specifics of {product-title} architecture including design intent, how it differs from {OCP}, and API compatibility.
10+
Learn the specifics of {product-title} architecture including design intent, how it differs from {oke}, and API compatibility.
1011

1112
[id="microshift-architectural-design_{context}"]
1213
== Architectural design
13-
{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:
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.
15+
16+
For example, {product-title} is contains only the following Kubernetes cluster capabilities:
17+
18+
* Networking
19+
* Ingress
20+
* Storage
21+
* Helm
22+
23+
{product-title} also provides the following Kubernetes functions:
24+
25+
* Orchestration
26+
* Security
27+
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.
29+
30+
.{product-title} as part of {op-system-bundle}.
31+
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.>]
32+
33+
The following operational differences from {oke} can help you understand where {product-title} can be deployed:
34+
35+
[id="microshift-differences-oke_{context}"]
36+
== Key differences from {oke}
1437

15-
[id="microshift-differences-ocp_{context}"]
16-
== Key differences from {OCP}
17-
* Application-level events and metrics are observation-only
1838
* Devices with {product-title} installed are self-managing
1939
* Compatible with RPM-OStree-based systems
2040
* Uses only the APIs needed for essential functions, such as security and runtime controls
2141
* Enables a subset of commands from the OpenShift CLI (`oc`) tool
42+
* Does not support workload high availability (HA) or horizontal scalability with the addition of worker nodes
43+
44+
.{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.>]
46+
47+
Figure 2 shows that {oke} has the same cluster capabilities as {product-title}, and adds the following:
48+
49+
* Install
50+
* Over-the-air updates
51+
* Cluster Operators
52+
* Operator Lifecycle Manager
53+
* Monitoring
54+
* Logging
55+
* Registry
56+
* Authorization
57+
* Console
58+
* Cloud Integration
59+
* Virtual Machines (VMs) through {VirtProductName}
2260

23-
// * You can use in locations where full control is needed
24-
// * Works offline and in low-connectivity environments
25-
// * You do not need to perform external orchestration
26-
// * Installs on top of {op-system-first}, an operating system especially for edge computing
27-
// * Use several single-node deployments to ... (use case example)
28-
// Bullets need more specific detail
61+
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.
2962

3063
[id="microshift-openshift-apis_{context}"]
3164
== {product-title} OpenShift APIs

‎microshift_getting_started/microshift-understanding.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ include::_attributes/attributes-microshift.adoc[]
66

77
toc::[]
88

9-
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.
9+
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.
1010

1111
include::modules/microshift-about.adoc[leveloffset=+1]

‎microshift_storage/expanding-persistent-volumes-microshift.adoc

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,14 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
include::modules/storage-expanding-add-volume-expansion.adoc[leveloffset=+1]
9+
//include::modules/storage-expanding-add-volume-expansion.adoc[leveloffset=+1]
1010

1111
include::modules/storage-expanding-csi-volumes.adoc[leveloffset=+1]
1212

13-
include::modules/storage-expanding-flexvolume.adoc[leveloffset=+1]
13+
//include::modules/storage-expanding-flexvolume.adoc[leveloffset=+1]
1414

1515
include::modules/storage-expanding-local-volumes.adoc[leveloffset=+1]
1616

1717
include::modules/storage-expanding-filesystem-pvc.adoc[leveloffset=+1]
1818

19-
include::modules/storage-expanding-recovering-failure.adoc[leveloffset=+1]
20-
21-
[role="_additional-resources"]
22-
.Additional resources
23-
24-
* 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]).
19+
include::modules/storage-expanding-recovering-failure.adoc[leveloffset=+1]

‎modules/microshift-about.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@
77

88
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:
99

10-
* Overcoming the operational challenge of minimal system resources, for example, a dual-core processor.
10+
* Running the same Kubernetes workloads you run in the cloud, but at the edge.
11+
* Overcoming the operational challenge of minimal system resources.
1112
* Addressing the environmental challenges of severe networking constraints such as low or no connectivity.
1213
* Meeting the physical constraint of hard-to-access locations by installing your system images directly on edge devices.
13-
* Building on and integrating with edge-optimized operating systems such as {op-system-first}.
14+
* Building on and integrating with edge-optimized operating systems such as {op-system-ostree-first}.
1415

15-
{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.
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.

‎modules/microshift-oc-apis-errors.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Not all {OCP} CLI tool (`oc`) commands are relevant for {product-title} deployme
1010
.Example output
1111

1212
For example, when the following `new-project` command is run:
13-
+
13+
1414
[source, terminal]
1515
----
1616
$ oc new-project test
1717
----
1818

1919
The error following error message can be generated:
20-
+
20+
2121
[source, terminal]
2222
----
2323
Error from server (NotFound): the server could not find the requested resource (get projectrequests.project.openshift.io)

0 commit comments

Comments
 (0)