OSDOCS-17110 CQA for Microshift #106151
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -6,7 +6,8 @@ include::_attributes/attributes-microshift.adoc[] | |||||
|
|
||||||
| toc::[] | ||||||
|
|
||||||
| [role="_abstract"] | ||||||
| Install {microshift-short} from an RPM package to deploy the service on a supported version of {op-system-base-full}. This method uses standard package management tools to help you manage the installation and future updates. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
no, deployments are only discussed for rhel image systems at the edge; this is incorrect language |
||||||
|
|
||||||
| include::modules/microshift-install-rpm-before.adoc[leveloffset=+1] | ||||||
|
|
||||||
|
|
@@ -18,7 +19,7 @@ include::modules/microshift-install-rpms.adoc[leveloffset=+1] | |||||
| [role="_additional-resources"] | ||||||
| == Additional resources | ||||||
| * xref:../microshift_install_get_ready/microshift-fips.adoc#microshift-fips[Using FIPS mode with {microshift-short}] | ||||||
| * link:https://console.redhat.com/openshift/install/pull-secret[pull secret] | ||||||
| * xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file] | ||||||
| * link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/interactively_installing_rhel_over_the_network/customizing-the-system-in-the-installer_rhel-installer#manual-partitioning_customizing-the-system-in-the-installer[Configuring manual partitioning] | ||||||
| * link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management] | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,12 +1,14 @@ | ||||||
| :_mod-docs-content-type: ASSEMBLY | ||||||
| [id="microshift-stop-start"] | ||||||
| = Stopping and starting {microshift-short} | ||||||
| include::_attributes/attributes-microshift.adoc[] | ||||||
|
|
||||||
| :context: microshift-stop-start | ||||||
|
|
||||||
| toc::[] | ||||||
|
|
||||||
| [role="_abstract"] | ||||||
| Stop or start the {microshift-short} service to troubleshoot issues, perform fresh installations, or add optional RPM packages. Controlling the service state enables configuration changes to take effect and simplifies system maintenance. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
this is not true; restarting microshift is HIGHLY disruptive |
||||||
|
|
||||||
| include::modules/microshift-service-starting.adoc[leveloffset=+1] | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,13 @@ | ||
| :_mod-docs-content-type: ASSEMBLY | ||
| [id="microshift-uninstall-rpm"] | ||
| = Uninstalling {microshift-short} | ||
| include::_attributes/attributes-microshift.adoc[] | ||
|
|
||
| :context: microshift-uninstall-rpm | ||
|
|
||
| toc::[] | ||
|
|
||
| [role="_abstract"] | ||
| Uninstall {microshift-short} to remove the software from your system. You must run the `microshift-cleanup-data` script to delete all data and configuration files before you remove the packages. | ||
|
Contributor
There was a problem hiding this comment. you actually said the opposite of what was here; please check with @ggiguash if your language is still correct |
||
|
|
||
| include::modules/microshift-uninstall-microshift-rpms.adoc[leveloffset=+1] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,7 +9,7 @@ | |
| = Accessing the {microshift-short} node locally | ||
|
|
||
| [role="_abstract"] | ||
| Access the {microshift-short} node locally by using a kubeconfig file to manage your cluster directly from the host machine. This configuration verififies that the cluster status and perform administrative tasks without external network dependencies. | ||
|
|
||
| .Prerequisites | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,7 +9,7 @@ | |
| = Opening the firewall for remote access to the {microshift-short} node | ||
|
|
||
| [role="_abstract"] | ||
| Open the firewall on the {microshift-short} host to enable remote access from a separate workstation. This configuration allows a remote user to connect to the node and helps ensure they can access the Kubernetes API server. | ||
|
|
||
| For this procedure, `user@microshift` is the user on the {microshift-short} host machine and is responsible for setting up that machine so that it can be accessed by a remote user on a separate workstation. | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -9,7 +9,7 @@ | |||||
| = Accessing the {microshift-short} node remotely | ||||||
|
|
||||||
| [role="_abstract"] | ||||||
| To manage your cluster from a local workstation, access the {microshift-short} service remotely by using a kubeconfig file. You can now control the cluster without logging in to the host machine. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
microshift does not make clusters, it is a single node |
||||||
|
|
||||||
| The `user@workstation` login is used to access the host machine remotely. The `<user>` value in the procedure is the name of the user that `user@workstation` logs in with to the {microshift-short} host. | ||||||
|
|
||||||
|
|
@@ -37,7 +37,7 @@ The `user@workstation` login is used to access the host machine remotely. The `< | |||||
| + | ||||||
| Replace the value, _<{microshift-short}_hostname>_, with the either the name or the IP address of the host running {microshift}. | ||||||
|
|
||||||
| . As `user@workstation`, copy the generated `kubeconfig` file that has the hostname or IP address you want to connect to from the {op-system-base} machine running {microshift-short} to your local machine by running the following command: | ||||||
| + | ||||||
| [source,terminal,subs="+quotes"] | ||||||
| ---- | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,4 +12,4 @@ Access the {microshift-short} service by using the {oc-first}. | |
|
|
||
| * You can access the node from either the same machine running the {microshift-short} service or from a remote location. | ||
| * You can use this access to observe and administer workloads. | ||
| * When using the following steps, choose the `kubeconfig` file that has the hostname or IP address you want to connect to and place it in the relevant directory. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -6,7 +6,8 @@ | |||||
| [id="microshift-install-rpm-before_{context}"] | ||||||
| = Before installing {microshift-short} from an RPM package | ||||||
|
|
||||||
| [role="_abstract"] | ||||||
| Prepare your host machine to handle memory configuration and FIPS mode requirements before installing {microshift-short}. Proper preparation ensures a successful installation. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
i don't think this extra sentence added anything of value; not minimalism |
||||||
|
|
||||||
| [id="microshift-configuring-volume-groups_{context}"] | ||||||
| == Configuring volume groups | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -6,7 +6,8 @@ | |||||
| [id="microshift-install-rpm-preparing_{context}"] | ||||||
| = Preparing to install {microshift-short} from an RPM package | ||||||
|
|
||||||
| [role="_abstract"] | ||||||
| To support the persistent volumes of your workload, configure a logical volume manager (LVM) volume group on your machine. You can adjust the capacity settings so that your system has enough space for your applications. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| .Prerequisites | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -6,7 +6,8 @@ | |||||
| [id="installing-microshift-from-rpm-package_{context}"] | ||||||
| = Installing {microshift-short} from an RPM package | ||||||
|
|
||||||
| [role="_abstract"] | ||||||
| Install {microshift-short} from an RPM package to deploy the software on your Red Hat Enterprise Linux system. This method manages updates by using standard subscription tools and maintains a supported configuration by locking your operating system version. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
i don't know what subscription tools you mean here: microshift does not use update channels like openshift; my guess is that your change is inaccurate |
||||||
|
|
||||||
| .Prerequisites | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -6,7 +6,8 @@ | |||||
| [id="starting-microshift_service_{context}"] | ||||||
| = Starting the {microshift-short} service | ||||||
|
|
||||||
| [role="_abstract"] | ||||||
| Start the {microshift-short} service to activate your cluster and prepare it for running workloads. This step verifies that all necessary components are running and ready to accept applications. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
microshit does not have components like openshift does |
||||||
|
|
||||||
| .Prerequisites | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -8,7 +8,8 @@ | |||||
| [id="stopping-microshift-service_{context}"] | ||||||
| = Stopping the {microshift-short} service | ||||||
|
|
||||||
| [role="_abstract"] | ||||||
| Stop the {microshift-short} service and all running workloads to safely halt cluster operations. This allows maintenance or troubleshooting to be performed without active processes interfering and achieving a complete system shutdown. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
there is no procedure here to stop workloads |
||||||
|
|
||||||
| .Prerequisites | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,9 @@ | |
| [id="microshift-uninstall-microshift-rpms_{context}"] | ||
| = Uninstalling {microshift-short} from an RPM package | ||
|
|
||
| [role="_abstract"] | ||
| Uninstall the {microshift-short} RPM package to remove the software and reset your system. This process deletes all data, pods, and configurations to help ensure a clean environment for future deployments. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You are logged into {microshift-short} as an administrator with root-user access. | ||
|
|
@@ -18,9 +21,10 @@ | |
| + | ||
| [source,terminal,subs="+quotes"] | ||
| ---- | ||
| $ sudo microshift-cleanup-data --all | ||
| ---- | ||
| + | ||
| When you run the script with the `--all` argument, you perform the following clean up actions: | ||
|
|
||
| * Stop and disable all {microshift-short} services | ||
| * Delete all {microshift-short} pods | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
spelling is wrong, use the attribute file where it was