Clear Linux* Project Docs
Clear Linux
v: latest
Language Versions
English
简体中文 (Simplified Chinese)
Document Versions
latest
future versions
clearlinux.org links
Project Home
GitHub
Get started
Pre-install
Check Processor Compatibility
Option 1: Use the
clear-linux-check-config.sh
script on an existing Linux system
Create a bootable USB drive using Etcher*
Prerequisites
Install
Install Clear Linux* OS from the live desktop
System requirements
Preliminary steps
Install from live image
Minimum installation requirements
Clear Linux OS Desktop Installer
Navigation
Required options
Advanced options
Finish installation
Troubleshooting
Related topics
Install Clear Linux* OS from the live server
System requirements
Preliminary steps
Install Clear Linux OS on your target system
Launch the Clear Linux OS Installer
Minimum installation requirements
Main Menu
Navigation
Required options
Recommended options
Advanced options
Finish installation
Troubleshooting
Related topics
Install using clr-installer and a configuration file
Prerequisites
Download and make bootable USB of the live server image
Example 1: Fresh installation onto bare metal
Example 2: Replicate a previous installation
References
Install Clear Linux OS Over the Network with iPXE
Prerequisites
Install Clear Linux OS on server
Setup nginx web server to host iPXE
Configure iPXE
Add clr-installer YAML configuration files
Configure network
Setup NAT
Setup dnsmaq for DHCP, DNS, and TFTP functionalities
Verify setup
Deploy
Install in a virtual machine
Clear Linux* OS on Microsoft Hyper-V*
Overview
Prerequisites
Download the Clear Linux OS disk image for Hyper-V
Create and configure new VM
Start the VM
Related topics
Clear Linux* OS on KVM
Install QEMU-KVM
Download and launch the virtual machine image
Optional: Enable SSH access
Optional: Install a graphical user interface (GUI)
Clear Linux* OS on Parallels* Desktop for Mac*
Prerequisites
Download ISO image
Initialize new VM
Install Clear Linux OS on VM
Clear Linux* OS on Proxmox* Virtual Environment
Prerequisites
Download the Latest Clear Linux OS Live Server Image
Upload Clear Linux OS Live Server Image to Promox Server
Create VM on Proxmox
Start VM and Install Clear Linux OS on Promox
Clear Linux* OS using virt-manager
Prerequisites
Download the Clear Linux OS installer ISO
Launch and set up virt-manager
Create a new virt-manager virtual machine
Install Clear Linux OS in the virt-manager VM
Clear Linux* OS on VirtualBox*
Prerequisites
Download and extract the Clear Linux OS installer ISO
Create a new VirtualBox virtual machine
Install Clear Linux OS on the VirtualBox VM
Troubleshooting
Clear Linux* OS on VMware* Workstation Player
Overview
Install the VMware Workstation Player hypervisor
Create a blank VM
Enable UEFI boot support
Instantiate Clear Linux OS
Related topics
Clear Linux* OS on VMware* ESXi
Overview
Download the latest Clear Linux OS installer ISO
Upload the Clear Linux OS installer ISO to the VMware server
Create and configure a new VM
Install Clear Linux OS into the new VM
Reconfigure the VM’s settings to boot the newly-installed Clear Linux OS
Power on the VM and boot Clear Linux OS
Increase Virtual Disk Size of an Image
Determine disk size and list of partitions
Increase virtual disk size
Deploy to the cloud
Clear Linux* OS on Amazon Web Services*
Prerequisites
Locate, select, and launch the Clear Linux OS Basic AMI
Connect to your Clear Linux OS basic instance
Update the Clear Linux OS instance
Stop the Clear Linux OS instance
Related topics
Clear Linux* OS on Microsoft* Azure*
Description
Prerequisites
Install MS Azure CLI 2.0 on Clear Linux OS
Log into your Microsoft Azure account
Create a MS Azure resource group
Create and log into the Clear Linux OS virtual machine
Stop and deallocate the Clear Linux OS VM and resources
Next steps
Related topics
Clear Linux* OS on DigitalOcean*
Prerequisites
Add Clear Linux OS Image to DigitalOcean
Create and Deploy a Clear Linux OS Instance
Connect to Your Clear Linux OS Instance
Related topics
Clear Linux* OS on Google Cloud Platform*
Prerequisites
Setup Clear Linux OS VM on GCP
Related topics
Import Clear Linux Image and Launch Instance on AWS
Prerequisites
Download or create a Clear Linux OS image for AWS
Create an S3 bucket
Upload the Clear Linux OS image into the bucket
Add a user to IAM with AWS_CLI privilege
Install and configure the AWS CLI tool on your system
Import a snapshot of the Clear Linux OS image
Create an AMI from the snapshot
Launch an instance
Connect to your Clear Linux OS instance
Related topics
Clear Linux* OS on QingCloud*
Prerequisites
Select and start Clear Linux OS virtual host with QingCloud console
Apply for a public IP and add it to the virtual host
Connect to Clear Linux OS virtual host
Remove Clear Linux OS virtual host
Delete the applied public IP
Containers
Clear Linux* OS container images
Container image types
About
What is Clear Linux OS?
What Clear Linux OS isn’t?
Is Clear Linux OS completely Open Source?
Who is the target audience?
How does Clear Linux OS address security?
What’s the thinking around Server vs. Desktop?
What makes Clear Linux OS different?
Release Cadence
Updates
Ease of Use
Custom Derivatives
Create
Deploy
Administrate
Why create new components rather than modifying existing projects?
Which Components are used in Clear Linux?
Guides
Clear Linux
Autoproxy
Description
How it works
Troubleshooting
autospec
Description
How it works
Examples
Test packaged software
References
Related topics
Bundles
Related topics
Kernels
Bare metal only
Also compatible with VMs
VM only
Debug system
Background
Usage
Implementation
Kubernetes* migration
Background
Prerequisites
Upgrade 1.17.x —> 1.18.15
Upgrade 1.18.15 —> 1.19.x
Related topics
mixer
Description
How it works
Examples
References
Related topics
Performance
Overview
Software build toolchain
Kernel
Operating system
Related topics
OS Security
Security in updates
Security in software
Security in system design
Stateless
File-level separation
Software configuration
System reset
Additional information
swupd
Description
How it works
Examples
Quick reference
Related topics
swupd 3rd-party
Prerequisite
Create directory to hold 3rd-party app
Create bundle of 3rd-party app with mixer
Install and manage 3rd-party bundle on client system
Create more bundles and add to client
Some limitations of 3rd-party bundles
Related topics
Telemetrics
Overview
How to use
Examples
Reference
Maintenance
Architect the life-cycle of Clear Linux* OS
Prerequisites
Description
Content Workflow
Release Workflow
Implementation
Configure Huge Pages
Modify a Clear Linux OS-based container image
Overview
Prerequisites
Example 1: Add a bundle
Example 2: Change Clear Linux OS version (single-stage build)
Example 3: Change Clear Linux OS version (multi-stage build)
Example 4: Customize an application image at runtime
Background
Related topics
Build a new Clear Linux OS-based container image
Prerequisites
Build the base container image
Manage bundles in a container
CPU Power and Performance
Overview
CPU power saving mechanisms
Linux CPU clock frequency scaling
Thermal management
Deploy at Scale
Overview
Pick a usage and update strategy
Pick an image distribution strategy
Considerations with stateless systems
Developer Workstation
Workstation Setup
swupd search
Core Concepts
Download, verify, and decompress a Clear Linux* OS image
Linux OS steps
macOS* steps
Windows* OS steps
Image types
Enable systemd-boot Menu
Create and enable a new user space
Create a new user
Add the new user to the
wheel
group
Install and update the OS software to its current version
Add a bundle
Next steps
Fix a broken installation
Overview
Prerequisites
Boot a live desktop image to fix target system
Mount root partition, verify, and fix
Modify hostname
Overview
Set your hostname
View your hostname
Increase Virtual Disk Size of an Image
Determine disk size and list of partitions
Increase virtual disk size
Query package info from upstream repository
Overview
Prerequisites
Configure DNF
DNF command usage examples
Resource limits
System-wide limits
Per-user limits
Service limits
Restart system services after an OS update
Overview
How it works
Basic options
Monitor options
Example
Telemetry
Conclusion
Validate signatures
Overview
Image content validation
Update content validation
Network
Assign a static IP address
Identify which program is managing the interface
Using NetworkManager
Using systemd-networkd
Use DPDK to send packets between platforms
Overview
Prerequisites
Install dpdk and build l3fwd example (Platform B)
Build pktgen (Platform A)
Bind NICs to DPDK kernel drivers (Platforms A and B)
Set hugepages (Platforms A and B)
Set up the physical environment (Platforms A and B)
Run l3fwd application (Platform B)
Run pktgen application (Platform A)
Appendix A: Use pass-through for virtual machines
Firewall
Default ruleset
Firewall software
Troubleshooting
Combine multiple interfaces with network bonding
Enable and configure SSH service
Overview
Prerequisites
Change default port
Enable SFTP
Enable root login
Enable X11-forwarding
Proxy Configuration
Prerequisites
Set system time
Remote-desktop to a host using VNC
Install the VNC server and misc. components on your host
Configure a VNC-server-start method on your host
Install a VNC viewer app and an SSH client on your client system
Establish a VNC connection to your host
Terminate a VNC connection to your host
Encrypt VNC traffic through an SSH tunnel
Configure Wi-Fi
Using Network Manager
Using wpa_supplicant
Other resources
Kernel
Firmware
Overview
Included firmware
Additional firmware loading
CPU microcode loading
Troubleshooting
Capture Kernel Boot Messages in the Journal
Prerequisites
Enable journaling of kernel boot messages
Alternative
Kernel development
Overview
Request changes be included with the Clear Linux OS kernel
Set up kernel development environment
Customize the Linux kernel source
Build and install the kernel
Related topics
Add kernel modules manually
Overview
Description
Kernel module availability
Build, install, and load an out-of-tree module
Examples
Related topic
Add kernel modules with DKMS
Overview
Description
Kernel module availability
Install DKMS
Build, install, and load an out-of-tree module
Examples
Related topics
Tutorials
Apache* Hadoop*
Description
Prerequisites
Install Apache Hadoop
Configure Apache Hadoop
Configure your SSH key
Run the Hadoop daemons
Run the MapReduce wordcount example
Broadcom* Drivers
Identify your device model
Drivers
brcmfmac and brcmsmac
b43 and b43legacy
broadcom-wl
Firmware
Troubleshooting
Docker*
Prerequisites
Install the containers-basic bundle
Integration with Kata Containers* (optional)
Additional Docker configuration
Pulling and running an image from Docker Hub*
Creating a Docker swarm cluster
Related topics
Flatpak*
Description
Prerequisites
Install a Flatpak app with GNOME Software
Install a Flatpak with the command line
Function Multi-Versioning
Description
Install and configure a Clear Linux OS host on bare metal
Detect loop vectorization candidates
Generate the FMV patch
FFT project example using FFTW
HPC Cluster
Prerequisites
Set up controller node
Set up worker nodes
Set up password-less SSH access and pdsh on all nodes
Create
slurm.conf
configuration file
Copy MUNGE key and
slurm.conf
to all worker nodes
Verify controller can run jobs on all nodes
Create and run example scripts
Example 1: Return the hostname of each worker and output to
show-hostnames.out
Example 2: An MPI “Hello, World!” program
Kata Containers*
Description
Prerequisites
Install Kata Containers
Run Kata Containers
Troubleshooting
Kubernetes*
Background
Prerequisites
Set up Kubernetes automatically
Uninstalling
Set up Kubernetes manually
Configure host system
Initialize the master node
Choose a pod network add-on
Choose a container runtime
Use your cluster
Troubleshooting
Package configuration customization
Logs
Setting proxy servers for Kubernetes
DNS issues
Reference
What is Kubernetes?
What is a Container Network Interface (CNI)?
What is a Container Runtime Interface (CRI)?
What is Kata Containers*?
Related topics
Kubernetes* Best Practices
Description
Prerequisites
Update the control plane
Update worker nodes
LAMP Web Server
Install Apache
Install the httpd bundle
Change the default configuration and data directory
Install PHP
Install MariaDB
Security hardening
Install phpMyAdmin
Use phpMyAdmin to manage a database
Next steps
Mirror Upstream Clear Linux OS Update Server
Prerequisites
Install up Clear Linux OS server to host updates
Clone the Clear Linux OS update content
Setup a web server to host the mirrored content
Test your mirror
Keep your mirror in sync with upstream
NVIDIA* Drivers
Prerequisites
Known issues
Installation
Configure workarounds
Install DKMS
Download the NVIDIA drivers
Disable the nouveau driver
Configure alternative software paths
Install the NVIDIA drivers
Updating
Uninstallation
Troubleshooting
No display or blank screen
“Oh no! Something has gone wrong” GNOME* crash
Slow boot times
Brightness control
Additional resources
NVIDIA* CUDA Toolkit
Prerequisites
Compatibility
Check compatibility of NVIDIA components
Check GCC compatibility
Downloading and Installation
Download the NVIDIA CUDA Toolkit
Install the NVIDIA CUDA Toolkit
Using the NVIDIA CUDA Toolkit
Uninstalling
Debugging
Additional resources
OpenFaaS*
Background
Prerequisites
Deploy OpenFaaS
OpenFaaS templates
Example: Develop a function
PHP and PHP-FPM
Description
Background
Prerequisites
Configure PHP
Install PHP extensions
Enable PHP extensions
Configure PHP-FPM
Redis*
Description
Install the Redis bundle
Start the Redis-server
Example 1: Use the redis-cli and commands
Example 2: Run the Clear Linux OS Redis Docker* image
Next Steps
Samba* as a client
Prerequisites
Connect to Windows shared location with Nautilus
Samba Server
Prerequisites
Set up file sharing
Access the shared drive
TensorFlow* machine learning
Prerequisites
Set up a Jupyter Notebook
Run the Jupyter machine learning example code
Related topics
VMware* Workstation Pro
Prerequisites
Install VMware Workstation Pro
Install VMware kernel modules
Install DKMS
Install kernel modules
Troubleshooting
WordPress* Server
Before you begin
Create a WordPress server
Download WordPress and manage directories
Set up WordPress with web-based GUI
Complete successful login
YubiKey* Support
Description
Prerequisites
Enable Linux udev rules for YubiKey
Enable U2F in Mozilla Firefox
Related topics
OpenZFS*
Background
Known Issues
Prerequisites
Install the DKMS kernel
Bundles
Install
Download OpenZFS release
Compile the module
Compile userspace tools
Set up systemd
Load the kernel module at boot
Troubleshooting
Next steps
Dual-boot Clear Linux* OS with Any GRUB-based Linux* Distro
Prerequisites
Preliminary steps
Install Clear Linux OS with Advanced Installation
Boot Clear Linux OS Using One of Three Methods
Method 1: Use systemd-boot to Boot Clear Linux OS and also Chain-boot GRUB
Method 2: Use GRUB to Boot Clear Linux OS
Dual-boot Clear Linux* OS and Windows* 10 OS
Method 1: Shrink Windows partition and install Clear Linux OS
Method 2: Add another hard disk to your system where you installed Windows
Advanced: Use systemd-boot to boot Windows 10 OS and Clear Linux OS
Alternative: Install Windows 10 OS After Clear Linux OS
Prerequisites
Install Windows 10 OS
Multi-boot Clear Linux* OS with other operating systems
Detailed procedures
Dual-boot Clear Linux* OS and Windows* 10 OS
Dual-boot Clear Linux* OS with Any GRUB-based Linux* Distro
Archive
Migrate Clear Containers to Kata Containers*
Description
Prerequisites
Stop Clear Containers instances
Manually migrate customized configuration files
Enable Kata Containers as default
Run Kata Containers
Reference
Compatible Hardware
Available bundles
Bundle list
Recommended minimum system requirements
Installer requirements
System requirements
Recommended configurations
Clear Linux* OS image types
Man pages
clr-man-pages
OS Format
os-core
stateless
clr-power-tweaks
clr_power
clr-power-tweaks.conf
clrtrust
clrtrust
micro-config-drive
ucd-data-fetch
ucd
cloud-config
mixer-tools
mixer
mixer.repo
mixer.add-rpms
mixer.versions
mixer.build
mixer.bundle
mixer.init
mixer.config
swupd-client
swupd-update.timer
swupd
update-triggers.target
swupd-update.service
tallow
tallow
tallow.patterns
tallow.conf
telemetrics-client
telemctl
telem-record-gen
telempostd
telemprobd
telemetry
telemetrics.conf
Tutorial difficulty ratings
Time and complexity
User experience level
Impact of failure
FAQ
General
What is Clear Linux OS?
Why another Linux distribution?
Is it a derivative of another Linux distribution?
Can others copy improvements from Clear Linux OS?
How often does it update?
Is telemetry required?
What is the default firewall?
Where are the files that I usually see under /etc like fstab?
Does it use the Intel Compiler (icc)?
Software
How is software installed and updated?
Does it use RPMs or DEBs packages like other distros?
Why does it have a different approach to software management?
Can I install a software package from another OS on Clear Linux OS?
Software availability
What software is available on Clear Linux OS?
Is Google* Chrome* available?
Is Microsoft* Visual Studio Code* available?
Is FFmpeg available?
Is ZFS* available?
Can you add a driver that I need?
Contribute
Contribute via GitHub
Contribution guidelines
Writing guide
Use simple English
Make content scannable
Use strong verbs
Avoid long noun phrases
Parallelism
Grammar and punctuation
Structure and formatting guide
Markup
Documentation organization
Inline text formatting
Code blocks and examples
Lists and instructions
Notices
Links
Images
References
Clear Linux* Project Docs
Home
About
Developer
Software
Index
Index – E
environment variable
[SharedDrive]
https_proxy
RTE_SDK
,
[1]
RTE_TARGET
,
[1]
valid users
*Other names and brands may be claimed as the property of others.
*Trademarks
Cookies
Privacy Terms