Plan
Verify your environment meets MicroShift requirements
Confirm that your hardware or hypervisor meets the minimum resource requirements and that your Red Hat Enterprise Linux (RHEL) version is compatible with your target MicroShift version before beginning installation.
System requirements for installing MicroShift
You must add the resource requirements of your specific workloads to the baseline minimums for MicroShift and Red Hat Enterprise Linux (RHEL).
For example, if an IoT gateway solution requires 4 GB of RAM, your system needs to have at least 2 GB for RHEL and MicroShift, plus 4 GB for the workloads. Thus, this example deployment requires 6 GB of RAM in total.
Allow for extra capacity for future needs if you are deploying physical devices in remote locations. If you are uncertain of the RAM required, use the maximum RAM capacity that the device can support.
The following conditions must be met before installing MicroShift:
-
A compatible version of RHEL. For more information, see "Version compatibility".
-
Hardware or hypervisors that are certified for your RHEL version are strongly recommended. For more information, see the following links:
-
For information about the support policy for non-certified hardware or hypervisors, see the following link:
-
AArch64 or x86_64 system architecture.
-
2 CPU cores.
-
2 GB RAM. Installing from the network (UEFI HTTPs or PXE boot) requires 3 GB RAM for RHEL.
-
10 GB of storage.
-
You have an active MicroShift subscription on your Red Hat account. If you do not have a subscription, contact your sales representative for more information.
-
If your workload requires Persistent Volumes (PVs), you have a Logical Volume Manager (LVM) Volume Group (VG) with enough free capacity for the workloads.
-
You configure secure access to the system to be able to manage it. For more information, see the following link:
Version compatibility
You must pair a supported version of Red Hat Enterprise Linux (RHEL) with the MicroShift version. For more information, see the "Red Hat Device Edge release compatibility matrix".
Red Hat Device Edge release compatibility matrix
Red Hat Enterprise Linux (RHEL) and MicroShift work together as a single solution for device-edge computing. You can update each component separately, but the product versions must be compatible.
Supported configurations of Red Hat Device Edge use verified releases for each together as listed in the following table:
|
|
Be sure to check the support status of a release on the product lifecycle page. |
| RHEL Version(s) | MicroShift Version | Supported MicroShift Version → Version Updates |
|---|---|---|
10.2 |
4.22 |
4.22.0 → 4.22.z (Technology Preview) |
9.8 |
4.22 |
4.22.0 → 4.22.z, 4.22 on RHEL 9.8 → 4.22 on RHEL 10.2 (Technology Preview) |
9.6 |
4.21 |
4.21.0 → 4.21.z, 4.21 → 4.22, 4.21 → 4.22 on RHEL 9.8, 4.21 → 4.22 on RHEL 10.2 (Technology Preview) |
9.6 |
4.20 |
4.20.0 → 4.20.z, 4.20 → 4.21, 4.20 → 4.22 on RHEL 10.2 (Technology Preview) |
9.6 |
4.19 |
4.19.0 → 4.19.z, 4.19 → 4.20 |
9.4 |
4.18 |
4.18.0 → 4.18.z, 4.18 → 4.20 on RHEL 9.6 |
9.4 |
4.17 |
4.17.1 → 4.17.z, 4.17 → 4.18 |
9.4 |
4.16 |
4.16.0 → 4.16.z, 4.16 → 4.17, 4.16 → 4.18 |
RHEL installation types
MicroShift supports multiple installation methods depending on your target edge environment and workload requirements. You can deploy MicroShift by using the standard RPM packages on an existing machine or build an immutable, image-based operating system tailored for disconnected or networked edge deployments.
Choose the best Red Hat Enterprise Linux (RHEL) installation type based on where you want to run your node and what your applications need to do. For the best results, apply the following principles:
-
For every installation target, you must configure both the operating system and MicroShift.
-
Consider your application storage needs, networking for node or application access, and your authentication and security requirements.
-
Understand the differences between the RHEL installation types, including the support scope of each, and the tools used.
Using RPMs, or package-based installation
This simple installation type uses a basic command to install MicroShift on an existing RHEL machine. Basic CLI tools are required for this installation type.
RHEL image-based installations
Image-based installation types involve creating an rpm-ostree-based, immutable version of RHEL that is optimized for edge deployment.
-
RHEL for Edge can be deployed to the edge in production environments. You can use this installation type where network connections are present, restricted, or completely offline, depending on the local environment.
-
Image mode for RHEL is based on OCI container images and bootable containers. See the following link for an introduction to bootc technology:
When choosing an image-based installation, consider whether the installation target is intended to be in an offline or networked state, where you plan to build system images, and how you plan to load your Red Hat Device Edge. Use the following scenarios as general guidance:
-
If you build either a fully self-contained RHEL for Edge or an image mode for RHEL ISO outside a disconnected environment, and then install the ISO locally on your edge devices, you likely do not need an RPM repository or a mirror registry.
-
If you build an ISO outside a disconnected environment that does not include the container images, but consists of only the RPMs, you need a mirror registry inside your disconnected environment. You use your mirror registry to pull container images.
-
If you build images inside a disconnected environment, or use package-based installations, you need both a mirror registry and a local RPM mirror repository. You can use either the RHEL reposync utility or Red Hat Satellite for advanced use cases. See the following links for more information:
MicroShift installation tools
To use MicroShift, you must already have or plan to install a Red Hat Enterprise Linux (RHEL) type, such as on bare metal, or as a virtual machine (VM) that you provision. Although each use case has different details, each installation of Red Hat Device Edge uses RHEL tools and the OpenShift CLI (oc).
You can use RPMs to install MicroShift on an existing RHEL machine. You do not need other tools unless you are also installing an image-based RHEL system or VM at the same time.
RHEL installation tools and concepts
To successfully construct and deploy a custom MicroShift image, you must understand the core RHEL components involved in the deployment process.
Review the following resources to familiarize yourself with the required image building components:
-
A Kickstart file, which contains the configuration and instructions used during the installation of your specific operating system. For more information, see the following link:
-
RHEL image builder is a tool for creating deployment-ready customized system images. RHEL image builder uses a blueprint that you create to make the ISO. RHEL image builder is best installed on a RHEL VM and is built with the
composer-clitool. To set up these tools and review the workflow, see the following RHEL documentation links: -
A blueprint file directs RHEL image builder to the items to include in the ISO. An image blueprint provides a persistent definition of image customizations. You can create multiple builds from a single blueprint. You can also edit an existing blueprint to build a new ISO as requirements change. See the following link for more information:
-
An ISO, which is the bootable operating system on which MicroShift runs. See the following links for more information:
Red Hat Device Edge installation steps
Before proceeding with your specific installation method, you must prepare your environment for installation. To ensure a successful deployment, you must follow the general prerequisites such as obtaining your pull secret, planning your storage strategy, and defining your network topology, before you begin.
For most installation types, you must also take the following steps:
-
Download the pull secret from the Red Hat Hybrid Cloud Console using the following link:
-
Be ready to configure MicroShift by adding parameters and values to the MicroShift YAML configuration file. For more information, see "Customizing MicroShift by using the configuration file".
-
Decide whether you need to configure storage for the application and tasks you are using in your MicroShift node, or disable the MicroShift storage plugin completely.
-
For more information about creating volume groups and persistent volumes on RHEL, see the following link:
-
Configure networking settings according to the access needs you plan for your MicroShift node and applications. Consider whether you want to use single or dual-stack networks, configure a firewall, or configure routes.
You can use the Red Hat Enterprise Linux for Real Time (real-time kernel) where predictable latency is critical. Workload partitioning is also required for low-latency applications. For more information about low latency and the real-time kernel, see "Configuring low latency".
Encrypt etcd data
Kubernetes objects are stored in an etcd database and might contain sensitive data. The etcd data is not encrypted by default. You can encrypt the disk that contains the etcd database by using the Linux Unified Key Setup-on-disk-format (LUKS) management tool for block device encryption.