Using TencentDB for Redis as the State Server

Application Scenario

Redis is a fast, flexible, and reliable key-value store, ideal for addressing real-time data access scenarios with high performance and concurrency.

TencentDB for Redis is a cache and storage service built by Tencent Cloud that is compatible with the Redis protocol. It supports active-standby hot backup and provides a full range of database services, including automatic disaster recovery, data backup, fault migration, instance monitoring, online scaling, and data rollback.

TencentDB for Redis, acting as the state server for the FanRuan cluster, mainly stores and caches login information, template locks, SessionIDs, and WebSocket connections, while authenticating all access and operations.

To connect a FanRuan project to TencentDB for Redis, you must verify project version compatibility and ensure that the required plugins are installed.

Verifying Project Version Compatibility

Log in to the project as the admin and choose System Management > Registration Management > Version Information to view the minor version number of the project.

• For FineReport projects, ensure the project is of V11 or later versions.

• For FineBI projects, ensure the project is of V6.0.17 or later versions.

• FineDataLink projects are not supported.

Installing the TencentDB for Redis Plugin

Connecting a FanRuan cluster to TencentDB for Redis requires the TencentDB for Redis plugin.

This plugin must be installed manually by the admin.

You can download the plugin. TencentDB for Redis Plugin

For details about plugin installation, see Server Plugin Management.

Note:

When using TencentDB for Redis as the state server, uninstalling or disabling the TencentDB for Redis plugin may cause abnormal project status:

• The load balancer endpoint becomes unavailable.

• Individual nodes can still be accessed normally.

• The state server status shows as disabled.

The cluster will recover if you use another type of state server.

If you enable or reinstall the TencentDB for Redis plugin, the cluster will automatically connect to the previous TencentDB for Redis and recover.

You need to prepare and deploy TencentDB for Redis by yourself.

FanRuan does not provide related documentation or guidance. Refer to the official website of Tencent Cloud for assistance. The following section only specifies essential content. For details, see TencentDB for Redis.

Note:

If you lack sufficient operation and maintenance (O&M) capabilities, you are advised to tick Deploy Standalone Redis when deploying a new project via FineOps, eliminating the need for manual deployment and configuration tuning.

Preparing the Product

FanRuan does not provide related documentation or guidance on purchasing, deploying, or using TencentDB for Redis. Only essential requirements are specified.

Refer to the official website of Tencent Cloud for assistance. For details, see TencentDB for Redis.

• Ensure TencentDB for Redis is of V4.0 with a cluster architecture.  

• Ensure the prepared TencentDB for Redis has one shard.

Preparing Redis Information

Prepare the Redis host IP address, port number, and password for project connection.

You can connect the project to TencentDB for Redis using the following methods. Choose one based on actual conditions.

Connection via Cluster Management in FineOps

In Cluster Management of FineOps, you can connect a project to a self-provided TencentDB for Redis as the state server.

1. Log in to FineOps as the admin and select the required O&M project. Choose Maintenance > Cluster Management.

2. Configure State Server.

3. Fill in the information and click Save. TencentDB for Redis can be connected normally if the prompt "Connected successfully" appears.

• Cache System: Select TencentDB for Redis.

• Host, Port, and Password: Fill in the Redis information prepared in the "Preparing TencentDB for Redis" section.

• ACL: Do not tick it. ACL is a feature of Redis 6.0 and is unavailable for TencentDB for Redis.

Connection via Cluster Management in System Management

Note:

This method applies to FanRuan projects not deployed via FineOps only. Do not use this method for FineOps-deployed projects.

Under System Management > Intelligent O&M > Cluster Configuration of the FanRuan application, you can configure the self-provided TencentDB for Redis as the state server.

1. Log in to the FanRuan application as the admin and choose System Management > Intelligent O&M > Cluster Configuration.

2. Enable the state server and select TencentDB for Redis from the dropdown list of Cache System.

Enter the Redis information prepared in the "Preparing TencentDB for Redis" section and click Test Connection and Save to use TencentDB for Redis as the state server.

Note:

If you are switching to a different Redis state server instead of connecting to Redis for the first time, you need to restart the FanRuan cluster after the successful switchover to ensure the configuration cache on each node is updated.