Overview
You can use FineOps to deploy FineReport 11.0 projects.
This document offers four standard deployment schemes based on user volumes and business usage. Choose the one that best meets your needs.
Scheme Selection
The schemes in this document are designed for new project deployment scenarios, providing recommended server configuration based on user volumes and business usage.
Uncertain Usage
If you are uncertain about the business usage, you can estimate the user volume based on the number of employees and select the corresponding scheme.
Mismatch Between User Volume and Business Usage
If the user volume and business usage corresponds to different schemes, choose the scheme with higher configuration.
For example, if the number of registered users is 1800 (which corresponds to Scheme One) and the number of concurrent scheduled tasks is 90 (which corresponds to Scheme Two), you should select Scheme Two that requires higher configuration.
Increased Growth
As usage increases over time, if your current server resources become insufficient and require expansion, contact FanRuan technical support personnel for assistance.
| Usage Type | Usage Description | Minimum Configuration Scheme | Scheme One Standalone (Elementary) | Scheme Two Standalone (Recommended) | Scheme Three Dual-Node Cluster | Scheme Four Multi-node Cluster |
|---|---|---|---|---|---|---|
User Volume | ||||||
| Number of registered users | Number of FineReport system users You can estimate it based on the number of employees. | < 1000 | < 2000 | < 4000 | < 8000 | < 4000 * N |
| Number of concurrent users | Number of users sending requests to the FineReport system per minute You can estimate it following Number of registered users * (0.5% to 5%). | < 50 | < 100 | < 200 | < 400 | < 200 * N |
Business Usage - Template Data Volume | ||||||
| Number of data rows in a single dataset | Maximum number of data rows in a single dataset in templates that are viewed/exported/printed | < 300 thousand | < 500 thousand | < 1 million | < 1 million | < 1 million |
| Number of cells in a single template | Maximum number of cells (Row count * Column count) in a single template that is viewed/exported/printed | < 500 thousand | < 1 million | < 3 million | < 3 million | < 3 million |
| Total number of cells | Total number of template cells in all active sessions in the FineReport system For multi-node clusters, this must be calculated based on the number of sessions across all nodes. | < 5 million | < 10 million | < 40 million | < 40 million * 2 | < 40 million * N |
| Business Usage - Export and Print Concurrency | ||||||
| Number of concurrent exports using large datasets | Number of concurrent template exports using large datasets in the FineReport system | < 30 | < 30 | < 60 | < 120 | < 60 * N |
| Number of regular prints per second | Number of template prints per second in the FineReport system | < 30 | < 30 | < 30 | < 60 | < 30 * N |
| Number of custom streaming interface prints per second | Number of template prints per second using custom streaming interfaces in the FineReport system | < 1000 | < 1000 | < 1000 | < 1000 | < 1000 * N |
Business Usage - Data Entry | ||||||
| Number of Excel cells per import | Maximum number of cells (Row count * Column count) imported from the Excel file per import during data submission | < 500 thousand | < 1 million | < 1 million | < 1 million | < 1 million |
| Number of cells submitted to the database per submission | Maximum volume of data submitted to the database per submission | < 500 thousand | < 1 million | < 1 million | < 1 million | < 1 million |
| Business Usage - Scheduled Task Concurrency | ||||||
| Number of concurrent scheduled tasks | Number of concurrent scheduled tasks running in the FineReport system | < 50 | < 100 | < 100 | < 200 | < 100 * N |
Scheme and Configuration
| Scheme | Description | Server Configuration |
|---|---|---|
| Minimum Configuration Scheme | It is designed for customers with minimal business usage. | It is designed for customers with minimal business usage only, where FineReport and FineOps can be deployed on one server. Main application server: 8-core CPU, 32 GB of memory, and 300 GB of disk space It is used to deploy the FineReport application and components including Nginx (the internal gateway), MySQL (the configuration database), and Elasticsearch (the log storage service provider). It is used to deploy all FineOps components. |
| Scheme One | It provides recommended elementary configuration for single-node projects. | 1. FineReport main application server: 8-core CPU, 32 GB of memory, and 200 GB of disk space It is used to deploy the FineReport application. 2. Server for FineReport components and FineOps: 8-core CPU, 32 GB of memory, and 300 GB of disk space It is used to deploy the following components: Nginx, MySQL, and Elasticsearch. It is used to deploy all FineOps components. |
| Scheme Two | It provides recommended advanced configuration for single-node projects. | 1. FineReport main application server: 16-core CPU, 64 GB of memory, and 200 GB of disk space It is used to deploy the FineReport application. 2. Server for FineReport components and FineOps: 8-core CPU, 32 GB of memory, and 300 GB of disk space It is used to deploy the following components: Nginx, MySQL, and Elasticsearch. It is used to deploy all FineOps components. |
| Scheme Three | It provides the optimal configuration for dual-node clusters. | 1. FineReport main application server one: 16-core CPU, 64 GB of memory, and 200 GB of disk space It is used to deploy the FineReport application. 2. FineReport main application server two: 16-core CPU, 64 GB of memory, and 200 GB of disk space It is used to deploy the FineReport application. 3. FineReport component server: 4-core CPU, 16 GB of memory, and 300 GB of disk space It is used to deploy the following components: Nginx, MySQL, Elasticsearch, and the cluster component. 4. FineOps server: 4-core CPU, 16 GB of memory, and 200 GB of disk space It is used to deploy all FineOps components. |
| Scheme Four | It provides the optimal configuration for multi-node clusters. | 1. Number of main application servers: N (Number of registered users/4000) Each main application server: 16-core CPU, 64 GB of memory, and 200 GB of disk space Each main application server is used to deploy a FineReport application. 2. Component server: 8-core CPU, 32 GB of memory, and 500 GB of disk space It is used to deploy the following components: Nginx, MySQL, Elasticsearch, and the cluster component. 3. FineOps server: 4-core CPU, 16 GB of memory, and 100 GB + 50 * N GB of disk space It is used to deploy all FineOps components. |
Minimum Configuration Scheme
Note: This scheme is intended for customers with little business usage and limited server resources only. All components of FineReport and FineOps are deployed on one server.
Ensure the usage meets the following requirements: The number of system users, concurrent users, data rows in a single dataset, cells in a single template, and total cells is less than 1000, 50, 300 thousand, 500 thousand, and five million, respectively.
It requires one main application server with 8-core CPU, 32 GB of memory, and 300 GB of disk space.
It is used to deploy the FineReport application and components including Nginx (the internal gateway), MySQL (the configuration database), and Elasticsearch (the log storage service provider).
It is used to deploy all FineOps components.
| Configuration | FineReport and FineOps Server | |
|---|---|---|
Component to be installed | 1. It is used to install the FineReport project as well as log and configuration components. For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.
2. It is used to install FineOps. For details about the role of FineOps components, see Understanding the Roles of FineOps Components. Note:
| |
| Basic server requirement | Non-VM (Recommended) | Due to the nature of virtual machines, such as competing for resources, unexpected system failures may occur. Therefore, you are not advised to deploy FanRuan applications on virtual machines. |
| Operating system | Operating system type | Linux |
| Operating system architecture | X86_64 | |
| Operating system kernel | Version 3.10 and above | |
| Operating system software | Recommended: Ubuntu 22 Supported: Ubuntu 18.04.4 and later releases (Ubuntu 20.04 is not supported.) CentOS 7.3 to 7.9 Red Hat 7.6 and later releases Rocky Linux 8.8 to 9.4 Note:1. Since CentOS is discontinued, you are advised to use Ubuntu. 2. When using Ubuntu, verify the user privilege (as the default root user is not a super administrator) and confirm that the disk type is XFS. For details, see notes in the following content. | |
| CPU | CPU core quantity | 8 cores |
CPU clock speed | 2.4 GHz and above | |
| Memory | Remaining free physical memory | 32 GB |
| Disk | Remaining free disk space | The server shall have a partition with remaining free space of more than 300 GB. Note: |
| Disk performance | The disk read/write speed must be greater than 100 MB/s. | |
| Mounting directory | Mounting directory preparation | For details, see Preparing the FineReport Mounting Directory. For details, see Preparing the FineOps Server. Note: |
| File system auto-mounting | Ensure that the file system of the mounting directory is configured to be automatically mounted during a boot. Otherwise, containers may fail to access these directories, leading to data loss or application startup issues. | |
| Non-shared path | The mounting directory cannot be a shared-use path. Sharing the file system may cause performance degradation, file permission issues, and data inconsistency, affecting the reliability and response speed of applications running in the container. | |
| Permission and command | Tar command | Ensure the server has the tar command installed. The tar command is a commonly used tool for packaging and compressing files. FineOps requires this command for file extraction. |
| Sed command | Ensure the server has the sed command installed. The sed command is used for text processing. FineOps requires this command for text processing. | |
| Sudo privilege | The server user responsible for deploying the project must have the necessary sudo privileges. 1. Using the root user (superuser) for project deployment and operation is preferred. 2. To use a non-root user for deployment and operation, see Linux User Privilege Explanation. Note: | |
| Port and network | Intranet latency | Less than 1 ms |
| Server intranet bandwidth (between the application and the business database) | At least 100 MB/s | |
| Server extranet bandwidth (between the project and the client) | At least 100 Mbps (12.5 MB/s) Note:1. As the concurrent volume of project sessions increases, scale resources accordingly. 2. External bandwidth requirements can be appropriately lowered if the connected business database and self-prepared components operate in the intranet environment. | |
Component-used port and component port interconnection | For details, see Confirming the FineReport Server Network. For details, see Preparing the FineOps Server. | |
Scheme One
It requires two servers:
1. FineReport main application server: 8-core CPU, 32 GB of memory, and 200 GB of disk space
It is used to deploy the FineReport application.
2. Server for FineReport components and FineOps: 8-core CPU, 32 GB of memory, and 300 GB of disk space
It is used to deploy the following components: Nginx, MySQL, and Elasticsearch.
It is used to deploy all FineOps components.
| Configuration | FineReport Main Application Server | Server for FineReportComponents and FineOps | |
|---|---|---|---|
Component to be installed | It is used to install the FineReport project. For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.
| 1. It is used to install the log and configuration components of the FineReport project. For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.
2. It is used to install FineOps. For details about the role of FineOps components, see Understanding the Roles of FineOps Components. Note:
| |
| Basic server requirement | Time consistency | The time on all servers must be synchronized, with a maximum difference of no more than 5 seconds. Inconsistent server time can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies. | |
Time zone consistency | All servers must be set to the same time zone. Inconsistent server time zones can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies. | ||
| Interconnection with intranet | All servers can communicate with each other on the intranet or have open ports for access. For details, see the following content. | ||
| Non-VM (Recommended) | Due to the nature of virtual machines, such as competing for resources, unexpected system failures may occur. Therefore, you are not advised to deploy FanRuan applications on virtual machines. | ||
| Operating system | Operating system type | Linux | |
| Operating system architecture | X86_64 | ||
| Operating system kernel | Version 3.10 and above | ||
| Operating system software | Recommended: Ubuntu 22 Supported: Ubuntu 18.04.4 and later releases (Ubuntu 20.04 is not supported.) CentOS 7.3 to 7.9 Red Hat 7.6 and later releases Rocky Linux 8.8 to 9.4 Note:1. Since CentOS is discontinued, you are advised to use Ubuntu. 2. When using Ubuntu, verify the user privilege (as the default root user is not a super administrator) and confirm that the disk type is XFS. For details, see notes in the following content. | ||
| CPU | CPU core quantity | 8 cores | 8 cores |
CPU clock speed | 2.4 GHz and above | ||
| Memory | Remaining free physical memory | 32 GB | 32 GB |
| Disk | Remaining free disk space | The server shall have a partition with remaining free space of more than 200 GB. Note:1. There must be a single partition that meets the condition. | The server shall have a partition with remaining free space of more than 300 GB. Note:1. There must be a single partition that meets the condition. 2. The required disk space decreases if you use self-prepared components. If you use a self-provided Elasticsearch component, the required remaining free disk space on the server can be reduced by 100 GB. If you use a self-provided external configuration database component, the required remaining free disk space on the server can be reduced by 50 GB. |
| Disk performance | The disk read/write speed must be greater than 100 MB/s. | ||
| Mounting directory | Mounting directory preparation | For details, see Preparing the FineReport Mounting Directory. Note: | For details, see Preparing the FineOps Server. Note: |
| File system auto-mounting | Ensure that the file system of the mounting directory is configured to be automatically mounted during a boot. Otherwise, containers may fail to access these directories, leading to data loss or application startup issues. | ||
| Non-shared path | The mounting directory cannot be a shared-use path. Sharing the file system may cause performance degradation, file permission issues, and data inconsistency, affecting the reliability and response speed of applications running in the container. | ||
| Permission and command | Tar command | Ensure the server has the tar command installed. The tar command is a commonly used tool for packaging and compressing files. FineOps requires this command for file extraction. | |
| Sed command | Ensure the server has the sed command installed. The sed command is used for text processing. FineOps requires this command for text processing. | ||
| SSH | Ensure you can connect to the FineOps server via the SSH protocol. Ensure the password used for SSH connection contains no single English quotation marks, otherwise, the permission will fail to be validated during deployment. | ||
| Sudo privilege | The server user responsible for deploying the project must have the necessary sudo privileges. 1. Using the root user (superuser) for project deployment and operation is preferred. 2. To use a non-root user for deployment and operation, see Linux User Privilege Explanation. Note: | ||
| Port and network | Intranet latency | Less than 1 ms | |
| Server intranet bandwidth (between the application and the business database) | At least 100 MB/s | ||
| Server extranet bandwidth (between the project and the client) | At least 100 Mbps (12.5 MB/s) Note:1. As the concurrent volume of project sessions increases, scale resources accordingly. 2. External bandwidth requirements can be appropriately lowered if the connected business database and self-prepared components operate in the intranet environment. | At least 50 Mbps (6.25 MB/s) | |
Component-used port and component port interconnection | For details, see Confirming the FineReport Server Network. | For details, see Confirming the FineReport Server Network. For details, see Preparing the FineOps Server. | |
Scheme Two
It requires two servers:
1. FineReport main application server: 16-core CPU, 64 GB of memory, and 200 GB of disk space
It is used to deploy the FineReport application.
2. Server for FineReport components and FineOps: 8-core CPU, 32 GB of memory, and 300 GB of disk space
It is used to deploy the following components: Nginx, MySQL, and Elasticsearch.
It is used to deploy all FineOps components.
| Configuration | FineReport Main Application Server | Server for FineReportComponents and FineOps | |
|---|---|---|---|
Component to be installed | It is used to install the FineReport project. For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.
| 1. It is used to install the log and configuration components of the FineReport project. For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.
2. It is used to install FineOps. For details about the role of FineOps components, see Understanding the Roles of FineOps Components. Note:
| |
| Basic server requirement | Time consistency | The time on all servers must be synchronized, with a maximum difference of no more than 5 seconds. Inconsistent server time can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies. | |
Time zone consistency | All servers must be set to the same time zone. Inconsistent server time zones can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies. | ||
| Interconnection with intranet | All servers can communicate with each other on the intranet or have open ports for access. For details, see the following content. | ||
| Non-VM (Recommended) | Due to the nature of virtual machines, such as competing for resources, unexpected system failures may occur. Therefore, you are not advised to deploy FanRuan applications on virtual machines. | ||
| Operating system | Operating system type | Linux | |
| Operating system architecture | X86_64 | ||
| Operating system kernel | Version 3.10 and above | ||
| Operating system software | Recommended: Ubuntu 22 Supported: Ubuntu 18.04.4 and later releases (Ubuntu 20.04 is not supported.) CentOS 7.3 to 7.9 Red Hat 7.6 and later releases Rocky Linux 8.8 to 9.4 Note:1. Since CentOS is discontinued, you are advised to use Ubuntu. 2. When using Ubuntu, verify the user privilege (as the default root user is not a super administrator) and confirm that the disk type is XFS. For details, see notes in the following content. | ||
| CPU | CPU core quantity | 16 cores | 8 cores |
CPU clock speed | 2.4 GHz and above | ||
| Memory | Remaining free physical memory | 64 GB | 32 GB |
| Disk | Remaining free disk space | The server shall have a partition with remaining free space of more than 200 GB. Note:1. There must be a single partition that meets the condition. 2. The required disk space decreases if you use self-prepared components. If you use a self-provided Elasticsearch component, the required remaining free disk space on the server can be reduced by 100 GB. If you use a self-provided external configuration database component, the required remaining free disk space on the server can be reduced by 50 GB. | The server shall have a partition with remaining free space of more than 300 GB. Note:There must be a single partition that meets the condition. |
| Disk performance | The disk read/write speed must be greater than 100 MB/s. | ||
| Mounting directory | Mounting directory preparation | For details, see Preparing the FineReport Mounting Directory. Note: | For details, see Preparing the FineOps Server. Note: |
| File system auto-mounting | Ensure that the file system of the mounting directory is configured to be automatically mounted during a boot. Otherwise, containers may fail to access these directories, leading to data loss or application startup issues. | ||
| Non-shared path | The mounting directory cannot be a shared-use path. Sharing the file system may cause performance degradation, file permission issues, and data inconsistency, affecting the reliability and response speed of applications running in the container. | ||
| Permission and command | Tar command | Ensure the server has the tar command installed. The tar command is a commonly used tool for packaging and compressing files. FineOps requires this command for file extraction. | |
| Sed command | Ensure the server has the sed command installed. The sed command is used for text processing. FineOps requires this command for text processing. | ||
| SSH | Ensure you can connect to the FineOps server via the SSH protocol. Ensure the password used for SSH connection contains no single English quotation marks, otherwise, the permission will fail to be validated during deployment. | ||
| Sudo privilege | The server user responsible for deploying the project must have the necessary sudo privileges. 1. Using the root user (superuser) for project deployment and operation is preferred. 2. To use a non-root user for deployment and operation, see Linux User Privilege Explanation. Note: | ||
| Port and network | Intranet latency | Less than 1 ms | |
| Server intranet bandwidth (between the application and the business database) | At least 100 MB/s | ||
| Server extranet bandwidth (between the project and the client) | At least 100 Mbps (12.5 MB/s) Note:1. As the concurrent volume of project sessions increases, scale resources accordingly. 2. External bandwidth requirements can be appropriately lowered if the connected business database and self-prepared components operate in the intranet environment. | At least 50 Mbps (6.25 MB/s) | |
Component-used port and component port interconnection | For details, see Confirming the FineReport Server Network. | For details, see Preparing the FineOps Server. | |
Scheme Three
It requires four servers, namely, two main application servers, one component server, and one FineOps server.
FineReport main application server one: 16-core CPU, 64 GB of memory, and 200 GB of disk space, used to deploy one FineReport application
FineReport main application server two: 16-core CPU, 64 GB of memory, and 200 GB of disk space, used to deploy one FineReport application
FineReport component server: 8-core CPU, 16 GB of memory, and 300 GB of disk space, used to deploy Nginx, MySQL, Elasticsearch, and the cluster component
FineOps server: 4-core CPU, 16 GB of memory, and 120 GB of disk space, used to deploy all FineOps components
| Configuration | FineReport Main Application Server One | FineReport Main Application Server Two | FineReport Component Server | FineOps Server | |
|---|---|---|---|---|---|
Component to be installed | It is used to install the FineReport project. For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.
| It is used to install the FineReport project. For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.
| 1. It is used to install the FineReport cluster as well as log and configuration components. For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.
| It is used to install FineOps. For details about the role of FineOps components, see Understanding the Roles of FineOps Components. Note:1. If you have installed FineOps, skip the content in this column. 2. If the FineReport component and FineOps are to be deployed on the same server, the server's configuration should be the combined total of required configuration of the FineReport component server and the FineOps server.
| |
| Basic server requirement | Time consistency | The time on all servers must be synchronized, with a maximum difference of no more than 5 seconds. Inconsistent server time can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies. | |||
Time zone consistency | All servers must be set to the same time zone. Inconsistent server time zones can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies. | ||||
| Interconnection with intranet | All servers can communicate with each other on the intranet or have open ports for access. For details, see the following content. | ||||
| Non-VM (Recommended) | Due to the nature of virtual machines, such as competing for resources, unexpected system failures may occur. Therefore, you are not advised to deploy FanRuan applications on virtual machines. | ||||
| Operating system | Operating system type | Linux | |||
| Operating system architecture | X86_64 | ||||
| Operating system kernel | Version 3.10 and above | ||||
| Operating system software | Recommended: Ubuntu 22 Supported: Ubuntu 18.04.4 and later releases (Ubuntu 20.04 is not supported.) CentOS 7.3 to 7.9 Red Hat 7.6 and later releases Rocky Linux 8.8 to 9.4 Note:1. Since CentOS is discontinued, you are advised to use Ubuntu. 2. When using Ubuntu, verify the user privilege (as the default root user is not a super administrator) and confirm that the disk type is XFS. For details, see notes in the following content. | ||||
| CPU | CPU core quantity | 16 cores | 16 cores | 8 cores | 8 cores |
CPU clock speed | 2.4 GHz and above | ||||
| Memory | Remaining free physical memory | 64 GB | 64 GB | 16 GB | 16 GB |
| Disk | Remaining free disk space | The server shall have a partition with remaining free space of more than 200 GB. Note:There must be a single partition that meets the condition. | The server shall have a partition with remaining free space of more than 200 GB. Note: | The server shall have a partition with remaining free space of more than 300 GB. Note:1. There must be a single partition that meets the condition. 2. The required disk space decreases if you use self-prepared components. If you use a self-provided Elasticsearch component, the required remaining free disk space on the server can be reduced by 100 GB. If you use a self-provided external configuration database component, the required remaining free disk space on the server can be reduced by 50 GB. If you use a self-provided file storage component, the required remaining free disk space on the server can be reduced by 100 GB. | The server shall have a partition with remaining free space of more than 120 GB. Note:There must be a single partition that meets the condition. |
| Disk performance | The disk read/write speed must be greater than 100 MB/s. | ||||
Disk type | / | / | If you have not prepared the file service component, the MinIO component must be deployed, and the disk type must be XFS.Note: 1. The default disk type of Ubuntu systems is typically not XFS. Adjust it accordingly. 2. The default disk type of Alibaba Cloud servers is typically not XFS. Adjust it accordingly. 3. This operation may format the disk. FanRuan does not provide related guidance. Follow the instructions from your server vendor and proceed with caution. | / | |
| Mounting directory | Mounting directory preparation | For details, see Preparing the FineReport Mounting Directory. Note: | For details, see Preparing the FineOps Server. Note: | ||
| File system auto-mounting | Ensure that the file system of the mounting directory is configured to be automatically mounted during a boot. Otherwise, containers may fail to access these directories, leading to data loss or application startup issues. | ||||
| Non-shared path | The mounting directory cannot be a shared-use path. Sharing the file system may cause performance degradation, file permission issues, and data inconsistency, affecting the reliability and response speed of applications running in the container. | ||||
| Permission and command | Tar command | Ensure the server has the tar command installed. The tar command is a commonly used tool for packaging and compressing files. FineOps requires this command for file extraction. | |||
| Sed command | Ensure the server has the sed command installed. The sed command is used for text processing. FineOps requires this command for text processing. | ||||
| SSH | Ensure you can connect to the FineOps server via the SSH protocol. Ensure the password used for SSH connection contains no single English quotation marks, otherwise, the permission will fail to be validated during deployment. | ||||
| Sudo privilege | The server user responsible for deploying the project must have the necessary sudo privileges. 1. Using the root user (superuser) for project deployment and operation is preferred. 2. To use a non-root user for deployment and operation, see Linux User Privilege Explanation. Note: | ||||
| Port and network | Intranet latency | Less than 1 ms | |||
| Server intranet bandwidth (between the application and the business database) | At least 100 MB/s | ||||
| Server extranet bandwidth (between the project and the client) | / | / | At least 100 Mbps (12.5 MB/s) Note:1. As the concurrent volume of project sessions increases, scale resources accordingly. 2. External bandwidth requirements can be appropriately lowered if the connected business database and self-prepared components operate in the intranet environment. | At least 50 Mbps (6.25 MB/s) | |
Component-used port and component port interconnection | For details, see Confirming the FineReport Server Network. | For details, see Preparing the FineOps Server. | |||
Scheme Four
It requires N (Number of registered users/4000) main application servers, one component server, and one FineOps server.
Each main application server: 16-core CPU, 64 GB of memory, and 200 GB of disk space, used to deploy one FineReport application
Component server: 8-core CPU, 16 GB of memory, and 500 GB of disk space, used to deploy Nginx, MySQL, Elasticsearch, and the cluster component
FineOps server: 4-core CPU, 16 GB of memory, and 100 GB + 50 * N GB of disk space, used to deploy all FineOps components
| Configuration | Each FineReport Main Application Server | FineReport Component Server | FineOps Server | |
|---|---|---|---|---|
Component to be installed | It is used to install the FineReport project. For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.
| 1. It is used to install the FineReport cluster as well as log and configuration components. For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.
| It is used to install FineOps. For details about the role of FineOps components, see Understanding the Roles of FineOps Components. Note:1. If you have installed FineOps, skip the content in this column. 2. If the FineReport component and FineOps are to be deployed on the same server, the server's configuration should be the combined total of required configuration of the FineReport component server and the FineOps server.
| |
| Basic server requirement | Time consistency | The time on all servers must be synchronized, with a maximum difference of no more than 5 seconds. Inconsistent server time can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies. | ||
Time zone consistency | All servers must be set to the same time zone. Inconsistent server time zones can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies. | |||
| Interconnection with intranet | All servers can communicate with each other on the intranet or have open ports for access. For details, see the following content. | |||
| Non-VM (Recommended) | Due to the nature of virtual machines, such as competing for resources, unexpected system failures may occur. Therefore, you are not advised to deploy FanRuan applications on virtual machines. | |||
| Operating system | Operating system type | Linux | ||
| Operating system architecture | X86_64 | |||
| Operating system kernel | Version 3.10 and above | |||
| Operating system software | Recommended: Ubuntu 22 Supported: Ubuntu 18.04.4 and later releases (Ubuntu 20.04 is not supported.) CentOS 7.3 to 7.9 Red Hat 7.6 and later releases Rocky Linux 8.8 to 9.4 Note:1. Since CentOS is discontinued, you are advised to use Ubuntu. 2. When using Ubuntu, verify the user privilege (as the default root user is not a super administrator) and confirm that the disk type is XFS. For details, see notes in the following content. | |||
| CPU | CPU core quantity | 16 cores | 8 cores | 4 cores |
CPU clock speed | 2.4 GHz and above | |||
| Memory | Remaining free physical memory | 64 GB | 16 GB | 16 GB |
| Disk | Remaining free disk space | The server shall have a partition with remaining free space of more than 200 GB. Note:There must be a single partition that meets the condition. | The server shall have a partition with remaining free space of more than 500 GB. Note:1. There must be a single partition that meets the condition. 2. The required disk space decreases if you use self-prepared components. If you use a self-provided Elasticsearch component, the required remaining free disk space on the server can be reduced by 100 GB. If you use a self-provided external configuration database component, the required remaining free disk space on the server can be reduced by 50 GB. If you use a self-provided file storage component, the required remaining free disk space on the server can be reduced by 100 GB. | The server shall have a partition with remaining free space of more than 100 GB + 50 * N GB. Note:1. There must be a single partition that meets the condition. 2. The required disk space of the FineOps server increases with the number of nodes of the O&M project to be connected (if any). An extra 50 GB is required per node. |
| Disk performance | The disk read/write speed must be greater than 100 MB/s. | |||
Disk type | / | If you have not prepared the file service component, the MinIO component must be deployed, and the disk type must be XFS.Note: 1. The default disk type of Ubuntu systems is typically not XFS. Adjust it accordingly. 2. The default disk type of Alibaba Cloud servers is typically not XFS. Adjust it accordingly. 3. This operation may format the disk. FanRuan does not provide related guidance. Follow the instructions from your server vendor and proceed with caution. | / | |
| Mounting directory | Mounting directory preparation | For details, see Preparing the FineReport Mounting Directory. Note: | For details, see Preparing the FineOps Server. Note: | |
| File system auto-mounting | Ensure that the file system of the mounting directory is configured to be automatically mounted during a boot. Otherwise, containers may fail to access these directories, leading to data loss or application startup issues. | |||
| Non-shared path | The mounting directory cannot be a shared-use path. Sharing the file system may cause performance degradation, file permission issues, and data inconsistency, affecting the reliability and response speed of applications running in the container. | |||
| Permission and command | Tar command | Ensure the server has the tar command installed. The tar command is a commonly used tool for packaging and compressing files. FineOps requires this command for file extraction. | ||
| Sed command | Ensure the server has the sed command installed. The sed command is used for text processing. FineOps requires this command for text processing. | |||
| SSH | Ensure you can connect to the FineOps server via the SSH protocol. Ensure the password used for SSH connection contains no single English quotation marks, otherwise, the permission will fail to be validated during deployment. | |||
| Sudo privilege | The server user responsible for deploying the project must have the necessary sudo privileges. 1. Using the root user (superuser) for project deployment and operation is preferred. 2. To use a non-root user for deployment and operation, see Linux User Privilege Explanation. Note: | |||
| Port and network | Intranet latency | Less than 1 ms | ||
| Server intranet bandwidth (between the application and the business database) | At least 100 MB/s | |||
| Server extranet bandwidth (between the project and the client) | / | At least 100 Mbps (12.5 MB/s) Note:1. As the concurrent volume of project sessions increases, scale resources accordingly. 2. External bandwidth requirements can be appropriately lowered if the connected business database and self-prepared components operate in the intranet environment. | At least 50 Mbps (6.25 MB/s) | |
Component-used port and component port interconnection | For details, see Confirming the FineReport Server Network. | For details, see Preparing the FineOps Server. | ||
Annex
FineReport Performance Test Report
FineReport 11.0 Performance Test Report.pdf
Required Resources of FineReport Components
The configuration requirements in the above tables must be met because each component of FineReport projects has minimum operational requirements, as shown in the following table.
Note:1. To prevent resource over-provisioning, a CPU-sharing strategy is used, as the components do not run at full load simultaneously. Therefore, the required number of server CPU cores is not the total number of maximum CPU cores used by each container.
Note 2. The server memory size must be at least the total of the maximum memory used by each container, to implement the JAVA memory configuration for each container, including Xmx, off-heap memory, FineIO read/write memory, CodeCache, and Metaspace.
| Component | Maximum CPU Usage | Maximum Memory Usage | Memory Allocation (Xmx) | Disk Space |
|---|---|---|---|---|
FineReport | 8 cores | Deployed with Elasticsearch: Xmx+ 5 GB | Server memory - 8 GB 30 GB at most | 200 GB |
| Ops Agent | 1 core | 1 GB | / | / |
| Filebeat | 0.1 core | 0.3 GB | / | / |
| Elasticsearch | 1 core | 4 GB | 2 GB | 50 GB |
| Nginx | 1 core | 2 GB | / | / |
| MySQL | 2 cores | 6 GB | / | 50 GB |
| Redis | 1 core | 4.5 GB | 4 GB | / |
| MinIO | 1 core | 2 GB | / | 100 GB |
Previous：Preparing the FineBI Mounting Directory