New Project Deployment

1. To ensure the stability of the stored cluster log:

• The Elasticsearch suite must be installed during the containerized deployment of a cluster, no longer an optional installation item.

• Installed the Filebeat component on each project node when installing Elasticsearch.

2. A help folder was created in the mounting directory of the project during deployment.

1. Relaxed the restrictions on project names by supporting English uppercase and Chinese characters.

2. Supported the use of external shared directories as file servers for deploying new clusters.

3. Allowed empty access paths in Project Setting.

1. Allowed filling in an extranet IP address in Node Configuration to adapt to servers where intranet access was supported only when the intranet IP address was mapped to an extranet IP address.

2. Allowed suspending deployment to stop the deployment and remove the operations made.

3. Increased the default limit of Xmx of deployed FineBI components to reduce the risk of out-of-memory (OOM) kill error.

• Before optimization: The default value of Xmx equaled machine memory minus 8 GB.

• After optimization: The default value of Xmx equaled machine memory minus 10 GB.

1. Lowered the resource requirements as the node_exporter, nginx_exporter, and elasticsearch_exporter components were deleted, whose functions were merged into the OPS Agent component, which could be used to collect the indicator information of the server and components.

2. Deployed the FanRuan Internal Gateway component by default during standalone deployment to facilitate the subsequent SSL configuration and capacity expansion.

1. Limited the number of application servers of FineOps-deployed projects, with five nodes as the upper limit.

2. Supported the deployment of dual-node internal gateway components for FineOps-deployed cluster projects.

3. Optimized the interaction of deploying a new project by adjusting the entry for configuring component ports, avoiding missing configuration checks.

Supported the use of self-prepared Elasticsearch of 8.x and above versions.

Added Environment Check to check the deployment environment and provide prompts.

V2.9.0 

Supported the deployment of new projects with minimal resource demands in the Trial Environment, which was tailored for low-usage scenarios such as product trials and functional testing.

Deployed the Engine - Metadata Node and MinIO components of FineBI 6.1 projects on the first added main application node.

1. Added a Deployment Time Zone setting item in Project Setting, with validation in Node Configuration to ensure alignment between the server time zone and the deployment time zone.

2. Added port conflict prompts and provided available port suggestions in Deployment List.

FineOps deployment

Deploy FineOps.

FanRuan applications rely on FineOps for deployment, which should be deployed in advance.

1. Know various types of O&M projects.

FanRuan provides multiple products including FineBI, FineReport, and FineDataLink. Confirm the required product type.

2. Understand the role of each component of O&M projects.

The projects deployed by FineOps include projects, supporting external configuration databases, clustered components, O&M components, and so on. Understand the role of each component and determine whether to install them.

• For FineBI project, see: 

Confirming Server Configuration of the FineBI Project 

Confirming Server Network of the FineBI Project

Preparing the FineBI Mounting Directory

• For FineReport projects, see:

Confirming Server Configuration of the FineReport Project

Confirming Server Network of the FineReport Project

Preparing the FineReport Mounting Directory

• For FineDataLink projects:

Confirm the server configuration of the FineDataLink project. 

Confirm the server network of the FineDataLink project. 

Prepare the mounting directory of the FineDataLink project.

Confirm that the image repository supports the connection to the FanRuan cloud repository.

Images are required to deploy components in a new project. Ensure that it is supported to pull images from the cloud or prepare images in the image repository.

FineOps Xmx configuration

Integrating projects with FineOps may consume some FineOps server resources. 

The new project cannot be deployed if the configured FineOps resources are insufficient. It will prompt "The FineOps configuration has reached the upper limit, and no new projects are supported. Proceed as follows as soon as possible: Increase the Xmx value."

1. Choose Platform Management > O&M Component, and click the Modify Configuration button of the OPS component. 

2. Configure the Xmx value as prompted to ensure the new project can be deployed.

You can customize the project name.

The project name cannot be empty.

Only Chinese characters, English letters (upper and lower cases), and numbers are supported.

The project name length cannot exceed 12 digits.

The project name cannot be duplicated with an existing project name.

FineOps 2.7.0 and earlier releases support FineReport, FineBI 6.0, and FineDataLink projects. 

FineOps 2.7.1 and later releases support FineReport, FineBI 6.1, and FineDataLink projects.

A single FineReport/FineDataLink project can have one to five application service(s) deployed via FineOps.

For a FineBI 6.1 project, an Engine - Metadata Node component must be deployed. The application services include BI applications and worker components, with a mandatory 1:1 or 1:2 ratio to balance the project.

The access link of the application is Domain name/IP address/Path/decision.

You can customize the path to access the application, which defaults to webroot.

The path can include English letters and numbers or be left empty.

Note

:

To access the project through a short domain name or IP address, you must keep Path empty. The configuration cannot be changed once the project is successfully deployed. The access path of the root directory corresponding to the project is http://IP address:Port number/root.

• Formal Environment: The deployment environment is checked strictly following requirements for production environments to ensure normal functionality.

• Trial Environment: Choose it with caution! Memory size and disk space of the server required for project deployment are not checked. Functionality is limited, and large data usage is restricted.

Enter the time zone used for deploying components in the standard IANA time zone format.

