mirror of
https://github.com/infiniflow/ragflow.git
synced 2025-12-05 19:39:02 +00:00
### What problem does this PR solve?
Introduce new feature: RAGFlow system admin service and CLI
### Introduction
Admin Service is a dedicated management component designed to monitor,
maintain, and administrate the RAGFlow system. It provides comprehensive
tools for ensuring system stability, performing operational tasks, and
managing users and permissions efficiently.
The service offers monitoring of critical components, including the
RAGFlow server, Task Executor processes, and dependent services such as
MySQL, Infinity / Elasticsearch, Redis, and MinIO. It automatically
checks their health status, resource usage, and uptime, and performs
restarts in case of failures to minimize downtime.
For user and system management, it supports listing, creating,
modifying, and deleting users and their associated resources like
knowledge bases and Agents.
Built with scalability and reliability in mind, the Admin Service
ensures smooth system operation and simplifies maintenance workflows.
It consists of a server-side Service and a command-line client (CLI),
both implemented in Python. User commands are parsed using the Lark
parsing toolkit.
- **Admin Service**: A backend service that interfaces with the RAGFlow
system to execute administrative operations and monitor its status.
- **Admin CLI**: A command-line interface that allows users to connect
to the Admin Service and issue commands for system management.
### Starting the Admin Service
1. Before start Admin Service, please make sure RAGFlow system is
already started.
2. Run the service script:
```bash
python admin/admin_server.py
```
The service will start and listen for incoming connections from the CLI
on the configured port.
### Using the Admin CLI
1. Ensure the Admin Service is running.
2. Launch the CLI client:
```bash
python admin/admin_client.py -h 0.0.0.0 -p 9381
## Supported Commands
Commands are case-insensitive and must be terminated with a semicolon
(`;`).
### Service Management Commands
- [x] `LIST SERVICES;`
- Lists all available services within the RAGFlow system.
- [ ] `SHOW SERVICE <id>;`
- Shows detailed status information for the service identified by
`<id>`.
- [ ] `STARTUP SERVICE <id>;`
- Attempts to start the service identified by `<id>`.
- [ ] `SHUTDOWN SERVICE <id>;`
- Attempts to gracefully shut down the service identified by `<id>`.
- [ ] `RESTART SERVICE <id>;`
- Attempts to restart the service identified by `<id>`.
### User Management Commands
- [x] `LIST USERS;`
- Lists all users known to the system.
- [ ] `SHOW USER '<username>';`
- Shows details and permissions for the specified user. The username
must be enclosed in single or double quotes.
- [ ] `DROP USER '<username>';`
- Removes the specified user from the system. Use with caution.
- [ ] `ALTER USER PASSWORD '<username>' '<new_password>';`
- Changes the password for the specified user.
### Data and Agent Commands
- [ ] `LIST DATASETS OF '<username>';`
- Lists the datasets associated with the specified user.
- [ ] `LIST AGENTS OF '<username>';`
- Lists the agents associated with the specified user.
### Meta-Commands
Meta-commands are prefixed with a backslash (`\`).
- `\?` or `\help`
- Shows help information for the available commands.
- `\q` or `\quit`
- Exits the CLI application.
## Examples
```commandline
admin> list users;
+-------------------------------+------------------------+-----------+-------------+
| create_date | email | is_active | nickname |
+-------------------------------+------------------------+-----------+-------------+
| Fri, 22 Nov 2024 16:03:41 GMT | jeffery@infiniflow.org | 1 | Jeffery |
| Fri, 22 Nov 2024 16:10:55 GMT | aya@infiniflow.org | 1 | Waterdancer |
+-------------------------------+------------------------+-----------+-------------+
admin> list services;
+-------------------------------------------------------------------------------------------+-----------+----+---------------+-------+----------------+
| extra | host | id | name | port | service_type |
+-------------------------------------------------------------------------------------------+-----------+----+---------------+-------+----------------+
| {} | 0.0.0.0 | 0 | ragflow_0 | 9380 | ragflow_server |
| {'meta_type': 'mysql', 'password': 'infini_rag_flow', 'username': 'root'} | localhost | 1 | mysql | 5455 | meta_data |
| {'password': 'infini_rag_flow', 'store_type': 'minio', 'user': 'rag_flow'} | localhost | 2 | minio | 9000 | file_store |
| {'password': 'infini_rag_flow', 'retrieval_type': 'elasticsearch', 'username': 'elastic'} | localhost | 3 | elasticsearch | 1200 | retrieval |
| {'db_name': 'default_db', 'retrieval_type': 'infinity'} | localhost | 4 | infinity | 23817 | retrieval |
| {'database': 1, 'mq_type': 'redis', 'password': 'infini_rag_flow'} | localhost | 5 | redis | 6379 | message_queue |
+-------------------------------------------------------------------------------------------+-----------+----+---------------+-------+----------------+
```
### Type of change
- [x] New Feature (non-breaking change which adds functionality)
Signed-off-by: jinhai <haijin.chn@gmail.com>
281 lines
8.6 KiB
Python
281 lines
8.6 KiB
Python
import logging
|
|
import threading
|
|
from enum import Enum
|
|
|
|
from pydantic import BaseModel
|
|
from typing import Any
|
|
from api.utils import read_config
|
|
from urllib.parse import urlparse
|
|
|
|
|
|
class ServiceConfigs:
|
|
def __init__(self):
|
|
self.configs = []
|
|
self.lock = threading.Lock()
|
|
|
|
|
|
SERVICE_CONFIGS = ServiceConfigs
|
|
|
|
|
|
class ServiceType(Enum):
|
|
METADATA = "metadata"
|
|
RETRIEVAL = "retrieval"
|
|
MESSAGE_QUEUE = "message_queue"
|
|
RAGFLOW_SERVER = "ragflow_server"
|
|
TASK_EXECUTOR = "task_executor"
|
|
FILE_STORE = "file_store"
|
|
|
|
|
|
class BaseConfig(BaseModel):
|
|
id: int
|
|
name: str
|
|
host: str
|
|
port: int
|
|
service_type: str
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
return {'id': self.id, 'name': self.name, 'host': self.host, 'port': self.port, 'service_type': self.service_type}
|
|
|
|
|
|
class MetaConfig(BaseConfig):
|
|
meta_type: str
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
extra_dict = result['extra'].copy()
|
|
extra_dict['meta_type'] = self.meta_type
|
|
result['extra'] = extra_dict
|
|
return result
|
|
|
|
|
|
class MySQLConfig(MetaConfig):
|
|
username: str
|
|
password: str
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
extra_dict = result['extra'].copy()
|
|
extra_dict['username'] = self.username
|
|
extra_dict['password'] = self.password
|
|
result['extra'] = extra_dict
|
|
return result
|
|
|
|
|
|
class PostgresConfig(MetaConfig):
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
return result
|
|
|
|
|
|
class RetrievalConfig(BaseConfig):
|
|
retrieval_type: str
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
extra_dict = result['extra'].copy()
|
|
extra_dict['retrieval_type'] = self.retrieval_type
|
|
result['extra'] = extra_dict
|
|
return result
|
|
|
|
|
|
class InfinityConfig(RetrievalConfig):
|
|
db_name: str
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
extra_dict = result['extra'].copy()
|
|
extra_dict['db_name'] = self.db_name
|
|
result['extra'] = extra_dict
|
|
return result
|
|
|
|
|
|
class ElasticsearchConfig(RetrievalConfig):
|
|
username: str
|
|
password: str
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
extra_dict = result['extra'].copy()
|
|
extra_dict['username'] = self.username
|
|
extra_dict['password'] = self.password
|
|
result['extra'] = extra_dict
|
|
return result
|
|
|
|
|
|
class MessageQueueConfig(BaseConfig):
|
|
mq_type: str
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
extra_dict = result['extra'].copy()
|
|
extra_dict['mq_type'] = self.mq_type
|
|
result['extra'] = extra_dict
|
|
return result
|
|
|
|
|
|
class RedisConfig(MessageQueueConfig):
|
|
database: int
|
|
password: str
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
extra_dict = result['extra'].copy()
|
|
extra_dict['database'] = self.database
|
|
extra_dict['password'] = self.password
|
|
result['extra'] = extra_dict
|
|
return result
|
|
|
|
|
|
class RabbitMQConfig(MessageQueueConfig):
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
return result
|
|
|
|
|
|
class RAGFlowServerConfig(BaseConfig):
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
return result
|
|
|
|
|
|
class TaskExecutorConfig(BaseConfig):
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
return result
|
|
|
|
|
|
class FileStoreConfig(BaseConfig):
|
|
store_type: str
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
extra_dict = result['extra'].copy()
|
|
extra_dict['store_type'] = self.store_type
|
|
result['extra'] = extra_dict
|
|
return result
|
|
|
|
|
|
class MinioConfig(FileStoreConfig):
|
|
user: str
|
|
password: str
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
result = super().to_dict()
|
|
if 'extra' not in result:
|
|
result['extra'] = dict()
|
|
extra_dict = result['extra'].copy()
|
|
extra_dict['user'] = self.user
|
|
extra_dict['password'] = self.password
|
|
result['extra'] = extra_dict
|
|
return result
|
|
|
|
|
|
def load_configurations(config_path: str) -> list[BaseConfig]:
|
|
raw_configs = read_config(config_path)
|
|
configurations = []
|
|
ragflow_count = 0
|
|
id_count = 0
|
|
for k, v in raw_configs.items():
|
|
match (k):
|
|
case "ragflow":
|
|
name: str = f'ragflow_{ragflow_count}'
|
|
host: str = v['host']
|
|
http_port: int = v['http_port']
|
|
config = RAGFlowServerConfig(id=id_count, name=name, host=host, port=http_port, service_type="ragflow_server")
|
|
configurations.append(config)
|
|
id_count += 1
|
|
case "es":
|
|
name: str = 'elasticsearch'
|
|
url = v['hosts']
|
|
parsed = urlparse(url)
|
|
host: str = parsed.hostname
|
|
port: int = parsed.port
|
|
username: str = v.get('username')
|
|
password: str = v.get('password')
|
|
config = ElasticsearchConfig(id=id_count, name=name, host=host, port=port, service_type="retrieval",
|
|
retrieval_type="elasticsearch",
|
|
username=username, password=password)
|
|
configurations.append(config)
|
|
id_count += 1
|
|
|
|
case "infinity":
|
|
name: str = 'infinity'
|
|
url = v['uri']
|
|
parts = url.split(':', 1)
|
|
host = parts[0]
|
|
port = int(parts[1])
|
|
database: str = v.get('db_name', 'default_db')
|
|
config = InfinityConfig(id=id_count, name=name, host=host, port=port, service_type="retrieval", retrieval_type="infinity",
|
|
db_name=database)
|
|
configurations.append(config)
|
|
id_count += 1
|
|
case "minio":
|
|
name: str = 'minio'
|
|
url = v['host']
|
|
parts = url.split(':', 1)
|
|
host = parts[0]
|
|
port = int(parts[1])
|
|
user = v.get('user')
|
|
password = v.get('password')
|
|
config = MinioConfig(id=id_count, name=name, host=host, port=port, user=user, password=password, service_type="file_store",
|
|
store_type="minio")
|
|
configurations.append(config)
|
|
id_count += 1
|
|
case "redis":
|
|
name: str = 'redis'
|
|
url = v['host']
|
|
parts = url.split(':', 1)
|
|
host = parts[0]
|
|
port = int(parts[1])
|
|
password = v.get('password')
|
|
db: int = v.get('db')
|
|
config = RedisConfig(id=id_count, name=name, host=host, port=port, password=password, database=db,
|
|
service_type="message_queue", mq_type="redis")
|
|
configurations.append(config)
|
|
id_count += 1
|
|
case "mysql":
|
|
name: str = 'mysql'
|
|
host: str = v.get('host')
|
|
port: int = v.get('port')
|
|
username = v.get('user')
|
|
password = v.get('password')
|
|
config = MySQLConfig(id=id_count, name=name, host=host, port=port, username=username, password=password,
|
|
service_type="meta_data", meta_type="mysql")
|
|
configurations.append(config)
|
|
id_count += 1
|
|
case "admin":
|
|
pass
|
|
case _:
|
|
logging.warning(f"Unknown configuration key: {k}")
|
|
continue
|
|
|
|
return configurations
|