.. _cloud-up-cloud-servers: ~~~~~~~~~~~~~ Cloud Servers ~~~~~~~~~~~~~ The **Cloud Servers** page is the landing page of RLM Cloud. It lists the license servers you manage, lets you provision new servers, and gives you access to each server's configuration, options file, and licenses. Viewing the page requires **View** access; individual actions are gated by the access level noted with each feature below. ------ .. _cloud-up-servers-list: ###################### The Cloud Servers List ###################### When you open the portal, the **Cloud Servers** page displays a paginated table of your license servers (requires **View**). Each row represents one license server and shows: * A **status dot** indicating the current state of the server. * **Server** – the display name you assigned when the server was provisioned. * **Primary Server Host** – the machine on which the server runs. When the failover tab is active, a **Failover Server Host** column is also shown (see :ref:`cloud-up-failover`). * **Actions** – per-server controls for configuration, options, and server operations. .. TODO: screenshot You can locate servers quickly using the controls above the table: * **Search** by server name. * Filter by **Host** using the dropdown. * Choose how many rows appear per page: **5**, **10**, or **25**. .. _cloud-up-status-indicators: Status Indicators ***************** The status dot at the start of each row reflects the live state of the server: * **Green** – the server is up. This applies whether the server has a single license pool or multiple pools. * **Yellow** – the server is partially up (some pools are not responding). * **Red** – the server is down. The host is unreachable, or the main pool is not running. * **Grey** – the server is disabled. Expanding a Server Row ********************** Click a server row to expand it and view that server's license pools and live checkouts. The checkout information refreshes automatically about every 10 seconds, so the expanded view reflects current usage without reloading the page. The Primary / Failover Tabs *************************** A **Primary** / **Failover** tab strip appears above the table only when at least one of your servers has a failover machine configured. Use the tabs to switch between viewing the primary hosts and the failover hosts. See :ref:`cloud-up-failover` for details on monitoring failover servers from this page. ------ .. _cloud-up-add-server: ##################### Provisioning a Server ##################### To add a new license server, click **Add Server** (requires **Edit**). The portal opens the provisioning form and pre-fills several values for you: * The next free **Port**, starting from 5500. * The **License Server Instance** number. * An auto-generated **Server ID**. * A random **License Server Password**. Complete the form: * **Server Machine** – the machine the server will run on. Select one from the dropdown (required). * **Display Name** – the name shown for this server throughout the portal (required). * **Server ID**, **Port**, **Instance** – shown for reference. These are generated by the portal and are not edited here. * **License Server Password** – editable. It may contain letters, digits, hyphens, and underscores, up to 32 characters. * **Company** and **Contact** – optional links to a company and contact record. * **Notes** – optional free-text notes. .. TODO: screenshot When the form is complete, click **Provision Server**. The portal provisions the server on the selected license machine as a background job and reports completion with a toast notification. ------ .. _cloud-up-server-configuration: ######################### Server Configuration Page ######################### The **Server Configuration** page is reached from a server row and shows everything about a single server. Viewing the page requires **View**; the actions on it are gated by access level as noted below. The top of the page shows the server's **Enabled** / **Disabled** state and, for **Manage** users, a **Restart** control and a menu to enable, disable, or delete the server. .. TODO: screenshot .. _cloud-up-customer-license: Your Customer Server License **************************** This panel displays a generated, one-line *customer license* that you hand to the end customer so their applications can reach this server. A toggle selects the transport: * **HTTPS** – uses port 443. * **HTTP** – uses port 5053. When HTTP mode is selected, the portal warns that both port 5053 and the server's own port must be open. .. note:: HTTP has now been deprecated and is not recommended. Use **Copy to clipboard** to copy the license line, or **Download License** to save it as a ``.lic`` file to give to your customer. When **Failover** is configured, both the primary and failover license must be provided to your customer to enable failover. Server Information ****************** The **Server Information** panel summarizes the server's identity: display name, machine name/IP, **Server ID**, port, instance, password, and the linked **Company** and **Contact**. Server Notes ************ The **Server Notes** panel holds free-text notes about the server. **Manage** users can edit the notes and click **Save**; **View** users see them read-only. If you make changes and try to navigate away before saving, the portal warns you about the unsaved changes. .. _cloud-up-licenses-on-server: Licenses on this Server *********************** The **Licenses on this server** table lists the licenses installed on the server, showing **Product Name**, **License Type**, **Expiry**, and **Count**. The **Add License**, **Replace**, and **Delete** controls each require **Edit**, and are disabled when the server is disabled. Deleting a license warns you that it removes the license file and triggers a reread of the server. .. note:: The details of adding and replacing licenses are covered in :ref:`cloud-up-licenses`. ------ .. _cloud-up-options-file: ######################## Editing the Options File ######################## You can open a server's RLM options file from a server row. Opening the file requires **View**; editing it requires **Manage**. The options file opens in the **CODE** editor, a monospace text editor. Note the following when editing: * The ``REPORTLOG``, ``DEBUGLOG``, and ``ROTATE`` lines at the top of the file are generated automatically by RLM Cloud Control. Do not edit them. * Add your own options *below* the marked "do not edit this line" line. * Click **SAVE FILE** to write your changes. The change is applied to the license machine as a background job. .. admonition:: Finish editing promptly You have approximately 10 minutes to finish editing and save the options file. Save your changes within that window to avoid losing them. ------ .. _cloud-up-server-actions: ############## Server Actions ############## The portal provides the following per-server and bulk actions. Each is confirmed before it runs: * **Reread** / **Restart** (requires **Manage**) – reread or restart a single server. * **Reread All** / **Restart All** (requires **Manage**) – reread or restart all of your servers at once. * **Enable** / **Disable** (requires **Manage**) – disabled servers render greyed out, and their actions are disabled until they are re-enabled. * **Delete** (requires **Edit**) – removes the server and its licenses, then tears it down on the license machine asynchronously. .. note:: Actions that write to the license machine – provisioning a license, reread/restart, saving the options file, and delete – run as background jobs. The portal reports completion with a toast notification.