Installing Rulex Platform#

Rulex Platform software is delivered in two different architectural versions: a standalone installation or a cloud/server deployment.

The standalone version is installed on computers or virtual machines and provides an easy entry point for all the people who want to play with their data and start immediately to get value from our software.

The cloud/server version, on the other hand, is the typical installation in enterprise environments where scaling and reducing computational hardware costs are of the utmost importance. Rulex Platform supports all most important cloud/server providers (Azure, Google, Red Hat Openshift, AWS…).

Prerequisites#

Rulex Platform’s installation process is very easy and intuitive.

The software will quickly be up and running on your machine.

Note

Windows OS, Ubuntu and Darwin are currently supported.

To start using Rulex Platform standalone version and to install it on your machine, you need to satisfy the following prerequisites:

  • Rulex Platform Installer: the installer is the executable that will guide you through the installation phase, providing all the files required to run Rulex Platform. The installer file format will be .exe for Windows, .deb for Ubuntu and .dmg for Darwin.

  • Product Key: the Product Key is a code, which is provided along with the installer, identifying all the features of the purchased license. It is a combination of alphanumerical characters that contains:

    • The services purchased and the limitations you have on their use (e.g. the tasks included in your package);

    • The number of users that can use the services simultaneously;

    • The maximum number of sessions that can be run at the same time.

To receive the Product Key, you can contact your Rulex Point of Contact or you can fill in the form linked here to receive a 30-days free trial.

In order to use Rulex Platform in the best way possible, the machine you are using must comply with certain requirements (all the values listed below should be considered as recommended):

Requirement Area

Details

Runtime prerequisite

Microsoft Windows 10 (64 bit) - 1909 or higher.
Windows Server 2016 or higher.

CPU

CPU with x86_64 architecture. 4 core minimum, 8 core recommended.

RAM

4 GB (minimum), 16 GB (recommended), 32 GB (best performance) - single user application.
8 GB (minimum), 32 GB (recommended), 64 GB (best performance) - multiple users application, server-like.

Hard Disk Space

50 GB (minimum), 100 GB (recommended), 200 GB (best performance) - single user application.
100 GB (minimum), 250 GB (recommended). 1 TB (best performance) - multiple users application, server-like.

IOPS

1000 minimum, 2000 recommended.

Network

https://licensemanager.rulex.cloud/license must always be accessible.

Additional tools

Microsoft C++ Redistributable, which can be downloaded from here. The link is also provided during the installation process in the standard installation.

Requirement Area

Details

Runtime

Ubuntu 22.04 LTS (Jammy Jellyfish)

CPU

CPU with x86_64 architecture. 4 core minimum, 8 core recommended.

RAM

4 GB (minimum), 16 GB (recommended), 32 GB (best performance) - single user application.
8 GB (minimum), 32 GB (recommended), 64 GB (best performance) - multiple users application, server-like.

Hard Disk Space

50 GB (minimum), 100 GB (recommended), 200 GB (best performance) - single user application.
100 GB (minimum), 250 GB (recommended), 1 TB (best performance) - multiple users application, server-like.

IOPS

1000 minimum, 2000 recommended.

Network

https://licensemanager.rulex.cloud/license must always be accessible.

Additional tools

Microsoft C++ Redistributable, which can be downloaded from here. The link is also provided during the installation process in the standard installation.

Requirement Area

Details

Runtime

macOS Sonoma

CPU

Mac Apple Silicon M1, M2, M3 - ARM64

RAM

8 GB (minimum) – 16 GB (recommended) - single user application

Hard Disk Space

256 GB (minimum) – 512 GB (recommended) - single user application

IOPS

1000 recommended, 2000 optimum.

Network

https://licensemanager.rulex.cloud/license must always be accessible.

Standalone wizard installation#

To install Rulex Platform, follow the steps below:

  1. Locate the folder where you saved the Rulex Platform installer on your personal computer.

  2. Double-click the installer file to launch the installation.

  3. Click Next in the welcome screen to get started.

  4. Click I Agree in the Terms and Conditions window.
     If you do not accept the terms and conditions, Rulex Platform will not be installed.

  5. Insert your product key.

  6. Wait until the Valid product key message appears, then click OK.

  7. Select the required installation option:

    • Anyone who uses this computer (all users) - to allow all computer users to use Rulex.

    This option is called a machine wide installation and is available only to the system administrator of the machine.

    • Only for me (username) - to allow only the current user (i.e. yourself) to use this installation of Rulex.

  8. Click Next to install Rulex in the proposed default location, otherwise click Browse to navigate to a different folder.

  9. Click Install.

  10. Select the Run Rulex Platform checkbox if you want Rulex Platform to open automatically at the end of the installation process.

  11. Click Finish to end the installation process.

