mirror of
https://github.com/infiniflow/ragflow.git
synced 2025-12-08 20:42:30 +08:00
d11b1628a1
### 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>
142 lines
4.1 KiB
Python
142 lines
4.1 KiB
Python
from flask import Blueprint, request
|
|
from auth import login_verify
|
|
from responses import success_response, error_response
|
|
from services import UserMgr, ServiceMgr
|
|
from exceptions import AdminException
|
|
|
|
admin_bp = Blueprint('admin', __name__, url_prefix='/api/v1/admin')
|
|
|
|
|
|
@admin_bp.route('/auth', methods=['GET'])
|
|
@login_verify
|
|
def auth_admin():
|
|
try:
|
|
return success_response(None, "Admin is authorized", 0)
|
|
except Exception as e:
|
|
return error_response(str(e), 500)
|
|
|
|
|
|
@admin_bp.route('/users', methods=['GET'])
|
|
@login_verify
|
|
def list_users():
|
|
try:
|
|
users = UserMgr.get_all_users()
|
|
return success_response(users, "Get all users", 0)
|
|
except Exception as e:
|
|
return error_response(str(e), 500)
|
|
|
|
|
|
@admin_bp.route('/users', methods=['POST'])
|
|
@login_verify
|
|
def create_user():
|
|
try:
|
|
data = request.get_json()
|
|
if not data or 'username' not in data or 'password' not in data:
|
|
return error_response("Username and password are required", 400)
|
|
|
|
username = data['username']
|
|
password = data['password']
|
|
role = data.get('role', 'user')
|
|
|
|
user = UserMgr.create_user(username, password, role)
|
|
return success_response(user, "User created successfully", 201)
|
|
|
|
except AdminException as e:
|
|
return error_response(e.message, e.code)
|
|
except Exception as e:
|
|
return error_response(str(e), 500)
|
|
|
|
|
|
@admin_bp.route('/users/<username>', methods=['DELETE'])
|
|
@login_verify
|
|
def delete_user(username):
|
|
try:
|
|
UserMgr.delete_user(username)
|
|
return success_response(None, "User and all data deleted successfully")
|
|
|
|
except AdminException as e:
|
|
return error_response(e.message, e.code)
|
|
except Exception as e:
|
|
return error_response(str(e), 500)
|
|
|
|
|
|
@admin_bp.route('/users/<username>/password', methods=['PUT'])
|
|
@login_verify
|
|
def change_password(username):
|
|
try:
|
|
data = request.get_json()
|
|
if not data or 'new_password' not in data:
|
|
return error_response("New password is required", 400)
|
|
|
|
new_password = data['new_password']
|
|
UserMgr.update_user_password(username, new_password)
|
|
return success_response(None, "Password updated successfully")
|
|
|
|
except AdminException as e:
|
|
return error_response(e.message, e.code)
|
|
except Exception as e:
|
|
return error_response(str(e), 500)
|
|
|
|
|
|
@admin_bp.route('/users/<username>', methods=['GET'])
|
|
@login_verify
|
|
def get_user_details(username):
|
|
try:
|
|
user_details = UserMgr.get_user_details(username)
|
|
return success_response(user_details)
|
|
|
|
except AdminException as e:
|
|
return error_response(e.message, e.code)
|
|
except Exception as e:
|
|
return error_response(str(e), 500)
|
|
|
|
|
|
@admin_bp.route('/services', methods=['GET'])
|
|
@login_verify
|
|
def get_services():
|
|
try:
|
|
services = ServiceMgr.get_all_services()
|
|
return success_response(services, "Get all services", 0)
|
|
except Exception as e:
|
|
return error_response(str(e), 500)
|
|
|
|
|
|
@admin_bp.route('/service_types/<service_type>', methods=['GET'])
|
|
@login_verify
|
|
def get_services_by_type(service_type_str):
|
|
try:
|
|
services = ServiceMgr.get_services_by_type(service_type_str)
|
|
return success_response(services)
|
|
except Exception as e:
|
|
return error_response(str(e), 500)
|
|
|
|
|
|
@admin_bp.route('/services/<service_id>', methods=['GET'])
|
|
@login_verify
|
|
def get_service(service_id):
|
|
try:
|
|
services = ServiceMgr.get_service_details(service_id)
|
|
return success_response(services)
|
|
except Exception as e:
|
|
return error_response(str(e), 500)
|
|
|
|
|
|
@admin_bp.route('/services/<service_id>', methods=['DELETE'])
|
|
@login_verify
|
|
def shutdown_service(service_id):
|
|
try:
|
|
services = ServiceMgr.shutdown_service(service_id)
|
|
return success_response(services)
|
|
except Exception as e:
|
|
return error_response(str(e), 500)
|
|
|
|
|
|
@admin_bp.route('/services/<service_id>', methods=['PUT'])
|
|
@login_verify
|
|
def restart_service(service_id):
|
|
try:
|
|
services = ServiceMgr.restart_service(service_id)
|
|
return success_response(services)
|
|
except Exception as e:
|
|
return error_response(str(e), 500)
|