Skip to content

Commit 96d86dc

Browse files
committed
OSDOCS-8012: fix attribute for microshift
1 parent 4ebf111 commit 96d86dc

File tree

110 files changed

+313
-318
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+313
-318
lines changed

_attributes/attributes-microshift.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,11 @@
1313
:rhel-major: rhel-9
1414
:op-system-base-full: Red Hat Enterprise Linux (RHEL)
1515
:op-system: RHEL
16+
:op-system-base: RHEL
1617
:op-system-ostree-first: Red Hat Enterprise Linux for Edge (RHEL for Edge)
1718
:op-system-ostree: RHEL for Edge
1819
:op-system-version: 9.2
1920
:op-system-version-major: 9
20-
:op-system-bundle-first: Red Hat Device Edge (RHDE)
2121
:op-system-bundle: Red Hat Device Edge
22-
:op-system-bundle-short: RHDE
2322
:rpm-repo-version: rhocp-4.14
2423
:VirtProductName: OpenShift Virtualization

_topic_maps/_topic_map_ms.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ Name: Release notes
3333
Dir: microshift_release_notes
3434
Distros: microshift
3535
Topics:
36-
- Name: MicroShift 4.14 release notes
36+
- Name: Red Hat build of MicroShift 4.14 release notes
3737
File: microshift-4-14-release-notes
3838
---
3939
Name: Getting started
4040
Dir: microshift_getting_started
4141
Distros: microshift
4242
Topics:
43-
- Name: Understanding MicroShift
43+
- Name: Understanding Red Hat build of MicroShift
4444
File: microshift-understanding
4545
- Name: Architecture
4646
File: microshift-architecture
@@ -66,7 +66,7 @@ Topics:
6666
File: microshift-about-updates
6767
- Name: Update options
6868
File: microshift-update-options
69-
- Name: Updates with RPM-OSTree systems
69+
- Name: Updates with rom-ostree systems
7070
File: microshift-update-rpms-ostree
7171
- Name: Manual updates with RPMs
7272
File: microshift-update-rpms-manually
@@ -75,9 +75,9 @@ Name: Support
7575
Dir: microshift_support
7676
Distros: microshift
7777
Topics:
78-
- Name: MicroShift etcd
78+
- Name: The etcd service
7979
File: microshift-etcd
80-
- Name: MicroShift sos report
80+
- Name: The sos tool
8181
File: microshift-sos-report
8282
---
8383
Name: API reference
@@ -401,15 +401,15 @@ Name: Storage
401401
Dir: microshift_storage
402402
Distros: microshift
403403
Topics:
404-
- Name: About MicroShift storage
404+
- Name: About storage
405405
File: index
406-
- Name: Understanding ephemeral storage for MicroShift
406+
- Name: Understanding ephemeral storage
407407
File: understanding-ephemeral-storage-microshift
408-
- Name: Generic ephemeral volumes for MicroShift
408+
- Name: Generic ephemeral volumes
409409
File: generic-ephemeral-volumes-microshift
410-
- Name: Understanding persistent storage for MicroShift
410+
- Name: Understanding persistent storage
411411
File: understanding-persistent-storage-microshift
412-
- Name: Expanding persistent volumes for MicroShift
412+
- Name: Expanding persistent volumes
413413
File: expanding-persistent-volumes-microshift
414414
- Name: Dynamic storage using the LVMS plugin
415415
File: microshift-storage-plugin-overview

microshift_configuring/microshift-cluster-access-kubeconfig.adoc

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

77
toc::[]
88

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

1111
include::modules/microshift-kubeconfig-overview.adoc[leveloffset=+1]
1212

microshift_configuring/microshift-greenboot-checking-status.adoc

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

77
toc::[]
88

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

1111
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.
1212

microshift_configuring/microshift-using-config-tools.adoc

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

77
toc::[]
88

9-
A YAML file customizes {product-title} instances with your preferences, settings, and parameters.
9+
A YAML file customizes {microshift-short} instances with your preferences, settings, and parameters.
1010

1111
include::snippets/microshift-greenboot-status-snip.adoc[leveloffset=+2]
1212

microshift_getting_started/microshift-architecture.adoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ 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 {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.
1515

1616
For example, {microshift-short} contains only the following Kubernetes cluster capabilities:
1717

@@ -58,12 +58,12 @@ Figure 2 shows that {oke} has the same cluster capabilities as {product-title},
5858
* Cloud Integration
5959
* Virtual Machines (VMs) through {VirtProductName}
6060

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.
6262

6363
[id="microshift-openshift-apis_{context}"]
64-
== {product-title} OpenShift APIs
64+
== {microshift-short} OpenShift APIs
6565

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}.
6767

6868
[cols="1,1",options="header"]
6969
|===
@@ -74,4 +74,8 @@ In addition to standard Kubernetes APIs, {product-title} includes a small subset
7474
| security.openshift.io/v1
7575
|===
7676

77-
include::modules/microshift-k8s-apis.adoc[leveloffset=+1]
77+
include::modules/microshift-k8s-apis.adoc[leveloffset=+1]
78+
79+
[role="_additional-resources"]
80+
.Additional resources
81+
* xref:../microshift_rest_api/index.adoc#api-index[API index]

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}, 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.
1010

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

microshift_install/microshift-embed-in-rpm-ostree.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
:_content-type: ASSEMBLY
22
[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
44
include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-embed-in-rpm-ostree
66

77
toc::[]
88

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}.
1010

1111
//include::snippets/microshift-tech-preview-snip.adoc[leveloffset=+1]
1212

@@ -28,7 +28,6 @@ include::modules/microshift-ca-adding-bundle.adoc[leveloffset=+1]
2828
include::modules/microshift-ca-adding-bundle-ostree.adoc[leveloffset=+2]
2929

3030
[role="_additional-resources"]
31-
[id="additional-resources_microshift-add-cert-bundle"]
3231
.Additional resources
3332

3433
* xref:../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-creating-ostree-iso_microshift-embed-in-rpm-ostree[Creating the {op-system-ostree} image]

microshift_install/microshift-greenboot.adoc

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

77
toc::[]
88

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 {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:
1010

1111
* 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.
1212
* When health check scripts are installed and configured, health checks run every time the system starts.
1313
* 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.
1414
* When a failure is detected, the system boots into the last known working configuration using the `rpm-ostree` rollback capability.
1515
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.
1717

1818
[NOTE]
1919
====

microshift_install/microshift-installing-troubleshooting.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ include::_attributes/attributes-microshift.adoc[]
66

77
toc::[]
88

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

1111
include::modules/microshift-gathering-sos-report.adoc[leveloffset=+1]
1212

1313
[id="additional-resources_microshift-installing-troubleshooting_{context}"]
1414
[role="_additional-resources"]
1515
== Additional resources
16-
* 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]
1717

1818
* 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

Comments
 (0)