Clear Linux* Project Docs
Clear Linux
v: latest
Language Versions
English
Chinese
Document Versions
latest
L19.01
clearlinux.org links
Project Home
GitHub
Get started
Pre-install
Check processor and EFI firmware compatibility
Check compatibility
Create a bootable USB drive
Prerequisites
Create a bootable USB drive on Linux*
Create a bootable USB drive on macOS*
Create a bootable USB drive on Windows*
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
Install Clear Linux* OS on bare metal with live server
System requirements
Download the latest Clear Linux OS live server image
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
Install using clr-installer and a configuration file
Prerequisites
Process
References
Install in a virtual machine
Launch Clear Linux* OS Compute Engine on Google Cloud Platform*
Prerequisites
Setup Clear Linux OS VM on GCP
Related topics
Use Hyper-V*
Prerequisites
Enable Hyper-V
Create a virtual network
Create a virtual machine
Run Clear Linux* OS as a KVM guest OS
Install QEMU-KVM
Download and launch the virtual machine
SSH access into the virtual machine
Optional: Add the GNOME Display Manager (GDM)
Install a Clear Linux* OS VM in 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
Install Clear Linux* OS as a VMware* Workstation Player guest OS
Overview
Install the VMware Workstation Player hypervisor
Download the latest Clear Linux OS installer
Create and configure a new VM
Install Clear Linux OS into the new VM
Detach the Clear Linux OS installer ISO from the VM
Enable UEFI boot support
Related topics
Run pre-configured Clear Linux* OS image as a VMware* Workstation Player guest OS
Overview
Install the VMware Workstation Player hypervisor
Download the latest Clear Linux OS VMware image
Image types
Create and configure a new VM
Attach the pre-configured Clear Linux OS VMware image
Enable UEFI boot support
Power on the VM
Related topics
Install Clear Linux* OS as a VMware* ESXi guest OS
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
Related topics
Run preconfigured Clear Linux* OS image as a VMware* ESXi guest OS
Overview
Download the latest Clear Linux OS VMware image
Upload the Clear Linux OS image to the VMware server
Convert the Clear Linux OS image to an ESXi-supported format
Create and configure a new VM
Power on the VM and boot Clear Linux OS
Related topics
Increase virtual disk size of an image
Determine the partition order and sizes of the prebuilt image
Increase virtual disk size
About
Training
Guides
Clear Linux
Autoproxy
Description
How it works
autospec
Description
How it works
Examples
Test packaged software
References
Related topics
Kernels
Bare metal only
Also compatible with VMs
VM only
Debug system
Background
Usage
Implementation
ister.py image builder
Description
Examples
Related topics
mixer
Description
How it works
Examples
References
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
Telemetrics
Overview
How to use
Examples
Reference
Maintenance
Architect the life-cycle of Clear Linux* OS
Prerequisites
Description
Content Workflow
Release Workflow
Implementation
Assign a static IP address
Identify which program is managing the interface
Using NetworkManager
Using systemd-networkd
Bulk provision
Overview
Prerequisites
Configuration
CPU Power and Performance
Overview
CPU power saving mechanisms
Linux CPU clock frequency scaling
Thermal management
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
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
Install from live image
Mount root partition, verify, and fix
Modify hostname
Overview
Set your hostname
View your hostname
Increase virtual disk size of an image
Determine the partition order and sizes of the prebuilt image
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
Set the time
Validate signatures
Overview
Image content validation
Update content validation
Deploy at Scale
Overview
Pick a usage and update strategy
Pick an image distribution strategy
Considerations with stateless systems
Network
Build a custom Clear Linux* OS based Docker container image
Prerequisites
Build the base container image
Manage bundles in a container
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
Install over the network with iPXE
Overview
Prerequisites
Configuration
Combine multiple interfaces with network bonding
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
Kernel
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
Stacks
Data Analytics Reference Stack
The Data Analytics Reference Stack release
Using the Docker images
Building DARS images
Enable AWS Greengrass* and OpenVINO™ toolkit
Overview
Supported platforms
Install the OS on the edge device
Configure AWS Greengrass group
Create and package Lambda function
Configure Lambda function
Deploy Lambda function
References
Deep Learning Reference Stack
Overview
TensorFlow single and multi-node benchmarks
PyTorch single and multi-node benchmarks
Kubeflow multi-node benchmarks
Use Jupyter Notebook
Uninstallation
Related topics
Tutorials
WordPress* on Clear Linux* OS
Set up a LAMP web server on Clear Linux* OS
Install Apache
Change the default configuration and data directory
Install PHP
Install MariaDB
Install phpMyAdmin
Use phpMyAdmin to manage a database
Next steps
Set up WordPress* on a LAMP web server
Before you begin
Create a WordPress server
Use Flatpak* to install applications on Clear Linux* OS
Before you begin
Install Flatpak on your host system
Install and run the LibreOffice Flatpak image
Launch LibreOffice
TensorFlow* machine learning on Clear Linux* OS
Prerequisites
Set up a Jupyter notebook
Run the Jupyter machine learning example code
Related topics
Run Docker* on Clear Linux* OS
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
Run Clear Linux* OS using Microsoft Azure CLI 2.0
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
Set up a single node cluster with Hadoop*
Prerequisites
Install Apache Hadoop
Configure Apache Hadoop
Configure your SSH key
Run the Hadoop daemons
Run the MapReduce wordcount example
Use the function multi-version patch generator
Install and configure a Clear Linux OS host on bare metal
Detect loop vectorization candidates
Generate the FMV patch
FFT project example using FFTW
Create and launch Clear Linux* OS from 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
Enable simple file sharing with a Windows* machine using Samba*
Prerequisites
Set up file sharing
Map Clear Linux OS drive in Windows
Connect to Windows* shared location from Clear Linux* OS desktop
Prerequisites
Connect to Windows shared location with Nautilus
Set up a standalone cluster system using Apache* Spark*
Prerequisites
Install Apache Spark
Configure Apache Spark
Start the master server and a worker daemon
Run the Spark wordcount example
Install Kata Containers*
Prerequisites
Install Kata Containers
Run Kata Containers
More information about Docker
Troubleshooting
Migrate Clear Containers to Kata Containers*
Stop Clear Containers instances
Manually migrate customized configuration files
Enable Kata Containers as default
Run Kata Containers
Run Kubernetes*
Prerequisites
Install Kubernetes and CRI runtimes
Configure Kubernetes
Configure and run Kubernetes
Configure and run CRI-O + kata-runtime
Install pod network add-on
Use your cluster
Related topics
Cloud native setup automation (optional)
Package configuration customization (optional)
Proxy configuration (optional)
Next steps
Troubleshooting
Kubernetes Best Practices on Clear Linux OS
Use swupd to update clusters
Prerequisites
Update the control plane
Update worker nodes
Enable YubiKey U2F Support
Prerequisites
Enable Linux udev rules for YubiKey
Enable U2F in Mozilla Firefox
Related topics
Install NVIDIA* Drivers
Prerequisites
Install DKMS
Download and install the NVIDIA drivers
Download the NVIDIA drivers for Linux
Disable the nouveau driver
Configure alternative software paths
Install the NVIDIA drivers
Updating the NVIDIA drivers
Uninstalling the NVIDIA drivers
Debugging installation of NVIDIA drivers
Additional resources
Run Redis on Clear Linux* OS
Prerequisites
Install the redis bundle
Start the redis-server
Example 1: Use the redis-cli and try commands
Example 2: Run the Clear Linux OS redis docker image
Next Steps
Setting up proxy
Prerequisites
Shells and programs in a desktop session
Terminal
wget
System service (Docker)
git over ssh
Reference
Compatible Hardware
Useful bundle commands
Additional information
Available bundles
Bundle list
openssh-server
Prerequisites
Change default port
Enable SFTP
Enable root login
Enable X11-forwarding
Documentation guidelines
Contribution guidelines
Writing guide: Describes the style we use to keep our documents clear and concise.
Structure and formatting guide: Explains how we organize and format content, using reStructuredText and Sphinx.
How to contribute
Contribute via GitHub
References
Recommended minimum system requirements
Installer requirements
System requirements
Recommended configurations
Clear Linux* OS image types
Clear Linux concepts
Autospec
How autospec works
Control files
Related topics
Bundles
Next steps
Mixer
Create a mix
Related topics
swupd: software updater
Versioning
Updating
Bundles
Telemetrics
Architecture
Next steps
Stateless
File-level separation
Software configuration
System reset
Additional information
OS Security
Security in updates
Security in software
Security in system design
FAQ
General
Why did you make another distro?
Can other distros copy Clear Linux OS improvements?
How often do you update?
Is telemetry required?
What is the default firewall?
Where are the files that I usually see under /etc like fstab?
Software packages
How is software installed and updated?
Does Clear Linux OS use RPMs like other distros?
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 FFmpeg available?
Is ZFS* available?
Can you add a driver that I need?
Clear Linux* Project Docs
Clear Linux* Project
About
Developer
Software
Docs
»
<no title>
Edit on GitHub
This work is licensed under a
Creative Commons Attribution 4.0 International License