Skip to content

Commit c5ac4fd

Browse files
authored
Merge pull request #219 from Monstrofil/patch-6
Update Ubuntu docs for the Ubuntu 22 release
2 parents 57326fa + 8667f00 commit c5ac4fd

File tree

6 files changed

+76
-83
lines changed

6 files changed

+76
-83
lines changed

docs/ubuntu/faq/README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,43 @@
11
# FAQ
22

3-
### What is the CloudLinux subsystem on Ubuntu?
3+
## What is the CloudLinux Subsystem on Ubuntu?
44

5-
CloudLinux subsystem on Ubuntu is a scope of deb-packages that allows using CloudLinux features on Ubuntu OS.
5+
CloudLinux Subsystem on Ubuntu is a scope of deb-packages that allows using CloudLinux features on Ubuntu OS.
66
The main goal of this subsystem is to allow using the already existing CloudLinux functionality on another OS.
77

8-
### How to install the CloudLinux subsystem on Ubuntu?
8+
## How to install the CloudLinux subsystem on Ubuntu?
99

1010
See [Installation](/sub-system-ubuntu/installation/).
1111

12-
### Is the CloudLinux subsystem on Ubuntu paid/unpaid?
12+
## Is the CloudLinux Subsystem on Ubuntu paid/unpaid?
1313

14-
During the beta period it is free.
14+
The CloudLinux Subsystem on Ubuntu is paid.
15+
It follows the same licensing model as CloudLinux OS.
1516

16-
### Can I get the ISO for the CloudLinux subsystem on Ubuntu?
17+
## Can I get the ISO for the CloudLinux subsystem on Ubuntu?
1718

1819
As of now, only installation via `ubuntu2cloudlinux.py` is available.
20+
ISO images can be provided upon request.
1921

20-
### What control panel can be used with the CloudLinux subsystem on Ubuntu?
22+
## What control panel can be used with the CloudLinux subsystem on Ubuntu?
2123

2224
As of now, only cPanel is supported. Plesk and DirectAdmin are not supported.
2325

24-
### How can I get support for my CloudLinux subsystem on Ubuntu servers?
26+
## How can I get support for my CloudLinux subsystem on Ubuntu servers?
2527

