mirror of
https://github.com/GNS3/gns3-server
synced 2024-11-28 19:28:07 +00:00
339 lines
14 KiB
Python
339 lines
14 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2020 GNS3 Technologies Inc.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
"""
|
|
API endpoints for Docker nodes.
|
|
"""
|
|
|
|
import os
|
|
|
|
from fastapi import APIRouter, Body, status
|
|
from fastapi.encoders import jsonable_encoder
|
|
from fastapi.responses import StreamingResponse
|
|
from uuid import UUID
|
|
|
|
from gns3server.endpoints import schemas
|
|
from gns3server.compute.docker import Docker
|
|
|
|
router = APIRouter()
|
|
|
|
|
|
@router.post("/",
|
|
response_model=schemas.Docker,
|
|
status_code=status.HTTP_201_CREATED,
|
|
responses={409: {"model": schemas.ErrorMessage, "description": "Could not create Docker node"}})
|
|
async def create_docker_node(project_id: UUID, node_data: schemas.DockerCreate):
|
|
"""
|
|
Create a new Docker node.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
node_data = jsonable_encoder(node_data, exclude_unset=True)
|
|
container = await docker_manager.create_node(node_data.pop("name"),
|
|
str(project_id),
|
|
node_data.get("node_id"),
|
|
image=node_data.pop("image"),
|
|
start_command=node_data.get("start_command"),
|
|
environment=node_data.get("environment"),
|
|
adapters=node_data.get("adapters"),
|
|
console=node_data.get("console"),
|
|
console_type=node_data.get("console_type"),
|
|
console_resolution=node_data.get("console_resolution", "1024x768"),
|
|
console_http_port=node_data.get("console_http_port", 80),
|
|
console_http_path=node_data.get("console_http_path", "/"),
|
|
aux=node_data.get("aux"),
|
|
aux_type=node_data.pop("aux_type", "none"),
|
|
extra_hosts=node_data.get("extra_hosts"),
|
|
extra_volumes=node_data.get("extra_volumes"),
|
|
memory=node_data.get("memory", 0),
|
|
cpus=node_data.get("cpus", 0))
|
|
for name, value in node_data.items():
|
|
if name != "node_id":
|
|
if hasattr(container, name) and getattr(container, name) != value:
|
|
setattr(container, name, value)
|
|
|
|
return container.__json__()
|
|
|
|
|
|
@router.get("/{node_id}",
|
|
response_model=schemas.Docker,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
def get_docker_node(project_id: UUID, node_id: UUID):
|
|
"""
|
|
Return a Docker node.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
return container.__json__()
|
|
|
|
|
|
@router.put("/{node_id}",
|
|
response_model=schemas.Docker,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def update_docker(project_id: UUID, node_id: UUID, node_data: schemas.DockerUpdate):
|
|
"""
|
|
Update a Docker node.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
|
|
props = [
|
|
"name", "console", "console_type", "aux", "aux_type", "console_resolution",
|
|
"console_http_port", "console_http_path", "start_command",
|
|
"environment", "adapters", "extra_hosts", "extra_volumes",
|
|
"memory", "cpus"
|
|
]
|
|
|
|
changed = False
|
|
node_data = jsonable_encoder(node_data, exclude_unset=True)
|
|
for prop in props:
|
|
if prop in node_data and node_data[prop] != getattr(container, prop):
|
|
setattr(container, prop, node_data[prop])
|
|
changed = True
|
|
# We don't call container.update for nothing because it will restart the container
|
|
if changed:
|
|
await container.update()
|
|
container.updated()
|
|
return container.__json__()
|
|
|
|
|
|
@router.post("/{node_id}/start",
|
|
status_code=status.HTTP_204_NO_CONTENT,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def start_docker_node(project_id: UUID, node_id: UUID):
|
|
"""
|
|
Start a Docker node.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
await container.start()
|
|
|
|
|
|
@router.post("/{node_id}/stop",
|
|
status_code=status.HTTP_204_NO_CONTENT,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def stop_docker_node(project_id: UUID, node_id: UUID):
|
|
"""
|
|
Stop a Docker node.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
await container.stop()
|
|
|
|
|
|
@router.post("/{node_id}/suspend",
|
|
status_code=status.HTTP_204_NO_CONTENT,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def suspend_docker_node(project_id: UUID, node_id: UUID):
|
|
"""
|
|
Suspend a Docker node.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
await container.pause()
|
|
|
|
|
|
@router.post("/{node_id}/reload",
|
|
status_code=status.HTTP_204_NO_CONTENT,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def reload_docker_node(project_id: UUID, node_id: UUID):
|
|
"""
|
|
Reload a Docker node.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
await container.restart()
|
|
|
|
|
|
@router.post("/{node_id}/pause",
|
|
status_code=status.HTTP_204_NO_CONTENT,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def pause_docker_node(project_id: UUID, node_id: UUID):
|
|
"""
|
|
Pause a Docker node.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
await container.pause()
|
|
|
|
|
|
@router.post("/{node_id}/unpause",
|
|
status_code=status.HTTP_204_NO_CONTENT,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def unpause_docker_node(project_id: UUID, node_id: UUID):
|
|
"""
|
|
Unpause a Docker node.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
await container.unpause()
|
|
|
|
|
|
@router.delete("/{node_id}",
|
|
status_code=status.HTTP_204_NO_CONTENT,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def delete_docker_node(project_id: UUID, node_id: UUID):
|
|
"""
|
|
Delete a Docker node.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
await container.delete()
|
|
|
|
|
|
@router.post("/{node_id}/duplicate",
|
|
response_model=schemas.Docker,
|
|
status_code=status.HTTP_201_CREATED,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def duplicate_docker_node(project_id: UUID, node_id: UUID, destination_node_id: UUID = Body(..., embed=True)):
|
|
"""
|
|
Duplicate a Docker node.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
new_node = await docker_manager.duplicate_node(str(node_id), str(destination_node_id))
|
|
return new_node.__json__()
|
|
|
|
|
|
@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
|
|
status_code=status.HTTP_201_CREATED,
|
|
response_model=schemas.UDPNIO,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def create_nio(project_id: UUID, node_id: UUID, adapter_number: int, port_number: int, nio_data: schemas.UDPNIO):
|
|
"""
|
|
Add a NIO (Network Input/Output) to the node.
|
|
The port number on the Docker node is always 0.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
nio = docker_manager.create_nio(jsonable_encoder(nio_data, exclude_unset=True))
|
|
await container.adapter_add_nio_binding(adapter_number, nio)
|
|
return nio.__json__()
|
|
|
|
|
|
@router.put("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
|
|
status_code=status.HTTP_201_CREATED,
|
|
response_model=schemas.UDPNIO,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def update_nio(project_id: UUID, node_id: UUID, adapter_number: int, port_number: int, nio_data: schemas.UDPNIO):
|
|
"""
|
|
Update a NIO (Network Input/Output) on the node.
|
|
The port number on the Docker node is always 0.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
nio = container.get_nio(adapter_number)
|
|
if nio_data.filters:
|
|
nio.filters = nio_data.filters
|
|
await container.adapter_update_nio_binding(adapter_number, nio)
|
|
return nio.__json__()
|
|
|
|
|
|
@router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
|
|
status_code=status.HTTP_204_NO_CONTENT,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def delete_nio(project_id: UUID, node_id: UUID, adapter_number: int, port_number: int):
|
|
"""
|
|
Delete a NIO (Network Input/Output) from the node.
|
|
The port number on the Docker node is always 0.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
await container.adapter_remove_nio_binding(adapter_number)
|
|
|
|
|
|
@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/start_capture",
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def start_capture(project_id: UUID, node_id: UUID, adapter_number: int, port_number: int, node_capture_data: schemas.NodeCapture):
|
|
"""
|
|
Start a packet capture on the node.
|
|
The port number on the Docker node is always 0.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
pcap_file_path = os.path.join(container.project.capture_working_directory(), node_capture_data.capture_file_name)
|
|
await container.start_capture(adapter_number, pcap_file_path)
|
|
return {"pcap_file_path": str(pcap_file_path)}
|
|
|
|
|
|
@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/stop_capture",
|
|
status_code=status.HTTP_204_NO_CONTENT,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def stop_capture(project_id: UUID, node_id: UUID, adapter_number: int, port_number: int):
|
|
"""
|
|
Stop a packet capture on the node.
|
|
The port number on the Docker node is always 0.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
await container.stop_capture(adapter_number)
|
|
|
|
|
|
@router.post("/{node_id}/console/reset",
|
|
status_code=status.HTTP_204_NO_CONTENT,
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def reset_console(project_id: UUID, node_id: UUID):
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
await container.reset_console()
|
|
|
|
|
|
@router.get("/{node_id}/adapters/{adapter_number}/ports/{port_number}/pcap",
|
|
responses={404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}})
|
|
async def stream_pcap_file(project_id: UUID, node_id: UUID, adapter_number: int, port_number: int):
|
|
"""
|
|
Stream the pcap capture file.
|
|
The port number on the Docker node is always 0.
|
|
"""
|
|
|
|
docker_manager = Docker.instance()
|
|
container = docker_manager.get_node(str(node_id), project_id=str(project_id))
|
|
nio = container.get_nio(adapter_number)
|
|
stream = docker_manager.stream_pcap_file(nio, container.project.id)
|
|
return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")
|
|
|
|
# @Route.get(
|
|
# r"/projects/{project_id}/docker/nodes/{node_id}/console/ws",
|
|
# description="WebSocket for console",
|
|
# parameters={
|
|
# "project_id": "Project UUID",
|
|
# "node_id": "Node UUID",
|
|
# })
|
|
# async def console_ws(request, response):
|
|
#
|
|
# docker_manager = Docker.instance()
|
|
# container = docker_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
|
|
# return await container.start_websocket_console(request)
|
|
|
|
|
|
|