FineOps Deployment

Version 

Application Scenario 

FineOps is launched by FanRuan Software to provide enterprises with all-round O&M solutions for FanRuan applications, ensuring their stable operation.

It can help users solve some pain points and challenges in managing FanRuan applications (such as FineReport and FineBI).

FineOps is necessary to deploy FanRuan projects (such as FineBI, FineReport, and FineDataLink) in a standard manner.

Function Description 

This article describes how to deploy FineOps.

This article is mainly for users who have limited server resources.

Check whether the prepared server meets the requirements to deploy FineOps referring to the following documents.

Obtaining the FineKey Installation Package

Contact the technical support personnel to obtain the installation package of the FineKey tool.

Uploading the FineKey Installation Package 

Upload the FineKey installation package to the Linux system.

In this example, the package is uploaded to the /home/ops directory of CentOS 7.6.1810, as shown in the following figure.

Decompressing the FineKey Installation Package 

1. Use the cd command to enter the folder where the tool package is located.

2. Enter the corresponding command according to the type of the installation package to extract the file. For details, contact the technical support personnel.

The extracted files are shown in the following table.

Configuring the YAML File 

The YAML file refers to the finekey.yaml file in the /finekey/conf directory that controls the entire automated deployment process.

• To use the default deployment configuration (of the installation directory, the component port, the warehouse, etc.), you can deploy FineOps on the current host machine without modifying the YAML file.

• To change the configuration of FineOps or the component-occupied port, modify the values of corresponding parameters in the YAML file. Finish configuring the YAML file before starting FineKey.

File Content Description

#Component port configuration
#components:
#nginx:
#portMapping: {80: 8080}
#
#ops:
#portMapping: {8081: 8080}

#Component port configuration
components:
#nginx:
#portMapping: {80: 8080}
#
ops:
portMapping: {8088: 8080}

Sample File

node:
  ip: localhost            #Node IP
  port: 22                 #Node SSH port
  user:                    #Node SSH username
  password:                #Node SSH password
dataRootPath: ~/data
repo:
  port: 5000    #Registry Port
  #Specifies an existing container registry
  url:          #Registry URL
  username:     #Registry username
  password:     #Registry password
  ssl: true     #Repository with SSL set or not

online: false   #Online installation
#Component port configuration
#components:
#  nginx:
#    portMapping: {80: 8080}
#
#  ops:
#    portMapping: {8081: 8080}
#
#  ops_agent:
#    portMapping: {9071: 9070}
#
#  grafana:
#    portMapping: {3000: 3000}
#
#  prometheus:
#    portMapping: {9090: 9090}
#
#  alertmanager:
#    portMapping: {9093: 9093}
#
#  skywalking_oap:
#    portMapping: {11800: 11800, 12800: 12800}
#
#  elasticsearch:
#    portMapping: {9200: 9200}
#    password: elasticadmin

Executing a Deployment 

1. Use the cd command to enter the bin folder of the decompression directory.

2. Enter the following command to execute the automated deployment.

Note 1: Execute the command strictly according to the commands in the document, and do not change them to other commands such as sudo and ./finekey. Failure to do so may result in a failed deployment.

3. Wait for the whole deployment process to complete, which will take some time.

Note 1: If an error occurs during deployment, refer to the Troubleshooting of FineOps Deployment for the corresponding solution. Note that the /data directory refers to the data folder in the user's home directory rather than the /data directory. For example, in case of a root user deployment, the installation directory would be /root/data.

Note 2: If the free space of the disk where the directory is mounted is detected to be less than 100 GB during the deployment, a prompt saying "The current path capacity check failed, Please re-enter the path" will appear. You do not need to exit the deployment. Modify the YAML file, enter the directory that meets the conditions, and continue the deployment.

Completing the Deployment 

If the "deployment success! bye~" prompt appears, FineOps has been successfully deployed.

Right after the prompt is the project address of FineOps. You can copy it for later access.

Note: The port in the address is the port set to be occupied by the nginx component. 

• In case of a root user deployment, the default port number is 80, the port number in the access address can be omitted, and you can use the IP address to access FineOps: http://IP address/ops/decision. 

• In case of a non-root user deployment, the default port number is 8090 and the access address is http://IP address:8090/ops/decision. 

• If you have modified the port number of the nginx component in the finekey.yaml file, the access address is http://IP address:nginx port number/ops/decision.

Accessing the Project 

FineOps services start automatically once the project is deployed. Enter the project address in the previous step in the address bar of a browser to access FineOps.

Selecting a Browser

Access FineOps using browsers of the following versions, otherwise the page may be displayed abnormally.

If you use a browser that does not meet the version requirements to access FineOps, a pop-up window will appear on some pages, prompting "It is detected that the current browser version is too low, which may cause some components to be displayed abnormally."

Accessing the Project

Enter the project address in the previous step in the address bar of a browser to access FineOps.

For example, enter http://IP address/ops/decision in the address bar.

After you have completed the operations in this article, you can proceed to the next step.