Merge pull request #251 from ruslan1us/CLPRO-2609

CLPRO-2609: Publish documentation regarding CLI for linking a server …

Author: annkots

docs/cloudlinuxos/shared-pro/README.md

@@ -2955,3 +2955,71 @@ Required packages:
 * `lvemanager` >= 6.2.10-1
 * `alt-php-xray` >= 0.2-1
 
+## Link server to CLN account
+
+**Why do we need a server linking to CLN?**  
+One of the main CloudlinuxOS Shared Pro features is Centralized Monitoring. In case when a customer uses the license provided by the reseller the server registered with such license will be linked to the reseller's CLN account. As a result, customers cannot see the data in Centralized Monitoring. To allow a customer to see the data in such a case we implemented an ability to link the server to the customer's own CLN account.
+
+**Who can use it?**  
+Only customers who use CloudlinuxOS Shared Pro licenses provided by resellers.
+However, it's crucial to understand when linking is appropriate.
+
+* When to link: The primary users for this feature are customers of license-only resellers (e.g., WebPros, LicensePal, Jones M.). If you acquired your license this way, you can link the server to your CLN account. By doing so, you acknowledge that it is your responsibility to only link servers that are owned and operated by the same entity.
+
+:::warning When NOT to link!
+* Some partners use a single account to manage servers they own directly alongside servers they resell to various clients. To avoid mixing data and granting unintended access, these distinct groups of servers should not be linked to one end-customer account.
+:::
+
+If your server is eligible for linking, you will see a component in the CloudLinux Manager UI.
+
+**How to link a server?** 
+If your server is linkable you will see in the Cloudlinux Manager UI (Dashboard tab) the component with input field which allows linking the server to CLN.
+
+![](/images/cm-ui-component.png)
+
+To link the server, it is required to perform the following:
+
+1. Create a CLN account if you do not have one [https://cln.cloudlinux.com/console/register/customer](https://cln.cloudlinux.com/console/register/customer).
+2. Log into your CLN account and copy the linking token. If you click the “Get the token” button you will be redirected to [https://cln.cloudlinux.com/console/profile/details](https://cln.cloudlinux.com/console/profile/details) where can copy the token
+3. Paste the token into the “Enter token” input and click the “Link server” button
+
+After these steps you server will be linked. And you will see it in the Centralized Monitoring.
+
+![](/images/linked-server-centralized-monitoring.png)
+
+### CLI utility /usr/sbin/cl-link-to-cln 
+
+We can also bind a server from the command line. To do this can be used `/usr/sbin/cl-link-to-cln` utility.
+
+```
+/usr/sbin/cl-link-to-cln --help  
+Usage: cl-link-to-cln [options]
+Options:
+  -h, --help            show this help message and exit
+  -t TOKEN, --linking-token=TOKEN
+                        Token to link the server
+  -s, --linking-status  Show if status linked or not
+```
+
+To link we have to:
+
+1. Check if the server can be linked:
+```
+/usr/sbin/cl-link-to-cln --linking-status  
+{
+    "result": "success",
+    "timestamp": 1698670480.3382068,
+    "linked": false,
+    "linkable": true
+}
+```
+
+* **linked (boolean)** field define if server is already linked
+* **linkable (boolean)** field define if server can be linked
+
+2. Link the server with the command:
+```
+/usr/sbin/cl-link-to-cln --linking-token=TOKEN
+```
+
+Token you can find here [https://cln.cloudlinux.com/console/profile/details](https://cln.cloudlinux.com/console/profile/details).