Skip to content

Commit 03ca1ba

Browse files
committed
Update relevant sections in preparation for the first Cl10 release
1 parent 6e570bf commit 03ca1ba

File tree

5 files changed

+168
-113
lines changed

5 files changed

+168
-113
lines changed

docs/cloudlinuxos/cloudlinux_installation/README.md

Lines changed: 83 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,18 @@ You can check the entire list here: [Hardware enablement considerations in adopt
3838

3939
## Software Compatibility
4040

41-
CloudLinux OS is designed to maintain full binary compatibility with CentOS and Red Hat Enterprise Linux (RHEL). This means that any software, applications, or scripts that run on CentOS or RHEL can run on CloudLinux OS without modification. The operating system ensures broad compatibility with the vast ecosystem of Linux software, providing a seamless and stable environment for hosting providers and users transitioning from other enterprise Linux distributions. This compatibility extends to package management, system libraries, and core functionalities, making CloudLinux OS a reliable drop-in replacement that supports the same software stack as its counterparts.
41+
CloudLinux OS is designed to maintain full binary compatibility with CentOS and Red Hat Enterprise Linux (RHEL).
42+
43+
This means that any software, applications, or scripts that run on CentOS or RHEL can run on CloudLinux OS without modification. The operating system ensures broad compatibility with the vast ecosystem of Linux software, providing a seamless and stable environment for hosting providers and users transitioning from other enterprise Linux distributions.
44+
45+
This compatibility extends to package management, system libraries, and core functionality, making CloudLinux OS a reliable drop-in replacement that supports the same software stack as its counterparts.
4246

4347
### ZFS
4448

4549
CloudLinux 8+ provides limited support for ZFS, to the same degree as other RHEL-like distributions. More precisely, that means:
4650

4751
1. CloudLinux doesn't ship any prebuilt packages of `kmod-zfs` or `zfs-dkms`, etc. But it doesn't restrict customers from using [packages built by the OpenZFS Team](https://openzfs.github.io/openzfs-docs/Getting%20Started/RHEL-based%20distro/index.html) as they are known to be compatible and work fine on CloudLinux and AlmaLinux. In fact, we know that some of our customers are already using them for quite some time.
48-
1. The most recent CloudLinux conversion script (`cldeploy`) does not prevent the conversion of the system with `zfs` modules loaded
52+
1. The current CloudLinux conversion script (`cldeploy`) does not prevent the conversion of the system with `zfs` modules loaded
4953
1. CloudLinux tries to keep kABI mostly compatible with RHEL's, so in case ZFS works with the RHEL-like kernel, but not with a similar CloudLinux one, we will accept tickets to fix that
5054
1. Because ZFS is known to have some lag in adapting to kernel changes, we consider it the customer's responsibility to test the upgradeability of the environment to the most recent kernels and ZFS versions before upgrading the entire fleet.
5155
1. Most CloudLinux features, like CageFS, should work fine with ZFS-backed mount points, and if not, we will try our best to provide fixes according to severity and demand
@@ -56,54 +60,63 @@ LVE IO Limits (as well as generic cgroups limits) don't work because the ZFS dat
5660
:::
5761

5862

59-
## Getting License
63+
## Getting a license
6064

61-
You will need a valid activation key - trial or paid - to be able to use your CloudLinux OS server.
65+
You will need a valid activation key, trial or paid, to be able to use your CloudLinux OS server.
6266

63-
### Getting Trial License
67+
### Getting a trial license
6468

65-
The trial activation key can be used to convert your server to CloudLinux OS.
69+
A trial activation key can be used to convert your server to CloudLinux OS.
6670

6771
:::tip Note
68-
The trial license subscription will work for 30 days.
72+
A trial activation key will be valid for 30 days.
6973
:::
7074

71-
If you have any issues getting activation key or if you have any questions regarding using your
72-
trial subscription contact [sales@cloudlinux.com](mailto:sales@cloudlinux.com) and we will help.
75+
If you have any issues getting an activation key or if you have any questions regarding using your
76+
trial subscription, contact [sales@cloudlinux.com](mailto:sales@cloudlinux.com) and we will help.
7377

74-
To get the activation key:
78+
To get an activation key, follow these steps:
7579

7680
1. Register with CloudLinux Network: [https://cln.cloudlinux.com/console/register/customer](https://cln.cloudlinux.com/console/register/customer) (skip it if you already registered)
7781
2. You will receive an email with activation link
7882
3. Login at [https://cln.cloudlinux.com/console/auth/login](https://cln.cloudlinux.com/console/auth/login)
79-
4. Choose the appropriate [CloudLinux edition](/introduction/) that fits your needs.
83+
4. Choose the appropriate [CloudLinux edition](/introduction/) that suits your needs.
8084
5. Click on `Get Trial Activation Key`.
8185

82-
You will get a key that looks like: `12314-d34463a182fede4f4d7e140f1841bcf2`.
86+
You will get an activation key that looks like this: `12314-d34463a182fede4f4d7e140f1841bcf2`.
8387

8488
## Converting existing servers
8589

86-
Sometimes it is required to convert already existing servers with **`CentOS`** or **`AlmaLinux`** and make them **`CloudLinux OS`**.
90+
Sometimes it's required to convert already existing servers with CentOS or AlmaLinux and make them CloudLinux OS.
91+
92+
For CloudLinux OS 10, it's the primary installation method.
8793

88-
It is easy to convert your existing installation through the cldeploy script. The process takes a few minutes and replaces just a handful of RPMs.
94+
It's easy to convert your existing installation through the `cldeploy` script.
95+
The process takes a few minutes and replaces just a handful of packages.
8996

9097
:::warning
91-
Unlike [Fresh installation](#installing-new-servers), converting immediately requires a CloudLinux OS license.
92-
Please refer to the [guide](#license-activation) to get an activation key.
98+
Unlike [new server installation](#installing-new-servers),
99+
converting an existing server requires a CloudLinux OS license to be provided.
100+
Please refer to the [guide](#getting-a-license) to get an activation key.
93101
:::
94102

95103
### Requirements
96104

97-
Currently supported OS for conversion:
105+
Currently supported operating systems for conversion:
98106
* CentOS 7
99-
* AlmaLinux OS 8, AlmaLinux OS 9
107+
* AlmaLinux OS 8-10
100108
* RockyLinux (installation only, no uninstall option)
101109

102-
:::warning Unsupported OS for conversion:
110+
:::warning Unsupported operating systems for conversion
103111
* CentOS 8
104112
* CentOS Stream
105113
:::
106114

115+
:::warning SELinux
116+
SELinux is not supported on CloudLinux OS 6 and 7.
117+
SELinux is supported on CloudLinux OS 8+, but might not work or be compatible with control panels and various components.
118+
:::
119+
107120
Supported control panels:
108121
* cPanel ([Documentation](https://docs.cpanel.net/installation-guide/system-requirements-cloudlinux/))
109122
* Plesk
@@ -112,27 +125,27 @@ Supported control panels:
112125
* InterWorx ([Documentation](https://appendix.interworx.com/current/nodeworx/plugins/install-use-cloudlinux-plugin-interworx.html))
113126
* Webuzo ([Documentation](https://webuzo.com/docs/installing-webuzo/install-cloudlinux-os/))
114127

115-
:::warning Other control panels:
128+
:::warning Other control panels
116129
Control panels not mentioned in the list of supported panels have native integration or integration done by the developer of the panel.
117130
We cannot guarantee the stability or correct operation of CloudLinux components on such panels.
118131
:::
119132

120-
:::warning Warning:
121-
Some CloudLinux components may not be supported by the control panel itself or the control panel can have its own analog of such a component.
133+
:::warning Control panel compatibility
134+
Some CloudLinux components may not be supported by the control panel itself or the control panel can have its own equivalent of such a component.
122135
You can verify this information when reviewing the system requirements for installing a specific CloudLinux component.
123136
:::
124137

125138

126-
#### Note: CentOS 8 is EOL
139+
#### CentOS 8 is EOL
127140

128141
CentOS 8 reached End Of Life (EOL) on December 31st, 2021.
129-
If you would like to convert from CentOS 8 to CloudLinux OS 8, do the following:
142+
If you would like to convert from CentOS 8 to CloudLinux OS 8, follow these steps:
130143

131144
* Convert CentOS 8 to AlmaLinux 8 using [almalinux-deploy](https://github.com/AlmaLinux/almalinux-deploy)
132145
* Convert AlmaLinux 8 to CloudLinux 8 using [cldeploy](/cloudlinux_installation/#cldeploy-explained)
133146

134147

135-
### Downloading and running conversion script
148+
### Downloading and running the conversion script
136149

137150
#### Key-based activation
138151

@@ -162,35 +175,37 @@ sh cldeploy -i --to-admin-edition
162175
```
163176

164177
### Next steps
165-
After successful conversion, reboot your system by running the following command:
178+
After a successful conversion, reboot your system:
166179

167180
```
168181
reboot
169182
```
170183

171-
Once you reboot - your server should be running with CloudLinux OS LVE kernel.
184+
Once you reboot, your server should be running with CloudLinux OS LVE kernel.
185+
186+
#### Checking the booted kernel
187+
188+
:::tip Note
189+
This information applies only to CloudLinux OS 8 and below.
190+
CloudLinux OS 9 and above use the non-modified AlmaLinux kernel.
191+
:::
172192

173-
You may check the booted kernel with the following command:
193+
You can check the booted kernel with the following command:
174194

175195
```
176196
uname -r
177197
```
178198

179199
:::warning Note
180-
If after rebooting you do not see the CloudLinux kernel (the kernel has the abbreviation LVE in its name)
181-
then please consider check our [knowledge base](https://cloudlinux.zendesk.com/hc/en-us/) or
200+
If after rebooting you don't see the CloudLinux kernel (the kernel has the abbreviation LVE in its name)
201+
then please consider checking our [knowledge base](https://cloudlinux.zendesk.com/hc/en-us/) or
182202
contact [support](https://cloudlinux.zendesk.com/hc/en-us/requests/new).
183203
:::
184204

185-
:::warning Note
186-
SELinux is not supported on CloudLinux OS 6 and 7. SELinux is supported on CloudLinux OS 8+,
187-
but might not work or be compatible with control panels and various components.
188-
:::
205+
#### Automatic hybridization
189206

190-
:::tip Note
191-
At the end of conversion from CentOS 7.x to CloudLinux OS 7,
192-
the cldeploy script converts CloudLinux OS 7 to [CloudLinux OS 7 Hybrid](/cloudlinuxos/cloudlinux_os_kernel/#hybrid-kernels).
193-
:::
207+
At the end of converting from CentOS 7.x to CloudLinux OS 7,
208+
the script converts CloudLinux OS 7 to [CloudLinux OS 7 Hybrid](/cloudlinuxos/cloudlinux_os_kernel/#hybrid-kernels).
194209

195210
Automatic hybridization will be performed for the AMD processors with the following CPU families:
196211

@@ -244,20 +259,20 @@ If you receive any troubles during the conversion process,
244259
please feel free to search our [knowledge base](https://cloudlinux.zendesk.com/hc/en-us)
245260
or contact our support and attach the conversion log (/var/log/cldeploy.log).
246261

247-
### How to enable secure boot for CloudLinux 9
262+
### How to enable Secure Boot for CloudLinux 9+
248263

249264
#### Overview
250-
CloudLinux 9 uses a non-modified AlmaLinux 9 kernel.\
251-
To make secure boot work with CloudLinux's kernel module you need to enroll the CloudLinux secure boot key to your server.\
252-
This procedure shows how to do it
265+
CloudLinux 9 and above use a non-modified AlmaLinux kernel.
266+
To make Secure Boot work with CloudLinux's kernel module, you need to enroll the CloudLinux secure boot key onto your server.
267+
The following procedure shows how to do it.
253268

254269
#### Requirements
255270
* UEFI support
256271
* mokutil package installed
257272
* Access to server's BIOS options menu and boot screen
258273

259274
:::tip **Note!**
260-
Starting from kernel 5.14.0-362.8.1.el9_3 and kmod_lve-2.1-20 the secure boot is available without importing CloudLinux key.
275+
Starting from kernel 5.14.0-362.8.1.el9_3 and kmod_lve-2.1-20 Secure Boot is available without importing the CloudLinux key.
261276
:::
262277

263278
#### Procedure
@@ -295,15 +310,15 @@ Select **`Yes/OK`**\
295310
* Select **`Reboot`** (Older versions may say **`Continue boot`**)\
296311
![Step 6](/images/cloudlinuxos/cloudlinux_installation/cl9_secureboot/6.webp)
297312
298-
* Now you can enable Secure Boot in BIOS options menu
313+
You can now enable Secure Boot in the BIOS options menu.
299314
300315
#### Useful Commands
301316
* `mokutil --sb-state` (to check current Secure Boot state);
302317
* `mokutil --list-enrolled` (to show list of enrolled keys).
303318
304-
#### If you wish to remove the CloudLinux key from the MOK list, follow the instructions below
319+
#### Remove the CloudLinux key from the MOK list
305320
:::warning Warning
306-
Do not delete the key when secure boot is enabled - server will be unable to boot
321+
Do not delete the key when Secure Boot is enabled - server will be unable to boot
307322
:::
308323
309324
1. Disable Secure Boot
@@ -357,11 +372,13 @@ Here's what the cldeploy script does during uninstallation:
357372
* mod_hostinglimits RPM is removed.
358373
359374
:::tip Note
360-
**cldeploy doesn't remove the kernel** to prevent condition when server has no kernels and wouldn't boot. Instead, script provide the instructions on how you could remove it manually later, when it is safe to do so.
375+
**cldeploy doesn't remove the kernel** to prevent situations where the server has no kernels and won't boot.
376+
Instead, the script provides instructions on how you could remove it manually later, when it is safe to do so.
361377
:::
362378
363-
On cPanel servers, rebuild of Apache with EasyApache will complete the conversion back, but doesn't have to be performed immediately.<sup> *</sup>
364-
On DirectAdmin servers, rebuild of Apache with custombuild will complete the conversion back, but doesn't have to be performed immediately.
379+
On cPanel servers, rebuilding Apache with EasyApache will complete the reversion, but doesn't have to be performed immediately.
380+
381+
On DirectAdmin servers, rebuilding Apache with custombuild will complete the reversion, but doesn't have to be performed immediately.
365382
366383
More information is also available here: [Uninstall CloudLinux](/cloudlinuxos/cloudlinux_installation/#uninstalling).
367384
@@ -385,6 +402,11 @@ clnreg_ks --force
385402
```
386403
:::
387404
405+
:::warning CloudLinux OS 10
406+
CloudLinux OS 10 ISOs are not available.
407+
Please use the [conversion procedure](/cloudlinuxos/cloudlinux_installation/#converting-existing-servers) on AlmaLinux 10 to create new CloudLinux OS 10 servers.
408+
:::
409+
388410
### Downloading ISO
389411
390412
You can download the latest CloudLinux OS ISO and use it to install CloudLinux OS on your server:
@@ -584,6 +606,11 @@ yum install rhn-setup
584606
* [Xen](/cloudlinux_installation/#installing-new-servers)
585607
* [CloudLinux Azure Images](./#cloudlinux-azure-images)
586608

609+
:::warning CloudLinux OS 10
610+
CloudLinux OS 10 images are not available.
611+
Please use the [conversion procedure](/cloudlinuxos/cloudlinux_installation/#converting-existing-servers) on AlmaLinux 10 to create new CloudLinux OS 10 servers.
612+
:::
613+
587614
### CloudLinux Azure Images
588615

589616
We build and release CloudLinux 7.9 and CloudLinux 8.6 for Azure and upload to the [Mircosoft Azure Community Galleries](https://learn.microsoft.com/en-us/azure/virtual-machines/share-gallery-community?tabs=cli).
@@ -1431,18 +1458,19 @@ timeout=5
14311458
6. Reboot and check that you are running CloudLinux OS . <span class="notranslate">`uname -r`</span> should show something like: <span class="notranslate">`2.6.18-294.8.1.el5.lve0.7.33`</span>.
14321459

14331460

1434-
## Switch license
1461+
## Switching to a different license type
14351462

1436-
You can convert your existing CloudLinux OS installation to CloudLinux OS Legacy (Shared).
1463+
You can convert your existing CloudLinux OS installation to a different license type, such as CloudLinux OS Legacy (Shared).
14371464

1438-
1. Obtain new key from [CLN](https://cln.cloudlinux.com)
1439-
2. Run `rhnreg_ks --force --activationkey=<new_key>`
1465+
1. Obtain a new activation key from [CLN](https://cln.cloudlinux.com)
1466+
2. Run `rhnreg_ks --force --activationkey=<new_activation_key>`
14401467

1441-
You can pass `--migrate-silently` argument to skip confirmation.
1468+
You can pass the `--migrate-silently` argument to skip the confirmation prompt.
14421469

14431470
## Uninstalling
14441471

1445-
You can always uninstall CloudLinux OS. In this case, the system will be converted back to AlmaLinux or CentOS* (Depends on what system the conversion was done from).
1472+
You can always uninstall CloudLinux OS.
1473+
In this case, the system will be converted back to AlmaLinux or CentOS* (depending on the system the conversion was done from).
14461474

14471475
:::warning
14481476
CentOS Linux 8 reached End Of Life (EOL) on December 31st, 2021. You can still uninstall CloudLinux and return to CentOS 8, but we don't guarantee stable operation of the system and its repositories after this action.

0 commit comments

Comments
 (0)