You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Learn about how `kubeconfig` files are used with {product-title} deployments. CLI tools use `kubeconfig` files to communicate with the API server of a cluster. These files provide cluster details, IP addresses, and other information needed for authentication.
9
+
Learn about how `kubeconfig` files are used with {microshift-short} deployments. CLI tools use `kubeconfig` files to communicate with the API server of a cluster. These files provide cluster details, IP addresses, and other information needed for authentication.
To deploy applications or make other changes through the {product-title} API with tools other than `kustomize` manifests, you must wait until the Greenboot health checks have finished. This ensures that your changes are not lost if Greenboot rolls your `rpm-ostree` system back to an earlier state.
9
+
To deploy applications or make other changes through the {microshift-short} API with tools other than `kustomize` manifests, you must wait until the Greenboot health checks have finished. This ensures that your changes are not lost if Greenboot rolls your `rpm-ostree` system back to an earlier state.
10
10
11
11
The `greenboot-healthcheck` service runs one time and then exits. After Greenboot has exited and the system is in a healthy state, you can proceed with configuration changes and deployments.
Copy file name to clipboardExpand all lines: microshift_getting_started/microshift-architecture.adoc
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Learn the specifics of {product-title} architecture including design intent, how
11
11
12
12
[id="microshift-architectural-design_{context}"]
13
13
== 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 {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.
14
+
{microshift-short} 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.
15
15
16
16
For example, {microshift-short} contains only the following Kubernetes cluster capabilities:
17
17
@@ -58,12 +58,12 @@ Figure 2 shows that {oke} has the same cluster capabilities as {product-title},
58
58
* Cloud Integration
59
59
* Virtual Machines (VMs) through {VirtProductName}
60
60
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.
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 {microshift-short}, functions such as over-the-air-updates, monitoring, and logging, are performed by the operating system.
62
62
63
63
[id="microshift-openshift-apis_{context}"]
64
-
== {product-title} OpenShift APIs
64
+
== {microshift-short} OpenShift APIs
65
65
66
-
In addition to standard Kubernetes APIs, {product-title} includes a small subset of the APIs supported by {OCP}.
66
+
In addition to standard Kubernetes APIs, {microshift-short} includes a small subset of the APIs supported by {OCP}.
67
67
68
68
[cols="1,1",options="header"]
69
69
|===
@@ -74,4 +74,8 @@ In addition to standard Kubernetes APIs, {product-title} includes a small subset
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.
9
+
Get an overview of what you can do with {microshift-short}, a Kubernetes distribution derived from {OCP} that is designed for optimizing small form factor devices and edge computing.
Copy file name to clipboardExpand all lines: microshift_install/microshift-embed-in-rpm-ostree.adoc
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
:_content-type: ASSEMBLY
2
2
[id="microshift-embed-in-rpm-ostree"]
3
-
= Embedding {product-title} in a {op-system-ostree} image
3
+
= Embedding {microshift-short} in a {op-system-ostree} image
4
4
include::_attributes/attributes-microshift.adoc[]
5
5
:context: microshift-embed-in-rpm-ostree
6
6
7
7
toc::[]
8
8
9
-
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}.
9
+
You can embed {microshift-short} into a {op-system-ostree-first}{op-system-version} image. Use this guide to build a {op-system} image containing {microshift-short}.
* xref:../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-creating-ostree-iso_microshift-embed-in-rpm-ostree[Creating the {op-system-ostree} image]
Greenboot is the generic health check framework for the `systemd` service on RPM-OSTree-based systems. The `microshift-greenboot` RPM and `greenboot-default-health-checks` are RPM packages installed with {product-title}. Greenboot is used to assess system health and automate a rollback to the last healthy state in the event of software trouble, for example:
9
+
Greenboot is the generic health check framework for the `systemd` service on RPM-OSTree-based systems. The `microshift-greenboot` RPM and `greenboot-default-health-checks` are RPM packages installed with {microshift-short}. Greenboot is used to assess system health and automate a rollback to the last healthy state in the event of software trouble, for example:
10
10
11
11
* This health check framework is especially useful when you need to check for software problems and perform system rollbacks on edge devices where direct serviceability is either limited or non-existent.
12
12
* When health check scripts are installed and configured, health checks run every time the system starts.
13
13
* Using Greenboot can reduce your risk of being locked out of edge devices during updates and prevent a significant interruption of service if an update fails.
14
14
* When a failure is detected, the system boots into the last known working configuration using the `rpm-ostree` rollback capability.
15
15
16
-
A {product-title} application health check script is included in the `microshift-greenboot` RPM. The `greenboot-default-health-checks` RPM also includes health check scripts verifying that DNS and `ostree` services are accessible. In addition, you can create your own health check scripts for the workloads you are running. You can write one that verifies that an application has started, for example.
16
+
A {microshift-short} application health check script is included in the `microshift-greenboot` RPM. The `greenboot-default-health-checks` RPM also includes health check scripts verifying that DNS and `ostree` services are accessible. In addition, you can create your own health check scripts for the workloads you are running. You can write one that verifies that an application has started, for example.
To troubleshoot a failed {product-title} installation, you can run an sos report. Use the `sos report` command to generate a detailed report that shows all of the enabled plugins and data from the different components and applications in a system.
9
+
To troubleshoot a failed {microshift-short} installation, you can run an sos report. Use the `sos report` command to generate a detailed report that shows all of the enabled plugins and data from the different components and applications in a system.
* xref:../microshift_support/microshift-sos-report.adoc#microshift-sos-report[About MicroShift sos reports]
16
+
* xref:../microshift_support/microshift-sos-report.adoc#microshift-sos-report[About {microshift-short} sos reports]
17
17
18
18
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/getting_the_most_from_your_support_experience/generating-an-sos-report-for-technical-support_getting-the-most-from-your-support-experience[Generating an sos report for technical support]
0 commit comments