You are advised to set it to the time zone of the project server.

If the input value does not conform to the IANA time zone format, the system will prompt "Enter the correct time zone."

Basic Component

You can choose the components to install and decide whether to deploy FanRuan-prepared components and whether to access user-prepared components. The components that must be installed are not included here.

Component	Note
Data Storage Service	It is exclusive to FineBI 6.1 projects, used to store and share data resources within FineBI, ensuring accessibility from each node. 1. You are advised to use a self-provided simple storage service (S3) such as Alibaba Cloud OSS, Huawei Cloud OBS, Amazon S3, and other cloud storage service systems. 2. You can install one MinIO component on the first main application node of the project. Note : 1. Starting from V2.18.0, the use of shared external directories as data storage services is no longer supported.   2. FineOps 2.18.0 and later releases allow you to change the data storage service. For projects using the shared external directory, you are advised to use an S3 component for data storage instead.   3. If MinIO is used as the data storage component, you are advised to format the server's disk with XFS.
FanRuan Internal Gateway	1. FanRuan internal gateway has experienced custom development based on FanRuan business to balance user requests and improve performance. Therefore, self-provided gateways are not supported. 2. You cannot configure SSL for single-application projects through FineOps if do not deploy the internal gateway component. 3. The dual-node internal gateway consists of two independent nodes and does not operate as a cluster.
Log Service	For single-application projects, Swift (LogDB) that comes with the product will be enabled for log storage if you do not deploy a log service. For multi-application projects, you must use a self-provided Elasticsearch component if do not choose Deploy Elasticsearch, or else the project cannot be deployed. Elasticsearch 8.x and later releases are supported. The link address shall be in a format similar to https://lP address:Port number.
File Service	For cluster components, you must use a self-provided file server if do not choose Deploy MinIO, or else the project cannot be deployed. The supported file server types include SFTP, FTP, and shared external directories. You can log in to the project after it is successfully deployed and switch the file server as needed.  For details, see Introduction to MinIO File Server.
External Configuration Database	You must prepare an extra external configuration database if do not install the FineOps MySQL component, or else the project cannot be deployed. The supported database types include MySQL 5, MySQL 8, RDS MySQL, and Oracle. (MySQL 8 is not supported by V1.14.0 and earlier versions.) You can log in to the project after it is successfully deployed and switch the external configuration database as needed.
State Server	For multi-node projects, you must prepare an extra state server if do not deploy the FineOps Redis component, or else the project cannot be deployed. The supported state server types include Redis Standalone and Redis Cluster. You can log in to the project after it is successfully deployed and switch the state server as needed.
Pipeline Task	For FineDataLink projects, the functions related to pipeline tasks are unusable if the Kafka component is not installed. You can log in to the project after project deployment and connect to a self-provided Kafka. Only standalone Kafka or a single-node of Kafka clusters is supported. You cannot connect to a Kafka cluster through the load-balancing mechanism.

Select Main Application.

Note

:

The FanRuan project requires an exclusive server. You are advised not to deploy other projects or contents, including FineOps on a main application server.

Enter the host IP address (intranet IP address) of the node.

Note:

You cannot add a host repetitively to the same project. 

Enter a server username with sudo permission.

The supported verification methods include Password and Public Key.

Note:

1. The password and the key are solely used for project deployment and are not required post-deployment. The connection between the project and FineOps relies on platform configuration. Therefore, subsequent changes to the server password will not impact O&M and monitoring.

2. If public key authentication is selected, upload a private key file with the extension .key, .pem, or .crt (for example, id_rsa.key). Do not upload private key files with other extensions or public key files such as id_rsa.pub.

Enter the node installation directory on the server, which is the mounting directory set in the pre-preparation phase.

The default directory is ~/data, which is the data folder in the home directory of the server being used.

Note:

You can use the user account to access the server in the terminal and enter the echo $HOME command to view the home directory.

Optional

If the server does not support intranet access unless the intranet IP address is mapped to an extranet IP address, you must fill in a connectable extranet IP address.

Select Component.

Note:

1. If multiple component nodes are configured, the components are randomly deployed on these nodes.

2. The FanRuan project requires an exclusive server. You are advised not to deploy other projects or contents, including FineOps on a component server.

Enter the host IP address (intranet IP address) of the node.

Note:

You cannot add a host repetitively to the same project.

Enter a server username with sudo permission.

The supported verification methods include Password and Public Key.

Note:

1. The password and the key are solely used for project deployment and are not required post-deployment. The connection between the project and FineOps relies on platform configuration. Therefore, subsequent changes to the server password will not impact O&M and monitoring.

2. If public key authentication is selected, upload a private key file with the extension .key, .pem, or .crt (for example, id_rsa.key). Do not upload private key files with other extensions or public key files such as id_rsa.pub.

Enter the node installation directory on the server, which is the mounting directory set in the pre-preparation phase.

The default directory is ~/data, which is the data folder in the home directory of the server being used.

Note:

You can use the user account to access the server in the terminal, and enter the echo $HOME command to view the home directory.

Optional

If the server does not support intranet access unless the intranet IP address is mapped to an extranet IP address, you can fill in a connectable extranet IP address.