The installation on Ubuntu must be performed as follows:

  1. In the Ubuntu terminal, type the following command: sudo dpkg -i your_installer_name.deb

  2. Define the installation option by typing either 0 or 1:

    • 0 means the installation will be performed on the current user, so the installer will be stored in the path /home/username/opt/rulexplatform.

    • 1 means the installation will be performed machine-wide, so all users within the machine will have Rulex Platform installed, so the installer will be stored in the path /opt/rulexplatform.

  3. Insert the Product Key in the required field.

  4. Type the username. This username is going to become admin of the new installation.

  5. Specify the configuration file path. This field is not mandatory, so it can be left empty by pressing Enter on the keyboard.

  6. If any dependency is missing, type sudo apt --fix-broken install to install any missing dependency.

  7. To run Rulex Platform, type ./rulexplatform if you are already in the folder where the installer is stored, while type /path/to/rulexplatform if it is stored in a folder different from the one you are working on

Ubuntu uninstallation

In order to uninstall Rulex Platform on Ubuntu follow the steps explained below.

  1. Open Ubuntu.

  2. Write the command sudo apt purge rulexplatform and press Enter key. You will be asked if you want to continue with the operation. At this point type Y as yes and press Enter key.

    https://cdn.rulex.ai/docs/Factory/ubuntu_uninstall1.webp

  3. Finally, type your username if the application was installed on your account only, press Enter key and wait until the uninstallation has been completed.

    https://cdn.rulex.ai/docs/Factory/ubuntu_uninstall4.webp

Note

If you want to know more about the difference between Purge and Remove refer to the Ubuntu technical documentation.

Note

This uninstallation procedure applies also if the application was installed silently.

The installation on Darwin follows the steps below:

  1. Download the installer.

  2. Double-click on the downloaded installer file.

  3. Drag the Rulex Platform icon onto the Applications folder icon following the arrow’s direction in the window that automatically appears.

    https://cdn.rulex.ai/docs/Factory/darwin1.webp

  4. Eject the application from the desktop or from the Locations list located in the left panel of the Finder.

  5. In the Finder, double-click the application to launch it. Therefore, a progress bar will show you the status.

    https://cdn.rulex.ai/docs/Factory/darwin2.webp

  6. At this point a message will inform you that the application has been downloaded from the internet and that Apple verified that it is safe. Click Open to ultimate the application launch.

    https://cdn.rulex.ai/docs/Factory/darwin3.webp

  7. Click CLOSE when the Operation Forbidden message appears.

    https://cdn.rulex.ai/docs/Factory/darwin4.webp

  8. Insert the requested product key in the corresponding box.

    https://cdn.rulex.ai/docs/Factory/darwin5.webp

  9. Wait few seconds for Rulex Platform main page to load. Once you have selected the component to open, an error message could appear. In this case you simply refresh the page by clicking on the View option and select Reload or by pressing Command + R.

    https://cdn.rulex.ai/docs/Factory/darwin6.webp

Warning

If you want to uninstall the application, you must delete it by moving it into the trash bin. However, by deleting the application, the product key is not automatically removed.

In order to delete the product key as well, you must open the Library and delete the entire RulexPlatform folder.

Standalone silent installation#

In some occurrences you need to install Rulex Platform standalone silently through an automatic script.

&".\rulex_platform_installer_x.x.x-x.exe" /S /allusers /PK="xxxxx-xxxxx-xxxxx-xxxxx-xxxxx"

Where the optional listed arguments perform the following:

  • /S launches an installer in silent mode

  • /allusers launches an installer for all users

  • /PK=”myproductkey” passes a product key to a silent installer

If the operation is successful, the command returns 0, while if it fails, it returns an error code.

Possible error codes are listed in the table below:

Exit Code

Meaning

101

Error in loading DLL dependencies of installer plugins.

102

Error in retrieving product key.

103

Error in license manager service connection.

104

Product key has a bad format.

105

Error in license manager service logout.

106

Product key does not exist.

107

Error in accessing Windows Registry for Product Key.

108

Error in accessing Windows Registry for admins.

109

Error in encrypting settings files.

110

Error in selecting an installation for all users without entering a Factory Enterprise product key.

  1. Edit the Ubuntu environment file, located at the path /etc/environment and add the following rows:

    • export RULEX_ALLUSERS=0/1 (choose 0 if you want the installation to be ‘only for me’ or 1 if you want to install it for all users)

    • export RULEX_PRODUCT_KEY=your_product_key

    • export RULEX_CONFIGURATION_FILE=SKIP/PATH_TO_FILE (type ‘SKIP’ if no configuration file will be specified)

    • export RULEX_USERNAME=your_username

  2. Start the installation by typing sudo dpkg -i installer_name.deb