2628
Feel free to contact Support via [Support Portal](https://www.cloudlinux.com/support-portal/).
2729

28-
### Can I use Docker with the CloudLinux subsystem on Ubuntu?
30+
## Can I use Docker with the CloudLinux subsystem on Ubuntu?
2931

3032
You cannot use Docker with the CloudLinux subsystem on Ubuntu in the current version.
3133

32-
### Is control panel integration functionality available in the current release?
34+
## Is control panel integration functionality available in the current release?
3335

3436
Yes, it is available.
3537

36-
### How to set up a PHP-fpm handler for the domain?
38+
## How to set up a PHP-fpm handler for the domain?
3739

38-
Since the PHP-fpm handler is required to use AccelerateWP, you may need to configure it manually.
40+
Since the PHP-fpm handler is required to use Accelerate WP, you may need to configure it manually.
3941

4042
These are configuration steps:
4143

docs/ubuntu/features/README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,28 +27,23 @@ The documentation is available [here](/cloudlinuxos/limits/#reseller-limits).
2727

2828
## MySQL Governor
2929

30-
MySQL Governor is software to monitor and restrict MySQL usage in a shared hosting environment. The monitoring is done
31-
via resource usage statistics per each MySQL thread.
30+
MySQL Governor is a software package that monitors and restricts MySQL usage in a shared hosting environment. The monitoring is done via resource usage statistics per each MySQL thread.
3231

3332
MySQL Governor can also kill off slow SELECT queries.
3433

35-
MySQL Governor has multiple modes of operations, depending on the configuration. It can work in monitor-only mode, or it
36-
can use different throttling scenarios.
34+
MySQL Governor has multiple modes of operations, depending on the configuration. It can work in monitor-only mode, or it can use different throttling scenarios.
3735

38-
MySQL Governor allows restricting customers who use too many resources. It supports following limits:
36+
MySQL Governor allows restricting customers that use too many resources. It supports following limits:
3937

4038
| | | |
4139
|-------|-------|--------------------------------------------------------------------------------------------------------|
4240
| CPU | % | CPU speed relative to one core. 150% would mean one and a half cores |
4341
| READ | bytes | bytes read. Cached reads are not counted, only those that were actually read from disk will be counted |
4442
| WRITE | bytes | bytes written. Cached writes are not counted, only once data is written to disk, it is counted |
4543

46-
You can set different limits for different periods: current, short, med, long. By default those periods are defined as 1
47-
second, 5 seconds, 1 minute and 5 minutes. They can be re-defined using
48-
the [configuration file](/cloudlinuxos/cloudlinux_os_components/#configuration-and-operation). The idea is
49-
to use larger acceptable values for shorter periods. Like you could allow a customer to use two cores (200%) for one
50-
second, but only 1 core (on average) for 1 minute, and only 70% within 5 minutes. That would make sure that customer can
51-
burst for short periods of time.
44+
You can set different limits for different periods: current, short, mid, long. By default those periods are defined as 1 second, 5 seconds, 1 minute and 5 minutes. They can be re-defined using the [configuration file](/cloudlinuxos/cloudlinux_os_components/#configuration-and-operation).
45+
The idea is to use larger acceptable values for shorter periods. Like you could allow a customer to use two cores (200%) for one second, but only 1 core (on average) for 1 minute, and only 70% within 5 minutes.
46+
That would make sure that customer can burst for short periods of time.
5247

5348
When a customer is restricted, the customer will be placed into special LVE with ID 3. All restricted customers will be
5449
placed into that LVE, and you can control the amount of resources available to restricted customers. Restricted
@@ -60,10 +55,9 @@ connections to the server.
6055
:::warning Attention!
6156
MySQL Governor on Ubuntu supports the following only:
6257

63-
* cl-MySQL80 on non-panel system
58+
* cl-MySQL80 on non-panel systems
6459
* cl-MySQL80 on cPanel
65-
* cl-MariaDB103 on non-panel system
66-
:::
60+
:::
6761

6862
1. Install MySQL Governor
6963

docs/ubuntu/installation/README.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,48 @@
11
# Installation
22

3-
:::tip
4-
For the current release, installation from the ISO images is not available.
3+
:::tip
4+
For the current release, installation from the ISO images is not available.
55
:::
66

7-
To install the CloudLinux subsystem, run the following command:
7+
To install the CloudLinux Subsystem on an Ubuntu machine:
88

9-
```
9+
1. Make sure you have Python 3 installed on your system. If not, install it using the following command:
10+
11+
```shell
1012
apt install python3
13+
```
14+
15+
2. Download the `ubuntu2cloudlinux.py` script:
16+
17+
```shell
1118
wget https://repo.cloudlinux.com/cloudlinux-ubuntu/sources/cln/ubuntu2cloudlinux.py
12-
python3 ubuntu2cloudlinux.py
13-
reboot
1419
```
1520

16-
No registration required! You can start working right after the installation.
21+
3. Run the script. Provide a key if your license is key-based:
22+
23+
```shell
24+
python3 ubuntu2cloudlinux.py --key=your_key
25+
```
26+
27+
If you have an IP-based license, pass the `--byip` option instead:
28+
29+
```shell
30+
python3 ubuntu2cloudlinux.py --byip
31+
```
32+
33+
The script will install the CloudLinux Subsystem on your Ubuntu machine. After the installation is complete, reboot your system.
1734

1835
## Ubuntu2Cloudlinux explained
1936

20-
The `ubuntu2cloudlinux.py` script gives an opportunity to install CloudLinux Subsystem For Ubuntu. It is a simplier script compared to the CLdeploy script for CentOS and AlmaLinux. For example, it doesn't replace the Linux kernel, only adds a dynamic module to it. Here is a list of actions done by the `ubuntu2cloudlinux`:
37+
The `ubuntu2cloudlinux.py` script installs the CloudLinux Subsystem For Ubuntu.
38+
It is a simpler script compared to the CLdeploy script for CentOS and AlmaLinux. For example, it doesn't replace the Linux kernel, only adds a dynamic module to it.
39+
Here is a list of actions that the `ubuntu2cloudlinux` script performs:
2140

22-
* It checks that you are running the latest available version of the `ubuntu2cloudlinux.py script`, and updates itself if necessary.
41+
* Checks that you are running the latest available version of the `ubuntu2cloudlinux.py script`, and updates itself if necessary.
2342
* Upgrades all installed packages to the latest versions (unless the `--skip-full-update` option is passed).
24-
* Adds CloudLinux repositories for Ubuntu and a corresponding gpg key to your system.
43+
* Registers your system with the CloudLinux Network (CLN) using the provided key or IP address.
44+
* Adds CloudLinux repositories for Ubuntu and a corresponding GPG key to your system.
2545
* Installs a minimum set of CloudLinux OS components: lve, kernel module kmodlve-dkms, lve-utils, lve-stats, alt-python.
2646
* Installs CloudLinux Manager (currently works with cPanel on Ubuntu).
2747
* Installs the mod_hostinglimits Apache module.
28-
* Asks you to manually reboot the system to load a new kernel module.
48+
* Asks you to manually reboot the system to load the new kernel module.

docs/ubuntu/introduction/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,17 @@
55
* [Ubuntu](https://ubuntu.com/) is a registered trademark of Canonical Ltd.
66
:::
77

8-
CloudLinux subsystem on Ubuntu is a scope of deb-packages which allows using CloudLinux features on Ubuntu OS. It is a Stable version of a free extension designed exclusively for Ubuntu® 20.04 LTS users.
8+
CloudLinux subsystem on Ubuntu is a scope of deb-packages which allows using CloudLinux features on Ubuntu OS. It is a Stable version of a free extension designed exclusively for Ubuntu® 22.04 LTS users.
99

1010
## Supported version of Ubuntu
1111

12-
We support Ubuntu 20.04 LTS.
12+
We support Ubuntu 22.04 LTS.
1313

1414
## CloudLinux OS editions comparison
1515

16+
CloudLinux Subsystem for Ubuntu supports the same editions as CloudLinux OS, with some exceptions.
17+
18+
In the table below, a feature marked with "No" for the CloudLinux Subsystem for Ubuntu means that no edition of CloudLinux Subsystem for Ubuntu supports this feature.
1619

1720
|**Features**|**CloudLinux OS Solo**|**CloudLinux OS Admin**|**CloudLinux OS Legacy (Shared)**|**CloudLinux OS Shared Pro**|**<font color="#2c98f0">CloudLinux Subsystem For Ubuntu</font>**|
1821
|:-:|:-:|:-:|:-:|:-:|:-:|
@@ -38,7 +41,7 @@ We support Ubuntu 20.04 LTS.
3841

3942
\** Limits are disabled by default.
4043

41-
\*** Python/Node.js/Ruby Selectors are available only for cPanel, DirectAdmin servers, and servers with custom panel with own integration.
44+
\*** Python/Node.js/Ruby Selectors are available only for cPanel, DirectAdmin, and servers with custom panels with own integration.
4245

4346
## Supported control panels
4447

docs/ubuntu/troubleshooting/README.md

Lines changed: 6 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -5,41 +5,12 @@
55
To troubleshoot and resolve issues, you can use the following log files:
66

77
```
8-
/var/log/ubuntu2cloudlinux.log - conversion log
9-
/var/log/lve-stats.log - lve-stats
10-
/var/log/dmesg - kernel module
8+
/var/log/ubuntu2cloudlinux.log - conversion log
9+
/var/log/lve-stats.log - lve-stats
10+
/var/log/dmesg - kernel module
1111
```
1212

13-
## Knows Issues
13+
## Known issues
1414

15-
1. Please take into account that if one of the [`alt-python37*` packages](/sub-system-ubuntu/troubleshooting/#list-of-alt-python37-packages) is updated, you should execute the following command to ensure the proper functionality of the LVE-stats daemon:
16-
17-
```
18-
/sbin/service lvestats try-restart
19-
```
20-
21-
#### List of alt-python37* packages:
22-
23-
* alt-python37
24-
* alt-python37-raven
25-
* alt-python37-simplejson
26-
* alt-python37-sqlalchemy
27-
* alt-python37-alembic
28-
* alt-python37-libs
29-
* alt-python37-markupsafe
30-
* alt-python37-setuptools
31-
* alt-python37-contextlib
32-
* alt-python37-mako
33-
* alt-python27-cllib
34-
* alt-python37-prettytable
35-
* alt-python37-logilab-common
36-
* alt-python37-jinja2
37-
* alt-python37-psycopg2
38-
* alt-sqlite
39-
40-
Behavior like this will be fixed in the upcoming versions.
41-
42-
2. LVE statistics work only with SQLite, other databases (e.g. MySQL, postgreSQL) will be available in the following releases.
43-
3. `alt-php*-zts` packages are not available yet.
44-
4. The `tmpreaper package` is used instead of `tmpwatch`.
45-
5. PNG format for LVE Charts does not work correctly on CloudLinux subsystem on Ubuntu (lvechart utility may produce broken images).
15+
1. `alt-php*-zts` packages are not available at the moment.
16+
2. The `tmpreaper package` is used instead of `tmpwatch`.

docs/ubuntu/uninstalling/README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
# Uninstalling
22

3-
### Deleting the CloudLinux Subsystem For Ubuntu
3+
## Deleting the CloudLinux Subsystem For Ubuntu
44

55
You can uninstall CloudLinux Subsystem For Ubuntu by running the following commands:
66

7-
```
7+
```shell
8+
# Install Python 3 if you don't have it
89
apt install python3
910
```
10-
```
11+
12+
```shell
1113
wget https://repo.cloudlinux.com/cloudlinux-ubuntu/sources/cln/ubuntu2cloudlinux.py
1214
```
13-
```
15+
16+
```shell
1417
python3 ubuntu2cloudlinux.py --uninstall
1518
```
16-
```
19+
20+
```shell
1721
reboot
1822
```
1923

24+
The script will:
2025

21-
In that case the script will:
22-
23-
* Remove the CloudLinux OS components which are installed on your system, choosing from the following list: lve, kmodlve-dkms, lve-utils, lve-stats, lvemanager, cagefs, alt-python, alt-php, db-governor.
26+
* Remove the CloudLinux OS components which are installed on your system, going over the following list: lve, kmodlve-dkms, lve-utils, lve-stats, lvemanager, cagefs, alt-python, alt-php, db-governor.
2427
* Remove configs for CloudLinux repositories for Ubuntu.
2528
* Ask you to check for remaining packages from CloudLinux and manually reboot your system.

0 commit comments

Comments
 (0)