Understanding the Roles of O&M Project Components

  • Last update: 2024-07-09
  • Overview

    Version

    FineOps Version

    Functional Change

    V2.0.0/
    V2.3.0

    Multi-application service projects (clusters) support the deployment of the nginx component (cluster) as the FanRuan internal gateway.

    V2.3.0The log service component supports the connection with self-prepared ElasticSearch of 7.10 and above versions.

    Application Scenario

    Projects (FineBI, FineReport, FineDataLink) deployed via FineOps include not only the projects, but also associated external configuration databases, cluster components, and O&M components.

    This document describes the role of each component in detail. See the following table for a brief introduction.

    Component

    Mandatory or Not

    Description

    bi-web

    Must be deployed for FineB

    FineBI application node

    bi-engine-master

    Must be deployed for FineB

    FineBI engine metadata node

    bi-engine-worker

    Must be deployed for FineB

    FineBI engine computation node

    bi-minio

    Must be deployed for FineBI and a self-prepared component is recommended

    FineBI data storage component

    fr

    Must be deployed for FineReport

    FineReport application node

    fdl

    Must be deployed for FineDataLink

    FineDataLink application node

    ops_agent

    Must be deployed

    Used to manage components, upgrade containers, and collect various indicator information of physical servers and components

    nginx

    Optional for standalone projects, but mandatory for cluster projects

    Provide the load forwarding service and serve as the service entry for projects and other cluster component 

    elasticsearch

    Optional for standalone projects, but mandatory for cluster projects

    Log storage

    filebeat

    Installed together with elasticsearch

    Log collection

    mysql

    Must be installed, and a self-prepared component is recommended

    Serve as the external configuration database to store project configuration information

    redis

    Unnecessary for standalone projects, but mandatory for cluster projects

    Serve as the state server for clusters

    minio

    Unnecessary for standalone projects, but mandatory for cluster projects

    Serve as the file server for clusters

    kafka

    Optional for FineDataLink

    Support FineDataLink Pipeline Task

    nacos

    Unnecessary for standalone FineDataLink projects, but mandatory for cluster projects

    Service registry

    nacos_mysql

    Installed together with nacosThe mysql component required for nacos services

    Essential Components

    Such components must be installed under all circumstances. They are installed by default and do not appear as selectable options of basic components during deployment.

    bi-web/bi-engine-master/bi-engine-worker

    These components are needed only for FineBI projects.


    Description

    Component Role

    bi-web/bi-engine-master/bi-engine-worker/fr/fdl

    They are project and engine node components of FineBI 6.1, with no demo data.

    One bi-engine-master component must be deployed, and bi-web and worker components must be deployed in a ratio of 1:1 or 1:2.

    Mandatory or Optional

    Must be installed

    Installation Location

    Install it on the main application node.

    Prepare main application servers at least according to the number of bi-web components, ensuring the balanced installation on each server.

    fr

    This component is needed only for FineReport projects.


    Description

    Component Role

    fr

    It is the FineReport project node component, with no demo data.

    Mandatory or Optional

    Must be installed

    Installation Location

    Install it on the main application node.

    Install one on each main application node.

    fdl

    This component is needed only for FineDataLink projects.


    Description

    Component Role

    fdl

    It is the FineDataLink project node component, with no demo data.

    Mandatory or Optional

    Must be installed

    Installation Location

    Install it on the main application node.

    Install one on each main application node.

    ops_agent


    Description

    Component Role

    Install for each physical node of the server.

    Used to manage components, upgrade containers, and collect various indicator information of physical servers and components.

    Mandatory or Optional

    Must be installed

    Installation Location

    Install it on each main application node and component node of the project.

    Basic Component

    FanRuan Internal Gateway


    Description

    Component Role

    Provide the load forwarding service and serve as the service entry for projects and other clusters.

    Mandatory or Optional

    1.  Optional for single-application service projects

    • Support the installation of the standalone nginx component, which is installed by default.

    • To use FineOps to configure SSL, you are advised to install it.

    • If the nginx component is not installed, change the external access entry from the nginx port to the bi6/fr/fdl component port.

    2.Mandatory for multi-application service projects

    • Support the installation of standalone or two-node nginx components.

    • The standalone nginx component is installed by default.

    • Self-prepared components are not supported.

    Installation Location

    It is typically installed on the component node. If there are multiple component nodes, this component will be installed on a random node. The following are special cases:

    1.For single-application service projects, when you choose to install the FanRuan internal gateway (nginx) - standalone, if no component nodes are prepared, the standalone nginx component will be installed on the main application node.

    2.  For multi-application service projects, when you choose to install the FanRuan internal gateway (nginx) - cluster, if only one component node is prepared, one nginx node will be installed on the component node, and the other node will be installed on a random main application node.

    Log Service

    The log service includes the elasticsearch component and the filebeat component.

    1.  elasticsearch


    Description

    Component Role

    Provide log storage services.

    Replace the original swift log (logdb) in the product as log storage and collect the requests from the projects, external databases, business databases, and other cluster components.

    Mandatory or Optional

    1.Optional for single-application service projects

    • If this component is not deployed, the original swift log (logdb) of the application will be used for log storage.

    • Support the installation of the elasticsearch component or connection to self-prepared external ElasticSearch of 7.10 and above versions.

    • Do not pause the component after it is successfully deployed/connected, otherwise the project operation log will be lost.

    2.Mandatory for multi-application service projects

    • Support the installation of the elasticsearch component or connection to self-prepared external ElasticSearch of 7.10 and above versions.

    • Do not pause the component after it is successfully deployed/connected, otherwise the project operation log will be lost.

    Installation Location

    It is typically installed on the component node.

    If there are multiple component nodes, this component will be installed on a random node.

    Special case: For single-application service projects, if no component nodes are prepared, this component will be installed on the main application node.

    2.  filebeat


    Description
    Component Role

    Provide log collection service. It should be installed with the elasticsearch component.

    Mandatory or Optional

    Install it if you install the elasticsearch component.

    Installation Location

    Install one on each main application node.

    File Server


    Description

    Component Role

    It is used to store and share files and resources required by each application node, ensuring that every node can access and utilize them.

    Mandatory or Optional

    1.Not required for single-application service projects

    2.Mandatory for multi-application service projects

    • A MinIO file server is installed by default.

    • Support the installation of the MinIO file server or connection to external self-prepared file servers (SFTP, FTP, external shared directories).

    • To use other types of file servers, log in to a successfully deployed project, and change the file server as needed.

    Installation Location

    The MinIO file server is typically installed on the component node.

    If there are multiple component nodes, this component will be installed on a random node.

    External Configuration Database


    Description

    Component Role

    It is used to store and maintain configuration information and parameters of each application node. These parameters must be set reasonably to ensure coordinated node operations.

    Mandatory or Optional

    This component must be installed.

    • A MySQL 8 database is installed by default.

    • Support the installation of the MySQL 8 database or connection to external self-prepared databases (MySQL 5, MySQL 8, RDSMySQL, Oracle).

    • To use other types of databases, log in to a successfully deployed project, and change the file server as needed.

    Installation Location

    The MySQL 8 database is typically installed on the component node.

    If there are multiple component nodes, this component will be installed on a random node.

    Special case: For single-application service projects, if no component nodes are prepared, this component will be installed on the main application node.

    State Server


    Description

    Component Role

    It monitors the running status of each node and the whole cluster, records logs and error messages, and coordinates communication and task allocation among nodes.

    Mandatory or Optional

    1.Not required for single-application service projects

    2.Mandatory for multi-application service projects

    • A standalone Redis server is installed by default.

    • Support the installation of the Redis standalone state server or connection to an external self-prepared state server (Redis standalone, Redis cluster).

    • To use other types of state servers, log in to a successfully deployed project, and change the file server as needed.

    Installation Location

    The Redis standalone server is typically installed on the components node.

    If there are multiple component nodes, this component will be installed on a random node.

    Data Storage Service

    Consider whether to install the data storage service when deploying the FineBI 6.1 project only.


    Description

    Component Role

    It is used to store and share data resources within FineBI, ensuring that every node can access and utilize them.

    Mandatory or Optional

    This component must be installed.

    • A self-prepared file server is preferred for data storage, supporting SFTP, FTP, and external shared directories.

    • Support the installation of a MinIO file server.

    Installation Location

    The MinIO file server is typically installed on the main application node.

    The data storage service and bi-web/bi-engine-master/bi-engine-worker components are randomly and evenly installed on servers.

    Pipeline Task

    Consider whether to install the pipeline task when deploying the FineDataLink project only.


    Description

    Component Role

    It monitors the running status of each node and the whole cluster, records logs and error messages, and coordinates communication and task allocation among nodes.

    Mandatory or Optional

    Optional for FineDataLink projects.

    • A kafka (open-source data streaming platform) is installed by default.

    • If the kafka component is not installed, you cannot use functions related to FineDataLink Pipeline Task.

    • Self-prepared components are not supported.

    Installation Location

    The Kafka open-source stream processing platform is typically installed on component nodes.

    If there are multiple component nodes, this component will be installed on a random node.

    Special case: For single-application service projects, if no component nodes are prepared, this component will be installed on the main application node.

    Nacos

    Consider whether to install nacos when deploying the FineDataLink project only.

    Nacos includes the nacos component and the nacos_mysql component

    1.  nacos


    Description

    Component Role

    It serves as the service registry, and ensures that user scheduling requests can be evenly distributed across different cluster nodes, thereby guaranteeing high availability and concurrency in the execution of nodes in scheduled tasks.

    Mandatory or Optional

    1.Not required for FineDataLink single-application service projects

    2.Mandatory for FineDataLink multi-application service projects

    • A Nacos service registry is installed by default.

    Installation Location

    The nacos component is typically installed on the component node.

    If there are multiple component nodes, this component will be installed on a random node.

    2.  nacos_mysql


    Description
    Component Role

    It is the mysql component required for nacos services.

    Mandatory or Optional

    Installed together with the nacos component.

    Installation Location

    Installed together with the nacos component.

    Attachment List


    Theme: New Project Deployment
    Previous
    Next
    • Helpful
    • Not helpful
    • Only read