Cloud version#

Rulex Platform Cloud deployment is completely automated using the modern HELM technology which permits to script all the delivery procedure.

The following items are needed before installing the cloud version of Rulex Platform:

  • Helm Chart which acts as a package manager to manage and deploy applications in a cluster.

  • Product Key

  • First User Access, if Rulex Authentication Server is deployed.

Note

These items will be provided by the Rulex Sales team before installation.

The following prerequisites are the minimum parameters required to deploy Rulex Platform cloud:

Prerequisites

Area

Minimum values (if applicable) / notes

Orchestrator services

Kubernetes (1.25.x or higher) or OpenShift (4.12.x or higher).

Cluster

The cluster must be sized according to the established usage, the minimum required is 4 nodes, each one with 8 vCPU, 32 GB Ram.

Ingress Controller

HTTP 2 must be enabled.

TLS Certificate

DNS

The DNS must be configured to connect to the cluster.

NFS Filesystem

The system must belong to a Storage Class Read-Write Many, with 1800 IOPS and a size of 2TB.

RabbitMQ operator

RabbitMQ will be used as an internal broker.

Docker registry

This docker registry must be mirrored with Rulex Docker Registry to download base images of Rulex Platform microservices.

Helm

Helm must be installed in the same environment as the Kubernetes CLI (or OpenShift CLI in the case of an OpenShift Orchestrator).

Network Connectivity

The client must have access to the Rulex License Manager: https://licensemanager.rulex.cloud/license

The following requirements are optional, depending on customer’s needs:

  • Database PostgreSQL, if Rulex Authentication Server is present. The following are recommended:

    • Azure Database for PostgreSQL,

    • Amazon RDS for PostgreSQL,

    • BigAnimal,

    • Cloud SQL for PostgreSQL,

    • Crunchy Bridge,

    • Crunchy PostgreSQL for Kubernetes,

    • EnterpriseDB.

  • Keda, to enable Rulex Platform autoscaling.

  • Service Mesh operator, to further encrypt AMQPS calls and convert them into standard HTTPS calls (Istio Service Mesh is recommended).

To deploy Rulex Platform cloud, follow the steps below:

Procedure

  1. Define the required parameters in the YAML settings file, whose values will then be used in the PowerShell command in Step 2.

    The following are the most important arguments to set:

    Argument

    Name

    Description

    Type

    Name

    platform.hostname

    Domain name assigned to the cluster.

    string

    Authentication Server

    msAuth.enable

    If true, the authentication server will be installed.

    bool

    Authentication Server Username

    msAuth.adminUsername

    Authentication server admin username.

    string

    Authentication Server Password

    msAuth.adminPassword

    Authentication server admin password.

    string

    Persistent volume configurations

    persistentVolume.enable

    If true, a persistent volume and the secret with the StorageAccount credentials are created.

    bool

    Persistent volume Storage class

    persistentVolumeClaim.storageClassName

    Name of the storage class.

    string

    Persistent volume Storage definition

    persistentVolume.storageDefinition

    Storage account driver and configuration.

    yaml

    Persistent volume Storage account secret

    persistentVolume.storageAccountSecret

    Storage account authentication secret.

    yaml

    Tip

    The complete list of mandatory and optional parameters is available in the dedicated page: Cloud Settings (YAML).

    Optional values have default values, which are used if such parameters are not specified in the YAML file. It is possible to find more information about the YAML format at the following link: https://yaml.org/.

    An example of value settings in a YAML configuration file is described below.

    platform:
   hostname: <to_fill>
msAuth:
   enable: true
   adminUsername: <username>
   adminPassword: <password>
persistentVolumeClaim:
   enable: true
   storageClassName: <to_fill>
persistentVolume:
   enable: true
   storageDefinition: {}
   storageAccountSecret: {}

  2. Launch the following PowerShell commands:

    $values_settings = "<file that contains all helm settings>"

# Deploy Rulex Platform
helm install platform $helm_registry/platform --values $values_settings

# installation of the infrastructure
helm install infrastructure $helm_registry/infrastructure --values $values_settings

  3. Finalize the deployment during your first access

    After the deployment has been completed, log in into Rulex Platform using the URL <hostname>/web (e.g. test.rulex.cloud/web).

    Warning

    The above-mentioned steps cover the standard scenario where the Rulex Authentication Server has been deployed.