O&M Component Management

  • Last update: 2024-07-23
  • Overview

    Version

    FineOps Version

    Functional Change

    V1.5.5
    /
    V1.5.7

    Started the elasticsearch and skywalking_oap components by default.

    V1.7.0

    Added a secondary dialog box to prevent accidental operation during component starting, stopping, or restarting.

    V2.0.0

    Optimized the interaction by adjusting the function entry location.

    V2.1.0

    Optimized the logic for changing configurations and verified limit values of memory and CPU.

    Application Scenario

    The O&M platform has multiple components, so the admin needs a summary page to maintain all containers.

    When a component is unusable, the admin needs methods and means for quick recovery.

    Function Description

    FineOps provides the function of O&M Component.

    Log in to FineOps as the admin and choose Platform Management > O&M Component to manage components of the O&M platform.

    Information Display

    The O&M Component page displays all components' information of the O&M platform. 

    The following table shows the types of O&M components that can be displayed.

    iconNote:

    The basic version of FineOps does not have tracing-related components, such as elasticsearch and skywalking_oap.


    Type

    Component

    Component Description

    O&M Platform Related

    ops

    It is a FineOps container used to operate and maintain FineReport and FineBI projects.

    nginx

    It provides load forwarding services, serving as the entry and access point for all services.

    ops-agent

    1. It is related to binding physical nodes and is used for managing and upgrading components of the O&M platform.

    2. It is used to collect the indicator information of ops servers, nginx, and elasticsearch.

    Monitoring and Alerting

    pushgateway

    It temporarily stores indicators collected by ops-agent for prometheus to retrieve.

    prometheus

    It uses pushgateway to retrieve indicator data collected by ops-agent and provides the retrieved data to the monitoring dashboard.

    grafana

    It is used to display the monitoring dashboard.

    alertmanager

    It is an alerting container used for modifying and triggering alert rules.

    Tracing

    elasticsearch

    It collects requests from FineReport, FineBI, external databases, business databases, and other external components in O&M projects.

    skywalking_oap

    It is used to report, analyze, and organize data of tracing.

    Image Repository

    registry

    It is a repository for storing docker images.

    The following table shows the various types of component information that can be displayed.

    Information

    Description

    Current Version

    The currently installed image version of the component

    Component Quantity

    The amount of components of this type

    Latest Version

    Whether an updatable version exists

    If the version is the latest, it displays: "Already the latest version."

    If the version is updatable, it displays the latest image version number, and One-Click Update is supported in the upper right corner of the page.

    Component Configuration

    It displays the configurations of all containers under this category in section "Configuration Modification"(If the containers are not configured, it displays "Unlimited".).

    Container Name

    It displays the container names for convenient identification of usage.

    Container Status

    Whether the container is started

    Running: started

    Exited: not started

    Image Information

    Information about the images used by containers

    Physical Node

    The IP address of the server where the container resides

    Running Time

    It displays the containers' continuous running time. For ops components, it also displays component health status. 

    Healthy: The container is running healthily.

    Unhealthy: The container is unable to run properly, and it is possibly restarting. You can wait patiently until it becomes healthy.

    Configuration

    It displays the configurations in section "Configuration Modification"(If the containers are not configured, it displays "Unlimited".).

    Operation

    It includes various operations: updating, starting, stopping, restarting, and modifying configurations and terminals.

    Component Operation

    Component Update

    1. If a Latest Version is available, you can manually click One-Click Update to update the component. For details, see Intranet-Based FineOps Upgrade.

    2. After you update the O&M platform online, when you log in to the platform as the admin, the platform will automatically detect and update components.

    3. If the current version is already up-to-date, the One-Click Update button cannot be clicked and will prompt "Already the latest version."

    Component Start/Stop

    You can perform operations such as starting, stopping, and restarting components quickly.

    iconNote:
    1. Some components are interdependent, so restarting one component may trigger the restart of others.

    2. Stopping components may affect O&M functions. The following table shows the details.

    Type

    Component

    Component Description

    O&M Platform Related

    ops

    This component must be enabled. If it is not enabled, the O&M platform will crash and you cannot access it. 

    Therefore, you cannot start or stop the ops component on the O&M component page, you can only restart it.

    nginx

    This component must be enabled, as all services are accessed through this entry. If it is not enabled, you cannot access the O&M platform.

    Therefore, you cannot start or stop the nginx component on the O&M component page, you can only restart it.

    ops-agent

    This component must be enabled to manage components.

    Therefore, you cannot start or stop the ops-agent component on the O&M component page, you can only restart it.

    Monitoring and Alerting

    pushgateway

    If you do not enable this component, the dashboards in Project Monitoring will not display data.

    prometheus

    If you do not enable this component, the dashboards in Project Monitoring will not display data. You cannot use Alert and Alert Center.

    grafana

    If you do not enable this component, you cannot view the dashboards in Project Monitoring.

    alertmanager

    If you do not enable this component, you cannot use Alert and Alert Center.

    Tracing

    elasticsearch

    If you do not enable this component, you cannot use Tracing and Project Monitoring > Health Monitoring.

    skywalking_oap

    If you do not enable this component, you cannot use Tracing and Project Monitoring > Health Monitoring.

    Image Repository

    registry

    If you have your own repository, you do not need to enable this component.

    If you do not have an image repository, you can enable this component to serve as the repository for Image Management.

    Configuration Modification

    You can modify the CPU and memory upper limits for components.

    Components will be automatically restarted when the used memory reaches the upper limit. Refrain from imposing restrictions on components with continuous business requirements.

    Components will be automatically restarted after you change general configurations, which may affect the normal operation of the project. Do not perform these operations during use.

    iconNote:
    1. Enter a number greater than zero. The value of the container CPU cannot exceed the upper limit of the server CPU. The value of the container memory cannot exceed the upper limit of the server memory.

    2. The following table lists the minimum configuration requirements for proper operations of the components. You are advised to configure with twice the minimum configuration. You can adjust according to the actual server conditions.

    Type

    Component

    Maximum CPU Usage

    Maximum Memory Usage

    Maximum On-heap Memory

    O&M Platform Related

    ops

    2Core

    //

    nginx

    1Core

    //

    ops-agent

    1Core

    /

    1G

    Monitoring and Alerting

    pushgateway

    0.1Core

    0.1G

    0.1G

    prometheus

    1Core

    1G

    /

    grafana

    1Core

    1G

    /

    alertmanager

    1Core

    1G

    /

    Tracing

    elasticsearch

    1Core

    /

    2G

    skywalking_oap

    1Core

    /

    2G

    Image Repository

    registry

    1Core

    //

    Terminal Entry

    Although the O&M platform has provided many interface operations, the admin may still need to use terminal tools to connect to and manage components.

    The O&M platform provides terminal tools to support quick access to component terminals. See the following figure:

    The command line page is displayed on the left, where you can input commands for query or execution. You can clear the page with one click.

    The specific container information of the component is displayed on the right.

    iconNote:

    1. The component must be in the running state to access its terminal. Otherwise, it will prompt "Entering a terminal is not supported in the current container status."

    2. A single O&M platform supports the simultaneous connection of three component terminals at most. When exceeding three connections, it will prompt "Up to 3 terminals can be connected, and the upper limit has been reached. Disconnect other terminals and try again."


    iconNote:

    3. If there is no command operation for 10 minutes after connecting to the terminal, the connection will be automatically terminated, and it will prompt "The terminal is disconnected. Reconnect the terminal." 

    附件列表


    主题: Platform Management
    Previous
    Next
    • Helpful
    • Not helpful
    • Only read