Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion microshift_install_rpm/microshift-access-node.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ include::_attributes/attributes-microshift.adoc[]
= Accessing the {microshift-short} node with oc
:context: microshift-access-node


toc::[]

[role="_abstract"]
Access a {microshift-short} node by using the {oc-first}.
Access a {microshift-short} node with the {oc-first}.

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

Expand Down
1 change: 1 addition & 0 deletions microshift_install_rpm/microshift-stop-start.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

[role="_abstract"]
You can stop or start {microshift-short} for a variety of reasons, including a fresh installation, adding optional RPM packages, and troubleshooting.

include::modules/microshift-service-starting.adoc[leveloffset=+1]
Expand Down
4 changes: 3 additions & 1 deletion microshift_install_rpm/microshift-uninstall-rpm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
[id="microshift-uninstall-rpm"]
include::_attributes/attributes-microshift.adoc[]
= Uninstalling {microshift-short}

:context: microshift-uninstall-rpm

toc::[]

Before you uninstall {microshift-short}, clean up all the {microshift-short} data and configuration by running the `microshift-cleanup-data` script.
[role="_abstract"]
When you want to uninstall {microshift-short} RPMs, you must take specific steps to remove the data from your host.

include::modules/microshift-uninstall-microshift-rpms.adoc[leveloffset=+1]
2 changes: 1 addition & 1 deletion modules/microshift-accessing-node-remotely.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 contains 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:
. 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"]
----
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-accessing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 contains the hostname or IP address you want to connect to and place it in the relevant directory.
* 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.
3 changes: 2 additions & 1 deletion modules/microshift-install-rpm-before.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
[id="microshift-install-rpm-before_{context}"]
= Before installing {microshift-short} from an RPM package

Preparation of the host machine is recommended before installing {microshift-short} for memory configuration and FIPS mode.
[role="_abstract"]
Before installing {microshift-short} for memory configuration and FIPS mode, you must prepare the host.

[id="microshift-configuring-volume-groups_{context}"]
== Configuring volume groups
Expand Down
5 changes: 3 additions & 2 deletions modules/microshift-install-rpm-preparing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
[id="microshift-install-rpm-preparing_{context}"]
= Preparing to install {microshift-short} from an RPM package

Configure your {op-system-base} machine to have a logical volume manager (LVM) volume group (VG) with sufficient capacity for the persistent volumes (PVs) of your workload.
[role="_abstract"]
When you are getting ready to install {microshift-short} RPMs, make sure you have enough storage capacity for the workload you want to run.

.Prerequisites

Expand Down Expand Up @@ -41,5 +42,5 @@ Example output:
[source,terminal]
----
VG #PV #LV #SN Attr VSize VFree
rhel 1 2 0 wz--n- <127.00g 54.94g
rhel 1 2 0 wz--n- 127.00g 54.94g
----
1 change: 1 addition & 0 deletions modules/microshift-install-rpms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="installing-microshift-from-rpm-package_{context}"]
= Installing {microshift-short} from an RPM package

[role="_abstract"]
Use the following procedure to install {microshift-short} from an RPM package.

.Prerequisites
Expand Down
1 change: 1 addition & 0 deletions modules/microshift-service-starting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="starting-microshift_service_{context}"]
= Starting the {microshift-short} service

[role="_abstract"]
Use the following procedure to start the {microshift-short} service.

.Prerequisites
Expand Down
3 changes: 2 additions & 1 deletion modules/microshift-service-stopping.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
= Stopping the {microshift-short} service

[role="_abstract"]
To stop the {microshift-short} service, you can run `systemctl stop microshift`. You can also stop any deployed workloads by running `systemctl stop kubepods.slice`.
When you want to stop the {microshift-short} service, you must stop both the service and any deployed workloads.


.Prerequisites

Expand Down
9 changes: 7 additions & 2 deletions modules/microshift-uninstall-microshift-rpms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
[id="microshift-uninstall-microshift-rpms_{context}"]
= Uninstalling {microshift-short} from an RPM package

[role="_abstract"]
When you want to uninstall {microshift-short}, you must first clean up all data, pods, and configurations before removing the RPM packages.


.Prerequisites

* You are logged into {microshift-short} as an administrator with root-user access.
Expand All @@ -18,9 +22,10 @@
+
[source,terminal,subs="+quotes"]
----
$ sudo microshift-cleanup-data --all <1>
$ sudo microshift-cleanup-data --all
----
<1> When you run the script with the `--all` argument, you perform the following clean up actions:
+
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
Expand Down