In FinClip Digital Management Platform private deployment, operations configuration mainly revolves around Docker containers and Kubernetes-related content. We use industry-standard methods for deployment management, so you can leverage your general operations skills to manage FinClip. Below are configuration instructions for single-node deployment and cluster deployment.

Single Node Deployment

As mentioned earlier, FinClip uses docker compose for single-node deployment and management. Therefore, you can perform operations management of the FinClip system by following Docker's official configuration management methods.

1. Locate Configuration Directory

By viewing any running container, you can locate the directory where the Compose configuration is located

docker ps
docker inspect [container_id] | grep -i working_dir

2. Compose Directory Files

• docker-compose.yaml: The main configuration file for Compose, which defines various options for container startup, including file mounting, port configuration, and service environment variables.
• init.bash: Script for initializing data directories, mainly used to create data directories with specific permissions for container mounting to write data to the host.
• kong.yaml: Configuration for the gateway service, used to configure access routing.
• mysql_custom.cnf: Custom configuration for the database, commonly mounted to the mysql container
• purge_redeploy.sh: Utility script for cleaning data and restarting services. Please use with caution.

3. Customize Service Access Port

You can modify the access port by changing the port mapping of the gateway service in docker-compose.yaml.

    ports:
      - "30001:8000" # e.g., 30001

Cluster Deployment

FinClip supports deployment using Kubernetes and compatible container platforms. Through container orchestration platforms, you can achieve service high availability, automated scaling, resource optimization, and efficient management operations. FinClip services are packaged using Docker and support Helm chart for configuration management.

Kubernetes Resource Configuration

In Kubernetes deployment, configuration files mainly include:

• Deployment: Main configuration resource for running FinClip services
• Services: Service configuration for inter-service access. In specific cases, there may also be extended Services for accessing external services.
• ConfigMap: FinClip uses Kubernetes ConfigMap to save configuration files, including service configuration and routing configuration.
• Secret: Used to save image registry authentication content
• Ingress: Typically, we use Ingress to provide external access for services. This is optional, and you can also provide external access by configuring NodePort for gateway.

Helm Configuration

In Helm Chart configuration, the main configuration content is written in Values.yaml. You can modify it according to actual circumstances to generate Kubernetes configuration files.