mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-4752 Pre-GA docs nit corrections
This commit is contained in:
Shauna Diaz
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
c13e383798
commit
87fc5a8f4d
@@ -89,8 +89,8 @@ Topics:
|
||||
File: getting-started-cli
|
||||
- Name: Configuring the OpenShift CLI
|
||||
File: configuring-cli
|
||||
- Name: Managing CLI profiles
|
||||
File: managing-cli-profiles
|
||||
# - Name: Managing CLI profiles
|
||||
# File: managing-cli-profiles
|
||||
- Name: Extending the OpenShift CLI with plug-ins
|
||||
File: extending-cli-plugins
|
||||
# FIXME: auto-generated content in the next file includes commands
|
||||
|
||||
@@ -24,7 +24,10 @@ These tools expose simple commands to manage the applications, as well as intera
|
||||
|
||||
The following set of CLI tools are available in {product-title}:
|
||||
|
||||
* xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI (oc)]: This is the most commonly used CLI tool by {product-title} users. It helps both cluster administrators and developers to perform end-to-end operations across {product-title} using the terminal. Unlike the web console, it allows the user to work directly with the project source code using command scripts.
|
||||
* xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI (oc)]: This is the most commonly used CLI tool by {product-title} users. It helps both cluster administrators and developers to perform end-to-end operations across {product-title} using the terminal.
|
||||
ifndef::microshift[]
|
||||
Unlike the web console, it allows the user to work directly with the project source code using command scripts.
|
||||
endif::microshift[]
|
||||
|
||||
ifndef::microshift[]
|
||||
* xref:../cli_reference/kn-cli-tools.adoc#kn-cli-tools[Knative CLI (kn)]: The Knative (`kn`) CLI tool provides simple and intuitive terminal commands that can be used to interact with OpenShift Serverless components, such as Knative Serving and Eventing.
|
||||
|
||||
@@ -16,7 +16,7 @@ Learn the specifics of {product-title} architecture including design intent, how
|
||||
* Devices with {product-title} installed are self-managing
|
||||
* Compatible with rpm-ostree-based systems
|
||||
* Uses only the APIs needed for essential functions, such as security and runtime controls
|
||||
* Reuses select commands from the OpenShift CLI (`oc`) tool
|
||||
* Enables a subset of commands from the OpenShift CLI (`oc`) tool
|
||||
|
||||
// * You can use in locations where full control is needed
|
||||
// * Works offline and in low-connectivity environments
|
||||
|
||||
@@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
Get an overview of what you can do with {product-title}, a distribution of {OCP} designed for optimizing small form factors and edge computing.
|
||||
Get an overview of what you can do with {product-title}, a distribution of {OCP} designed for optimizing small form factor devices and edge computing.
|
||||
|
||||
include::modules/about-microshift.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -5,15 +5,15 @@ include::_attributes/attributes-microshift.adoc[]
|
||||
:context: microshift-install-rhel-for-edge
|
||||
toc::[]
|
||||
|
||||
You can embed MicroShift into a {op-system-ostree-first} {op-system-version} image.
|
||||
You can embed {product-title} into a {op-system-ostree-first} {op-system-version} image.
|
||||
|
||||
== Embedding MicroShift into a {op-system-ostree} image
|
||||
= Embedding {product-title} into a {op-system-ostree} image
|
||||
|
||||
Use the content within this section to build a {op-system-ostree-first} {op-system-version} image containing MicroShift.
|
||||
Use the content within this section to build a {op-system-ostree-first} {op-system-version} image containing {product-title}.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
{op-system} 9.0 is currently unsupported for MicroShift deployments.
|
||||
{op-system} 9.0 is currently unsupported for {product-title} deployments.
|
||||
====
|
||||
|
||||
//include modules/prerequisites-for-installing-microshift.adoc
|
||||
|
||||
@@ -1,29 +1,49 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="microshift-install-rpm"]
|
||||
= Installing MicroShift from an RPM package
|
||||
= Installing {product-title} from an RPM package
|
||||
include::_attributes/attributes-microshift.adoc[]
|
||||
:context: microshift-install-rpm
|
||||
toc::[]
|
||||
|
||||
You can install {product-title} from an RPM package on a machine with {op-system-first} {op-system-version}.
|
||||
You can install {product-title} from an RPM package on a machine with {op-system-first} {op-system-version}.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Red Hat will not provide or support an update or upgrade path from Developer Preview and Technology Preview versions to later versions of {product-title}. A new installation will be necessary.
|
||||
====
|
||||
|
||||
include::modules/system-requirements-installing-microshift.adoc[leveloffset=+1]
|
||||
include::modules/microshift-install-system-requirements.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/preparing-for-installing-microshift-rpm.adoc[leveloffset=+1]
|
||||
include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installing-microshift-rpm.adoc[leveloffset=+1]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
include::modules/starting-microshift-service.adoc[leveloffset=+1]
|
||||
* xref:../microshift_install/microshift-install-rpm.adoc#system-requirements-installing-microshift[System Requirements for Installing MicroShift] have been met.
|
||||
|
||||
include::modules/stopping-microshift-service.adoc[leveloffset=+1]
|
||||
* Download the link:https://console.redhat.com/openshift/install/pull-secret[pull secret] from the Red Hat Hybrid Cloud Console.
|
||||
|
||||
include::modules/accessing-microshift.adoc[leveloffset=+1]
|
||||
* xref:../microshift_configuring/microshift-using-config-tools.adoc#microshift-using-config-tools[Configuring MicroShift].
|
||||
|
||||
include::modules/accessing-microshift-cluster-locally.adoc[leveloffset=+2]
|
||||
* For more options on partition configuration, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/performing_a_standard_rhel_8_installation/index#manual-partitioning_graphical-installation[Configuring Manual Partitioning].
|
||||
|
||||
include::modules/accessing-microshift-cluster-remotely.adoc[leveloffset=+2]
|
||||
* For more information about resizing your existing LVs to free up capacity in your VGs, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_and_managing_logical_volumes/index#managing-lvm-volume-groups_configuring-and-managing-logical-volumes[Managing LVM Volume Groups]
|
||||
|
||||
include::modules/microshift-installing-from-rpm.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../microshift_install/microshift-install-rpm.adoc#system-requirements-installing-microshift[system requirements for installing MicroShift] have been met.
|
||||
|
||||
* xref:../microshift_install/microshift-install-rpm.adoc#preparing-install-microshift-from-rpm-package_microshift-install-rpm[Preparing to install MicroShift from an RPM package].
|
||||
|
||||
include::modules/microshift-service-starting.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/microshift-service-stopping.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/microshift-accessing.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/microshift-accessing-cluster-locally.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/microshift-accessing-cluster-remotely.adoc[leveloffset=+2]
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[id="con-about-microshift_{context}"]
|
||||
= About {product-title}
|
||||
|
||||
Working with low-resource field environments and hardware presents many challenges not experienced with cloud computing. {product-title} enables you to solve problems for edge devices by:
|
||||
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:
|
||||
|
||||
* Overcoming the operational challenge of minimal system resources, for example, a {op-system-chip}.
|
||||
* Addressing the environmental challenges of severe networking constraints such as low or no connectivity.
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="accssing-microshift-cluster-locally_{context}"]
|
||||
= Accessing the MicroShift cluster locally
|
||||
|
||||
Use the following procedure to access the MicroShift cluster locally.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have installed the `oc` CLI.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Optional: Enter the following command to create a `~/.kube/` folder if your {op-system} machine does not have one:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ mkdir -p ~/.kube/
|
||||
----
|
||||
|
||||
. Copy the generated `kubeconfig` file to the `~/.kube/config` folder:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo cat /var/lib/microshift/resources/kubeadmin/kubeconfig > ~/.kube/config
|
||||
----
|
||||
|
||||
. Verify that MicroShift is running by entering the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get all -A
|
||||
----
|
||||
@@ -1,69 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
:_content-type: CONCEPT
|
||||
[id="accessing-microshift-cluster-remotely_{context}"]
|
||||
= Accessing the MicroShift cluster remotely
|
||||
|
||||
Use the following procedure to access the MicroShift cluster from a remote workstation.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have installed the `oc` CLI.
|
||||
|
||||
.Procedure
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The following procedure assumes that there are two users. The first user, `user@microshift`, is the user on the {product-title} host machine. `user@microshift` is responsible for setting up the `op-system` machine so that it can be accessed by a remote user on a separate workstation.
|
||||
|
||||
The second user, `user@workstation`, accesses the {op-system} machine remotely from their workstation.
|
||||
====
|
||||
|
||||
. As `user@microshift` on the MicroShift host, open the firewall port for Kubernetes API server (`6443/tcp`) on your {op-system} machine by entering the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[user@microshift]$ sudo firewall-cmd --permanent --zone=public --add-port=6443/tcp && sudo firewall-cmd --reload
|
||||
----
|
||||
|
||||
. Optional: As `user@workstation`, enter the following command to create a `~/.kube/` folder if your {op-system} machine does not have one:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[user@workstation]$ mkdir -p ~/.kube/
|
||||
----
|
||||
|
||||
. As `user@workstation`, set a variable for the hostname of your MicroShift host by entering the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[user@microshift]$ MICROSHIFT_MACHINE=<name or IP address of MicroShift machine>
|
||||
----
|
||||
|
||||
. As `user@workstation`, copy the generated `kubeconfig` file from the {op-system} machine running MicroShift to your local machine by entering the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[user@workstation]$ ssh <user>@$MICROSHIFT_MACHINE "sudo cat /var/lib/microshift/resources/kubeadmin/kubeconfig" > ~/.kube/config
|
||||
----
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
The `<user>` value is the name of the user that `user@workstation` uses to log in to the MicroShift host.
|
||||
====
|
||||
|
||||
. As `user@workstation`, replace the `server` field in your `kubeconfig` file with the name or IP address of your {op-system} machine running MicroShift by entering the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[user@workstation]$ sed -i "s|server: https://127.0.0.1:6443|server: https://$MICROSHIFT_MACHINE:6443|" ~/.kube/config
|
||||
----
|
||||
|
||||
. As `user@workstation`, verify that MicroShift is running by entering the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[user@workstation]$ oc get all -A
|
||||
----
|
||||
@@ -1,9 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
:_content-type: CONCEPT
|
||||
[id="accssing-microshift-cluster_{context}"]
|
||||
= Accessing the MicroShift Cluster
|
||||
|
||||
Use the procedures in this section to access the MicroShift cluster locally (from the same machine running the MicroShift service) or remotely (from a different machine running the MicroShift service).
|
||||
@@ -1,74 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="installing-microshift-from-rpm-package_{context}"]
|
||||
= Installing MicroShift from an RPM package
|
||||
|
||||
Use the following procedure to install MicroShift from an RPM package.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* The xref:../microshift_install/microshift-install-rpm.adoc#system-requirements-installing-microshift[system requirements for installing MicroShift] have been met.
|
||||
* You have completed the steps at xref:../microshift_install/microshift-install-rpm.adoc#preparing-install-microshift-from-rpm-package_microshift-install-rpm[Preparing to install MicroShift from an RPM package].
|
||||
|
||||
.Procedure
|
||||
|
||||
. As a root user, enable the MicroShift repositories by entering the following command:
|
||||
+
|
||||
[source,terminal,subs="attributes+"]
|
||||
----
|
||||
$ sudo subscription-manager repos \
|
||||
--enable rhocp-{ocp-version}-for-rhel-8-$(uname -i)-rpms \
|
||||
--enable fast-datapath-for-{rhel-major}-$(uname -i)-rpms
|
||||
----
|
||||
|
||||
. Install MicroShift by entering the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo dnf install -y microshift
|
||||
----
|
||||
|
||||
. Download your installation link:https://console.redhat.com/openshift/install/pull-secret[pull secret] from the Red Hat Hybrid Cloud Console to a temporary folder, for example, `$HOME/openshift-pull-secret`. This pull secret allows you to authenticate with the container registries that serve the container images used by MicroShift.
|
||||
|
||||
. Enter the following command to copy the pull secret to the `/etc/crio` folder of your {op-system} machine:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo cp $HOME/openshift-pull-secret /etc/crio/openshift-pull-secret
|
||||
----
|
||||
|
||||
. Make the root user the owner of the `/etc/crio/openshift-pull-secret` file by entering the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo chown root:root /etc/crio/openshift-pull-secret
|
||||
----
|
||||
|
||||
. Make the `/etc/crio/openshift-pull-secret` file readable and writeable by the root user only by entering the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo chmod 600 /etc/crio/openshift-pull-secret
|
||||
----
|
||||
|
||||
. If your {op-system} machine has a firewall enabled, you must configure a few mandatory firewall rules. For `firewalld`, enter the following commands:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo firewall-cmd --permanent --zone=trusted --add-source=10.42.0.0/16
|
||||
----
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo firewall-cmd --permanent --zone=trusted --add-source=169.254.169.1
|
||||
----
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo firewall-cmd --reload
|
||||
----
|
||||
|
||||
If the Volume Group (VG) that you have prepared for MicroShift used the default name `rhel`, no further configuration is necessary. If you have used a different name, or if you want to change more configuration settings, see xref:../microshift_configuring/microshift-using-config-tools.adoc#microshift-using-config-tools[Configuring MicroShift].
|
||||
37
modules/microshift-accessing-cluster-locally.adoc
Normal file
37
modules/microshift-accessing-cluster-locally.adoc
Normal file
@@ -0,0 +1,37 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="accessing-microshift-cluster-locally_{context}"]
|
||||
= Accessing the {product-title} cluster locally
|
||||
|
||||
Use the following procedure to access the {product-title} cluster locally.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have installed the `oc` binary.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Optional: to create a `~/.kube/` folder if your {op-system} machine does not have one, run the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ mkdir -p ~/.kube/
|
||||
----
|
||||
|
||||
. Copy the generated `kubeconfig` file to the `~/.kube/` folder:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo cat /var/lib/microshift/resources/kubeadmin/kubeconfig > ~/.kube/config
|
||||
----
|
||||
|
||||
. Verify that {product-title} is running by entering the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get all -A
|
||||
----
|
||||
//Q: when and where was the kubeconfig file generated?
|
||||
63
modules/microshift-accessing-cluster-remotely.adoc
Normal file
63
modules/microshift-accessing-cluster-remotely.adoc
Normal file
@@ -0,0 +1,63 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
:_content-type: CONCEPT
|
||||
[id="accessing-microshift-cluster-remotely_{context}"]
|
||||
= Accessing the {product-title} cluster remotely
|
||||
|
||||
Use the following procedure to access the {product-title} cluster from a remote workstation. The procedure assumes that there are two users:
|
||||
|
||||
* The first user, `user@microshift`, is the user on the {product-title} host machine and is responsible for setting up the `op-system` machine so that it can be accessed by a remote user on a separate workstation.
|
||||
|
||||
* The second user, `user@workstation`, accesses the {op-system} machine remotely from their workstation. The `<user>` value in the procedure is the name of the user that `user@workstation` uses to log in to the {product-title} host.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have installed the the `oc` binary.
|
||||
|
||||
.Procedure
|
||||
|
||||
. As `user@microshift` on the {product-title} host, open the firewall port for the Kubernetes API server (`6443/tcp`) by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[user@microshift]$ sudo firewall-cmd --permanent --zone=public --add-port=6443/tcp && sudo firewall-cmd --reload
|
||||
----
|
||||
|
||||
. Optional: As `user@workstation`, to create a `~/.kube/` folder if your {op-system} machine does not have one, run the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[user@workstation]$ mkdir -p ~/.kube/
|
||||
----
|
||||
|
||||
. As `user@workstation`, set a variable for the hostname of your {product-title} host by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[user@microshift]$ MICROSHIFT_MACHINE=<name or IP address of {product-title} machine>
|
||||
----
|
||||
|
||||
. As `user@workstation`, copy the generated `kubeconfig` file from the {op-system} machine running {product-title} to your local machine by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[user@workstation]$ ssh <user>@$MICROSHIFT_MACHINE "sudo cat /var/lib/microshift/resources/kubeadmin/kubeconfig" > ~/.kube/config
|
||||
----
|
||||
|
||||
. As `user@workstation`, replace the `server` field in your `kubeconfig` file with the name or IP address of your {op-system} machine running {product-title} by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[user@workstation]$ sed -i "s|server: https://127.0.0.1:6443|server: https://$MICROSHIFT_MACHINE:6443|" ~/.kube/config
|
||||
----
|
||||
|
||||
.Verify {product-title} is running
|
||||
|
||||
. As `user@workstation`, verify that {product-title} is running by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[user@workstation]$ oc get all -A
|
||||
----
|
||||
9
modules/microshift-accessing.adoc
Normal file
9
modules/microshift-accessing.adoc
Normal file
@@ -0,0 +1,9 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
:_content-type: CONCEPT
|
||||
[id="accssing-microshift-cluster_{context}"]
|
||||
= Accessing the {product-title} cluster
|
||||
|
||||
Use the procedures in this section to access the {product-title} cluster locally, either from the same machine running the {product-title} service or remotely from a different machine running the {product-title} service.
|
||||
@@ -15,7 +15,7 @@ OVN-Kubernetes provides an overlay-based networking implementation. This overlay
|
||||
OVS runs as a systemd service on the {product-title} node. The OVS RPM package is installed as a dependency to the `microshift-networking` RPM package. OVS is started immediately when the `microshift-networking` RPM is installed.
|
||||
|
||||
=== IP forward
|
||||
The host network `sysctl net.ipv4.ip_forward` is automatically enabled by the `ovnkube-master` container when started. This is required to forward incoming traffic to the CNI. For example, accessing the NodePort service from outside of a cluster fails if `ip_forward` is disabled.
|
||||
The host network `sysctl net.ipv4.ip_forward` kernel parameter is automatically enabled by the `ovnkube-master` container when started. This is required to forward incoming traffic to the CNI. For example, accessing the NodePort service from outside of a cluster fails if `ip_forward` is disabled.
|
||||
|
||||
[id="microshift-network-performance_{context}"]
|
||||
== Network performance optimizations
|
||||
|
||||
47
modules/microshift-install-rpm-preparing.adoc
Normal file
47
modules/microshift-install-rpm-preparing.adoc
Normal file
@@ -0,0 +1,47 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
[id="preparing-install-microshift-from-rpm-package_{context}"]
|
||||
= Preparing to install {product-title} from an RPM package
|
||||
|
||||
Before installing {product-title} from an RPM package, you must configure your {op-system} machine to have a logical volume manager (LVM) volume group (VG) with sufficient capacity for the persistent volumes (PVs) of your workload.
|
||||
|
||||
{product-title} uses the logical volume manager storage (LVMS) Container Storage Interface (CSI) provider for storing PVs. LVMS relies on Linux's LVM to dynamically manage the backing storage for PVs. For this reason, your machine must have an LVM VG with unused space in which LVMS can create the LVM logical volumes (LVs) for your workload's PVs.
|
||||
|
||||
To configure a volume group (VG) that allows LVMS to create the LVs for your workload's PVs, adjust your root volume's size during the installation of {op-system}. Adjusting your root volume's size provides free space for additional LVs created by LVMS at runtime.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* The system requirements for installing {product-title} have been met.
|
||||
* You have root user access to your machine.
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the graphical installer under *Storage Configuration*, select *Custom* -> *Done* to open the dialog for configuring partitions and volumes.
|
||||
|
||||
. Under *New Red Hat Enterprise Linux 8.x Installation*, select *Click here to create them automatically*.
|
||||
|
||||
. Select the root partition, */*, reduce *Desired Capacity* so that the VG has sufficient capacity for your PVs, and then click *Update Settings*.
|
||||
|
||||
. Complete your installation.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
For more options on partition configuration, see the guide linked in the Additional information section for Configuring Manual Partitioning.
|
||||
====
|
||||
|
||||
. As a root user, verify the VG capacity available on your system by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo vgs
|
||||
----
|
||||
+
|
||||
Example output:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
VG #PV #LV #SN Attr VSize VFree
|
||||
rhel 1 2 0 wz--n- <127.00g 54.94g
|
||||
----
|
||||
@@ -1,18 +1,18 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
[id="system-requirements-installing-microshift"]
|
||||
= System requirements for installing {product-title}
|
||||
= System requirements for installing {product-title}
|
||||
|
||||
The following conditions must be met prior to installing {product-title}:
|
||||
The following conditions must be met prior to installing {product-title}:
|
||||
|
||||
* {op-system-first} {op-system-version}
|
||||
* 2 CPU cores
|
||||
* 2 GB of RAM
|
||||
* 10 GB of storage
|
||||
* 2 CPU cores
|
||||
* 2 GB of RAM
|
||||
* 10 GB of storage
|
||||
* You have an active {product-title} subscription on your Red Hat account. If you do not have a subscription, contact your sales representative for more information.
|
||||
* You have a subscription that includes {product-title} RPMs.
|
||||
* You have a subscription that includes {product-title} RPMs.
|
||||
* You have a Logical Volume Manager (LVM) Volume Group (VG) with sufficient capacity for the Persistent Volumes (PVs) of your workload.
|
||||
|
||||
.{product-title} supported architectures
|
||||
@@ -25,13 +25,9 @@ The following conditions must be met prior to installing {product-title}:
|
||||
|
||||
|Intel
|
||||
|`x86_64`
|
||||
|
||||
|ARM64
|
||||
|`aarch64`
|
||||
|===
|
||||
|
||||
|
||||
.{product-title} supported operating systems
|
||||
.{product-title} supported operating systems
|
||||
[options="header"]
|
||||
|===
|
||||
|Operating system |String
|
||||
74
modules/microshift-installing-from-rpm.adoc
Normal file
74
modules/microshift-installing-from-rpm.adoc
Normal file
@@ -0,0 +1,74 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="installing-microshift-from-rpm-package_{context}"]
|
||||
= Installing {product-title} from an RPM package
|
||||
|
||||
Use the following procedure to install {product-title} from an RPM package.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* The system requirements for installing {product-title} have been met.
|
||||
* You have completed the steps of preparing to install {product-title}from an RPM package.
|
||||
|
||||
.Procedure
|
||||
|
||||
. As a root user, enable the {product-title} repositories by running the following command:
|
||||
+
|
||||
[source,terminal,subs="attributes+"]
|
||||
----
|
||||
$ sudo subscription-manager repos \
|
||||
--enable rhocp-{ocp-version}-for-rhel-8-$(uname -i)-rpms \
|
||||
--enable fast-datapath-for-{rhel-major}-$(uname -i)-rpms
|
||||
----
|
||||
|
||||
. Install {product-title} by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo dnf install -y microshift
|
||||
----
|
||||
|
||||
. Download your installation pull secret from the Red Hat Hybrid Cloud Console to a temporary folder, for example, `$HOME/openshift-pull-secret`. This pull secret allows you to authenticate with the container registries that serve the container images used by {product-title}.
|
||||
|
||||
. To copy the pull secret to the `/etc/crio` folder of your {op-system} machine, run the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo cp $HOME/openshift-pull-secret /etc/crio/openshift-pull-secret
|
||||
----
|
||||
|
||||
. Make the root user the owner of the `/etc/crio/openshift-pull-secret` file by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo chown root:root /etc/crio/openshift-pull-secret
|
||||
----
|
||||
|
||||
. Make the `/etc/crio/openshift-pull-secret` file readable and writeable by the root user only by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo chmod 600 /etc/crio/openshift-pull-secret
|
||||
----
|
||||
|
||||
. If your {op-system} machine has a firewall enabled, you must configure a few mandatory firewall rules. For `firewalld`, run the following commands:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo firewall-cmd --permanent --zone=trusted --add-source=10.42.0.0/16
|
||||
----
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo firewall-cmd --permanent --zone=trusted --add-source=169.254.169.1
|
||||
----
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo firewall-cmd --reload
|
||||
----
|
||||
|
||||
If the Volume Group (VG) that you have prepared for {product-title} used the default name `rhel`, no further configuration is necessary. If you have used a different name, or if you want to change more configuration settings, see the Configuring {product-title} section.
|
||||
@@ -1,20 +1,20 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="starting-microshift_service_{context}"]
|
||||
= Starting the {product-title} service
|
||||
|
||||
Use the following procedure to start the {product-title} service.
|
||||
Use the following procedure to start the {product-title} service.
|
||||
|
||||
.Prerequisites
|
||||
.Prerequisites
|
||||
|
||||
* You have installed {product-title} from an RPM package.
|
||||
* You have installed {product-title} from an RPM package.
|
||||
|
||||
.Procedure
|
||||
.Procedure
|
||||
|
||||
. As a root user, start the {product-title} service by entering the following command:
|
||||
. As a root user, start the {product-title} service by entering the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
@@ -37,6 +37,6 @@ $ sudo systemctl disable microshift
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
The first time that the {product-title} service starts, it downloads and initializes {product-title}'s container images. As a result, it can take several minutes for {product-title} to start the first time that the service is deployed.
|
||||
Boot time is reduced for subsequent starts of the {product-title} service.
|
||||
The first time that the {product-title} service starts, it downloads and initializes {product-title}'s container images. As a result, it can take several minutes for {product-title} to start the first time that the service is deployed.
|
||||
Boot time is reduced for subsequent starts of the {product-title} service.
|
||||
====
|
||||
@@ -1,34 +1,34 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="stopping-microshift-service_{context}"]
|
||||
= Stopping the {product-title} service
|
||||
|
||||
Use the following procedure to stop the {product-title} service.
|
||||
Use the following procedure to stop the {product-title} service.
|
||||
|
||||
.Prerequisites
|
||||
.Prerequisites
|
||||
|
||||
* The {product-title} service is running.
|
||||
* The {product-title} service is running.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Enter the following command to stop the {product-title} service:
|
||||
. Enter the following command to stop the {product-title} service:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo systemctl stop microshift
|
||||
----
|
||||
|
||||
. Workloads deployed on {product-title} will continue running even after the {product-title} service has been stopped. Enter the following command to display running workloads:
|
||||
. Workloads deployed on {product-title} will continue running even after the {product-title} service has been stopped. Enter the following command to display running workloads:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo crictl ps -a
|
||||
----
|
||||
|
||||
. Enter the following commands to stop the deployed workloads:
|
||||
. Enter the following commands to stop the deployed workloads:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
@@ -18,6 +18,6 @@ $ microshift version
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
MicroShift Version: 4.10.0-0.microshift-e6980e25
|
||||
Base OCP Version: 4.10.18
|
||||
MicroShift Version: 4.12.0-0.microshift-e6980e25
|
||||
Base OCP Version: 4.12.0
|
||||
----
|
||||
|
||||
@@ -1,53 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// microshift/microshift-install-rpm.adoc
|
||||
|
||||
[id="preparing-install-microshift-from-rpm-package_{context}"]
|
||||
= Preparing to install {product-title} from an RPM package
|
||||
|
||||
Before installing {product-title} from an RPM package, you must configure your {op-system} machine to have a logical volume manager (LVM) volume group (VG) with sufficient capacity for the persistent volumes (PVs) of your workload.
|
||||
|
||||
{product-title} uses the logical volume manager storage (LVMS) Container Storage Interface (CSI) provider for storing PVs. LVMS relies on Linux's LVM to dynamically manage the backing storage for PVs. For this reason, your machine must have an LVM VG in which LVMS can create the LVM logical volumes (LVs) for your workload's PVs.
|
||||
|
||||
To configure an LVM VG that allows LVMS to create the LVM LVs for your workload's PVs, adjust your root volume's size during the installation of {op-system}. Adjusting your root volume's size provides free space for additional LVs created by LVMS at runtime.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* The xref:../microshift_install/microshift-install-rpm.adoc#system-requirements-installing-microshift[system requirements for installing MicroShift] have been met.
|
||||
* You have root user access to your machine.
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the graphical installer under *Storage Configuration*, select *Custom* -> *Done* to open the dialog for configuring partitions and volumes.
|
||||
|
||||
. Under *New Red Hat Enterprise Linux 8.x Installation*, select *Click here to create them automatically*.
|
||||
|
||||
. Select the root partition, */*, reduce *Desired Capacity* so that the VG has sufficient capacity for your PVs, and then click *Update Settings*.
|
||||
|
||||
. Complete your installation.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
For more options on partition configuration, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/performing_a_standard_rhel_8_installation/index#manual-partitioning_graphical-installation[Configuring Manual Partitioning].
|
||||
====
|
||||
|
||||
. As a root user, verify the VG capacity available on your system by entering the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo vgs
|
||||
----
|
||||
+
|
||||
Example output:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
VG #PV #LV #SN Attr VSize VFree
|
||||
rhel 1 2 0 wz--n- <127.00g 54.94g
|
||||
----
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
For more information about resizing your existing LVs to free up capacity in your VGs, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_and_managing_logical_volumes/index#managing-lvm-volume-groups_configuring-and-managing-logical-volumes[Managing LVM Volume Groups]
|
||||
====
|
||||
|
||||
Reference in New Issue
Block a user