parallelvirtualcluster
/
pvc
1
0
Fork 0
Code Issues 11 Pull Requests Projects Releases 111 Wiki Activity
pvc/api-daemon/pvcapid/flaskapi.py

10859 lines
320 KiB
Python
Raw Normal View History

Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
#!/usr/bin/env python3
# Daemon.py - PVC HTTP API daemon
# Part of the Parallel Virtual Cluster (PVC) system
#
Update copyright header on all files for 2024 Last release of 2023 is probably the best time to do this.
2023-12-29 11:16:59 -05:00
# Copyright (C) 2018-2024 Joshua M. Boniface <joshua@boniface.me>
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
#
# 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
Update file copyright header. Remove the option to select a later version of the GPL.
2021-03-25 16:57:17 -04:00
# the Free Software Foundation, version 3.
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
#
# 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 <https://www.gnu.org/licenses/>.
#
###############################################################################
import flask
from functools import wraps
from flask_restful import Resource, Api, reqparse, abort
from celery import Celery
Add Celery queue routing for tasks By default, tasks will continue to run as they did, on the primary coordinator's task runner. However this opens the possibility for defining more tasks that will run on other nodes or coordinators.
2023-11-04 14:29:59 -04:00
from kombu import Queue
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
from lxml.objectify import fromstring as lxml_fromstring
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
from uuid import uuid4
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Ensure queues are set up for non-coordinator nodes Allows a runner to operate on every possible node, not just coordinators, as OSDs or other things could be on any node. Also add more comments.
2023-11-04 15:05:07 -04:00
from daemon_lib.common import getPrimaryNode
from daemon_lib.zkhandler import ZKConnection
from daemon_lib.node import get_list as get_node_list
Port all Celery worker functions to discrete pkg Moves all tasks run by the Celery worker into a discrete package/module for easier installation. Also adjusts several parameters throughout to accomplish this.
2023-11-30 02:01:22 -05:00
from daemon_lib.benchmark import list_benchmarks
Ensure queues are set up for non-coordinator nodes Allows a runner to operate on every possible node, not just coordinators, as OSDs or other things could be on any node. Also add more comments.
2023-11-04 15:05:07 -04:00
Move API version string location to Daemon Prevents a startup bug with pvcapid-manage.py.
2021-05-30 00:09:39 -04:00
from pvcapid.Daemon import config, strtobool, API_VERSION
Revamp config parsing and imports Brings sanity to the passing of the config variable around the various submodules for use in the ZKConnection decorator.
2021-05-28 23:33:36 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
import pvcapid.helper as api_helper
import pvcapid.provisioner as api_provisioner
Add OVA upload to API (initial) Initial, very barebones OVA parsing and image creation. References #71
2020-02-15 02:09:28 -05:00
import pvcapid.ova as api_ova
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Add database management with SQLAlchemy Add management of the pvcprov database with SQLAlchemy, to allow seamless management of the database. Add automatic tasks to the postinst of the API to execute these migrations.
2020-02-15 22:10:34 -05:00
from flask_sqlalchemy import SQLAlchemy
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# Create Flask app and set config values
app = flask.Flask(__name__)
Isolate cluster-dependent Celery startup Avoids calling unworkable functions when generating API docs etc. by isolating them into a Celery startup function called by Daemon.py. Also update to Celery 4+ settings format.
2023-11-16 20:25:28 -05:00
# Set up SQLAlchemy backend
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = True
Isolate cluster-dependent Celery startup Avoids calling unworkable functions when generating API docs etc. by isolating them into a Celery startup function called by Daemon.py. Also update to Celery 4+ settings format.
2023-11-16 20:25:28 -05:00
app.config["SQLALCHEMY_DATABASE_URI"] = "postgresql://{}:{}@{}:{}/{}".format(
Move config parser into daemon_lib And reformat/add config values for API.
2023-11-29 23:35:12 -05:00
config["api_postgresql_user"],
config["api_postgresql_password"],
config["api_postgresql_host"],
config["api_postgresql_port"],
config["api_postgresql_dbname"],
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
)
Isolate cluster-dependent Celery startup Avoids calling unworkable functions when generating API docs etc. by isolating them into a Celery startup function called by Daemon.py. Also update to Celery 4+ settings format.
2023-11-16 20:25:28 -05:00
if config["debug"]:
app.config["DEBUG"] = True
else:
app.config["DEBUG"] = False
Move config parser into daemon_lib And reformat/add config values for API.
2023-11-29 23:35:12 -05:00
if config["api_auth_enabled"]:
app.config["SECRET_KEY"] = config["api_auth_secret_key"]
Isolate cluster-dependent Celery startup Avoids calling unworkable functions when generating API docs etc. by isolating them into a Celery startup function called by Daemon.py. Also update to Celery 4+ settings format.
2023-11-16 20:25:28 -05:00
# Create SQLAlchemy database
db = SQLAlchemy(app)
# Create Flask blueprint
blueprint = flask.Blueprint("api", __name__, url_prefix="/api/v1")
# Create Flask-RESTful definition
api = Api(blueprint)
app.register_blueprint(blueprint)
Ensure queues are set up for non-coordinator nodes Allows a runner to operate on every possible node, not just coordinators, as OSDs or other things could be on any node. Also add more comments.
2023-11-04 15:05:07 -04:00
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
# Set up Celery queues
Ensure queues are set up for non-coordinator nodes Allows a runner to operate on every possible node, not just coordinators, as OSDs or other things could be on any node. Also add more comments.
2023-11-04 15:05:07 -04:00
@ZKConnection(config)
def get_all_nodes(zkhandler):
_, all_nodes = get_node_list(zkhandler, None)
return [n["name"] for n in all_nodes]
Return proper run_on for ported tasks
2023-11-16 02:28:57 -05:00
@ZKConnection(config)
def get_primary_node(zkhandler):
return getPrimaryNode(zkhandler)
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
# Set up Celery task ID generator
# 1. Lets us make our own IDs (first section of UUID)
# 2. Lets us distribute jobs to the required pvcworkerd instances
def run_celery_task(task_name, **kwargs):
task_id = str(uuid4()).split("-")[0]
if "run_on" in kwargs and kwargs["run_on"] != "primary":
run_on = kwargs["run_on"]
Add Celery queue routing for tasks By default, tasks will continue to run as they did, on the primary coordinator's task runner. However this opens the possibility for defining more tasks that will run on other nodes or coordinators.
2023-11-04 14:29:59 -04:00
else:
run_on = get_primary_node()
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
print(
f"Incoming pvcworkerd task: '{task_name}' ({task_id}) assigned to worker {run_on} with args {kwargs}"
)
Add Celery queue routing for tasks By default, tasks will continue to run as they did, on the primary coordinator's task runner. However this opens the possibility for defining more tasks that will run on other nodes or coordinators.
2023-11-04 14:29:59 -04:00
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
task = celery.send_task(
task_name,
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
task_id=task_id,
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
kwargs=kwargs,
queue=run_on,
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
)
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
return task
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# Create celery definition
Isolate cluster-dependent Celery startup Avoids calling unworkable functions when generating API docs etc. by isolating them into a Celery startup function called by Daemon.py. Also update to Celery 4+ settings format.
2023-11-16 20:25:28 -05:00
celery_task_uri = "redis://{}:{}{}".format(
Move config parser into daemon_lib And reformat/add config values for API.
2023-11-29 23:35:12 -05:00
config["keydb_host"], config["keydb_port"], config["keydb_path"]
Isolate cluster-dependent Celery startup Avoids calling unworkable functions when generating API docs etc. by isolating them into a Celery startup function called by Daemon.py. Also update to Celery 4+ settings format.
2023-11-16 20:25:28 -05:00
)
Enable extended Celery results
2023-11-16 12:02:57 -05:00
celery = Celery(
app.name,
broker=celery_task_uri,
Fix broken result backend on old Celery
2024-01-09 12:06:23 -05:00
backend=celery_task_uri,
Enable extended Celery results
2023-11-16 12:02:57 -05:00
result_extended=True,
)
Fix missing result_backend on Debian 10/11 For whatever reason, a Celery worker on <5.2.x was not picking these up. Move them back to the root of the module so they are properly picked up on these older versions but still prevents calling the routing functions during an API doc generation.
2023-11-25 15:16:56 -05:00
app.config["broker_url"] = celery_task_uri
app.config["result_backend"] = celery_task_uri
celery.conf.update(app.config)
Isolate cluster-dependent Celery startup Avoids calling unworkable functions when generating API docs etc. by isolating them into a Celery startup function called by Daemon.py. Also update to Celery 4+ settings format.
2023-11-16 20:25:28 -05:00
def celery_startup():
Fix missing result_backend on Debian 10/11 For whatever reason, a Celery worker on <5.2.x was not picking these up. Move them back to the root of the module so they are properly picked up on these older versions but still prevents calling the routing functions during an API doc generation.
2023-11-25 15:16:56 -05:00
"""
Runs when the API daemon starts, but not the Celery workers or the API doc generator
"""
Isolate cluster-dependent Celery startup Avoids calling unworkable functions when generating API docs etc. by isolating them into a Celery startup function called by Daemon.py. Also update to Celery 4+ settings format.
2023-11-16 20:25:28 -05:00
app.config["task_queues"] = tuple(
[Queue(h, routing_key=f"{h}.#") for h in get_all_nodes()]
)
celery.conf.update(app.config)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
#
# Custom decorators
#
Format based on updated Black
2023-09-12 16:41:02 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# Request parser decorator
class RequestParser(object):
def __init__(self, reqargs):
self.reqargs = reqargs
Lint: E301 expected 1 blank line, found 0
2020-11-07 12:28:51 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
def __call__(self, function):
if not callable(function):
return
Lint: E306 expected 1 blank line before a nested definition, found 0
2020-11-07 12:17:38 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@wraps(function)
def wrapped_function(*args, **kwargs):
parser = reqparse.RequestParser()
# Parse and add each argument
for reqarg in self.reqargs:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
location = reqarg.get("location", None)
Add override args for RequestParser Properly fixes the issue with OVA upload bodies by allowing the restriction of the 'location' directive when parsing specific request args. Thus the 'form' location can be included by default but removed for those parsers that have a file body.
2020-11-09 10:26:01 -05:00
if location is None:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
location = ["args", "form"]
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
parser.add_argument(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqarg.get("name", None),
required=reqarg.get("required", False),
action=reqarg.get("action", None),
choices=reqarg.get("choices", ()),
help=reqarg.get("helptext", None),
location=location,
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
reqargs = parser.parse_args()
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
kwargs["reqargs"] = reqargs
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return function(*args, **kwargs)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return wrapped_function
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# Authentication decorator function
def Authenticator(function):
@wraps(function)
def authenticate(*args, **kwargs):
# No authentication required
Move config parser into daemon_lib And reformat/add config values for API.
2023-11-29 23:35:12 -05:00
if not config["api_auth_enabled"]:
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return function(*args, **kwargs)
# Session-based authentication
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if "token" in flask.session:
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return function(*args, **kwargs)
# Key header-based authentication
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if "X-Api-Key" in flask.request.headers:
if any(
token
Move config parser into daemon_lib And reformat/add config values for API.
2023-11-29 23:35:12 -05:00
for token in config["api_auth_tokens"]
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if flask.request.headers.get("X-Api-Key") == token.get("token")
):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return function(*args, **kwargs)
else:
Lint: E202 whitespace before '}'
2020-11-07 12:57:42 -05:00
return {"message": "X-Api-Key Authentication failed."}, 401
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# All authentications failed
Lint: E202 whitespace before '}'
2020-11-07 12:57:42 -05:00
return {"message": "X-Api-Key Authentication required."}, 401
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return authenticate
##########################################################
# API Root/Authentication
##########################################################
Format based on updated Black
2023-09-12 16:41:02 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /
class API_Root(Resource):
def get(self):
"""
Return the PVC API version string
---
tags:
- root
responses:
200:
description: OK
schema:
type: object
id: API-Version
properties:
message:
type: string
description: A text message
example: "PVC API version 1.0"
"""
Lint: E202 whitespace before '}'
2020-11-07 12:57:42 -05:00
return {"message": "PVC API version {}".format(API_VERSION)}
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Root, "/")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /doc - NOTE: Until flask_swagger is packaged for Debian this must be disabled
Lint: E265 block comment should start with '# '
2020-11-06 21:32:17 -05:00
# class API_Doc(Resource):
# def get(self):
# """
# Provide the Swagger API documentation
# ---
# tags:
# - root
# responses:
# 200:
# description: OK
# """
# swagger_data = swagger(pvc_api.app)
# swagger_data['info']['version'] = API_VERSION
# swagger_data['info']['title'] = "PVC Client and Provisioner API"
# swagger_data['host'] = "{}:{}".format(config['listen_address'], config['listen_port'])
# return swagger_data
Lint: W291 trailing whitespace
2020-11-07 13:47:02 -05:00
#
Lint: F821 undefined name 'API_Doc' Should have been commented out along with its class.
2020-11-07 13:26:59 -05:00
#
# api.add_resource(API_Doc, '/doc')
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /login
class API_Login(Resource):
def post(self):
"""
Log in to the PVC API with an authentication key
---
tags:
- root
parameters:
- in: query
name: token
type: string
required: true
responses:
200:
description: OK
schema:
type: object
id: Message
properties:
message:
type: string
description: A text message
302:
description: Authentication disabled
401:
description: Unauthorized
schema:
type: object
id: Message
"""
Move config parser into daemon_lib And reformat/add config values for API.
2023-11-29 23:35:12 -05:00
if not config["api_auth_enabled"]:
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return flask.redirect(Api.url_for(api, API_Root))
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if any(
token
Move config parser into daemon_lib And reformat/add config values for API.
2023-11-29 23:35:12 -05:00
for token in config["api_auth_tokens"]
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if flask.request.values["token"] in token["token"]
):
flask.session["token"] = flask.request.form["token"]
Lint: E202 whitespace before '}'
2020-11-07 12:57:42 -05:00
return {"message": "Authentication successful"}, 200
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
else:
Lint: E202 whitespace before '}'
2020-11-07 12:57:42 -05:00
{"message": "Authentication failed"}, 401
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Login, "/login")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /logout
class API_Logout(Resource):
def post(self):
"""
Log out of an existing PVC API session
---
tags:
- root
responses:
200:
description: OK
schema:
type: object
id: Message
302:
description: Authentication disabled
"""
Move config parser into daemon_lib And reformat/add config values for API.
2023-11-29 23:35:12 -05:00
if not config["api_auth_enabled"]:
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return flask.redirect(Api.url_for(api, API_Root))
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
flask.session.pop("token", None)
Lint: E202 whitespace before '}'
2020-11-07 12:57:42 -05:00
return {"message": "Deauthentication successful"}, 200
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Logout, "/logout")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /initialize
class API_Initialize(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "overwrite", "required": False},
{
"name": "yes-i-really-mean-it",
"required": True,
"helptext": "Initialization is destructive; please confirm with the argument 'yes-i-really-mean-it'.",
},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
Add cluster backup + restore functionality Adds cluster backup (JSON dump) and restore functions for use in disaster recovery. Further, adds additional confirmation to the initialization (as well as restore) endpoints to avoid accidental triggering, and also groups the init, backup, and restore commands in the CLI into a new "task" subsection.
2020-11-24 02:39:06 -05:00
def post(self, reqargs):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
"""
Initialize a new PVC cluster
Allow overwrite during init command
2021-05-30 23:59:17 -04:00
Move configuration keys to /config tree
2021-06-01 10:40:32 -04:00
If the 'overwrite' option is not True, the cluster will return 400 if the `/config/primary_node` key is found. If 'overwrite' is True, the existing cluster
Allow overwrite during init command
2021-05-30 23:59:17 -04:00
data will be erased and new, empty data written in its place.
All node daemons should be stopped before running this command, and the API daemon started manually to avoid undefined behavior.
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
---
tags:
- root
Add cluster backup + restore functionality Adds cluster backup (JSON dump) and restore functions for use in disaster recovery. Further, adds additional confirmation to the initialization (as well as restore) endpoints to avoid accidental triggering, and also groups the init, backup, and restore commands in the CLI into a new "task" subsection.
2020-11-24 02:39:06 -05:00
parameters:
Allow overwrite during init command
2021-05-30 23:59:17 -04:00
- in: query
name: overwrite
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: boolean
Allow overwrite during init command
2021-05-30 23:59:17 -04:00
required: false
description: A flag to enable or disable (default) overwriting existing data
Add cluster backup + restore functionality Adds cluster backup (JSON dump) and restore functions for use in disaster recovery. Further, adds additional confirmation to the initialization (as well as restore) endpoints to avoid accidental triggering, and also groups the init, backup, and restore commands in the CLI into a new "task" subsection.
2020-11-24 02:39:06 -05:00
- in: query
name: yes-i-really-mean-it
type: string
required: true
description: A confirmation string to ensure that the API consumer really means it
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
properties:
message:
type: string
description: A text message
400:
description: Bad request
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs.get("overwrite", "False") == "True":
Allow overwrite during init command
2021-05-30 23:59:17 -04:00
overwrite_flag = True
Fix incorrect handling of overwrite flag
2021-06-29 18:22:01 -04:00
else:
overwrite_flag = False
Allow overwrite during init command
2021-05-30 23:59:17 -04:00
Fix bad return from initialize call
2021-06-29 18:31:56 -04:00
return api_helper.initialize_cluster(overwrite=overwrite_flag)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Initialize, "/initialize")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Add cluster backup + restore functionality Adds cluster backup (JSON dump) and restore functions for use in disaster recovery. Further, adds additional confirmation to the initialization (as well as restore) endpoints to avoid accidental triggering, and also groups the init, backup, and restore commands in the CLI into a new "task" subsection.
2020-11-24 02:39:06 -05:00
# /backup
class API_Backup(Resource):
@Authenticator
def get(self):
"""
Back up the Zookeeper data of a cluster in JSON format
---
tags:
- root
responses:
200:
description: OK
schema:
type: object
id: Cluster Data
400:
description: Bad request
"""
return api_helper.backup_cluster()
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Backup, "/backup")
Add cluster backup + restore functionality Adds cluster backup (JSON dump) and restore functions for use in disaster recovery. Further, adds additional confirmation to the initialization (as well as restore) endpoints to avoid accidental triggering, and also groups the init, backup, and restore commands in the CLI into a new "task" subsection.
2020-11-24 02:39:06 -05:00
# /restore
class API_Restore(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "yes-i-really-mean-it",
"required": True,
"helptext": "Restore is destructive; please confirm with the argument 'yes-i-really-mean-it'.",
},
{
"name": "cluster_data",
"required": True,
"helptext": "A cluster JSON backup must be provided.",
},
]
)
Add cluster backup + restore functionality Adds cluster backup (JSON dump) and restore functions for use in disaster recovery. Further, adds additional confirmation to the initialization (as well as restore) endpoints to avoid accidental triggering, and also groups the init, backup, and restore commands in the CLI into a new "task" subsection.
2020-11-24 02:39:06 -05:00
@Authenticator
def post(self, reqargs):
"""
Restore a backup over the cluster; destroys the existing data
---
tags:
- root
parameters:
- in: query
name: yes-i-really-mean-it
type: string
required: true
description: A confirmation string to ensure that the API consumer really means it
- in: query
name: cluster_data
type: string
required: true
description: The raw JSON cluster backup data
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
500:
description: Restore error or code failure
schema:
type: object
id: Message
"""
try:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
cluster_data = reqargs.get("cluster_data")
Add cluster backup + restore functionality Adds cluster backup (JSON dump) and restore functions for use in disaster recovery. Further, adds additional confirmation to the initialization (as well as restore) endpoints to avoid accidental triggering, and also groups the init, backup, and restore commands in the CLI into a new "task" subsection.
2020-11-24 02:39:06 -05:00
except Exception as e:
return {"message": "Failed to load JSON backup: {}.".format(e)}, 400
return api_helper.restore_cluster(cluster_data)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Restore, "/restore")
Add cluster backup + restore functionality Adds cluster backup (JSON dump) and restore functions for use in disaster recovery. Further, adds additional confirmation to the initialization (as well as restore) endpoints to avoid accidental triggering, and also groups the init, backup, and restore commands in the CLI into a new "task" subsection.
2020-11-24 02:39:06 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /status
class API_Status(Resource):
@Authenticator
def get(self):
"""
Return the current PVC cluster status
---
tags:
- root
responses:
200:
description: OK
schema:
type: object
id: ClusterStatus
properties:
Update API specification
2023-02-22 00:06:52 -05:00
cluster_health:
type: object
properties:
health:
type: integer
description: The overall health (%) of the cluster
example: 100
messages:
type: array
description: A list of health event strings
items:
type: string
example: "hv1: plugin 'nics': bond0 DEGRADED with 1 active slaves, bond0 OK at 10000 Mbps"
node_health:
type: object
properties:
hvX:
type: object
description: A node entry for per-node health details, one per node in the cluster
properties:
health:
type: integer
description: The health (%) of the node
example: 100
messages:
type: array
description: A list of health event strings
items:
type: string
example: "'nics': bond0 DEGRADED with 1 active slaves, bond0 OK at 10000 Mbps"
maintenance:
Display Ceph health in PVC status as well Makes this output a little more realistic and allows proper monitoring of the Ceph cluster status (separate from the PVC status which is tracking only OSD up/in state).
2020-08-13 15:06:19 -04:00
type: string
Update API specification
2023-02-22 00:06:52 -05:00
description: Whether the cluster is in maintenance mode or not (string boolean)
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
example: "true"
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
primary_node:
type: string
description: The current primary coordinator node
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
example: "pvchv1"
Add PVC version to cluster status output
2023-02-22 16:05:28 -05:00
pvc_version:
type: string
description: The PVC version of the current primary coordinator node
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
example: "0.9.61"
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
upstream_ip:
type: string
description: The cluster upstream IP address in CIDR format
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
example: "10.0.0.254/24"
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
nodes:
type: object
properties:
total:
type: integer
description: The total number of nodes in the cluster
example: 3
state-combination:
type: integer
description: The total number of nodes in {state-combination} state, where {state-combination} is the node daemon and domain states in CSV format, e.g. "run,ready", "stop,flushed", etc.
vms:
type: object
properties:
total:
type: integer
description: The total number of VMs in the cluster
example: 6
state:
type: integer
description: The total number of VMs in {state} state, e.g. "start", "stop", etc.
networks:
type: integer
description: The total number of networks in the cluster
osds:
type: object
properties:
total:
type: integer
description: The total number of OSDs in the storage cluster
example: 3
state-combination:
type: integer
description: The total number of OSDs in {state-combination} state, where {state-combination} is the OSD up and in states in CSV format, e.g. "up,in", "down,out", etc.
pools:
type: integer
description: The total number of pools in the storage cluster
volumes:
type: integer
description: The total number of volumes in the storage cluster
snapshots:
type: integer
description: The total number of snapshots in the storage cluster
Add total cluster utilization stats Useful for evaluating the cluster resources as a whole.
2024-09-05 13:41:01 -04:00
resources:
type: object
properties:
memory:
type: object
properties:
total:
type: integer
description: The total amount of RAM (all nodes) in MB
used:
type: integer
description: The total used RAM (all nodes) in MB
free:
type: integer
description: The total free RAM (all nodes) in MB
allocated:
type: integer
description: The total amount of RAM allocated to running domains in MB
provisioned:
type: integer
description: The total amount of RAM provisioned to all domains (regardless of state) in MB
utilization:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: number
Add total cluster utilization stats Useful for evaluating the cluster resources as a whole.
2024-09-05 13:41:01 -04:00
description: The memory utilization percentage (average) of the cluster
vcpu:
type: object
properties:
total:
type: integer
description: The total number of real CPU cores (all nodes)
load:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: number
Add total cluster utilization stats Useful for evaluating the cluster resources as a whole.
2024-09-05 13:41:01 -04:00
description: The current 5-minute CPU load (all nodes summed)
allocated:
type: integer
description: The total number of vCPUs allocated to running domains
provisioned:
type: integer
description: The total number of vCPUs provisioned to all domains (regardless of state)
utilization:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: number
Add total cluster utilization stats Useful for evaluating the cluster resources as a whole.
2024-09-05 13:41:01 -04:00
description: The CPU utilization percentage (average) of the cluster
disk:
type: object
properties:
total:
type: integer
description: The total size of all OSDs in KB
used:
type: integer
description: The total used size of all OSDs in KB
free:
type: integer
description: The total free size of all OSDs in KB
utilization:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: number
Add total cluster utilization stats Useful for evaluating the cluster resources as a whole.
2024-09-05 13:41:01 -04:00
description: The disk utilization percentage (average) of the cluster
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
400:
description: Bad request
"""
return api_helper.cluster_status()
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "state",
"choices": ("true", "false"),
"required": True,
"helptext": "A valid state must be specified.",
}
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Set the cluster maintenance mode
---
tags:
Add API endpoint for current primary node This was never exposed before, so expose it for use in other functions being built.
2024-08-19 17:15:52 -04:00
- root
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
parameters:
- in: query
name: state
type: boolean
required: true
description: The cluster maintenance state
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.cluster_maintenance(reqargs.get("state", "false"))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Status, "/status")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Add API endpoint for current primary node This was never exposed before, so expose it for use in other functions being built.
2024-08-19 17:15:52 -04:00
# /status/primary_node
class API_Status_Primary(Resource):
def get(self):
"""
Return the name of the current primary node.
---
tags:
- root
responses:
200:
description: OK
schema:
type: object
properties:
primary_node:
type: string
description: The name of the current primary node
204:
description: No content
schema:
type: object
properties:
primary_node:
type: string
description: An empty response; there is not currently a primary node, try again later
"""
primary_node = get_primary_node()
if primary_node is None:
retdata = None
retcode = 204
else:
retdata = {"primary_node": primary_node}
retcode = 200
return retdata, retcode
api.add_resource(API_Status_Primary, "/status/primary_node")
Add Prometheus metric exporter Adds a "fake" Prometheus metrics endpoint which returns cluster status information in Prometheus format.
2023-12-08 11:45:52 -05:00
# /metrics
class API_Metrics(Resource):
def get(self):
"""
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
Return the current PVC cluster status in Prometheus-compatible metrics format and
the Ceph cluster metrics as one document.
Add Prometheus metric exporter Adds a "fake" Prometheus metrics endpoint which returns cluster status information in Prometheus format.
2023-12-08 11:45:52 -05:00
Allow enable/disable of Prometheus endpoints Since these are unauthenticated, it might be the case that an administrator wishes to completely disable these metrics endpoints. Provide that option via pvc.conf through pvc-ansible's existing enable_prometheus_exporters option and the new enable_prometheus configuration flag. Defaults to "yes" to provide all functionality unless explicitly disabled, as the author assumes that the PVC API is secured in other ways as well and that metric information is not completely sensitive.
2023-12-29 09:23:35 -05:00
Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal
with Prometheus compatibility (only basic auth support). Ensure this API endpoint
is only opened to trusted networks that cannot abuse the data provided!
Add Prometheus metric exporter Adds a "fake" Prometheus metrics endpoint which returns cluster status information in Prometheus format.
2023-12-08 11:45:52 -05:00
---
tags:
- root
responses:
200:
description: OK
400:
description: Bad request
"""
Rename health metrics and add resource metrics
2023-12-20 16:14:28 -05:00
health_output, health_retcode = api_helper.cluster_health_metrics()
resource_output, resource_retcode = api_helper.cluster_resource_metrics()
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
ceph_output, ceph_retcode = api_helper.ceph_metrics()
Add Zookeeper metrics proxy
2023-12-28 12:02:31 -05:00
zookeeper_output, zookeeper_retcode = api_helper.zookeeper_metrics()
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
Rename health metrics and add resource metrics
2023-12-20 16:14:28 -05:00
if health_retcode != 200 or resource_retcode != 200 or ceph_retcode != 200:
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
output = "Error: Failed to obtain data"
retcode = 400
else:
Add Zookeeper metrics proxy
2023-12-28 12:02:31 -05:00
output = health_output + resource_output + ceph_output + zookeeper_output
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
retcode = 200
response = flask.make_response(output, retcode)
response.mimetype = "text/plain"
return response
Add Prometheus metric exporter Adds a "fake" Prometheus metrics endpoint which returns cluster status information in Prometheus format.
2023-12-08 11:45:52 -05:00
Allow enable/disable of Prometheus endpoints Since these are unauthenticated, it might be the case that an administrator wishes to completely disable these metrics endpoints. Provide that option via pvc.conf through pvc-ansible's existing enable_prometheus_exporters option and the new enable_prometheus configuration flag. Defaults to "yes" to provide all functionality unless explicitly disabled, as the author assumes that the PVC API is secured in other ways as well and that metric information is not completely sensitive.
2023-12-29 09:23:35 -05:00
if config["enable_prometheus"]:
api.add_resource(API_Metrics, "/metrics")
Add Prometheus metric exporter Adds a "fake" Prometheus metrics endpoint which returns cluster status information in Prometheus format.
2023-12-08 11:45:52 -05:00
Rename health metrics and add resource metrics
2023-12-20 16:14:28 -05:00
# /metrics/health
class API_Metrics_Health(Resource):
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
def get(self):
"""
Rename health metrics and add resource metrics
2023-12-20 16:14:28 -05:00
Return the current PVC cluster health status in Prometheus-compatible metrics format
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
Allow enable/disable of Prometheus endpoints Since these are unauthenticated, it might be the case that an administrator wishes to completely disable these metrics endpoints. Provide that option via pvc.conf through pvc-ansible's existing enable_prometheus_exporters option and the new enable_prometheus configuration flag. Defaults to "yes" to provide all functionality unless explicitly disabled, as the author assumes that the PVC API is secured in other ways as well and that metric information is not completely sensitive.
2023-12-29 09:23:35 -05:00
Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal
with Prometheus compatibility (only basic auth support). Ensure this API endpoint
is only opened to trusted networks that cannot abuse the data provided!
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
---
tags:
- root
responses:
200:
description: OK
400:
description: Bad request
"""
Rename health metrics and add resource metrics
2023-12-20 16:14:28 -05:00
health_output, health_retcode = api_helper.cluster_health_metrics()
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
Rename health metrics and add resource metrics
2023-12-20 16:14:28 -05:00
if health_retcode != 200:
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
output = "Error: Failed to obtain data"
retcode = 400
else:
Rename health metrics and add resource metrics
2023-12-20 16:14:28 -05:00
output = health_output
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
retcode = 200
response = flask.make_response(output, retcode)
response.mimetype = "text/plain"
return response
Allow enable/disable of Prometheus endpoints Since these are unauthenticated, it might be the case that an administrator wishes to completely disable these metrics endpoints. Provide that option via pvc.conf through pvc-ansible's existing enable_prometheus_exporters option and the new enable_prometheus configuration flag. Defaults to "yes" to provide all functionality unless explicitly disabled, as the author assumes that the PVC API is secured in other ways as well and that metric information is not completely sensitive.
2023-12-29 09:23:35 -05:00
if config["enable_prometheus"]:
api.add_resource(API_Metrics_Health, "/metrics/health")
Rename health metrics and add resource metrics
2023-12-20 16:14:28 -05:00
# /metrics/resource
class API_Metrics_Resource(Resource):
def get(self):
"""
Return the current PVC cluster resource utilizations in Prometheus-compatible metrics format
Allow enable/disable of Prometheus endpoints Since these are unauthenticated, it might be the case that an administrator wishes to completely disable these metrics endpoints. Provide that option via pvc.conf through pvc-ansible's existing enable_prometheus_exporters option and the new enable_prometheus configuration flag. Defaults to "yes" to provide all functionality unless explicitly disabled, as the author assumes that the PVC API is secured in other ways as well and that metric information is not completely sensitive.
2023-12-29 09:23:35 -05:00
Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal
with Prometheus compatibility (only basic auth support). Ensure this API endpoint
is only opened to trusted networks that cannot abuse the data provided!
Rename health metrics and add resource metrics
2023-12-20 16:14:28 -05:00
---
tags:
- root
responses:
200:
description: OK
400:
description: Bad request
"""
resource_output, resource_retcode = api_helper.cluster_resource_metrics()
if resource_retcode != 200:
output = "Error: Failed to obtain data"
retcode = 400
else:
output = resource_output
retcode = 200
response = flask.make_response(output, retcode)
response.mimetype = "text/plain"
return response
Allow enable/disable of Prometheus endpoints Since these are unauthenticated, it might be the case that an administrator wishes to completely disable these metrics endpoints. Provide that option via pvc.conf through pvc-ansible's existing enable_prometheus_exporters option and the new enable_prometheus configuration flag. Defaults to "yes" to provide all functionality unless explicitly disabled, as the author assumes that the PVC API is secured in other ways as well and that metric information is not completely sensitive.
2023-12-29 09:23:35 -05:00
if config["enable_prometheus"]:
api.add_resource(API_Metrics_Resource, "/metrics/resource")
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
Add Ceph metrics proxy and health fault counts
2023-12-09 02:52:08 -05:00
# /metrics/ceph
class API_Metrics_Ceph(Resource):
def get(self):
"""
Return the current PVC Ceph Prometheus metrics
Proxies a metrics request to the current active MGR, since this is dynamic
and can't be controlled by PVC easily.
Allow enable/disable of Prometheus endpoints Since these are unauthenticated, it might be the case that an administrator wishes to completely disable these metrics endpoints. Provide that option via pvc.conf through pvc-ansible's existing enable_prometheus_exporters option and the new enable_prometheus configuration flag. Defaults to "yes" to provide all functionality unless explicitly disabled, as the author assumes that the PVC API is secured in other ways as well and that metric information is not completely sensitive.
2023-12-29 09:23:35 -05:00
Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal
with Prometheus compatibility (only basic auth support). Ensure this API endpoint
is only opened to trusted networks that cannot abuse the data provided!
Add Ceph metrics proxy and health fault counts
2023-12-09 02:52:08 -05:00
---
tags:
- root
responses:
200:
description: OK
400:
description: Bad request
"""
Rework metrics output and add combined endpoint
2023-12-09 15:47:40 -05:00
ceph_output, ceph_retcode = api_helper.ceph_metrics()
if ceph_retcode != 200:
output = "Error: Failed to obtain data"
retcode = 400
else:
output = ceph_output
retcode = 200
response = flask.make_response(output, retcode)
response.mimetype = "text/plain"
return response
Add Ceph metrics proxy and health fault counts
2023-12-09 02:52:08 -05:00
Allow enable/disable of Prometheus endpoints Since these are unauthenticated, it might be the case that an administrator wishes to completely disable these metrics endpoints. Provide that option via pvc.conf through pvc-ansible's existing enable_prometheus_exporters option and the new enable_prometheus configuration flag. Defaults to "yes" to provide all functionality unless explicitly disabled, as the author assumes that the PVC API is secured in other ways as well and that metric information is not completely sensitive.
2023-12-29 09:23:35 -05:00
if config["enable_prometheus"]:
api.add_resource(API_Metrics_Ceph, "/metrics/ceph")
Add Ceph metrics proxy and health fault counts
2023-12-09 02:52:08 -05:00
Add Zookeeper metrics proxy
2023-12-28 12:02:31 -05:00
# /metrics/zookeeper
class API_Metrics_Zookeeper(Resource):
def get(self):
"""
Return the current PVC Zookeeper Prometheus metrics
Proxies a metrics request to the current primary node, since all coordinators
run an active Zookeeper instance and we want one central location.
Allow enable/disable of Prometheus endpoints Since these are unauthenticated, it might be the case that an administrator wishes to completely disable these metrics endpoints. Provide that option via pvc.conf through pvc-ansible's existing enable_prometheus_exporters option and the new enable_prometheus configuration flag. Defaults to "yes" to provide all functionality unless explicitly disabled, as the author assumes that the PVC API is secured in other ways as well and that metric information is not completely sensitive.
2023-12-29 09:23:35 -05:00
Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal
with Prometheus compatibility (only basic auth support). Ensure this API endpoint
is only opened to trusted networks that cannot abuse the data provided!
Add Zookeeper metrics proxy
2023-12-28 12:02:31 -05:00
---
tags:
- root
responses:
200:
description: OK
400:
description: Bad request
"""
zookeeper_output, zookeeper_retcode = api_helper.zookeeper_metrics()
if zookeeper_retcode != 200:
output = "Error: Failed to obtain data"
retcode = 400
else:
output = zookeeper_output
retcode = 200
response = flask.make_response(output, retcode)
response.mimetype = "text/plain"
return response
Allow enable/disable of Prometheus endpoints Since these are unauthenticated, it might be the case that an administrator wishes to completely disable these metrics endpoints. Provide that option via pvc.conf through pvc-ansible's existing enable_prometheus_exporters option and the new enable_prometheus configuration flag. Defaults to "yes" to provide all functionality unless explicitly disabled, as the author assumes that the PVC API is secured in other ways as well and that metric information is not completely sensitive.
2023-12-29 09:23:35 -05:00
if config["enable_prometheus"]:
api.add_resource(API_Metrics_Zookeeper, "/metrics/zookeeper")
Add Zookeeper metrics proxy
2023-12-28 12:02:31 -05:00
Implement interfaces to faults
2023-12-04 01:37:54 -05:00
# /faults
class API_Faults(Resource):
@RequestParser(
[
{
"name": "sort_key",
"choices": (
"first_reported",
"last_reported",
"acknowledged_at",
"status",
"health_delta",
"message",
),
"helptext": "A valid sort key must be specified",
"required": False,
},
]
)
@Authenticator
def get(self, reqargs):
"""
Return a list of cluster faults
---
tags:
- faults
Fix Swagger doc issues
2024-08-19 16:55:13 -04:00
definitions:
- schema:
type: object
id: fault
properties:
id:
type: string
description: The ID of the fault
example: "10ae144b78b4cc5fdf09e2ebbac51235"
first_reported:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: string
Fix Swagger doc issues
2024-08-19 16:55:13 -04:00
description: The first time the fault was reported
example: "2023-12-01 16:47:59.849742"
last_reported:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: string
Fix Swagger doc issues
2024-08-19 16:55:13 -04:00
description: The last time the fault was reported
example: "2023-12-01 17:39:45.188398"
acknowledged_at:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: string
Fix Swagger doc issues
2024-08-19 16:55:13 -04:00
description: The time the fault was acknowledged, or empty if not acknowledged
example: "2023-12-01 17:50:00.000000"
status:
type: string
description: The current state of the fault, either "new" or "ack" (acknowledged)
example: "new"
health_delta:
type: integer
description: The health delta (amount it reduces cluster health from 100%) of the fault
example: 25
message:
type: string
description: The textual description of the fault
example: "Node hv1 was at 40% (psur@-10%, psql@-50%) <= 50% health"
Implement interfaces to faults
2023-12-04 01:37:54 -05:00
parameters:
- in: query
name: sort_key
type: string
required: false
description: The fault object key to sort results by
enum:
- first_reported
- last_reported
- acknowledged_at
- status
- health_delta
- message
responses:
200:
description: OK
schema:
type: array
items:
Fix Swagger doc issues
2024-08-19 16:55:13 -04:00
$ref: '#/definitions/fault'
Implement interfaces to faults
2023-12-04 01:37:54 -05:00
"""
return api_helper.fault_list(sort_key=reqargs.get("sort_key", "last_reported"))
Add mass ack/delete of faults
2023-12-06 13:33:27 -05:00
@Authenticator
def put(self):
"""
Acknowledge all cluster faults
---
tags:
- faults
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
description: A text message
"""
return api_helper.fault_acknowledge_all()
@Authenticator
def delete(self):
"""
Delete all cluster faults
---
tags:
- faults
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
description: A text message
"""
return api_helper.fault_delete_all()
Implement interfaces to faults
2023-12-04 01:37:54 -05:00
api.add_resource(API_Faults, "/faults")
# /faults/<fault_id>
class API_Faults_Element(Resource):
@Authenticator
def get(self, fault_id):
"""
Return a single cluster fault
---
tags:
- faults
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: fault_id
type: string
required: true
description: Path parameter
Implement interfaces to faults
2023-12-04 01:37:54 -05:00
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/fault'
"""
return api_helper.fault_list(limit=fault_id)
@Authenticator
def put(self, fault_id):
"""
Acknowledge a cluster fault
---
tags:
- faults
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: fault_id
type: string
required: true
description: Path parameter
Implement interfaces to faults
2023-12-04 01:37:54 -05:00
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
description: A text message
"""
return api_helper.fault_acknowledge(fault_id)
@Authenticator
def delete(self, fault_id):
"""
Delete a cluster fault
---
tags:
- faults
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: fault_id
type: string
required: true
description: Path parameter
Implement interfaces to faults
2023-12-04 01:37:54 -05:00
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
description: A text message
"""
return api_helper.fault_delete(fault_id)
api.add_resource(API_Faults_Element, "/faults/<fault_id>")
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
# /tasks
class API_Tasks(Resource):
@Authenticator
def get(self):
"""
Return a list of active Celery worker tasks
---
tags:
- root
responses:
200:
description: OK
schema:
type: object
properties:
active:
type: object
description: Celery app.control.inspect active tasks
reserved:
type: object
description: Celery app.control.inspect reserved tasks
scheduled:
type: object
description: Celery app.control.inspect scheduled tasks
"""
queue = celery.control.inspect()
response = {
"scheduled": queue.scheduled(),
"active": queue.active(),
"reserved": queue.reserved(),
}
return response
api.add_resource(API_Tasks, "/tasks")
# /tasks/<task_id>
class API_Tasks_Element(Resource):
@Authenticator
def get(self, task_id):
"""
View status of a Celery worker task {task_id}
---
tags:
- provisioner
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: task_id
type: string
required: true
description: Path parameter
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
responses:
200:
description: OK
schema:
type: object
properties:
total:
type: integer
description: Total number of steps
current:
type: integer
description: Current steps completed
state:
type: string
description: Current job state
status:
type: string
description: Status details about job
404:
description: Not found
schema:
type: object
id: Message
"""
task = celery.AsyncResult(task_id)
if task.state == "PENDING":
response = {
"state": task.state,
"current": 0,
"total": 1,
"status": "Pending job start",
}
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
elif task.state == "FAILURE":
response = {
"state": task.state,
"current": 1,
"total": 1,
"status": str(task.info),
}
else:
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
response = {
"state": task.state,
"current": task.info.get("current", 0),
"total": task.info.get("total", 1),
"status": task.info.get("status", ""),
}
if "result" in task.info:
response["result"] = task.info["result"]
return response
api.add_resource(API_Tasks_Element, "/tasks/<task_id>")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
##########################################################
# Client API - Node
##########################################################
Format based on updated Black
2023-09-12 16:41:02 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /node
class API_Node_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "limit"},
{"name": "daemon_state"},
{"name": "coordinator_state"},
{"name": "domain_state"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of nodes in the cluster
---
tags:
- node
definitions:
- schema:
type: object
id: node
properties:
name:
type: string
description: The name of the node
daemon_state:
type: string
description: The current daemon state
coordinator_state:
type: string
description: The current coordinator state
domain_state:
type: string
description: The current domain (VM) state
Add node PVC version data to Node information Allows API client to see the currently-active version of the node daemon.
2021-07-05 09:57:38 -04:00
pvc_version:
type: string
description: The current running PVC node daemon version
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
cpu_count:
type: integer
description: The number of available CPU cores
kernel:
type: string
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
description: The running kernel version from uname
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
os:
type: string
description: The current operating system type
arch:
type: string
description: The architecture of the CPU
Update API specification
2023-02-22 00:06:52 -05:00
health:
type: integer
description: The overall health (%) of the node
example: 100
Add last item to swagger doc
2023-02-22 00:25:27 -05:00
health_plugins:
type: array
description: A list of health plugin names currently loaded on the node
items:
type: string
example: "nics"
Update API specification
2023-02-22 00:06:52 -05:00
health_details:
type: array
description: A list of health plugin results
items:
type: object
properties:
name:
type: string
description: The name of the health plugin
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
example: "nics"
Update API specification
2023-02-22 00:06:52 -05:00
last_run:
type: integer
description: The UNIX timestamp (s) of the last plugin run
example: 1676786078
health_delta:
type: integer
description: The health delta (negatively applied to the health percentage) of the plugin's current state
example: 10
message:
type: string
description: The output message of the plugin
example: "bond0 DEGRADED with 1 active slaves, bond0 OK at 10000 Mbps"
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
load:
type: number
format: float
description: The current 5-minute CPU load
domains_count:
type: integer
description: The number of running domains (VMs)
running_domains:
type: string
description: The list of running domains (VMs) by UUID
vcpu:
type: object
properties:
total:
type: integer
description: The total number of real CPU cores available
allocated:
type: integer
description: The total number of allocated vCPU cores
memory:
type: object
properties:
total:
type: integer
description: The total amount of node RAM in MB
used:
type: integer
description: The total used RAM on the node in MB
free:
type: integer
description: The total free RAM on the node in MB
Add provisioned memory to node info Adds a separate field to the node memory, "provisioned", which totals the amount of memory provisioned to all VMs on the node, regardless of state, and in contrast to "allocated" which only counts running VMs. Allows for the detection of potential overprovisioned states when factoring in non-running VMs. Includes the supporting code to get this data, since the original implementation of VM memory selection was dependent on the VM being running and getting this from libvirt. Now, if the VM is not active, it gets this from the domain XML instead.
2020-10-18 14:02:34 -04:00
allocated:
type: integer
description: The total amount of RAM allocated to running domains in MB
provisioned:
type: integer
description: The total amount of RAM provisioned to all domains (regardless of state) on this node in MB
Add node network statistics and utilization values Adds a new physical network interface stats parser to the node keepalives, and leverages this information to provide a network utilization overview in the Prometheus metrics.
2023-12-21 15:12:20 -05:00
interfaces:
type: object
description: Details on speed, bytes, and packets per second of each node physical network interface
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
parameters:
- in: query
name: limit
type: string
required: false
Add VM list filtering by tag Uses same method as state or node filtering, rather than altering how the main LIMIT field works.
2021-07-14 00:51:48 -04:00
description: A search limit in the name, tags, or an exact UUID; fuzzy by default, use ^/$ to force exact matches
Implement limiting of node output Closes #98
2020-06-25 11:38:30 -04:00
- in: query
name: daemon_state
type: string
required: false
description: Limit results to nodes in the specified daemon state
- in: query
name: coordinator_state
type: string
required: false
description: Limit results to nodes in the specified coordinator state
- in: query
name: domain_state
type: string
required: false
description: Limit results to nodes in the specified domain state
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/node'
"""
Implement limiting of node output Closes #98
2020-06-25 11:38:30 -04:00
return api_helper.node_list(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
limit=reqargs.get("limit", None),
daemon_state=reqargs.get("daemon_state", None),
coordinator_state=reqargs.get("coordinator_state", None),
domain_state=reqargs.get("domain_state", None),
Implement limiting of node output Closes #98
2020-06-25 11:38:30 -04:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Node_Root, "/node")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /node/<node>
class API_Node_Element(Resource):
@Authenticator
def get(self, node):
"""
Return information about {node}
---
tags:
- node
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: node
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/node'
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.node_list(node, is_fuzzy=False)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Node_Element, "/node/<node>")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /node/<node>/daemon-state
class API_Node_DaemonState(Resource):
@Authenticator
def get(self, node):
"""
Return the daemon state of {node}
---
tags:
- node
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: node
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: NodeDaemonState
properties:
name:
type: string
description: The name of the node
daemon_state:
type: string
description: The current daemon state
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.node_daemon_state(node)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Node_DaemonState, "/node/<node>/daemon-state")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /node/<node>/coordinator-state
class API_Node_CoordinatorState(Resource):
@Authenticator
def get(self, node):
"""
Return the coordinator state of {node}
---
tags:
- node
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: node
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: NodeCoordinatorState
properties:
name:
type: string
description: The name of the node
coordinator_state:
type: string
description: The current coordinator state
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.node_coordinator_state(node)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "state",
"choices": ("primary", "secondary"),
"helptext": "A valid state must be specified",
"required": True,
}
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, node, reqargs):
"""
Set the coordinator state of {node}
---
tags:
- node
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: node
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: action
type: string
required: true
description: The new coordinator state of the node
enum:
- primary
- secondary
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs["state"] == "primary":
Revert "Implement wait for node coordinator transition" This reverts commit 0aefafa7f777157776084db846240dd027b81fe3. This does not work since the API goes away during the transition. References #72
2020-02-19 10:50:21 -05:00
return api_helper.node_primary(node)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs["state"] == "secondary":
Revert "Implement wait for node coordinator transition" This reverts commit 0aefafa7f777157776084db846240dd027b81fe3. This does not work since the API goes away during the transition. References #72
2020-02-19 10:50:21 -05:00
return api_helper.node_secondary(node)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
abort(400)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Node_CoordinatorState, "/node/<node>/coordinator-state")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /node/<node>/domain-state
class API_Node_DomainState(Resource):
@Authenticator
def get(self, node):
"""
Return the domain state of {node}
---
tags:
- node
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: node
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: NodeDomainState
properties:
name:
type: string
description: The name of the node
domain_state:
type: string
description: The current domain state
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.node_domain_state(node)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "state",
"choices": ("ready", "flush"),
"helptext": "A valid state must be specified",
"required": True,
},
{"name": "wait"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, node, reqargs):
"""
Set the domain state of {node}
---
tags:
- node
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: node
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: action
type: string
required: true
description: The new domain state of the node
enum:
- flush
- ready
- in: query
name: wait
type: boolean
description: Whether to block waiting for the full flush/ready state
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs["state"] == "flush":
return api_helper.node_flush(
node, bool(strtobool(reqargs.get("wait", "false")))
)
if reqargs["state"] == "ready":
return api_helper.node_ready(
node, bool(strtobool(reqargs.get("wait", "false")))
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
abort(400)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Node_DomainState, "/node/<node>/domain-state")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Add node log functions to API and CLI
2021-07-18 17:37:49 -04:00
# /node/<node</log
class API_Node_Log(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "lines"}])
Add node log functions to API and CLI
2021-07-18 17:37:49 -04:00
@Authenticator
def get(self, node, reqargs):
"""
Return the recent logs of {node}
---
tags:
- node
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: node
type: string
required: true
description: Path parameter
Add node log functions to API and CLI
2021-07-18 17:37:49 -04:00
- in: query
name: lines
type: integer
required: false
description: The number of lines to retrieve
responses:
200:
description: OK
schema:
type: object
id: NodeLog
properties:
name:
type: string
description: The name of the Node
data:
type: string
description: The recent log text
404:
description: Node not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.node_log(node, reqargs.get("lines", None))
Add node log functions to API and CLI
2021-07-18 17:37:49 -04:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Node_Log, "/node/<node>/log")
Add node log functions to API and CLI
2021-07-18 17:37:49 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
##########################################################
# Client API - VM
##########################################################
Format based on updated Black
2023-09-12 16:41:02 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /vm
class API_VM_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "limit"},
{"name": "node"},
{"name": "state"},
{"name": "tag"},
{"name": "negate"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of VMs in the cluster
---
tags:
- vm
definitions:
- schema:
type: object
id: vm
properties:
name:
type: string
description: The name of the VM
uuid:
type: string
description: The UUID of the VM
state:
type: string
description: The current state of the VM
node:
type: string
description: The node the VM is currently assigned to
last_node:
type: string
description: The last node the VM was assigned to before migrating
migrated:
type: string
description: Whether the VM has been migrated, either "no" or "from <last_node>"
failed_reason:
type: string
description: Information about why the VM failed to start
node_limit:
type: array
description: The node(s) the VM is permitted to be assigned to
items:
type: string
node_selector:
type: string
Add selector help and adjust flag name 1. Add documentation on the node selector flags. In the API, reference the daemon configuration manual which now includes details in this section; in the CLI, provide the help in "pvc vm define" in detail and then reference that command's help in the other commands that use this field. 2. Ensure the naming is consistent in the CLI, using the flag name "--node-selector" everywhere (was "--selector" for "pvc vm" commands and "--node-selector" for "pvc provisioner" commands).
2022-06-10 02:14:15 -04:00
description: The selector used to determine candidate nodes during migration; see 'target_selector' in the node daemon configuration reference
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
node_autostart:
type: boolean
description: Whether to autostart the VM when its node returns to ready domain state
Support per-VM migration type selectors Allow a VM to specify its migration type as a default choice. The valid options are "default" (i.e. behave as now), "live" which forces a live migration only, and "shutdown" which forces a shutdown migration only. The new option is treated as a VM meta option and is set to default if not found.
2020-10-29 11:31:32 -04:00
migration_method:
type: string
description: The preferred migration method (live, shutdown, none)
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
migration_max_downtime:
type: integer
description: The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
tags:
type: array
description: The tag(s) of the VM
items:
type: object
Remove is_backup flag for snapshots This won't be needed for anything.
2024-05-21 15:10:28 -04:00
properties:
name:
type: string
description: The name of the tag
type:
type: string
description: The type of the tag (user, system)
protected:
type: boolean
description: Whether the tag is protected or not
snapshots:
type: array
description: The snapshot(s) of the VM
items:
type: object
Add snapshot lists and timestamp Adds snapshots to the list of data in VM objects
2024-05-21 13:14:55 -04:00
properties:
name:
type: string
description: The name of the snapshot
timestamp:
type: string
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
description: Unix timestamp of the snapshot
Remove is_backup flag for snapshots This won't be needed for anything.
2024-05-21 15:10:28 -04:00
age:
type: string
Fix Swagger doc issues
2024-08-19 16:55:13 -04:00
description: Human-readable age of the snapshot in the largest viable unit (seconds, minutes, hours, days)
Add snapshot lists and timestamp Adds snapshots to the list of data in VM objects
2024-05-21 13:14:55 -04:00
rbd_snapshots:
type: array
items:
type: string
description: A list of RBD volume snapshots belonging to this VM snapshot, in '<pool>/<volume>@<snapshot>' format
xml_diff_lines:
type: array
items:
type: string
description: A list of strings representing the lines of an (n=1) unified diff between the current VM XML specification and the snapshot VM XML specification
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
description:
type: string
description: The description of the VM
profile:
type: string
description: The provisioner profile used to create the VM
memory:
type: integer
description: The assigned RAM of the VM in MB
Add statistics values to the API
2020-06-07 02:15:33 -04:00
memory_stats:
type: object
properties:
actual:
type: integer
description: The total active memory of the VM in kB
swap_in:
type: integer
description: The amount of swapped in data in kB
swap_out:
type: integer
description: The amount of swapped out data in kB
major_fault:
type: integer
description: The number of major page faults
minor_fault:
type: integer
description: The number of minor page faults
unused:
type: integer
description: The amount of memory left completely unused by the system in kB
available:
type: integer
description: The total amount of usable memory as seen by the domain in kB
usable:
type: integer
description: How much the balloon can be inflated without pushing the guest system to swap in kB
last_update:
type: integer
description: Timestamp of the last update of statistics, in seconds
rss:
type: integer
description: The Resident Set Size of the process running the domain in kB
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
vcpu:
type: integer
description: The assigned vCPUs of the VM
vcpu_topology:
type: string
description: The topology of the assigned vCPUs in Sockets/Cores/Threads format
Add statistics values to the API
2020-06-07 02:15:33 -04:00
vcpu_stats:
type: object
properties:
cpu_time:
type: integer
description: The active CPU time for all vCPUs
user_time:
type: integer
description: vCPU user time
system_time:
type: integer
description: vCPU system time
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
type:
type: string
description: The type of the VM
arch:
type: string
description: The architecture of the VM
machine:
type: string
description: The QEMU machine type of the VM
console:
type: string
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
description: The serial console type of the VM
Add live VNC information to domain output Sets in the node daemon, returns via the API, and shows in the CLI, information about the live VNC listen address and port for VNC-enabled VMs. Closes #115
2020-12-20 16:00:55 -05:00
vnc:
type: object
properties:
listen:
type: string
description: The active VNC listen address or 'None'
port:
type: string
description: The active VNC port or 'None'
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
emulator:
type: string
description: The binary emulator of the VM
features:
type: array
description: The available features of the VM
items:
type: string
networks:
type: array
description: The PVC networks attached to the VM
items:
type: object
properties:
type:
type: string
description: The PVC network type
mac:
type: string
description: The MAC address of the VM network interface
source:
type: string
description: The parent network bridge on the node
Add VNI to VM network API list Saves some processing on API clients.
2020-12-01 04:44:33 -05:00
vni:
type: integer
description: The VNI (PVC network) of the network bridge
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
model:
type: string
description: The virtual network device model
Add statistics values to the API
2020-06-07 02:15:33 -04:00
rd_bytes:
type: integer
description: The number of read bytes on the interface
rd_packets:
type: integer
description: The number of read packets on the interface
rd_errors:
type: integer
description: The number of read errors on the interface
rd_drops:
type: integer
description: The number of read drops on the interface
wr_bytes:
type: integer
description: The number of write bytes on the interface
wr_packets:
type: integer
description: The number of write packets on the interface
wr_errors:
type: integer
description: The number of write errors on the interface
wr_drops:
type: integer
description: The number of write drops on the interface
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
disks:
type: array
description: The PVC storage volumes attached to the VM
items:
type: object
properties:
type:
type: string
description: The type of volume
name:
type: string
description: The full name of the volume in "pool/volume" format
dev:
type: string
description: The device ID of the volume in the VM
bus:
type: string
description: The virtual bus of the volume in the VM
Add statistics values to the API
2020-06-07 02:15:33 -04:00
rd_req:
type: integer
description: The number of read requests from the volume
rd_bytes:
type: integer
description: The number of read bytes from the volume
wr_req:
type: integer
description: The number of write requests to the volume
wr_bytes:
type: integer
description: The number of write bytes to the volume
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
controllers:
type: array
description: The device controllers attached to the VM
items:
type: object
properties:
type:
type: string
description: The type of the controller
model:
type: string
description: The model of the controller
xml:
type: string
description: The raw Libvirt XML definition of the VM
parameters:
- in: query
name: limit
type: string
required: false
Add VM list filtering by tag Uses same method as state or node filtering, rather than altering how the main LIMIT field works.
2021-07-14 00:51:48 -04:00
description: A search limit in the name, tags, or an exact UUID; fuzzy by default, use ^/$ to force exact matches
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: node
type: string
required: false
description: Limit list to VMs assigned to this node
- in: query
name: state
type: string
required: false
description: Limit list to VMs in this state
Add VM list filtering by tag Uses same method as state or node filtering, rather than altering how the main LIMIT field works.
2021-07-14 00:51:48 -04:00
- in: query
name: tag
type: string
required: false
description: Limit list to VMs with this tag
Add limit negation to VM list When using the "state", "node", or "tag" arguments to a VM list, add support for a "negate" flag to look for all VMs *not in* the state, node, or tag state.
2021-10-07 11:13:30 -04:00
- in: query
name: negate
type: boolean
required: false
description: Negate the specified node, state, or tag limit(s)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/vm'
"""
return api_helper.vm_list(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
node=reqargs.get("node", None),
state=reqargs.get("state", None),
tag=reqargs.get("tag", None),
limit=reqargs.get("limit", None),
negate=bool(strtobool(reqargs.get("negate", "False"))),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "limit"},
{"name": "node"},
{
"name": "selector",
Flip behaviour of memory selectors It didn't make any sense to me for mem(prov) to be the default selector, since this has too many caveats versus mem(free). Switch to using mem(free) as the default (i.e. "mem") and make memprov the alternative.
2022-11-15 15:45:59 -05:00
"choices": ("mem", "memprov", "vcpus", "load", "vms", "none"),
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
"helptext": "A valid selector must be specified",
},
{"name": "autostart"},
{
"name": "migration_method",
"choices": ("live", "shutdown", "none"),
"helptext": "A valid migration_method must be specified",
},
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
{
"name": "migration_max_downtime",
"helptext": "A valid migration_max_downtime must be specified",
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
{"name": "user_tags", "action": "append"},
{"name": "protected_tags", "action": "append"},
{
"name": "xml",
"required": True,
"helptext": "A Libvirt XML document must be specified",
},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Update the description of VM define endpoint
2024-10-01 13:30:20 -04:00
Define/create a new virtual machine
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
---
tags:
- vm
parameters:
- in: query
name: xml
type: string
required: true
description: The raw Libvirt XML definition of the VM
- in: query
name: node
type: string
required: false
description: The node the VM should be assigned to; autoselect if empty or invalid
- in: query
name: limit
type: string
required: false
description: The CSV list of node(s) the VM is permitted to be assigned to; should include "node" and any other valid target nodes; this limit will be used for autoselection on definition and migration
- in: query
name: selector
type: string
required: false
Add selector help and adjust flag name 1. Add documentation on the node selector flags. In the API, reference the daemon configuration manual which now includes details in this section; in the CLI, provide the help in "pvc vm define" in detail and then reference that command's help in the other commands that use this field. 2. Ensure the naming is consistent in the CLI, using the flag name "--node-selector" everywhere (was "--selector" for "pvc vm" commands and "--node-selector" for "pvc provisioner" commands).
2022-06-10 02:14:15 -04:00
description: The selector used to determine candidate nodes during migration; see 'target_selector' in the node daemon configuration reference
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
enum:
- mem
Flip behaviour of memory selectors It didn't make any sense to me for mem(prov) to be the default selector, since this has too many caveats versus mem(free). Switch to using mem(free) as the default (i.e. "mem") and make memprov the alternative.
2022-11-15 15:45:59 -05:00
- memprov
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- vcpus
- load
- vms
Add memfree to selector and use proper defaults
2022-06-10 02:03:12 -04:00
- none (cluster default)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: autostart
type: boolean
required: false
description: Whether to autostart the VM when its node returns to ready domain state
Support per-VM migration type selectors Allow a VM to specify its migration type as a default choice. The valid options are "default" (i.e. behave as now), "live" which forces a live migration only, and "shutdown" which forces a shutdown migration only. The new option is treated as a VM meta option and is set to default if not found.
2020-10-29 11:31:32 -04:00
- in: query
name: migration_method
type: string
required: false
description: The preferred migration method (live, shutdown, none)
enum:
- live
- shutdown
- none
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
- in: query
name: migration_max_downtime
type: integer
required: false
description: The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime
default: 300
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
- in: query
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
name: user_tags
type: array
required: false
description: The user tag(s) of the VM
items:
type: string
- in: query
name: protected_tags
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
type: array
required: false
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
description: The protected user tag(s) of the VM
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
items:
type: string
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
user_tags = reqargs.get("user_tags", None)
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
if user_tags is None:
user_tags = []
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
protected_tags = reqargs.get("protected_tags", None)
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
if protected_tags is None:
protected_tags = []
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return api_helper.vm_define(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("xml"),
reqargs.get("node", None),
reqargs.get("limit", None),
reqargs.get("selector", "none"),
bool(strtobool(reqargs.get("autostart", "false"))),
reqargs.get("migration_method", "none"),
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
reqargs.get("migration_max_downtime", 300),
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
user_tags,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
protected_tags,
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_VM_Root, "/vm")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /vm/<vm>
class API_VM_Element(Resource):
@Authenticator
def get(self, vm):
"""
Return information about {vm}
---
tags:
- vm
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: vm
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/vm'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.vm_list(
node=None, state=None, tag=None, limit=vm, is_fuzzy=False, negate=False
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "limit"},
{"name": "node"},
{
"name": "selector",
Flip behaviour of memory selectors It didn't make any sense to me for mem(prov) to be the default selector, since this has too many caveats versus mem(free). Switch to using mem(free) as the default (i.e. "mem") and make memprov the alternative.
2022-11-15 15:45:59 -05:00
"choices": ("mem", "memprov", "vcpus", "load", "vms", "none"),
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
"helptext": "A valid selector must be specified",
},
{"name": "autostart"},
{
"name": "migration_method",
"choices": ("live", "shutdown", "none"),
"helptext": "A valid migration_method must be specified",
},
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
{
"name": "migration_max_downtime",
"helptext": "A valid migration_max_downtime must be specified",
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
{"name": "user_tags", "action": "append"},
{"name": "protected_tags", "action": "append"},
{
"name": "xml",
"required": True,
"helptext": "A Libvirt XML document must be specified",
},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, vm, reqargs):
"""
Update the description of VM define endpoint
2024-10-01 13:30:20 -04:00
Define/create a new virtual machine
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Note: The name {vm} is ignored; only the "name" value from the Libvirt XML is used
Update the description of VM define endpoint
2024-10-01 13:30:20 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
This endpoint is identical to "POST /api/v1/vm"
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: xml
type: string
required: true
description: The raw Libvirt XML definition of the VM
- in: query
name: node
type: string
required: false
description: The node the VM should be assigned to; autoselect if empty or invalid
- in: query
name: limit
type: string
required: false
description: The CSV list of node(s) the VM is permitted to be assigned to; should include "node" and any other valid target nodes; this limit will be used for autoselection on definition and migration
- in: query
name: selector
type: string
required: false
Add selector help and adjust flag name 1. Add documentation on the node selector flags. In the API, reference the daemon configuration manual which now includes details in this section; in the CLI, provide the help in "pvc vm define" in detail and then reference that command's help in the other commands that use this field. 2. Ensure the naming is consistent in the CLI, using the flag name "--node-selector" everywhere (was "--selector" for "pvc vm" commands and "--node-selector" for "pvc provisioner" commands).
2022-06-10 02:14:15 -04:00
description: The selector used to determine candidate nodes during migration; see 'target_selector' in the node daemon configuration reference
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
enum:
- mem
Flip behaviour of memory selectors It didn't make any sense to me for mem(prov) to be the default selector, since this has too many caveats versus mem(free). Switch to using mem(free) as the default (i.e. "mem") and make memprov the alternative.
2022-11-15 15:45:59 -05:00
- memprov
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- vcpus
- load
- vms
More gracefully handle none selectors Allow selection of "none" as the node selector, and handle this by always using the cluster default instead of writing it in.
2021-06-01 11:05:15 -04:00
- none (cluster default)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: autostart
type: boolean
required: false
description: Whether to autostart the VM when its node returns to ready domain state
Support per-VM migration type selectors Allow a VM to specify its migration type as a default choice. The valid options are "default" (i.e. behave as now), "live" which forces a live migration only, and "shutdown" which forces a shutdown migration only. The new option is treated as a VM meta option and is set to default if not found.
2020-10-29 11:31:32 -04:00
- in: query
name: migration_method
type: string
required: false
description: The preferred migration method (live, shutdown, none)
enum:
- live
- shutdown
- none
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
- in: query
name: migration_max_downtime
type: integer
required: false
description: The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime
default: 300
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
- in: query
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
name: user_tags
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
type: array
required: false
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
description: The user tag(s) of the VM
items:
type: string
- in: query
name: protected_tags
type: array
required: false
description: The protected user tag(s) of the VM
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
items:
type: string
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
user_tags = reqargs.get("user_tags", None)
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
if user_tags is None:
user_tags = []
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
protected_tags = reqargs.get("protected_tags", None)
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
if protected_tags is None:
protected_tags = []
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return api_helper.vm_define(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("xml"),
reqargs.get("node", None),
reqargs.get("limit", None),
reqargs.get("selector", "none"),
bool(strtobool(reqargs.get("autostart", "false"))),
reqargs.get("migration_method", "none"),
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
reqargs.get("migration_max_downtime", 300),
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
user_tags,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
protected_tags,
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "restart"},
{
"name": "xml",
"required": True,
"helptext": "A Libvirt XML document must be specified",
},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def put(self, vm, reqargs):
"""
Update the Libvirt XML of {vm}
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: xml
type: string
required: true
description: The raw Libvirt XML definition of the VM
- in: query
name: restart
type: boolean
description: Whether to automatically restart the VM to apply the new configuration
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.vm_modify(
vm,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
bool(strtobool(reqargs.get("restart", "false"))),
reqargs.get("xml", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "delete_disks"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def delete(self, vm, reqargs):
"""
Remove {vm}
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: delete_disks
type: boolean
default: false
description: Whether to automatically delete all VM disk volumes
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
404:
description: VM not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if bool(strtobool(reqargs.get("delete_disks", "false"))):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return api_helper.vm_remove(vm)
else:
return api_helper.vm_undefine(vm)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_VM_Element, "/vm/<vm>")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /vm/<vm>/meta
class API_VM_Metadata(Resource):
@Authenticator
def get(self, vm):
"""
Return the metadata of {vm}
---
tags:
- vm
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: vm
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: VMMetadata
properties:
name:
type: string
description: The name of the VM
node_limit:
type: array
description: The node(s) the VM is permitted to be assigned to
items:
type: string
node_selector:
type: string
Add selector help and adjust flag name 1. Add documentation on the node selector flags. In the API, reference the daemon configuration manual which now includes details in this section; in the CLI, provide the help in "pvc vm define" in detail and then reference that command's help in the other commands that use this field. 2. Ensure the naming is consistent in the CLI, using the flag name "--node-selector" everywhere (was "--selector" for "pvc vm" commands and "--node-selector" for "pvc provisioner" commands).
2022-06-10 02:14:15 -04:00
description: The selector used to determine candidate nodes during migration; see 'target_selector' in the node daemon configuration reference
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
node_autostart:
type: string
description: Whether to autostart the VM when its node returns to ready domain state
Support per-VM migration type selectors Allow a VM to specify its migration type as a default choice. The valid options are "default" (i.e. behave as now), "live" which forces a live migration only, and "shutdown" which forces a shutdown migration only. The new option is treated as a VM meta option and is set to default if not found.
2020-10-29 11:31:32 -04:00
migration_method:
type: string
description: The preferred migration method (live, shutdown, none)
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
migration_max_downtime:
type: integer
description: The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
404:
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
description: VM not found
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
schema:
type: object
id: Message
"""
return api_helper.get_vm_meta(vm)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "limit"},
{
"name": "selector",
Flip behaviour of memory selectors It didn't make any sense to me for mem(prov) to be the default selector, since this has too many caveats versus mem(free). Switch to using mem(free) as the default (i.e. "mem") and make memprov the alternative.
2022-11-15 15:45:59 -05:00
"choices": ("mem", "memprov", "vcpus", "load", "vms", "none"),
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
"helptext": "A valid selector must be specified",
},
{"name": "autostart"},
{"name": "profile"},
{
"name": "migration_method",
"choices": ("live", "shutdown", "none"),
"helptext": "A valid migration_method must be specified",
},
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
{
"name": "migration_max_downtime",
"helptext": "A valid migration_max_downtime must be specified",
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, vm, reqargs):
"""
Set the metadata of {vm}
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: limit
type: string
required: false
description: The CSV list of node(s) the VM is permitted to be assigned to; should include "node" and any other valid target nodes; this limit will be used for autoselection on definition and migration
- in: query
name: selector
type: string
required: false
Add selector help and adjust flag name 1. Add documentation on the node selector flags. In the API, reference the daemon configuration manual which now includes details in this section; in the CLI, provide the help in "pvc vm define" in detail and then reference that command's help in the other commands that use this field. 2. Ensure the naming is consistent in the CLI, using the flag name "--node-selector" everywhere (was "--selector" for "pvc vm" commands and "--node-selector" for "pvc provisioner" commands).
2022-06-10 02:14:15 -04:00
description: The selector used to determine candidate nodes during migration; see 'target_selector' in the node daemon configuration reference
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
enum:
- mem
Flip behaviour of memory selectors It didn't make any sense to me for mem(prov) to be the default selector, since this has too many caveats versus mem(free). Switch to using mem(free) as the default (i.e. "mem") and make memprov the alternative.
2022-11-15 15:45:59 -05:00
- memprov
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- vcpus
- load
- vms
Add memfree to selector and use proper defaults
2022-06-10 02:03:12 -04:00
- none (cluster default)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: autostart
type: boolean
required: false
description: Whether to autostart the VM when its node returns to ready domain state
- in: query
name: profile
type: string
required: false
description: The PVC provisioner profile for the VM
Support per-VM migration type selectors Allow a VM to specify its migration type as a default choice. The valid options are "default" (i.e. behave as now), "live" which forces a live migration only, and "shutdown" which forces a shutdown migration only. The new option is treated as a VM meta option and is set to default if not found.
2020-10-29 11:31:32 -04:00
- in: query
name: migration_method
type: string
required: false
description: The preferred migration method (live, shutdown, none)
enum:
- live
- shutdown
- none
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
- in: query
name: migration_max_downtime
type: integer
required: false
description: The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
404:
description: VM not found
schema:
type: object
id: Message
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
"""
return api_helper.update_vm_meta(
vm,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("limit", None),
reqargs.get("selector", None),
reqargs.get("autostart", None),
reqargs.get("profile", None),
reqargs.get("migration_method", None),
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
reqargs.get("migration_max_downtime", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_VM_Metadata, "/vm/<vm>/meta")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
# /vm/<vm>/tags
class API_VM_Tags(Resource):
@Authenticator
def get(self, vm):
"""
Return the tags of {vm}
---
tags:
- vm
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: vm
type: string
required: true
description: Path parameter
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
responses:
200:
description: OK
schema:
type: object
properties:
name:
type: string
description: The name of the VM
tags:
type: array
description: The tag(s) of the VM
items:
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
type: object
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
properties:
name:
type: string
description: The name of the tag
type:
type: string
description: The type of the tag (user, system)
protected:
type: boolean
description: Whether the tag is protected or not
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
404:
description: VM not found
schema:
type: object
id: Message
"""
return api_helper.get_vm_tags(vm)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "action",
"choices": ("add", "remove"),
"helptext": "A valid action must be specified",
},
{"name": "tag"},
{"name": "protected"},
]
)
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
@Authenticator
def post(self, vm, reqargs):
"""
Set the tags of {vm}
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
- in: query
name: action
type: string
required: true
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
description: The action to perform with the tag
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
enum:
- add
- remove
- in: query
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
name: tag
type: string
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
required: true
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
description: The text value of the tag
- in: query
name: protected
type: boolean
required: false
default: false
description: Set the protected state of the tag
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
404:
description: VM not found
schema:
type: object
id: Message
"""
Revamp tag handling and display Add an additional protected class, limit manipulation to one at a time, and ensure future flexibility. Also makes display consistent with other VM elements.
2021-07-13 19:04:56 -04:00
return api_helper.update_vm_tag(
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
vm,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("action"),
reqargs.get("tag"),
reqargs.get("protected", False),
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_VM_Tags, "/vm/<vm>/tags")
Add tags manipulation to API Also fixes some checks for Metadata too since these two actions are almost identical, and adds tags to define endpoint.
2021-07-13 02:17:30 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /vm/<vm</state
class API_VM_State(Resource):
@Authenticator
def get(self, vm):
"""
Return the state information of {vm}
---
tags:
- vm
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: vm
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: VMState
properties:
name:
type: string
description: The name of the VM
state:
type: string
description: The current state of the VM
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.vm_state(vm)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "state",
"choices": ("start", "shutdown", "stop", "restart", "disable"),
"helptext": "A valid state must be specified",
"required": True,
},
Perform automatic shutdown/stop on VM disable Instead of requiring the VM to already be stopped, instead allow disable state changes to perform a shutdown first. Also add a force option which will do a hard stop instead of a shutdown. References #148
2021-11-06 03:53:44 -04:00
{"name": "force"},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
{"name": "wait"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, vm, reqargs):
"""
Set the state of {vm}
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: state
type: string
required: true
description: The new state of the VM
enum:
- start
- shutdown
- stop
- restart
- disable
Perform automatic shutdown/stop on VM disable Instead of requiring the VM to already be stopped, instead allow disable state changes to perform a shutdown first. Also add a force option which will do a hard stop instead of a shutdown. References #148
2021-11-06 03:53:44 -04:00
- in: query
name: force
type: boolean
Add guard rails against manipulating mirrors Snapshot mirrors should normally be promoted using "mirror promote", and not started manually. This adds guard rails against that to the "start", "stop", and "disable" state commands to prevent changing mirror states without an explicit "--force" option.
2024-10-08 23:51:48 -04:00
description: For "disable", force stop instead of shutdown and/or force mirror state; for "start" or "stop", force mirror state.
Add wait support to API commands References #72
2020-02-19 09:51:19 -05:00
- in: query
name: wait
type: boolean
description: Whether to block waiting for the state change to complete
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
state = reqargs.get("state", None)
Perform automatic shutdown/stop on VM disable Instead of requiring the VM to already be stopped, instead allow disable state changes to perform a shutdown first. Also add a force option which will do a hard stop instead of a shutdown. References #148
2021-11-06 03:53:44 -04:00
force = bool(strtobool(reqargs.get("force", "false")))
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
wait = bool(strtobool(reqargs.get("wait", "false")))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if state == "start":
Add guard rails against manipulating mirrors Snapshot mirrors should normally be promoted using "mirror promote", and not started manually. This adds guard rails against that to the "start", "stop", and "disable" state commands to prevent changing mirror states without an explicit "--force" option.
2024-10-08 23:51:48 -04:00
return api_helper.vm_start(vm, force=force)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if state == "shutdown":
Add wait support to API commands References #72
2020-02-19 09:51:19 -05:00
return api_helper.vm_shutdown(vm, wait)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if state == "stop":
Add guard rails against manipulating mirrors Snapshot mirrors should normally be promoted using "mirror promote", and not started manually. This adds guard rails against that to the "start", "stop", and "disable" state commands to prevent changing mirror states without an explicit "--force" option.
2024-10-08 23:51:48 -04:00
return api_helper.vm_stop(vm, force=force)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if state == "restart":
Add wait support to API commands References #72
2020-02-19 09:51:19 -05:00
return api_helper.vm_restart(vm, wait)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if state == "disable":
Add guard rails against manipulating mirrors Snapshot mirrors should normally be promoted using "mirror promote", and not started manually. This adds guard rails against that to the "start", "stop", and "disable" state commands to prevent changing mirror states without an explicit "--force" option.
2024-10-08 23:51:48 -04:00
return api_helper.vm_disable(vm, force=force)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
abort(400)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_VM_State, "/vm/<vm>/state")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /vm/<vm>/node
class API_VM_Node(Resource):
@Authenticator
def get(self, vm):
"""
Return the node information of {vm}
---
tags:
- vm
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: vm
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: VMNode
properties:
name:
type: string
description: The name of the VM
node:
type: string
description: The node the VM is currently assigned to
last_node:
type: string
description: The last node the VM was assigned to before migrating
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.vm_node(vm)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "action",
"choices": ("migrate", "unmigrate", "move"),
"helptext": "A valid action must be specified",
"required": True,
},
{"name": "node"},
{"name": "force"},
{"name": "wait"},
{"name": "force_live"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, vm, reqargs):
"""
Set the node of {vm}
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: action
type: string
required: true
description: The action to take to change nodes
enum:
- migrate
- unmigrate
- move
- in: query
name: node
type: string
description: The node the VM should be assigned to; autoselect if empty or invalid
- in: query
name: force
type: boolean
description: Whether to force an already-migrated VM to a new node
Add wait support to API commands References #72
2020-02-19 09:51:19 -05:00
- in: query
name: wait
type: boolean
description: Whether to block waiting for the migration to complete
Allow enforcement of live migration Provides a CLI and API argument to force live migration, which triggers a new VM state "migrate-live". The node daemon VMInstance during migrate will read this flag from the state and, if enforced, will not trigger a shutdown migration. Closes #95
2020-06-06 11:49:21 -04:00
- in: query
name: force_live
type: boolean
description: Whether to enforce live migration and disable shutdown-based fallback migration
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
action = reqargs.get("action", None)
node = reqargs.get("node", None)
force = bool(strtobool(reqargs.get("force", "false")))
wait = bool(strtobool(reqargs.get("wait", "false")))
force_live = bool(strtobool(reqargs.get("force_live", "false")))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if action == "move":
Allow enforcement of live migration Provides a CLI and API argument to force live migration, which triggers a new VM state "migrate-live". The node daemon VMInstance during migrate will read this flag from the state and, if enforced, will not trigger a shutdown migration. Closes #95
2020-06-06 11:49:21 -04:00
return api_helper.vm_move(vm, node, wait, force_live)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if action == "migrate":
Allow enforcement of live migration Provides a CLI and API argument to force live migration, which triggers a new VM state "migrate-live". The node daemon VMInstance during migrate will read this flag from the state and, if enforced, will not trigger a shutdown migration. Closes #95
2020-06-06 11:49:21 -04:00
return api_helper.vm_migrate(vm, node, force, wait, force_live)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if action == "unmigrate":
Allow enforcement of live migration Provides a CLI and API argument to force live migration, which triggers a new VM state "migrate-live". The node daemon VMInstance during migrate will read this flag from the state and, if enforced, will not trigger a shutdown migration. Closes #95
2020-06-06 11:49:21 -04:00
return api_helper.vm_unmigrate(vm, wait, force_live)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
abort(400)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_VM_Node, "/vm/<vm>/node")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /vm/<vm>/locks
class API_VM_Locks(Resource):
@Authenticator
def post(self, vm):
"""
Flush disk locks of {vm}
---
tags:
- vm
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: vm
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
202:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
description: Accepted
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
properties:
task_id:
type: string
description: The internal Celery job ID of the task
task_name:
type: string
description: The internal Celery job task name
run_on:
type: string
description: The worker daemon instance assigned to run the task
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
"""
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
vm_node_detail, retcode = api_helper.vm_node(vm)
if retcode == 200:
vm_node = vm_node_detail["node"]
else:
return vm_node_detail, retcode
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
task = run_celery_task("vm.flush_locks", domain=vm, run_on=vm_node)
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
return (
Return and show task_name
2023-11-16 14:50:02 -05:00
{"task_id": task.id, "task_name": "vm.flush_locks", "run_on": vm_node},
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_VM_Locks, "/vm/<vm>/locks")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Add support for full VM backups Adds support for exporting full VM backups, including configuration, metainfo, and RBD disk images, with incremental support.
2023-10-17 10:15:06 -04:00
# /vm/<vm>/console
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
class API_VM_Console(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "lines"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, vm, reqargs):
"""
Return the recent console log of {vm}
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: lines
type: integer
required: false
description: The number of lines to retrieve
responses:
200:
description: OK
schema:
type: object
id: VMLog
properties:
name:
type: string
description: The name of the VM
data:
type: string
description: The recent console log text
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.vm_console(vm, reqargs.get("lines", None))
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_VM_Console, "/vm/<vm>/console")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Implement VM rename functionality Closes #125
2021-05-23 16:41:42 -04:00
# /vm/<vm>/rename
class API_VM_Rename(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "new_name"}])
Implement VM rename functionality Closes #125
2021-05-23 16:41:42 -04:00
@Authenticator
def post(self, vm, reqargs):
"""
Rename VM {vm}, and all connected disk volumes which include this name, to {new_name}
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Implement VM rename functionality Closes #125
2021-05-23 16:41:42 -04:00
- in: query
name: new_name
type: string
required: true
description: The new name of the VM
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.vm_rename(vm, reqargs.get("new_name", None))
Implement VM rename functionality Closes #125
2021-05-23 16:41:42 -04:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_VM_Rename, "/vm/<vm>/rename")
Implement VM rename functionality Closes #125
2021-05-23 16:41:42 -04:00
Add VM device hot attach/detach support Adds a new API endpoint to support hot attach/detach of devices, and the corresponding client-side logic to use this endpoint when doing VM network/storage add/remove actions. The live attach is now the default behaviour for these types of additions and removals, and can be disabled if needed. Closes #141
2021-09-12 15:41:05 -04:00
# /vm/<vm>/device
class API_VM_Device(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "xml",
"required": True,
"helptext": "A Libvirt XML device document must be specified",
},
]
)
Add VM device hot attach/detach support Adds a new API endpoint to support hot attach/detach of devices, and the corresponding client-side logic to use this endpoint when doing VM network/storage add/remove actions. The live attach is now the default behaviour for these types of additions and removals, and can be disabled if needed. Closes #141
2021-09-12 15:41:05 -04:00
@Authenticator
def post(self, vm, reqargs):
"""
Hot-attach device XML to {vm}
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Add VM device hot attach/detach support Adds a new API endpoint to support hot attach/detach of devices, and the corresponding client-side logic to use this endpoint when doing VM network/storage add/remove actions. The live attach is now the default behaviour for these types of additions and removals, and can be disabled if needed. Closes #141
2021-09-12 15:41:05 -04:00
- in: query
name: xml
type: string
required: true
description: The raw Libvirt XML definition of the device to attach
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Add VM device hot attach/detach support Adds a new API endpoint to support hot attach/detach of devices, and the corresponding client-side logic to use this endpoint when doing VM network/storage add/remove actions. The live attach is now the default behaviour for these types of additions and removals, and can be disabled if needed. Closes #141
2021-09-12 15:41:05 -04:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Add VM device hot attach/detach support Adds a new API endpoint to support hot attach/detach of devices, and the corresponding client-side logic to use this endpoint when doing VM network/storage add/remove actions. The live attach is now the default behaviour for these types of additions and removals, and can be disabled if needed. Closes #141
2021-09-12 15:41:05 -04:00
400:
description: Bad request
schema:
type: object
id: Message
"""
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
try:
xml = reqargs.get("xml", None)
lxml_fromstring(xml)
except Exception:
return {"message": "Specified XML document is not valid"}, 400
vm_node_detail, retcode = api_helper.vm_node(vm)
if retcode == 200:
vm_node = vm_node_detail["node"]
else:
return vm_node_detail, retcode
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
task = run_celery_task("vm.device_attach", domain=vm, xml=xml, run_on=vm_node)
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
return (
Return and show task_name
2023-11-16 14:50:02 -05:00
{"task_id": task.id, "task_name": "vm.device_attach", "run_on": vm_node},
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
)
Add VM device hot attach/detach support Adds a new API endpoint to support hot attach/detach of devices, and the corresponding client-side logic to use this endpoint when doing VM network/storage add/remove actions. The live attach is now the default behaviour for these types of additions and removals, and can be disabled if needed. Closes #141
2021-09-12 15:41:05 -04:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "xml",
"required": True,
"helptext": "A Libvirt XML device document must be specified",
},
]
)
Add VM device hot attach/detach support Adds a new API endpoint to support hot attach/detach of devices, and the corresponding client-side logic to use this endpoint when doing VM network/storage add/remove actions. The live attach is now the default behaviour for these types of additions and removals, and can be disabled if needed. Closes #141
2021-09-12 15:41:05 -04:00
@Authenticator
def delete(self, vm, reqargs):
"""
Hot-detach device XML to {vm}
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Add VM device hot attach/detach support Adds a new API endpoint to support hot attach/detach of devices, and the corresponding client-side logic to use this endpoint when doing VM network/storage add/remove actions. The live attach is now the default behaviour for these types of additions and removals, and can be disabled if needed. Closes #141
2021-09-12 15:41:05 -04:00
- in: query
name: xml
type: string
required: true
description: The raw Libvirt XML definition of the device to detach
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Add VM device hot attach/detach support Adds a new API endpoint to support hot attach/detach of devices, and the corresponding client-side logic to use this endpoint when doing VM network/storage add/remove actions. The live attach is now the default behaviour for these types of additions and removals, and can be disabled if needed. Closes #141
2021-09-12 15:41:05 -04:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Add VM device hot attach/detach support Adds a new API endpoint to support hot attach/detach of devices, and the corresponding client-side logic to use this endpoint when doing VM network/storage add/remove actions. The live attach is now the default behaviour for these types of additions and removals, and can be disabled if needed. Closes #141
2021-09-12 15:41:05 -04:00
400:
description: Bad request
schema:
type: object
id: Message
"""
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
try:
xml = reqargs.get("xml", None)
lxml_fromstring(xml)
except Exception:
return {"message": "Specified XML document is not valid"}, 400
vm_node_detail, retcode = api_helper.vm_node(vm)
if retcode == 200:
vm_node = vm_node_detail["node"]
else:
return vm_node_detail, retcode
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
task = run_celery_task("vm.device_detach", domain=vm, xml=xml, run_on=vm_node)
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
return (
Return and show task_name
2023-11-16 14:50:02 -05:00
{"task_id": task.id, "task_name": "vm.device_detach", "run_on": vm_node},
Port VM on-node tasks to Celery worker system Adds Celery versions of the flush_locks, device_attach, and device_detach functions.
2023-11-05 22:32:41 -05:00
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
)
Add VM device hot attach/detach support Adds a new API endpoint to support hot attach/detach of devices, and the corresponding client-side logic to use this endpoint when doing VM network/storage add/remove actions. The live attach is now the default behaviour for these types of additions and removals, and can be disabled if needed. Closes #141
2021-09-12 15:41:05 -04:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_VM_Device, "/vm/<vm>/device")
Add VM device hot attach/detach support Adds a new API endpoint to support hot attach/detach of devices, and the corresponding client-side logic to use this endpoint when doing VM network/storage add/remove actions. The live attach is now the default behaviour for these types of additions and removals, and can be disabled if needed. Closes #141
2021-09-12 15:41:05 -04:00
Add support for full VM backups Adds support for exporting full VM backups, including configuration, metainfo, and RBD disk images, with incremental support.
2023-10-17 10:15:06 -04:00
# /vm/<vm>/backup
class API_VM_Backup(Resource):
@RequestParser(
[
{
Use consistent path name and format
2023-10-24 01:20:44 -04:00
"name": "backup_path",
Add support for full VM backups Adds support for exporting full VM backups, including configuration, metainfo, and RBD disk images, with incremental support.
2023-10-17 10:15:06 -04:00
"required": True,
"helptext": "A local filesystem path on the primary coordinator must be specified",
},
{
"name": "incremental_parent",
"required": False,
},
{
Handle snapshots on restore and provide options Also rename the retain option to remove superfluous plural.
2023-10-24 00:23:12 -04:00
"name": "retain_snapshot",
Add support for full VM backups Adds support for exporting full VM backups, including configuration, metainfo, and RBD disk images, with incremental support.
2023-10-17 10:15:06 -04:00
"required": False,
},
]
)
@Authenticator
Complete VM restore functionality
2023-10-23 22:23:17 -04:00
def post(self, vm, reqargs):
Add support for full VM backups Adds support for exporting full VM backups, including configuration, metainfo, and RBD disk images, with incremental support.
2023-10-17 10:15:06 -04:00
"""
Create a backup of {vm} and its volumes to a local primary coordinator filesystem path
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Add support for full VM backups Adds support for exporting full VM backups, including configuration, metainfo, and RBD disk images, with incremental support.
2023-10-17 10:15:06 -04:00
- in: query
Use consistent path name and format
2023-10-24 01:20:44 -04:00
name: backup_path
Add support for full VM backups Adds support for exporting full VM backups, including configuration, metainfo, and RBD disk images, with incremental support.
2023-10-17 10:15:06 -04:00
type: string
required: true
description: A local filesystem path on the primary coordinator to store the backup
- in: query
name: incremental_parent
type: string
required: false
description: A previous backup datestamp to use as an incremental parent; if unspecified a full backup is taken
- in: query
Handle snapshots on restore and provide options Also rename the retain option to remove superfluous plural.
2023-10-24 00:23:12 -04:00
name: retain_snapshot
Add support for full VM backups Adds support for exporting full VM backups, including configuration, metainfo, and RBD disk images, with incremental support.
2023-10-17 10:15:06 -04:00
type: boolean
required: false
default: false
Handle snapshots on restore and provide options Also rename the retain option to remove superfluous plural.
2023-10-24 00:23:12 -04:00
description: Whether or not to retain this backup's volume snapshots to use as a future incremental parent; full backups only
Add support for full VM backups Adds support for exporting full VM backups, including configuration, metainfo, and RBD disk images, with incremental support.
2023-10-17 10:15:06 -04:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Use consistent path name and format
2023-10-24 01:20:44 -04:00
backup_path = reqargs.get("backup_path", None)
Add support for full VM backups Adds support for exporting full VM backups, including configuration, metainfo, and RBD disk images, with incremental support.
2023-10-17 10:15:06 -04:00
incremental_parent = reqargs.get("incremental_parent", None)
Handle snapshots on restore and provide options Also rename the retain option to remove superfluous plural.
2023-10-24 00:23:12 -04:00
retain_snapshot = bool(strtobool(reqargs.get("retain_snapshot", "false")))
Fix bad function name
2023-10-17 10:56:32 -04:00
return api_helper.vm_backup(
Use consistent path name and format
2023-10-24 01:20:44 -04:00
vm, backup_path, incremental_parent, retain_snapshot
Add support for full VM backups Adds support for exporting full VM backups, including configuration, metainfo, and RBD disk images, with incremental support.
2023-10-17 10:15:06 -04:00
)
Add backup deletion command
2023-10-24 01:08:36 -04:00
@RequestParser(
[
{
Use consistent path name and format
2023-10-24 01:20:44 -04:00
"name": "backup_path",
Add backup deletion command
2023-10-24 01:08:36 -04:00
"required": True,
"helptext": "A local filesystem path on the primary coordinator must be specified",
},
{
"name": "backup_datestring",
"required": True,
"helptext": "A backup datestring must be specified",
},
]
)
@Authenticator
def delete(self, vm, reqargs):
"""
Remove a backup of {vm}, including snapshots, from a local primary coordinator filesystem path
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Add backup deletion command
2023-10-24 01:08:36 -04:00
- in: query
Use consistent path name and format
2023-10-24 01:20:44 -04:00
name: backup_path
Add backup deletion command
2023-10-24 01:08:36 -04:00
type: string
required: true
description: A local filesystem path on the primary coordinator where the backup is stored
- in: query
name: backup_datestring
type: string
required: true
description: The backup datestring identifier (e.g. 20230102030405)
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Use consistent path name and format
2023-10-24 01:20:44 -04:00
backup_path = reqargs.get("backup_path", None)
Add backup deletion command
2023-10-24 01:08:36 -04:00
backup_datestring = reqargs.get("backup_datestring", None)
Use consistent path name and format
2023-10-24 01:20:44 -04:00
return api_helper.vm_remove_backup(vm, backup_path, backup_datestring)
Add backup deletion command
2023-10-24 01:08:36 -04:00
Add support for full VM backups Adds support for exporting full VM backups, including configuration, metainfo, and RBD disk images, with incremental support.
2023-10-17 10:15:06 -04:00
api.add_resource(API_VM_Backup, "/vm/<vm>/backup")
Complete VM restore functionality
2023-10-23 22:23:17 -04:00
# /vm/<vm>/restore
class API_VM_Restore(Resource):
@RequestParser(
[
{
Use consistent path name and format
2023-10-24 01:20:44 -04:00
"name": "backup_path",
Complete VM restore functionality
2023-10-23 22:23:17 -04:00
"required": True,
"helptext": "A local filesystem path on the primary coordinator must be specified",
},
{
"name": "backup_datestring",
"required": True,
"helptext": "A backup datestring must be specified",
Handle snapshots on restore and provide options Also rename the retain option to remove superfluous plural.
2023-10-24 00:23:12 -04:00
},
{
"name": "retain_snapshot",
"required": False,
},
Complete VM restore functionality
2023-10-23 22:23:17 -04:00
]
)
@Authenticator
def post(self, vm, reqargs):
"""
Restore a backup of {vm} and its volumes from a local primary coordinator filesystem path
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Complete VM restore functionality
2023-10-23 22:23:17 -04:00
- in: query
Use consistent path name and format
2023-10-24 01:20:44 -04:00
name: backup_path
Complete VM restore functionality
2023-10-23 22:23:17 -04:00
type: string
required: true
description: A local filesystem path on the primary coordinator where the backup is stored
- in: query
name: backup_datestring
type: string
required: true
description: The backup datestring identifier (e.g. 20230102030405)
Handle snapshots on restore and provide options Also rename the retain option to remove superfluous plural.
2023-10-24 00:23:12 -04:00
- in: query
name: retain_snapshot
type: boolean
required: false
default: true
description: Whether or not to retain the (parent, if incremental) volume snapshot after restore
Complete VM restore functionality
2023-10-23 22:23:17 -04:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Use consistent path name and format
2023-10-24 01:20:44 -04:00
backup_path = reqargs.get("backup_path", None)
Complete VM restore functionality
2023-10-23 22:23:17 -04:00
backup_datestring = reqargs.get("backup_datestring", None)
Handle snapshots on restore and provide options Also rename the retain option to remove superfluous plural.
2023-10-24 00:23:12 -04:00
retain_snapshot = bool(strtobool(reqargs.get("retain_snapshot", "true")))
Complete VM restore functionality
2023-10-23 22:23:17 -04:00
return api_helper.vm_restore(
Use consistent path name and format
2023-10-24 01:20:44 -04:00
vm, backup_path, backup_datestring, retain_snapshot
Complete VM restore functionality
2023-10-23 22:23:17 -04:00
)
api.add_resource(API_VM_Restore, "/vm/<vm>/restore")
Add VM snapshots functionality Adds the ability to create snapshots of an entire VM, including all its RBD disks and the VM XML config, though not any PVC metadata.
2024-05-16 09:23:31 -04:00
# /vm/<vm>/snapshot
class API_VM_Snapshot(Resource):
@RequestParser(
[
{
"name": "snapshot_name",
"required": False,
"helptext": "",
},
]
)
@Authenticator
def post(self, vm, reqargs):
"""
Take a snapshot of a VM's disks and configuration
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Add VM snapshots functionality Adds the ability to create snapshots of an entire VM, including all its RBD disks and the VM XML config, though not any PVC metadata.
2024-05-16 09:23:31 -04:00
- in: query
name: snapshot_name
type: string
required: false
description: A custom name for the snapshot instead of autogeneration by date
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Add VM snapshots functionality Adds the ability to create snapshots of an entire VM, including all its RBD disks and the VM XML config, though not any PVC metadata.
2024-05-16 09:23:31 -04:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Add VM snapshots functionality Adds the ability to create snapshots of an entire VM, including all its RBD disks and the VM XML config, though not any PVC metadata.
2024-05-16 09:23:31 -04:00
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
snapshot_name = reqargs.get("snapshot_name", None)
Convert VM snapshots to worker tasks Improves manageability and offloads these from the API context.
2024-08-20 16:42:18 -04:00
task = run_celery_task(
"vm.create_snapshot",
domain=vm,
snapshot_name=snapshot_name,
run_on="primary",
)
return (
{
"task_id": task.id,
"task_name": "vm.create_snapshot",
Show primary status in node run_on
2024-08-20 17:32:33 -04:00
"run_on": f"{get_primary_node()} (primary)",
Convert VM snapshots to worker tasks Improves manageability and offloads these from the API context.
2024-08-20 16:42:18 -04:00
},
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
)
Add VM snapshots functionality Adds the ability to create snapshots of an entire VM, including all its RBD disks and the VM XML config, though not any PVC metadata.
2024-05-16 09:23:31 -04:00
Add VM snapshot removal
2024-05-17 10:55:42 -04:00
@RequestParser(
[
{
"name": "snapshot_name",
"required": True,
"helptext": "A snapshot name must be specified",
},
]
)
@Authenticator
def delete(self, vm, reqargs):
"""
Remove a snapshot of a VM's disks and configuration
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Add VM snapshot removal
2024-05-17 10:55:42 -04:00
- in: query
name: snapshot_name
type: string
required: true
description: The name of the snapshot to remove
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Add VM snapshot removal
2024-05-17 10:55:42 -04:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Add VM snapshot removal
2024-05-17 10:55:42 -04:00
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
snapshot_name = reqargs.get("snapshot_name", None)
Convert VM snapshots to worker tasks Improves manageability and offloads these from the API context.
2024-08-20 16:42:18 -04:00
task = run_celery_task(
"vm.remove_snapshot",
domain=vm,
snapshot_name=snapshot_name,
run_on="primary",
)
return (
{
"task_id": task.id,
"task_name": "vm.remove_snapshot",
Show primary status in node run_on
2024-08-20 17:32:33 -04:00
"run_on": f"{get_primary_node()} (primary)",
Convert VM snapshots to worker tasks Improves manageability and offloads these from the API context.
2024-08-20 16:42:18 -04:00
},
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
)
Add VM snapshot removal
2024-05-17 10:55:42 -04:00
Add VM snapshots functionality Adds the ability to create snapshots of an entire VM, including all its RBD disks and the VM XML config, though not any PVC metadata.
2024-05-16 09:23:31 -04:00
api.add_resource(API_VM_Snapshot, "/vm/<vm>/snapshot")
Implement VM rollback Closes #184
2024-08-05 13:21:41 -04:00
# /vm/<vm>/snapshot/rollback
class API_VM_Snapshot_Rollback(Resource):
@RequestParser(
[
{
"name": "snapshot_name",
"required": True,
"helptext": "A snapshot name must be specified",
},
]
)
@Authenticator
def post(self, vm, reqargs):
"""
Roll back to a snapshot of a VM's disks and configuration
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Implement VM rollback Closes #184
2024-08-05 13:21:41 -04:00
- in: query
name: snapshot_name
type: string
required: true
description: The name of the snapshot to roll back to
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Implement VM rollback Closes #184
2024-08-05 13:21:41 -04:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Implement VM rollback Closes #184
2024-08-05 13:21:41 -04:00
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
snapshot_name = reqargs.get("snapshot_name", None)
Convert VM snapshots to worker tasks Improves manageability and offloads these from the API context.
2024-08-20 16:42:18 -04:00
task = run_celery_task(
"vm.rollback_snapshot",
domain=vm,
snapshot_name=snapshot_name,
run_on="primary",
)
return (
{
"task_id": task.id,
"task_name": "vm.rollback_snapshot",
Show primary status in node run_on
2024-08-20 17:32:33 -04:00
"run_on": f"{get_primary_node()} (primary)",
Convert VM snapshots to worker tasks Improves manageability and offloads these from the API context.
2024-08-20 16:42:18 -04:00
},
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
)
Implement VM rollback Closes #184
2024-08-05 13:21:41 -04:00
api.add_resource(API_VM_Snapshot_Rollback, "/vm/<vm>/snapshot/rollback")
Add initial implementation of snapshot export
2024-08-19 18:46:07 -04:00
# /vm/<vm>/snapshot/export
class API_VM_Snapshot_Export(Resource):
@RequestParser(
[
{
"name": "snapshot_name",
"required": True,
"helptext": "A snapshot name must be specified",
},
{
"name": "export_path",
"required": True,
"helptext": "An absolute directory path on the PVC primary coordinator to export files to",
},
{
"name": "incremental_parent",
"required": False,
"helptext": "A snapshot name to generate an incremental diff from",
},
]
)
@Authenticator
def post(self, vm, reqargs):
"""
Fix export swagger definition
2024-08-20 11:07:56 -04:00
Export a snapshot of a VM's disks and configuration to files
Add initial implementation of snapshot export
2024-08-19 18:46:07 -04:00
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Add initial implementation of snapshot export
2024-08-19 18:46:07 -04:00
- in: query
name: snapshot_name
type: string
required: true
Fix export swagger definition
2024-08-20 11:07:56 -04:00
description: The name of the snapshot to export (must exist)
- in: query
name: export_path
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: string
Fix export swagger definition
2024-08-20 11:07:56 -04:00
required: true
description: The absolute file path to export the snapshot to on the active primary coordinator
- in: query
name: incremental_parent
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
type: string
Fix export swagger definition
2024-08-20 11:07:56 -04:00
required: false
description: A snapshot name to generate an incremental diff from
Add initial implementation of snapshot export
2024-08-19 18:46:07 -04:00
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Add initial implementation of snapshot export
2024-08-19 18:46:07 -04:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Add initial implementation of snapshot export
2024-08-19 18:46:07 -04:00
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
snapshot_name = reqargs.get("snapshot_name", None)
export_path = reqargs.get("export_path", None)
incremental_parent = reqargs.get("incremental_parent", None)
Convert VM snapshots to worker tasks Improves manageability and offloads these from the API context.
2024-08-20 16:42:18 -04:00
task = run_celery_task(
"vm.export_snapshot",
domain=vm,
snapshot_name=snapshot_name,
export_path=export_path,
incremental_parent=incremental_parent,
run_on="primary",
)
return (
{
"task_id": task.id,
"task_name": "vm.export_snapshot",
Show primary status in node run_on
2024-08-20 17:32:33 -04:00
"run_on": f"{get_primary_node()} (primary)",
Convert VM snapshots to worker tasks Improves manageability and offloads these from the API context.
2024-08-20 16:42:18 -04:00
},
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
Add initial implementation of snapshot export
2024-08-19 18:46:07 -04:00
)
api.add_resource(API_VM_Snapshot_Export, "/vm/<vm>/snapshot/export")
Finish implementing snapshot import
2024-08-20 11:08:14 -04:00
# /vm/<vm>/snapshot/import
class API_VM_Snapshot_Import(Resource):
@RequestParser(
[
{
"name": "snapshot_name",
"required": True,
"helptext": "A snapshot name must be specified",
},
{
"name": "import_path",
"required": True,
"helptext": "An absolute directory path on the PVC primary coordinator to import files from",
},
{
"name": "retain_snapshot",
"required": False,
"helptext": "Whether to retain the snapshot of the import or not (default: true)",
},
]
)
@Authenticator
def post(self, vm, reqargs):
"""
Import a snapshot of a VM's disks and configuration from files
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Finish implementing snapshot import
2024-08-20 11:08:14 -04:00
- in: query
name: snapshot_name
type: string
required: true
description: The name of the snapshot to roll back to
- in: query
name: import_path
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: string
Finish implementing snapshot import
2024-08-20 11:08:14 -04:00
required: true
description: The absolute file path to import the snapshot from on the active primary coordinator
- in: query
name: retain_snapshot
type: boolean
required: false
default: true
description: Whether or not to retain the (parent, if incremental) volume snapshot after restore
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Finish implementing snapshot import
2024-08-20 11:08:14 -04:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Finish implementing snapshot import
2024-08-20 11:08:14 -04:00
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
snapshot_name = reqargs.get("snapshot_name", None)
import_path = reqargs.get("import_path", None)
retain_snapshot = bool(strtobool(reqargs.get("retain_snapshot", "True")))
Convert VM snapshots to worker tasks Improves manageability and offloads these from the API context.
2024-08-20 16:42:18 -04:00
task = run_celery_task(
"vm.import_snapshot",
domain=vm,
snapshot_name=snapshot_name,
import_path=import_path,
retain_snapshot=retain_snapshot,
run_on="primary",
)
return (
{
"task_id": task.id,
"task_name": "vm.import_snapshot",
Show primary status in node run_on
2024-08-20 17:32:33 -04:00
"run_on": f"{get_primary_node()} (primary)",
Convert VM snapshots to worker tasks Improves manageability and offloads these from the API context.
2024-08-20 16:42:18 -04:00
},
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
Finish implementing snapshot import
2024-08-20 11:08:14 -04:00
)
api.add_resource(API_VM_Snapshot_Import, "/vm/<vm>/snapshot/import")
Add VM snapshot send (initial)
2024-09-28 10:49:14 -04:00
# /vm/<vm>/snapshot/send
class API_VM_Snapshot_Send(Resource):
@RequestParser(
[
{
"name": "snapshot_name",
"required": True,
"helptext": "A snapshot name must be specified",
},
{
"name": "destination_api_uri",
"required": True,
"helptext": "A destination API URI must be specified",
},
{
"name": "destination_api_key",
"required": True,
"helptext": "A destination API key must be specified",
},
{
"name": "destination_api_verify_ssl",
"required": False,
},
{
"name": "incremental_parent",
"required": False,
},
{
"name": "destination_storage_pool",
"required": False,
},
]
)
@Authenticator
def post(self, vm, reqargs):
"""
Send a snapshot of a VM's disks and configuration to another PVC cluster
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Add VM snapshot send (initial)
2024-09-28 10:49:14 -04:00
- in: query
name: snapshot_name
type: string
required: true
description: The name of the snapshot to export (must exist)
- in: query
name: destination_api_uri
type: string
required: true
description: The base API URI of the destination PVC cluster (with prefix if applicable)
- in: query
name: destination_api_key
type: string
required: true
description: The API authentication key of the destination PVC cluster
- in: query
name: destination_api_verify_ssl
type: boolean
required: false
default: true
description: Whether or not to validate SSL certificates for an SSL-enabled destination API
- in: query
name: incremental_parent
type: string
required: false
description: A snapshot name to generate an incremental diff from; incremental send only if unset
- in: query
name: destination_storage_pool
type: string
required: false
default: source storage pool name
description: The remote cluster storage pool to create RBD volumes in, if different from the source storage pool
responses:
202:
description: Accepted
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Add VM snapshot send (initial)
2024-09-28 10:49:14 -04:00
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
snapshot_name = reqargs.get("snapshot_name", None)
destination_api_uri = reqargs.get("destination_api_uri", None)
destination_api_key = reqargs.get("destination_api_key", None)
destination_api_verify_ssl = bool(
strtobool(reqargs.get("destination_api_verify_ssl", "true"))
)
incremental_parent = reqargs.get("incremental_parent", None)
destination_storage_pool = reqargs.get("destination_storage_pool", None)
task = run_celery_task(
"vm.send_snapshot",
domain=vm,
snapshot_name=snapshot_name,
destination_api_uri=destination_api_uri,
destination_api_key=destination_api_key,
destination_api_verify_ssl=destination_api_verify_ssl,
incremental_parent=incremental_parent,
destination_storage_pool=destination_storage_pool,
run_on="primary",
)
return (
{
"task_id": task.id,
"task_name": "vm.send_snapshot",
"run_on": f"{get_primary_node()} (primary)",
},
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
)
api.add_resource(API_VM_Snapshot_Send, "/vm/<vm>/snapshot/send")
Add Ceph block receive (initial)
2024-09-11 00:51:07 -04:00
# /vm/<vm>/snapshot/receive/block
class API_VM_Snapshot_Receive_Block(Resource):
@RequestParser(
[
{
"name": "pool",
"required": True,
},
{
"name": "volume",
"required": True,
},
{
"name": "snapshot",
"required": True,
},
{
"name": "size",
"required": True,
},
]
)
@Authenticator
def post(self, vm, reqargs):
"""
Finish working implementation of send/receive Required some significant refactoring due to issues with the diff send, but it works.
2024-09-30 02:31:06 -04:00
Receive a full snapshot of a single RBD volume from another PVC cluster
Add Ceph block receive (initial)
2024-09-11 00:51:07 -04:00
NOTICE: This is an API-internal endpoint used by /vm/<vm>/snapshot/send; it should never be called by a client.
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Add Ceph block receive (initial)
2024-09-11 00:51:07 -04:00
- in: query
name: pool
type: string
required: true
description: The name of the destination Ceph RBD data pool
- in: query
name: volume
type: string
required: true
description: The name of the destination Ceph RBD volume
- in: query
name: snapshot
type: string
required: true
description: The name of the destination Ceph RBD volume snapshot
- in: query
name: size
type: integer
required: true
description: The size in bytes of the Ceph RBD volume
Finish working implementation of send/receive Required some significant refactoring due to issues with the diff send, but it works.
2024-09-30 02:31:06 -04:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.vm_snapshot_receive_block_full(
reqargs.get("pool"),
reqargs.get("volume"),
reqargs.get("snapshot"),
int(reqargs.get("size")),
Actually fix incremental sending
2024-09-30 16:30:23 -04:00
flask.request,
Finish working implementation of send/receive Required some significant refactoring due to issues with the diff send, but it works.
2024-09-30 02:31:06 -04:00
)
@RequestParser(
[
{
"name": "pool",
"required": True,
},
{
"name": "volume",
"required": True,
},
{
"name": "snapshot",
"required": True,
},
{
"name": "source_snapshot",
"required": True,
},
]
)
@Authenticator
def put(self, vm, reqargs):
"""
Receive a single diff element from a snapshot of a single RBD volume from another PVC cluster
NOTICE: This is an API-internal endpoint used by /vm/<vm>/snapshot/send; it should never be called by a client.
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Finish working implementation of send/receive Required some significant refactoring due to issues with the diff send, but it works.
2024-09-30 02:31:06 -04:00
- in: query
name: pool
type: string
required: true
description: The name of the destination Ceph RBD data pool
- in: query
name: volume
type: string
required: true
description: The name of the destination Ceph RBD volume
- in: query
name: snapshot
type: string
required: true
description: The name of the destination Ceph RBD volume snapshot
Add Ceph block receive (initial)
2024-09-11 00:51:07 -04:00
- in: query
name: source_snapshot
type: string
Finish working implementation of send/receive Required some significant refactoring due to issues with the diff send, but it works.
2024-09-30 02:31:06 -04:00
required: true
description: The name of the destination Ceph RBD volume snapshot parent
Add Ceph block receive (initial)
2024-09-11 00:51:07 -04:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Finish working implementation of send/receive Required some significant refactoring due to issues with the diff send, but it works.
2024-09-30 02:31:06 -04:00
return api_helper.vm_snapshot_receive_block_diff(
Add Ceph block receive (initial)
2024-09-11 00:51:07 -04:00
reqargs.get("pool"),
Add mostly complete implementation of VM send
2024-09-29 01:31:13 -04:00
reqargs.get("volume"),
Add Ceph block receive (initial)
2024-09-11 00:51:07 -04:00
reqargs.get("snapshot"),
Finish working implementation of send/receive Required some significant refactoring due to issues with the diff send, but it works.
2024-09-30 02:31:06 -04:00
reqargs.get("source_snapshot"),
Actually fix incremental sending
2024-09-30 16:30:23 -04:00
flask.request,
Finish working implementation of send/receive Required some significant refactoring due to issues with the diff send, but it works.
2024-09-30 02:31:06 -04:00
)
@RequestParser(
[
{
"name": "pool",
"required": True,
},
{
"name": "volume",
"required": True,
},
{
"name": "snapshot",
"required": True,
},
]
)
@Authenticator
def patch(self, vm, reqargs):
"""
Create the block snapshot at snapshot of volume
NOTICE: This is an API-internal endpoint used by /vm/<vm>/snapshot/send; it should never be called by a client.
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Finish working implementation of send/receive Required some significant refactoring due to issues with the diff send, but it works.
2024-09-30 02:31:06 -04:00
- in: query
name: pool
type: string
required: true
description: The name of the destination Ceph RBD data pool
- in: query
name: volume
type: string
required: true
description: The name of the destination Ceph RBD volume
- in: query
name: snapshot
type: string
required: true
description: The name of the destination Ceph RBD volume snapshot
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.vm_snapshot_receive_block_createsnap(
reqargs.get("pool"),
reqargs.get("volume"),
reqargs.get("snapshot"),
Add Ceph block receive (initial)
2024-09-11 00:51:07 -04:00
)
api.add_resource(API_VM_Snapshot_Receive_Block, "/vm/<vm>/snapshot/receive/block")
Add mostly complete implementation of VM send
2024-09-29 01:31:13 -04:00
# /vm/<vm>/snapshot/receive/config
class API_VM_Snapshot_Receive_Config(Resource):
@RequestParser(
[
{
"name": "snapshot",
"required": True,
},
{
"name": "source_snapshot",
"required": False,
},
]
)
@Authenticator
def post(self, vm, reqargs):
"""
Receive a snapshot of a VM configuration from another PVC cluster
NOTICE: This is an API-internal endpoint used by /vm/<vm>/snapshot/send; it should never be called by a client.
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Add mostly complete implementation of VM send
2024-09-29 01:31:13 -04:00
- in: query
name: pool
type: string
required: true
description: The name of the destination Ceph RBD data pool
- in: query
name: volume
type: string
required: true
description: The name of the destination Ceph RBD volume
- in: query
name: snapshot
type: string
required: true
description: The name of the destination Ceph RBD volume snapshot
- in: query
name: size
type: integer
required: true
description: The size in bytes of the Ceph RBD volume
- in: query
name: source_snapshot
type: string
required: false
description: The name of the destination Ceph RBD volume snapshot parent for incremental transfers
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.vm_snapshot_receive_config(
reqargs.get("snapshot"),
flask.request.get_json(),
source_snapshot=reqargs.get("source_snapshot"),
)
api.add_resource(API_VM_Snapshot_Receive_Config, "/vm/<vm>/snapshot/receive/config")
Implement friendlier VM mirror commands Adds two helper commands which automate sending and promoting VM snapshots as "vm mirror" commands. "vm mirror create" replicates the functionality of "snapshot create" and "snapshot send", performing both in one single task using an autogenerated dated snapshot name for automatic cross-cluster replication. "vm mirror promote" replicates the functionality of "vm shutdown", "snapshot create", "snapshot send", "vm start" (remote), and, optionally, "vm remove", performing in one single task an entire cross-cluster VM move with or without retaining the copy on the local cluster (if retained, the local copy becomes a snapshot mirror of the remote, flipping their statuses).
2024-10-08 22:53:12 -04:00
# /vm/<vm>/mirror/create
class API_VM_Mirror_Create(Resource):
@RequestParser(
[
{
"name": "destination_api_uri",
"required": True,
"helptext": "A destination API URI must be specified",
},
{
"name": "destination_api_key",
"required": True,
"helptext": "A destination API key must be specified",
},
{
"name": "destination_api_verify_ssl",
"required": False,
},
{
"name": "destination_storage_pool",
"required": False,
},
]
)
@Authenticator
def post(self, vm, reqargs):
"""
Create (or update) a snapshot mirror of a VM to a remote cluster
This method handles both the creation of a new VM snapshot, as well as sending that snapshot to a remote cluster, creating or updating a VM mirror. It will also automatically handle full vs. incremental block sends if possible based on the available snapshots on both sides.
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Implement friendlier VM mirror commands Adds two helper commands which automate sending and promoting VM snapshots as "vm mirror" commands. "vm mirror create" replicates the functionality of "snapshot create" and "snapshot send", performing both in one single task using an autogenerated dated snapshot name for automatic cross-cluster replication. "vm mirror promote" replicates the functionality of "vm shutdown", "snapshot create", "snapshot send", "vm start" (remote), and, optionally, "vm remove", performing in one single task an entire cross-cluster VM move with or without retaining the copy on the local cluster (if retained, the local copy becomes a snapshot mirror of the remote, flipping their statuses).
2024-10-08 22:53:12 -04:00
- in: query
name: destination_api_uri
type: string
required: true
description: The base API URI of the destination PVC cluster (with prefix if applicable)
- in: query
name: destination_api_key
type: string
required: true
description: The API authentication key of the destination PVC cluster
- in: query
name: destination_api_verify_ssl
type: boolean
required: false
default: true
description: Whether or not to validate SSL certificates for an SSL-enabled destination API
- in: query
name: destination_storage_pool
type: string
required: false
default: source storage pool name
description: The remote cluster storage pool to create RBD volumes in, if different from the source storage pool
responses:
202:
description: Accepted
schema:
type: object
description: The Celery job information of the task
id: CeleryTask
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
destination_api_uri = reqargs.get("destination_api_uri", None)
destination_api_key = reqargs.get("destination_api_key", None)
destination_api_verify_ssl = bool(
strtobool(reqargs.get("destination_api_verify_ssl", "true"))
)
destination_storage_pool = reqargs.get("destination_storage_pool", None)
task = run_celery_task(
"vm.create_mirror",
domain=vm,
destination_api_uri=destination_api_uri,
destination_api_key=destination_api_key,
destination_api_verify_ssl=destination_api_verify_ssl,
destination_storage_pool=destination_storage_pool,
run_on="primary",
)
return (
{
"task_id": task.id,
"task_name": "vm.send_snapshot",
"run_on": f"{get_primary_node()} (primary)",
},
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
)
api.add_resource(API_VM_Mirror_Create, "/vm/<vm>/mirror/create")
# /vm/<vm>/mirror/promote
class API_VM_Mirror_Promote(Resource):
@RequestParser(
[
{
"name": "destination_api_uri",
"required": True,
"helptext": "A destination API URI must be specified",
},
{
"name": "destination_api_key",
"required": True,
"helptext": "A destination API key must be specified",
},
{
"name": "destination_api_verify_ssl",
"required": False,
},
{
"name": "destination_storage_pool",
"required": False,
},
{
"name": "remove_on_source",
"required": False,
},
]
)
@Authenticator
def post(self, vm, reqargs):
"""
Promote a snapshot mirror of a VM on a remote cluster, flipping "mirror" state, and optionally removing the source VM on this cluster.
This method handles shutting down the VM on this cluster, creating a new VM snapshot, sending that snapshot to a remote cluster, then starting up the VM on the remote cluster. It will also automatically handle full vs. incremental block sends if possible based on the available snapshots on both sides.
NOTE: This method may be used alone to perform a one-shot cross-cluster move; creating the mirror first is not required, though doing so will improve performance by allowing an incremental block send.
---
tags:
- vm
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vm
type: string
required: true
description: Path parameter
Implement friendlier VM mirror commands Adds two helper commands which automate sending and promoting VM snapshots as "vm mirror" commands. "vm mirror create" replicates the functionality of "snapshot create" and "snapshot send", performing both in one single task using an autogenerated dated snapshot name for automatic cross-cluster replication. "vm mirror promote" replicates the functionality of "vm shutdown", "snapshot create", "snapshot send", "vm start" (remote), and, optionally, "vm remove", performing in one single task an entire cross-cluster VM move with or without retaining the copy on the local cluster (if retained, the local copy becomes a snapshot mirror of the remote, flipping their statuses).
2024-10-08 22:53:12 -04:00
- in: query
name: destination_api_uri
type: string
required: true
description: The base API URI of the destination PVC cluster (with prefix if applicable)
- in: query
name: destination_api_key
type: string
required: true
description: The API authentication key of the destination PVC cluster
- in: query
name: destination_api_verify_ssl
type: boolean
required: false
default: true
description: Whether or not to validate SSL certificates for an SSL-enabled destination API
- in: query
name: destination_storage_pool
type: string
required: false
default: source storage pool name
description: The remote cluster storage pool to create RBD volumes in, if different from the source storage pool
- in: query
name: remove_on_source
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: boolean
Implement friendlier VM mirror commands Adds two helper commands which automate sending and promoting VM snapshots as "vm mirror" commands. "vm mirror create" replicates the functionality of "snapshot create" and "snapshot send", performing both in one single task using an autogenerated dated snapshot name for automatic cross-cluster replication. "vm mirror promote" replicates the functionality of "vm shutdown", "snapshot create", "snapshot send", "vm start" (remote), and, optionally, "vm remove", performing in one single task an entire cross-cluster VM move with or without retaining the copy on the local cluster (if retained, the local copy becomes a snapshot mirror of the remote, flipping their statuses).
2024-10-08 22:53:12 -04:00
required: false
default: false
description: Remove the VM on the source cluster once promoted (performs a full move between clusters)
responses:
202:
description: Accepted
schema:
type: object
description: The Celery job information of the task
id: CeleryTask
400:
description: Execution error
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
destination_api_uri = reqargs.get("destination_api_uri", None)
destination_api_key = reqargs.get("destination_api_key", None)
destination_api_verify_ssl = bool(
strtobool(reqargs.get("destination_api_verify_ssl", "true"))
)
destination_storage_pool = reqargs.get("destination_storage_pool", None)
Fix boolean state of remove_on_source
2024-10-09 01:04:08 -04:00
remove_on_source = bool(strtobool(reqargs.get("remove_on_source", "false")))
Implement friendlier VM mirror commands Adds two helper commands which automate sending and promoting VM snapshots as "vm mirror" commands. "vm mirror create" replicates the functionality of "snapshot create" and "snapshot send", performing both in one single task using an autogenerated dated snapshot name for automatic cross-cluster replication. "vm mirror promote" replicates the functionality of "vm shutdown", "snapshot create", "snapshot send", "vm start" (remote), and, optionally, "vm remove", performing in one single task an entire cross-cluster VM move with or without retaining the copy on the local cluster (if retained, the local copy becomes a snapshot mirror of the remote, flipping their statuses).
2024-10-08 22:53:12 -04:00
task = run_celery_task(
"vm.promote_mirror",
domain=vm,
destination_api_uri=destination_api_uri,
destination_api_key=destination_api_key,
destination_api_verify_ssl=destination_api_verify_ssl,
destination_storage_pool=destination_storage_pool,
remove_on_source=remove_on_source,
run_on="primary",
)
return (
{
"task_id": task.id,
"task_name": "vm.send_snapshot",
"run_on": f"{get_primary_node()} (primary)",
},
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
)
api.add_resource(API_VM_Mirror_Promote, "/vm/<vm>/mirror/promote")
Port VM autobackups into pvcworkerd with snaps Moves VM autobackups from being in-CLI to being handled by the pvcworkerd system on the primary coordinator. Turns the CLI autobackup command into an actual API client endpoint rather than having its logic in the CLI. In addition, modifies the new autobackup to leverage the new "pvc vm snapshot" function set, just with special snapshot names. This helps automate this within the new snapshot scaffolding.
2024-08-23 17:01:31 -04:00
# /vm/autobackup
class API_VM_Autobackup_Root(Resource):
@RequestParser(
[
{"name": "force_full"},
{"name": "email_recipients"},
]
)
@Authenticator
def post(self, reqargs):
"""
Trigger a cluster autobackup job
---
tags:
- provisioner
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: query
name: email_recipients
type: string
required: false
description: A list of email addresses to send failure and report emails to, comma-separated
Port VM autobackups into pvcworkerd with snaps Moves VM autobackups from being in-CLI to being handled by the pvcworkerd system on the primary coordinator. Turns the CLI autobackup command into an actual API client endpoint rather than having its logic in the CLI. In addition, modifies the new autobackup to leverage the new "pvc vm snapshot" function set, just with special snapshot names. This helps automate this within the new snapshot scaffolding.
2024-08-23 17:01:31 -04:00
- in: query
name: force_full
type: boolean
required: false
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
default: false
Port VM autobackups into pvcworkerd with snaps Moves VM autobackups from being in-CLI to being handled by the pvcworkerd system on the primary coordinator. Turns the CLI autobackup command into an actual API client endpoint rather than having its logic in the CLI. In addition, modifies the new autobackup to leverage the new "pvc vm snapshot" function set, just with special snapshot names. This helps automate this within the new snapshot scaffolding.
2024-08-23 17:01:31 -04:00
description: If set and true, triggers a full autobackup regardless of schedule
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Port VM autobackups into pvcworkerd with snaps Moves VM autobackups from being in-CLI to being handled by the pvcworkerd system on the primary coordinator. Turns the CLI autobackup command into an actual API client endpoint rather than having its logic in the CLI. In addition, modifies the new autobackup to leverage the new "pvc vm snapshot" function set, just with special snapshot names. This helps automate this within the new snapshot scaffolding.
2024-08-23 17:01:31 -04:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Port VM autobackups into pvcworkerd with snaps Moves VM autobackups from being in-CLI to being handled by the pvcworkerd system on the primary coordinator. Turns the CLI autobackup command into an actual API client endpoint rather than having its logic in the CLI. In addition, modifies the new autobackup to leverage the new "pvc vm snapshot" function set, just with special snapshot names. This helps automate this within the new snapshot scaffolding.
2024-08-23 17:01:31 -04:00
400:
description: Bad request
schema:
type: object
id: Message
"""
Ensure email_recipients is always a list
2024-08-25 16:18:19 -04:00
email_recipients = reqargs.get("email_recipients", None)
if email_recipients is not None and not isinstance(email_recipients, list):
email_recipients = [email_recipients]
Port VM autobackups into pvcworkerd with snaps Moves VM autobackups from being in-CLI to being handled by the pvcworkerd system on the primary coordinator. Turns the CLI autobackup command into an actual API client endpoint rather than having its logic in the CLI. In addition, modifies the new autobackup to leverage the new "pvc vm snapshot" function set, just with special snapshot names. This helps automate this within the new snapshot scaffolding.
2024-08-23 17:01:31 -04:00
task = run_celery_task(
"cluster.autobackup",
Fix bug in API parameters
2024-08-25 19:13:31 -04:00
force_full=bool(strtobool(reqargs.get("force_full", "false"))),
Ensure email_recipients is always a list
2024-08-25 16:18:19 -04:00
email_recipients=email_recipients,
Port VM autobackups into pvcworkerd with snaps Moves VM autobackups from being in-CLI to being handled by the pvcworkerd system on the primary coordinator. Turns the CLI autobackup command into an actual API client endpoint rather than having its logic in the CLI. In addition, modifies the new autobackup to leverage the new "pvc vm snapshot" function set, just with special snapshot names. This helps automate this within the new snapshot scaffolding.
2024-08-23 17:01:31 -04:00
run_on="primary",
)
return (
{
"task_id": task.id,
"task_name": "cluster.autobackup",
"run_on": f"{get_primary_node()} (primary)",
},
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
)
api.add_resource(API_VM_Autobackup_Root, "/vm/autobackup")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
##########################################################
# Client API - Network
##########################################################
Format based on updated Black
2023-09-12 16:41:02 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /network
class API_Network_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of networks in the cluster
---
tags:
- network
definitions:
- schema:
type: object
id: network
properties:
vni:
type: integer
description: The VNI of the network
description:
type: string
description: The description of the network
type:
type: string
description: The type of network
enum:
- managed
- bridged
Add MTU to network creation/modification Addresses #144
2021-10-09 17:43:56 -04:00
mtu:
type: integer
description: The MTU of the network, if set; empty otherwise
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
domain:
type: string
description: The DNS domain of the network ("managed" networks only)
name_servers:
type: array
description: The configured DNS nameservers of the network for NS records ("managed" networks only)
items:
type: string
ip4:
type: object
description: The IPv4 details of the network ("managed" networks only)
properties:
network:
type: string
description: The IPv4 network subnet in CIDR format
gateway:
type: string
description: The IPv4 default gateway address
dhcp_flag:
type: boolean
description: Whether DHCP is enabled
dhcp_start:
type: string
description: The IPv4 DHCP pool start address
dhcp_end:
type: string
description: The IPv4 DHCP pool end address
ip6:
type: object
description: The IPv6 details of the network ("managed" networks only)
properties:
network:
type: string
description: The IPv6 network subnet in CIDR format
gateway:
type: string
description: The IPv6 default gateway address
dhcp_flag:
type: boolean
description: Whether DHCPv6 is enabled
parameters:
- in: query
name: limit
type: string
required: false
description: A VNI or description search limit; fuzzy by default, use ^/$ to force exact matches
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/network'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.net_list(reqargs.get("limit", None))
@RequestParser(
[
{"name": "vni", "required": True},
{"name": "description", "required": True},
{
"name": "nettype",
"choices": ("managed", "bridged"),
"helptext": "A valid nettype must be specified",
"required": True,
},
{"name": "mtu"},
{"name": "domain"},
{"name": "name_servers"},
{"name": "ip4_network"},
{"name": "ip4_gateway"},
{"name": "ip6_network"},
{"name": "ip6_gateway"},
{"name": "dhcp4"},
{"name": "dhcp4_start"},
{"name": "dhcp4_end"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Create a new network
---
tags:
- network
parameters:
- in: query
name: vni
type: integer
required: true
description: The VNI of the network
- in: query
name: description
type: string
required: true
description: The description of the network
- in: query
name: nettype
type: string
required: true
description: The type of network
enum:
- managed
- bridged
Add MTU to network creation/modification Addresses #144
2021-10-09 17:43:56 -04:00
- in: query
name: mtu
type: integer
description: The MTU of the network; defaults to the underlying interface MTU if not set
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: domain
type: string
description: The DNS domain of the network ("managed" networks only)
- in: query
name: name_servers
type: string
description: The CSV list of DNS nameservers for network NS records ("managed" networks only)
- in: query
name: ip4_network
type: string
description: The IPv4 network subnet of the network in CIDR format; IPv4 disabled if unspecified ("managed" networks only)
- in: query
name: ip4_gateway
type: string
description: The IPv4 default gateway address of the network ("managed" networks only)
- in: query
name: dhcp4
type: boolean
description: Whether to enable DHCPv4 for the network ("managed" networks only)
- in: query
name: dhcp4_start
type: string
description: The DHCPv4 pool start address of the network ("managed" networks only)
- in: query
name: dhcp4_end
type: string
description: The DHCPv4 pool end address of the network ("managed" networks only)
- in: query
name: ip6_network
type: string
description: The IPv6 network subnet of the network in CIDR format; IPv6 disabled if unspecified; DHCPv6 is always used in IPv6 managed networks ("managed" networks only)
- in: query
name: ip6_gateway
type: string
description: The IPv6 default gateway address of the network ("managed" networks only)
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs.get("name_servers", None):
name_servers = ",".join(reqargs.get("name_servers", None))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
else:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
name_servers = ""
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return api_helper.net_add(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("vni", None),
reqargs.get("description", None),
reqargs.get("nettype", None),
reqargs.get("mtu", ""),
reqargs.get("domain", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
name_servers,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("ip4_network", None),
reqargs.get("ip4_gateway", None),
reqargs.get("ip6_network", None),
reqargs.get("ip6_gateway", None),
bool(strtobool(reqargs.get("dhcp4", "false"))),
reqargs.get("dhcp4_start", None),
reqargs.get("dhcp4_end", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Network_Root, "/network")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /network/<vni>
class API_Network_Element(Resource):
@Authenticator
def get(self, vni):
"""
Return information about network {vni}
---
tags:
- network
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: vni
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/network'
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.net_list(vni, is_fuzzy=False)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "description", "required": True},
{
"name": "nettype",
"choices": ("managed", "bridged"),
"helptext": "A valid nettype must be specified",
"required": True,
},
{"name": "mtu"},
{"name": "domain"},
{"name": "name_servers"},
{"name": "ip4_network"},
{"name": "ip4_gateway"},
{"name": "ip6_network"},
{"name": "ip6_gateway"},
{"name": "dhcp4"},
{"name": "dhcp4_start"},
{"name": "dhcp4_end"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, vni, reqargs):
"""
Create a new network {vni}
---
tags:
- network
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vni
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: description
type: string
required: true
description: The description of the network
- in: query
name: nettype
type: string
required: true
description: The type of network
enum:
- managed
- bridged
Add MTU to network creation/modification Addresses #144
2021-10-09 17:43:56 -04:00
- in: query
name: mtu
type: integer
description: The MTU of the network; defaults to the underlying interface MTU if not set
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: domain
type: string
description: The DNS domain of the network ("managed" networks only)
- in: query
name: name_servers
type: string
description: The CSV list of DNS nameservers for network NS records ("managed" networks only)
- in: query
name: ip4_network
type: string
description: The IPv4 network subnet of the network in CIDR format; IPv4 disabled if unspecified ("managed" networks only)
- in: query
name: ip4_gateway
type: string
description: The IPv4 default gateway address of the network ("managed" networks only)
- in: query
name: dhcp4
type: boolean
description: Whether to enable DHCPv4 for the network ("managed" networks only)
- in: query
name: dhcp4_start
type: string
description: The DHCPv4 pool start address of the network ("managed" networks only)
- in: query
name: dhcp4_end
type: string
description: The DHCPv4 pool end address of the network ("managed" networks only)
- in: query
name: ip6_network
type: string
description: The IPv6 network subnet of the network in CIDR format; IPv6 disabled if unspecified; DHCPv6 is always used in IPv6 managed networks ("managed" networks only)
- in: query
name: ip6_gateway
type: string
description: The IPv6 default gateway address of the network ("managed" networks only)
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs.get("name_servers", None):
name_servers = ",".join(reqargs.get("name_servers", None))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
else:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
name_servers = ""
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return api_helper.net_add(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("vni", None),
reqargs.get("description", None),
reqargs.get("nettype", None),
reqargs.get("mtu", ""),
reqargs.get("domain", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
name_servers,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("ip4_network", None),
reqargs.get("ip4_gateway", None),
reqargs.get("ip6_network", None),
reqargs.get("ip6_gateway", None),
bool(strtobool(reqargs.get("dhcp4", "false"))),
reqargs.get("dhcp4_start", None),
reqargs.get("dhcp4_end", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "description"},
{"name": "mtu"},
{"name": "domain"},
{"name": "name_servers"},
{"name": "ip4_network"},
{"name": "ip4_gateway"},
{"name": "ip6_network"},
{"name": "ip6_gateway"},
{"name": "dhcp4"},
{"name": "dhcp4_start"},
{"name": "dhcp4_end"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def put(self, vni, reqargs):
"""
Update details of network {vni}
Note: A network's type cannot be changed; the network must be removed and recreated as the new type
---
tags:
- network
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vni
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: description
type: string
description: The description of the network
Add MTU to network creation/modification Addresses #144
2021-10-09 17:43:56 -04:00
- in: query
name: mtu
type: integer
description: The MTU of the network
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: domain
type: string
description: The DNS domain of the network ("managed" networks only)
- in: query
name: name_servers
type: string
description: The CSV list of DNS nameservers for network NS records ("managed" networks only)
- in: query
name: ip4_network
type: string
description: The IPv4 network subnet of the network in CIDR format; IPv4 disabled if unspecified ("managed" networks only)
- in: query
name: ip4_gateway
type: string
description: The IPv4 default gateway address of the network ("managed" networks only)
- in: query
name: dhcp4
type: boolean
description: Whether to enable DHCPv4 for the network ("managed" networks only)
- in: query
name: dhcp4_start
type: string
description: The DHCPv4 pool start address of the network ("managed" networks only)
- in: query
name: dhcp4_end
type: string
description: The DHCPv4 pool end address of the network ("managed" networks only)
- in: query
name: ip6_network
type: string
description: The IPv6 network subnet of the network in CIDR format; IPv6 disabled if unspecified; DHCPv6 is always used in IPv6 managed networks ("managed" networks only)
- in: query
name: ip6_gateway
type: string
description: The IPv6 default gateway address of the network ("managed" networks only)
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs.get("name_servers", None):
name_servers = ",".join(reqargs.get("name_servers", None))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
else:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
name_servers = ""
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return api_helper.net_modify(
vni,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("description", None),
reqargs.get("mtu", None),
reqargs.get("domain", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
name_servers,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("ip4_network", None),
reqargs.get("ip4_gateway", None),
reqargs.get("ip6_network", None),
reqargs.get("ip6_gateway", None),
reqargs.get("dhcp4", None),
reqargs.get("dhcp4_start", None),
reqargs.get("dhcp4_end", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
@Authenticator
def delete(self, vni):
"""
Remove network {vni}
---
tags:
- network
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: vni
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.net_remove(vni)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Network_Element, "/network/<vni>")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /network/<vni>/lease
class API_Network_Lease_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}, {"name": "static"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, vni, reqargs):
"""
Return a list of DHCP leases in network {vni}
---
tags:
- network
definitions:
- schema:
type: object
id: lease
properties:
hostname:
type: string
description: The (short) hostname of the lease
ip4_address:
type: string
description: The IPv4 address of the lease
mac_address:
type: string
description: The MAC address of the lease
timestamp:
type: integer
description: The UNIX timestamp of the lease creation
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vni
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: limit
type: string
required: false
description: A MAC address search limit; fuzzy by default, use ^/$ to force exact matches
- in: query
name: static
type: boolean
required: false
default: false
description: Whether to show only static leases
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/lease'
400:
description: Bad request
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.net_dhcp_list(
vni,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("limit", None),
bool(strtobool(reqargs.get("static", "false"))),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "macaddress", "required": True},
{"name": "ipaddress", "required": True},
{"name": "hostname"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, vni, reqargs):
"""
Create a new static DHCP lease in network {vni}
---
tags:
- network
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vni
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: macaddress
type: string
required: false
description: A MAC address for the lease
- in: query
name: ipaddress
type: string
required: false
description: An IPv4 address for the lease
- in: query
name: hostname
type: string
required: false
description: An optional hostname for the lease
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.net_dhcp_add(
vni,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("ipaddress", None),
reqargs.get("macaddress", None),
reqargs.get("hostname", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Network_Lease_Root, "/network/<vni>/lease")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /network/<vni>/lease/{mac}
class API_Network_Lease_Element(Resource):
@Authenticator
def get(self, vni, mac):
"""
Return information about DHCP lease {mac} in network {vni}
---
tags:
- network
definitions:
- schema:
type: object
id: lease
properties:
hostname:
type: string
description: The (short) hostname of the lease
ip4_address:
type: string
description: The IPv4 address of the lease
mac_address:
type: string
description: The MAC address of the lease
timestamp:
type: integer
description: The UNIX timestamp of the lease creation
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: vni
type: string
required: true
description: Path parameter
- in: path
name: mac
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/lease'
400:
description: Bad request
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.net_dhcp_list(vni, mac, False)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "ipaddress", "required": True}, {"name": "hostname"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
Lint: F821 undefined name 'reqargs' These were functions that were missing an expected reqargs pass.
2020-11-07 13:28:59 -05:00
def post(self, vni, mac, reqargs):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
"""
Create a new static DHCP lease {mac} in network {vni}
---
tags:
- network
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vni
type: string
required: true
description: Path parameter
- in: path
name: mac
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: macaddress
type: string
required: false
description: A MAC address for the lease
- in: query
name: ipaddress
type: string
required: false
description: An IPv4 address for the lease
- in: query
name: hostname
type: string
required: false
description: An optional hostname for the lease
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.net_dhcp_add(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
vni, reqargs.get("ipaddress", None), mac, reqargs.get("hostname", None)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
@Authenticator
def delete(self, vni, mac):
"""
Delete static DHCP lease {mac}
---
tags:
- network
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: vni
type: string
required: true
description: Path parameter
- in: path
name: mac
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.net_dhcp_remove(vni, mac)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Network_Lease_Element, "/network/<vni>/lease/<mac>")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /network/<vni>/acl
class API_Network_ACL_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "limit"},
{
"name": "direction",
"choices": ("in", "out"),
"helptext": "A valid direction must be specified.",
},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, vni, reqargs):
"""
Return a list of ACLs in network {vni}
---
tags:
- network
definitions:
- schema:
type: object
id: acl
properties:
description:
type: string
description: The description of the rule
direction:
type: string
description: The direction the rule applies in
order:
type: integer
description: The order of the rule in the chain
rule:
type: string
description: The NFT-format rule string
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vni
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: limit
type: string
required: false
description: A description search limit; fuzzy by default, use ^/$ to force exact matches
- in: query
name: direction
type: string
required: false
description: The direction of rules to display; both directions shown if unspecified
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/acl'
400:
description: Bad request
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.net_acl_list(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
vni, reqargs.get("limit", None), reqargs.get("direction", None)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "description",
"required": True,
"helptext": "A whitespace-free description must be specified.",
},
{"name": "rule", "required": True, "helptext": "A rule must be specified."},
{
"name": "direction",
"choices": ("in", "out"),
"helptext": "A valid direction must be specified.",
},
{"name": "order"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, vni, reqargs):
"""
Create a new ACL in network {vni}
---
tags:
- network
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vni
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: description
type: string
required: true
description: A whitespace-free description/name for the ACL
- in: query
name: direction
type: string
required: false
description: The direction of the ACL; defaults to "in" if unspecified
enum:
- in
- out
- in: query
name: order
type: integer
description: The order of the ACL in the chain; defaults to the end
- in: query
name: rule
type: string
required: true
description: The raw NFT firewall rule string
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_helper.net_acl_add(
vni,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("direction", "in"),
reqargs.get("description", None),
reqargs.get("rule", None),
reqargs.get("order", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Network_ACL_Root, "/network/<vni>/acl")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /network/<vni>/acl/<description>
class API_Network_ACL_Element(Resource):
@Authenticator
def get(self, vni, description):
"""
Return information about ACL {description} in network {vni}
---
tags:
- network
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: vni
type: string
required: true
description: Path parameter
- in: path
name: description
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/acl'
400:
description: Bad request
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.net_acl_list(vni, description, None, is_fuzzy=False)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "rule", "required": True, "helptext": "A rule must be specified."},
{
"name": "direction",
"choices": ("in", "out"),
"helptext": "A valid direction must be specified.",
},
{"name": "order"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, vni, description, reqargs):
"""
Create a new ACL {description} in network {vni}
---
tags:
- network
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: vni
type: string
required: true
description: Path parameter
- in: path
name: description
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: direction
type: string
required: false
description: The direction of the ACL; defaults to "in" if unspecified
enum:
- in
- out
- in: query
name: order
type: integer
description: The order of the ACL in the chain; defaults to the end
- in: query
name: rule
type: string
required: true
description: The raw NFT firewall rule string
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_helper.net_acl_add(
vni,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("direction", "in"),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
description,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("rule", None),
reqargs.get("order", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
@Authenticator
def delete(self, vni, description):
"""
Delete ACL {description} in network {vni}
---
tags:
- network
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: vni
type: string
required: true
description: Path parameter
- in: path
name: description
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.net_acl_remove(vni, description)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Network_ACL_Element, "/network/<vni>/acl/<description>")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Add SRIOV PF and VF listing to API
2021-06-21 01:42:55 -04:00
##########################################################
# Client API - SR-IOV
##########################################################
Format based on updated Black
2023-09-12 16:41:02 -04:00
Add SRIOV PF and VF listing to API
2021-06-21 01:42:55 -04:00
# /sriov
class API_SRIOV_Root(Resource):
@Authenticator
def get(self):
pass
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_SRIOV_Root, "/sriov")
Add SRIOV PF and VF listing to API
2021-06-21 01:42:55 -04:00
# /sriov/pf
class API_SRIOV_PF_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "node",
"required": True,
"helptext": "A valid node must be specified.",
},
]
)
Add SRIOV PF and VF listing to API
2021-06-21 01:42:55 -04:00
@Authenticator
def get(self, reqargs):
"""
Return a list of SR-IOV PFs on a given node
---
tags:
- network / sriov
responses:
200:
description: OK
schema:
type: object
id: sriov_pf
properties:
phy:
type: string
description: The name of the SR-IOV PF device
mtu:
type: string
description: The MTU of the SR-IOV PF device
vfs:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: array
Add SRIOV PF and VF listing to API
2021-06-21 01:42:55 -04:00
items:
type: string
description: The PHY name of a VF of this PF
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.sriov_pf_list(reqargs.get("node"))
Add SRIOV PF and VF listing to API
2021-06-21 01:42:55 -04:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_SRIOV_PF_Root, "/sriov/pf")
Add SRIOV PF and VF listing to API
2021-06-21 01:42:55 -04:00
Add SR-IOV listing/info endpoints to API
2021-06-21 17:12:14 -04:00
# /sriov/pf/<node>
class API_SRIOV_PF_Node(Resource):
@Authenticator
def get(self, node):
"""
Return a list of SR-IOV PFs on node {node}
---
tags:
- network / sriov
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: node
type: string
required: true
description: Path parameter
Add SR-IOV listing/info endpoints to API
2021-06-21 17:12:14 -04:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/sriov_pf'
"""
return api_helper.sriov_pf_list(node)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_SRIOV_PF_Node, "/sriov/pf/<node>")
Add SR-IOV listing/info endpoints to API
2021-06-21 17:12:14 -04:00
Add SRIOV PF and VF listing to API
2021-06-21 01:42:55 -04:00
# /sriov/vf
class API_SRIOV_VF_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "node",
"required": True,
"helptext": "A valid node must be specified.",
},
{
"name": "pf",
"required": False,
"helptext": "A PF parent may be specified.",
},
]
)
Add SRIOV PF and VF listing to API
2021-06-21 01:42:55 -04:00
@Authenticator
def get(self, reqargs):
"""
Return a list of SR-IOV VFs on a given node, optionally limited to those in the specified PF
---
tags:
- network / sriov
responses:
200:
description: OK
schema:
type: object
id: sriov_vf
properties:
phy:
type: string
description: The name of the SR-IOV VF device
pf:
type: string
description: The name of the SR-IOV PF parent of this VF device
mtu:
type: integer
description: The current MTU of the VF device
mac:
type: string
description: The current MAC address of the VF device
config:
type: object
properties:
vlan_id:
type: string
description: The tagged vLAN ID of the SR-IOV VF device
vlan_qos:
type: string
description: The QOS group of the tagged vLAN
tx_rate_min:
type: string
description: The minimum TX rate of the SR-IOV VF device
tx_rate_max:
type: string
description: The maximum TX rate of the SR-IOV VF device
spoof_check:
type: boolean
description: Whether device spoof checking is enabled or disabled
link_state:
type: string
description: The current SR-IOV VF link state (either enabled, disabled, or auto)
trust:
type: boolean
description: Whether guest device trust is enabled or disabled
query_rss:
type: boolean
description: Whether VF RSS querying is enabled or disabled
usage:
type: object
properties:
used:
type: boolean
description: Whether the SR-IOV VF is currently used by a VM or not
domain:
type: boolean
description: The UUID of the domain the SR-IOV VF is currently used by
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.sriov_vf_list(reqargs.get("node"), reqargs.get("pf", None))
Add SRIOV PF and VF listing to API
2021-06-21 01:42:55 -04:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_SRIOV_VF_Root, "/sriov/vf")
Add SRIOV PF and VF listing to API
2021-06-21 01:42:55 -04:00
Add SR-IOV listing/info endpoints to API
2021-06-21 17:12:14 -04:00
# /sriov/vf/<node>
class API_SRIOV_VF_Node(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "pf",
"required": False,
"helptext": "A PF parent may be specified.",
},
]
)
Add SR-IOV listing/info endpoints to API
2021-06-21 17:12:14 -04:00
@Authenticator
def get(self, node, reqargs):
"""
Return a list of SR-IOV VFs on node {node}, optionally limited to those in the specified PF
---
tags:
- network / sriov
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: node
type: string
required: true
description: Path parameter
Add SR-IOV listing/info endpoints to API
2021-06-21 17:12:14 -04:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/sriov_vf'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.sriov_vf_list(node, reqargs.get("pf", None))
Add SR-IOV listing/info endpoints to API
2021-06-21 17:12:14 -04:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_SRIOV_VF_Node, "/sriov/vf/<node>")
Add SR-IOV listing/info endpoints to API
2021-06-21 17:12:14 -04:00
# /sriov/vf/<node>/<vf>
class API_SRIOV_VF_Element(Resource):
@Authenticator
def get(self, node, vf):
"""
Return information about {vf} on {node}
---
tags:
- network / sriov
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: node
type: string
required: true
description: Path parameter
- in: path
name: vf
type: string
required: true
description: Path parameter
Add SR-IOV listing/info endpoints to API
2021-06-21 17:12:14 -04:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/sriov_vf'
404:
description: Not found
schema:
type: object
id: Message
"""
vf_list = list()
full_vf_list, _ = api_helper.sriov_vf_list(node)
for vf_element in full_vf_list:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if vf_element["phy"] == vf:
Add SR-IOV listing/info endpoints to API
2021-06-21 17:12:14 -04:00
vf_list.append(vf_element)
if len(vf_list) == 1:
return vf_list, 200
else:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return {"message": "No VF '{}' found on node '{}'".format(vf, node)}, 404
@RequestParser(
[
{"name": "vlan_id"},
{"name": "vlan_qos"},
{"name": "tx_rate_min"},
{"name": "tx_rate_max"},
{
"name": "link_state",
"choices": ("auto", "enable", "disable"),
"helptext": "A valid state must be specified",
},
{"name": "spoof_check"},
{"name": "trust"},
{"name": "query_rss"},
]
)
Implement SR-IOV VF config set Also fixes some random bugs, adds proper interface sorting, and assorted tweaks.
2021-06-21 18:40:11 -04:00
@Authenticator
def put(self, node, vf, reqargs):
"""
Set the configuration of {vf} on {node}
---
tags:
- network / sriov
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: node
type: string
required: true
description: Path parameter
- in: path
name: vf
type: string
required: true
description: Path parameter
Implement SR-IOV VF config set Also fixes some random bugs, adds proper interface sorting, and assorted tweaks.
2021-06-21 18:40:11 -04:00
- in: query
name: vlan_id
type: integer
required: false
description: The vLAN ID for vLAN tagging (0 is disabled)
- in: query
name: vlan_qos
type: integer
required: false
description: The vLAN QOS priority (0 is disabled)
- in: query
name: tx_rate_min
type: integer
required: false
description: The minimum TX rate (0 is disabled)
- in: query
name: tx_rate_max
type: integer
required: false
description: The maximum TX rate (0 is disabled)
- in: query
name: link_state
type: string
required: false
description: The administrative link state
enum:
- auto
- enable
- disable
- in: query
name: spoof_check
type: boolean
required: false
description: Enable or disable spoof checking
- in: query
name: trust
type: boolean
required: false
description: Enable or disable VF user trust
- in: query
name: query_rss
type: boolean
required: false
description: Enable or disable query RSS support
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_helper.update_sriov_vf_config(
node,
vf,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("vlan_id", None),
reqargs.get("vlan_qos", None),
reqargs.get("tx_rate_min", None),
reqargs.get("tx_rate_max", None),
reqargs.get("link_state", None),
reqargs.get("spoof_check", None),
reqargs.get("trust", None),
reqargs.get("query_rss", None),
Implement SR-IOV VF config set Also fixes some random bugs, adds proper interface sorting, and assorted tweaks.
2021-06-21 18:40:11 -04:00
)
Add SR-IOV listing/info endpoints to API
2021-06-21 17:12:14 -04:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_SRIOV_VF_Element, "/sriov/vf/<node>/<vf>")
Add SR-IOV listing/info endpoints to API
2021-06-21 17:12:14 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
##########################################################
# Client API - Storage
##########################################################
# Note: The prefix `/storage` allows future potential storage subsystems.
# Since Ceph is the only section not abstracted by PVC directly
# (i.e. it references Ceph-specific concepts), this makes more
# sense in the long-term.#
Format based on updated Black
2023-09-12 16:41:02 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage
class API_Storage_Root(Resource):
@Authenticator
def get(self):
pass
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Root, "/storage")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph
class API_Storage_Ceph_Root(Resource):
@Authenticator
def get(self):
pass
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_Root, "/storage/ceph")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/status
class API_Storage_Ceph_Status(Resource):
@Authenticator
def get(self):
"""
Return status data for the PVC Ceph cluster
---
tags:
- storage / ceph
responses:
200:
description: OK
schema:
type: object
properties:
type:
type: string
description: The type of Ceph data returned
primary_node:
type: string
description: The curent primary node in the cluster
ceph_data:
type: string
description: The raw output data
"""
return api_helper.ceph_status()
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_Status, "/storage/ceph/status")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/utilization
class API_Storage_Ceph_Utilization(Resource):
@Authenticator
def get(self):
"""
Return utilization data for the PVC Ceph cluster
---
tags:
- storage / ceph
responses:
200:
description: OK
schema:
type: object
properties:
type:
type: string
description: The type of Ceph data returned
primary_node:
type: string
description: The curent primary node in the cluster
ceph_data:
type: string
description: The raw output data
"""
Improve debug output and use ceph df util data
2020-06-06 22:49:47 -04:00
return api_helper.ceph_util()
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_Utilization, "/storage/ceph/utilization")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
# /storage/ceph/benchmark
class API_Storage_Ceph_Benchmark(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "job"}])
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
@Authenticator
def get(self, reqargs):
"""
List results from benchmark jobs
---
tags:
- storage / ceph
Add API spec for benchmark results
2020-08-25 12:43:16 -04:00
parameters:
- in: query
name: job
type: string
required: false
description: A single job name to limit results to
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
responses:
200:
description: OK
schema:
type: object
Add API spec for benchmark results
2020-08-25 12:43:16 -04:00
id: storagebenchmark
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
properties:
Add API spec for benchmark results
2020-08-25 12:43:16 -04:00
id:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: string
Add API spec for benchmark results
2020-08-25 12:43:16 -04:00
description: The database ID of the test result
job:
type: string
description: The job name (an ISO date) of the test result
Add test format versioning to storage benchmarks Adds a test_format database column and a value in the API return for the test format version, starting at 0 for the existing format as of 0.9.37. References #143
2021-10-02 00:53:27 -04:00
test_format:
type: integer
description: The PVC benchmark format of the results
Add API spec for benchmark results
2020-08-25 12:43:16 -04:00
benchmark_result:
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
type: object
Update benchmarks to include resource utilization Adds additional polled information on node cpu, memory, and network bandwidth for the node running the test. This should provide additional useful information about the results of the test. Also bumps the test format to 2 to ensure clients can handle the changes properly.
2024-09-18 10:19:12 -04:00
description: A benchmark test result; format not documented due to complexity
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
"""
Port all Celery worker functions to discrete pkg Moves all tasks run by the Celery worker into a discrete package/module for easier installation. Also adjusts several parameters throughout to accomplish this.
2023-11-30 02:01:22 -05:00
return list_benchmarks(config, reqargs.get("job", None))
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "pool",
"required": True,
"helptext": "A valid pool must be specified.",
},
Allow specifying job names for benchmarks
2024-09-18 14:55:12 -04:00
{
"name": "name",
"required": False,
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
@Authenticator
def post(self, reqargs):
"""
Execute a storage benchmark against a storage pool
---
tags:
- storage / ceph
parameters:
- in: query
name: pool
type: string
required: true
description: The PVC storage pool to benchmark
Allow specifying job names for benchmarks
2024-09-18 14:55:12 -04:00
- in: query
name: name
type: string
required: false
description: An optional override name for the job
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
400:
description: Bad request
schema:
type: object
id: Message
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
"""
# Verify that the pool is valid
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
_list, code = api_helper.ceph_pool_list(
reqargs.get("pool", None), is_fuzzy=False
)
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
if code != 200:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return {
"message": 'Pool "{}" is not valid.'.format(reqargs.get("pool"))
}, 400
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
task = run_celery_task(
Allow specifying job names for benchmarks
2024-09-18 14:55:12 -04:00
"storage.benchmark",
pool=reqargs.get("pool", None),
name=reqargs.get("name", None),
run_on="primary",
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return (
Return and show task_name
2023-11-16 14:50:02 -05:00
{
"task_id": task.id,
"task_name": "storage.benchmark",
Port VM autobackups into pvcworkerd with snaps Moves VM autobackups from being in-CLI to being handled by the pvcworkerd system on the primary coordinator. Turns the CLI autobackup command into an actual API client endpoint rather than having its logic in the CLI. In addition, modifies the new autobackup to leverage the new "pvc vm snapshot" function set, just with special snapshot names. This helps automate this within the new snapshot scaffolding.
2024-08-23 17:01:31 -04:00
"run_on": f"{get_primary_node()} (primary)",
Return and show task_name
2023-11-16 14:50:02 -05:00
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
202,
Port remaining tasks to new task handler Move the create_vm and run_benchmark tasks to use the new Celery subsystem, handlers, and wait command. Remove the obsolete, dedicated API endpoints. Standardize the CLI client and move the repeated handler code into a separate common function.
2023-11-16 01:57:56 -05:00
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_Benchmark, "/storage/ceph/benchmark")
Add storage benchmarking to API
2020-08-24 14:57:52 -04:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/option
class API_Storage_Ceph_Option(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "option",
"required": True,
"helptext": "A valid option must be specified.",
},
{
"name": "action",
"required": True,
"choices": ("set", "unset"),
"helptext": "A valid action must be specified.",
},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Set or unset OSD options on the Ceph cluster
---
tags:
- storage / ceph
parameters:
- in: query
name: option
type: string
required: true
description: The Ceph OSD option to act on; must be valid to "ceph osd set/unset"
- in: query
name: action
type: string
required: true
description: The action to take
enum:
- set
- unset
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs.get("action") == "set":
return api_helper.ceph_osd_set(reqargs.get("option"))
if reqargs.get("action") == "unset":
return api_helper.ceph_osd_unset(reqargs.get("option"))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
abort(400)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_Option, "/storage/ceph/option")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Add separate OSD DB device support Adds in three parts: 1. Create an API endpoint to create OSD DB volume groups on a device. Passed through to the node via the same command pipeline as creating/removing OSDs, and creates a volume group with a fixed name (osd-db). 2. Adds API support for specifying whether or not to use this DB volume group when creating a new OSD via the "ext_db" flag. Naming and sizing is fixed for simplicity and based on Ceph recommendations (5% of OSD size). The Zookeeper schema tracks the block device to use during removal. 3. Adds CLI support for the new and modified API endpoints, as well as displaying the block device and DB block device in the OSD list. While I debated supporting adding a DB device to an existing OSD, in practice this ended up being a very complex operation involving stopping the OSD and setting some options, so this is not supported; this can be specified during OSD creation only. Closes #142
2021-09-23 13:59:49 -04:00
# /storage/ceph/osddb
class API_Storage_Ceph_OSDDB_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "node",
"required": True,
"helptext": "A valid node must be specified.",
},
{
"name": "device",
"required": True,
Handle detect strings as arguments for blockdevs Allows specifying blockdevs in the OSD and OSD-DB addition commands as detect strings rather than actual block device paths. This provides greater flexibility for automation with pvcbootstrapd (which originates the concept of detect strings) and in general usage as well.
2021-12-24 15:18:38 -05:00
"helptext": "A valid device or detect string must be specified.",
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
},
]
)
Add separate OSD DB device support Adds in three parts: 1. Create an API endpoint to create OSD DB volume groups on a device. Passed through to the node via the same command pipeline as creating/removing OSDs, and creates a volume group with a fixed name (osd-db). 2. Adds API support for specifying whether or not to use this DB volume group when creating a new OSD via the "ext_db" flag. Naming and sizing is fixed for simplicity and based on Ceph recommendations (5% of OSD size). The Zookeeper schema tracks the block device to use during removal. 3. Adds CLI support for the new and modified API endpoints, as well as displaying the block device and DB block device in the OSD list. While I debated supporting adding a DB device to an existing OSD, in practice this ended up being a very complex operation involving stopping the OSD and setting some options, so this is not supported; this can be specified during OSD creation only. Closes #142
2021-09-23 13:59:49 -04:00
@Authenticator
def post(self, reqargs):
"""
Add a Ceph OSD database volume group to the cluster
Note: This task may take up to 30s to complete and return
---
tags:
- storage / ceph
parameters:
- in: query
name: node
type: string
required: true
description: The PVC node to create the OSD DB volume group on
- in: query
name: device
type: string
required: true
Handle detect strings as arguments for blockdevs Allows specifying blockdevs in the OSD and OSD-DB addition commands as detect strings rather than actual block device paths. This provides greater flexibility for automation with pvcbootstrapd (which originates the concept of detect strings) and in general usage as well.
2021-12-24 15:18:38 -05:00
description: The block device (e.g. "/dev/sdb", "/dev/disk/by-path/...", etc.) or detect string ("detect:NAME:SIZE:ID") to create the OSD DB volume group on
Add separate OSD DB device support Adds in three parts: 1. Create an API endpoint to create OSD DB volume groups on a device. Passed through to the node via the same command pipeline as creating/removing OSDs, and creates a volume group with a fixed name (osd-db). 2. Adds API support for specifying whether or not to use this DB volume group when creating a new OSD via the "ext_db" flag. Naming and sizing is fixed for simplicity and based on Ceph recommendations (5% of OSD size). The Zookeeper schema tracks the block device to use during removal. 3. Adds CLI support for the new and modified API endpoints, as well as displaying the block device and DB block device in the OSD list. While I debated supporting adding a DB device to an existing OSD, in practice this ended up being a very complex operation involving stopping the OSD and setting some options, so this is not supported; this can be specified during OSD creation only. Closes #142
2021-09-23 13:59:49 -04:00
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Add separate OSD DB device support Adds in three parts: 1. Create an API endpoint to create OSD DB volume groups on a device. Passed through to the node via the same command pipeline as creating/removing OSDs, and creates a volume group with a fixed name (osd-db). 2. Adds API support for specifying whether or not to use this DB volume group when creating a new OSD via the "ext_db" flag. Naming and sizing is fixed for simplicity and based on Ceph recommendations (5% of OSD size). The Zookeeper schema tracks the block device to use during removal. 3. Adds CLI support for the new and modified API endpoints, as well as displaying the block device and DB block device in the OSD list. While I debated supporting adding a DB device to an existing OSD, in practice this ended up being a very complex operation involving stopping the OSD and setting some options, so this is not supported; this can be specified during OSD creation only. Closes #142
2021-09-23 13:59:49 -04:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Add separate OSD DB device support Adds in three parts: 1. Create an API endpoint to create OSD DB volume groups on a device. Passed through to the node via the same command pipeline as creating/removing OSDs, and creates a volume group with a fixed name (osd-db). 2. Adds API support for specifying whether or not to use this DB volume group when creating a new OSD via the "ext_db" flag. Naming and sizing is fixed for simplicity and based on Ceph recommendations (5% of OSD size). The Zookeeper schema tracks the block device to use during removal. 3. Adds CLI support for the new and modified API endpoints, as well as displaying the block device and DB block device in the OSD list. While I debated supporting adding a DB device to an existing OSD, in practice this ended up being a very complex operation involving stopping the OSD and setting some options, so this is not supported; this can be specified during OSD creation only. Closes #142
2021-09-23 13:59:49 -04:00
400:
description: Bad request
schema:
type: object
id: Message
"""
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
node = reqargs.get("node", None)
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
task = run_celery_task(
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
"osd.add_db_vg", device=reqargs.get("device", None), run_on=node
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
)
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
return (
Return and show task_name
2023-11-16 14:50:02 -05:00
{"task_id": task.id, "task_name": "osd.add_db_vg", "run_on": node},
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
Add separate OSD DB device support Adds in three parts: 1. Create an API endpoint to create OSD DB volume groups on a device. Passed through to the node via the same command pipeline as creating/removing OSDs, and creates a volume group with a fixed name (osd-db). 2. Adds API support for specifying whether or not to use this DB volume group when creating a new OSD via the "ext_db" flag. Naming and sizing is fixed for simplicity and based on Ceph recommendations (5% of OSD size). The Zookeeper schema tracks the block device to use during removal. 3. Adds CLI support for the new and modified API endpoints, as well as displaying the block device and DB block device in the OSD list. While I debated supporting adding a DB device to an existing OSD, in practice this ended up being a very complex operation involving stopping the OSD and setting some options, so this is not supported; this can be specified during OSD creation only. Closes #142
2021-09-23 13:59:49 -04:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_OSDDB_Root, "/storage/ceph/osddb")
Add separate OSD DB device support Adds in three parts: 1. Create an API endpoint to create OSD DB volume groups on a device. Passed through to the node via the same command pipeline as creating/removing OSDs, and creates a volume group with a fixed name (osd-db). 2. Adds API support for specifying whether or not to use this DB volume group when creating a new OSD via the "ext_db" flag. Naming and sizing is fixed for simplicity and based on Ceph recommendations (5% of OSD size). The Zookeeper schema tracks the block device to use during removal. 3. Adds CLI support for the new and modified API endpoints, as well as displaying the block device and DB block device in the OSD list. While I debated supporting adding a DB device to an existing OSD, in practice this ended up being a very complex operation involving stopping the OSD and setting some options, so this is not supported; this can be specified during OSD creation only. Closes #142
2021-09-23 13:59:49 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/osd
class API_Storage_Ceph_OSD_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "limit"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of Ceph OSDs in the cluster
---
tags:
- storage / ceph
definitions:
- schema:
type: object
id: osd
properties:
id:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: string
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
description: The Ceph ID of the OSD
Add separate OSD DB device support Adds in three parts: 1. Create an API endpoint to create OSD DB volume groups on a device. Passed through to the node via the same command pipeline as creating/removing OSDs, and creates a volume group with a fixed name (osd-db). 2. Adds API support for specifying whether or not to use this DB volume group when creating a new OSD via the "ext_db" flag. Naming and sizing is fixed for simplicity and based on Ceph recommendations (5% of OSD size). The Zookeeper schema tracks the block device to use during removal. 3. Adds CLI support for the new and modified API endpoints, as well as displaying the block device and DB block device in the OSD list. While I debated supporting adding a DB device to an existing OSD, in practice this ended up being a very complex operation involving stopping the OSD and setting some options, so this is not supported; this can be specified during OSD creation only. Closes #142
2021-09-23 13:59:49 -04:00
device:
type: string
description: The OSD data block device
db_device:
type: string
description: The OSD database/WAL block device (logical volume); empty if not applicable
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
stats:
type: object
properties:
uuid:
type: string
description: The Ceph OSD UUID
up:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: integer
description: Whether OSD is in "up" state, as boolean integer
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
in:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: integer
description: Whether OSD is in "in" state, as boolean integer
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
primary_affinity:
type: integer
description: The Ceph primary affinity of the OSD
utilization:
type: number
description: The utilization percentage of the OSD
var:
type: number
description: The usage variability among OSDs
pgs:
type: integer
description: The number of placement groups on this OSD
kb:
type: integer
description: Size of the OSD in KB
weight:
type: number
description: The weight of the OSD in the CRUSH map
reweight:
type: number
description: The active cluster weight of the OSD
node:
type: string
description: The PVC node the OSD resides on
used:
type: string
description: The used space on the OSD in human-readable format
avail:
type: string
description: The free space on the OSD in human-readable format
wr_ops:
type: integer
description: Cluster-lifetime write operations to OSD
rd_ops:
type: integer
description: Cluster-lifetime read operations from OSD
wr_data:
type: integer
description: Cluster-lifetime write size to OSD
rd_data:
type: integer
description: Cluster-lifetime read size from OSD
state:
type: string
description: CSV of the current state of the OSD
parameters:
- in: query
name: limit
type: string
required: false
description: A OSD ID search limit; fuzzy by default, use ^/$ to force exact matches
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/osd'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.ceph_osd_list(reqargs.get("limit", None))
@RequestParser(
[
{
"name": "node",
"required": True,
"helptext": "A valid node must be specified.",
},
{
"name": "device",
"required": True,
Handle detect strings as arguments for blockdevs Allows specifying blockdevs in the OSD and OSD-DB addition commands as detect strings rather than actual block device paths. This provides greater flexibility for automation with pvcbootstrapd (which originates the concept of detect strings) and in general usage as well.
2021-12-24 15:18:38 -05:00
"helptext": "A valid device or detect string must be specified.",
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
},
{
"name": "weight",
"required": True,
"helptext": "An OSD weight must be specified.",
},
{
"name": "ext_db_ratio",
"required": False,
Add support for split OSD adds Allows creating multiple OSDs on a single (NVMe) block device, leveraging the "ceph-volume lvm batch" command. Replaces the previous method of creating OSDs. Also adds a new ZK item for each OSD indicating if it is split or not.
2023-11-01 21:17:38 -04:00
},
{
Adjust handling of ext_db and _count options Avoid the use of superfluous flag options, default them to none, and add support for fixed-size DB LVs.
2023-11-02 13:29:47 -04:00
"name": "ext_db_size",
Add support for split OSD adds Allows creating multiple OSDs on a single (NVMe) block device, leveraging the "ceph-volume lvm batch" command. Replaces the previous method of creating OSDs. Also adds a new ZK item for each OSD indicating if it is split or not.
2023-11-01 21:17:38 -04:00
"required": False,
},
{
Adjust handling of ext_db and _count options Avoid the use of superfluous flag options, default them to none, and add support for fixed-size DB LVs.
2023-11-02 13:29:47 -04:00
"name": "osd_count",
Add support for split OSD adds Allows creating multiple OSDs on a single (NVMe) block device, leveraging the "ceph-volume lvm batch" command. Replaces the previous method of creating OSDs. Also adds a new ZK item for each OSD indicating if it is split or not.
2023-11-01 21:17:38 -04:00
"required": False,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Add a Ceph OSD to the cluster
Adjust handling of ext_db and _count options Avoid the use of superfluous flag options, default them to none, and add support for fixed-size DB LVs.
2023-11-02 13:29:47 -04:00
Note: This task may take up to 60s to complete and return
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
---
tags:
- storage / ceph
parameters:
- in: query
name: node
type: string
required: true
description: The PVC node to create the OSD on
- in: query
name: device
type: string
required: true
Handle detect strings as arguments for blockdevs Allows specifying blockdevs in the OSD and OSD-DB addition commands as detect strings rather than actual block device paths. This provides greater flexibility for automation with pvcbootstrapd (which originates the concept of detect strings) and in general usage as well.
2021-12-24 15:18:38 -05:00
description: The block device (e.g. "/dev/sdb", "/dev/disk/by-path/...", etc.) or detect string ("detect:NAME:SIZE:ID") to create the OSD on
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: weight
type: number
required: true
description: The Ceph CRUSH weight for the OSD
Add support for configurable OSD DB ratios The default of 0.05 (5%) is likely ideal in the initial implementation, but allow this to be set explicitly for maximum flexibility in space-constrained or performance-critical use-cases.
2021-09-23 23:31:58 -04:00
- in: query
name: ext_db_ratio
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: number
Add support for configurable OSD DB ratios The default of 0.05 (5%) is likely ideal in the initial implementation, but allow this to be set explicitly for maximum flexibility in space-constrained or performance-critical use-cases.
2021-09-23 23:31:58 -04:00
required: false
Adjust handling of ext_db and _count options Avoid the use of superfluous flag options, default them to none, and add support for fixed-size DB LVs.
2023-11-02 13:29:47 -04:00
description: If set, creates an OSD DB LV with this decimal ratio of DB to total OSD size (usually 0.05 i.e. 5%); mutually exclusive with ext_db_size
Add support for split OSD adds Allows creating multiple OSDs on a single (NVMe) block device, leveraging the "ceph-volume lvm batch" command. Replaces the previous method of creating OSDs. Also adds a new ZK item for each OSD indicating if it is split or not.
2023-11-01 21:17:38 -04:00
- in: query
Adjust handling of ext_db and _count options Avoid the use of superfluous flag options, default them to none, and add support for fixed-size DB LVs.
2023-11-02 13:29:47 -04:00
name: ext_db_size
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: number
Add support for split OSD adds Allows creating multiple OSDs on a single (NVMe) block device, leveraging the "ceph-volume lvm batch" command. Replaces the previous method of creating OSDs. Also adds a new ZK item for each OSD indicating if it is split or not.
2023-11-01 21:17:38 -04:00
required: false
Adjust handling of ext_db and _count options Avoid the use of superfluous flag options, default them to none, and add support for fixed-size DB LVs.
2023-11-02 13:29:47 -04:00
description: If set, creates an OSD DB LV with this explicit size in human units (e.g. 1024M, 20G); mutually exclusive with ext_db_ratio
Add support for split OSD adds Allows creating multiple OSDs on a single (NVMe) block device, leveraging the "ceph-volume lvm batch" command. Replaces the previous method of creating OSDs. Also adds a new ZK item for each OSD indicating if it is split or not.
2023-11-01 21:17:38 -04:00
- in: query
Adjust handling of ext_db and _count options Avoid the use of superfluous flag options, default them to none, and add support for fixed-size DB LVs.
2023-11-02 13:29:47 -04:00
name: osd_count
Add support for split OSD adds Allows creating multiple OSDs on a single (NVMe) block device, leveraging the "ceph-volume lvm batch" command. Replaces the previous method of creating OSDs. Also adds a new ZK item for each OSD indicating if it is split or not.
2023-11-01 21:17:38 -04:00
type: integer
required: false
Adjust handling of ext_db and _count options Avoid the use of superfluous flag options, default them to none, and add support for fixed-size DB LVs.
2023-11-02 13:29:47 -04:00
description: If set, create this many OSDs on the block device instead of 1; usually 2 or 4 depending on size
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
400:
description: Bad request
schema:
type: object
id: Message
"""
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
node = reqargs.get("node", None)
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
task = run_celery_task(
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
"osd.add",
Explicitly use kwargs in Celery task calls
2023-11-16 11:55:15 -05:00
device=reqargs.get("device", None),
weight=reqargs.get("weight", None),
ext_db_ratio=reqargs.get("ext_db_ratio", None),
ext_db_size=reqargs.get("ext_db_size", None),
split_count=reqargs.get("osd_count", None),
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
run_on=node,
)
return (
Return and show task_name
2023-11-16 14:50:02 -05:00
{"task_id": task.id, "task_name": "osd.add", "run_on": node},
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_OSD_Root, "/storage/ceph/osd")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/osd/<osdid>
class API_Storage_Ceph_OSD_Element(Resource):
@Authenticator
def get(self, osdid):
"""
Return information about Ceph OSD {osdid}
---
tags:
- storage / ceph
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: osdid
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/osd'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.ceph_osd_list(osdid)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
@RequestParser(
[
{
Update OSD replacement functionality 1. Simplify this by leveraging the existing remove_osd/add_osd functions, since its task was functionally identical to those two in sequential order. 2. Add support for split OSDs within the command (replacing all OSDs on the block device(s) as required). 3. Add additional configurability and flexibility around the old device, weight, and external DB LVs.
2023-11-03 01:45:49 -04:00
"name": "new_device",
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
"required": True,
"helptext": "A valid device or detect string must be specified.",
},
Update OSD replacement functionality 1. Simplify this by leveraging the existing remove_osd/add_osd functions, since its task was functionally identical to those two in sequential order. 2. Add support for split OSDs within the command (replacing all OSDs on the block device(s) as required). 3. Add additional configurability and flexibility around the old device, weight, and external DB LVs.
2023-11-03 01:45:49 -04:00
{
"name": "old_device",
"required": False,
},
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
{
"name": "weight",
Update OSD replacement functionality 1. Simplify this by leveraging the existing remove_osd/add_osd functions, since its task was functionally identical to those two in sequential order. 2. Add support for split OSDs within the command (replacing all OSDs on the block device(s) as required). 3. Add additional configurability and flexibility around the old device, weight, and external DB LVs.
2023-11-03 01:45:49 -04:00
"required": False,
},
{
"name": "ext_db_ratio",
"required": False,
},
{
"name": "ext_db_size",
"required": False,
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
},
{
"name": "yes-i-really-mean-it",
"required": True,
"helptext": "Please confirm that 'yes-i-really-mean-it'.",
},
]
)
@Authenticator
def post(self, osdid, reqargs):
"""
Replace a Ceph OSD in the cluster
Note: This task may take up to 30s to complete and return
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: osdid
type: string
required: true
description: Path parameter
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
- in: query
Update OSD replacement functionality 1. Simplify this by leveraging the existing remove_osd/add_osd functions, since its task was functionally identical to those two in sequential order. 2. Add support for split OSDs within the command (replacing all OSDs on the block device(s) as required). 3. Add additional configurability and flexibility around the old device, weight, and external DB LVs.
2023-11-03 01:45:49 -04:00
name: new_device
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
type: string
required: true
description: The block device (e.g. "/dev/sdb", "/dev/disk/by-path/...", etc.) or detect string ("detect:NAME:SIZE:ID") to replace the OSD onto
Update OSD replacement functionality 1. Simplify this by leveraging the existing remove_osd/add_osd functions, since its task was functionally identical to those two in sequential order. 2. Add support for split OSDs within the command (replacing all OSDs on the block device(s) as required). 3. Add additional configurability and flexibility around the old device, weight, and external DB LVs.
2023-11-03 01:45:49 -04:00
- in: query
name: old_device
type: string
required: false
description: The block device (e.g. "/dev/sdb", "/dev/disk/by-path/...", etc.) or detect string ("detect:NAME:SIZE:ID") of the original OSD
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
- in: query
name: weight
type: number
Update OSD replacement functionality 1. Simplify this by leveraging the existing remove_osd/add_osd functions, since its task was functionally identical to those two in sequential order. 2. Add support for split OSDs within the command (replacing all OSDs on the block device(s) as required). 3. Add additional configurability and flexibility around the old device, weight, and external DB LVs.
2023-11-03 01:45:49 -04:00
required: false
description: The Ceph CRUSH weight for the replacement OSD
- in: query
name: ext_db_ratio
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: number
Update OSD replacement functionality 1. Simplify this by leveraging the existing remove_osd/add_osd functions, since its task was functionally identical to those two in sequential order. 2. Add support for split OSDs within the command (replacing all OSDs on the block device(s) as required). 3. Add additional configurability and flexibility around the old device, weight, and external DB LVs.
2023-11-03 01:45:49 -04:00
required: false
description: If set, creates an OSD DB LV for the replcement OSD with this decimal ratio of DB to total OSD size (usually 0.05 i.e. 5%); if unset, use existing ext_db_size
- in: query
name: ext_db_size
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: number
Update OSD replacement functionality 1. Simplify this by leveraging the existing remove_osd/add_osd functions, since its task was functionally identical to those two in sequential order. 2. Add support for split OSDs within the command (replacing all OSDs on the block device(s) as required). 3. Add additional configurability and flexibility around the old device, weight, and external DB LVs.
2023-11-03 01:45:49 -04:00
required: false
description: If set, creates an OSD DB LV for the replacement OSD with this explicit size in human units (e.g. 1024M, 20G); if unset, use existing ext_db_size
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
400:
description: Bad request
schema:
type: object
id: Message
"""
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
osd_node_detail, retcode = api_helper.ceph_osd_node(osdid)
if retcode == 200:
node = osd_node_detail["node"]
else:
return osd_node_detail, retcode
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
task = run_celery_task(
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
"osd.replace",
Explicitly use kwargs in Celery task calls
2023-11-16 11:55:15 -05:00
osd_id=osdid,
new_device=reqargs.get("new_device"),
old_device=reqargs.get("old_device", None),
weight=reqargs.get("weight", None),
ext_db_ratio=reqargs.get("ext_db_ratio", None),
ext_db_size=reqargs.get("ext_db_size", None),
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
run_on=node,
)
return (
Return and show task_name
2023-11-16 14:50:02 -05:00
{"task_id": task.id, "task_name": "osd.replace", "run_on": node},
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
)
@RequestParser(
[
{
"name": "device",
"required": True,
"helptext": "A valid device or detect string must be specified.",
},
]
)
@Authenticator
def put(self, osdid, reqargs):
"""
Refresh (reimport) a Ceph OSD in the cluster
Note: This task may take up to 30s to complete and return
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: osdid
type: string
required: true
description: Path parameter
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
- in: query
name: device
type: string
required: true
description: The block device (e.g. "/dev/sdb", "/dev/disk/by-path/...", etc.) or detect string ("detect:NAME:SIZE:ID") that the OSD should be using
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
400:
description: Bad request
schema:
type: object
id: Message
"""
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
osd_node_detail, retcode = api_helper.ceph_osd_node(osdid)
if retcode == 200:
node = osd_node_detail["node"]
else:
return osd_node_detail, retcode
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
task = run_celery_task(
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
"osd.refresh",
Explicitly use kwargs in Celery task calls
2023-11-16 11:55:15 -05:00
osd_id=osdid,
device=reqargs.get("device", None),
ext_db_flag=False,
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
run_on=node,
)
return (
Return and show task_name
2023-11-16 14:50:02 -05:00
{"task_id": task.id, "task_name": "osd.refresh", "run_on": node},
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
Add support for replacing/refreshing OSDs Adds commands to both replace an OSD disk, and refresh (reimport) an existing OSD disk on a new node. This handles the cases where an OSD disk should be replaced (either due to upgrades or failures) or where a node is rebuilt in-place and an existing OSD must be re-imported to it. This should avoid the need to do a full remove/add sequence for either case. Also cleans up some aspects of OSD removal that are identical between methods (e.g. using safe-to-destroy and sleeping after stopping) and fixes a bug if an OSD does not truly exist when the daemon starts up.
2022-05-06 15:31:58 -04:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
Add OSD removal force option Ensures a removal can continue even in situations where some step(s) might fail, for instance removing an obsolete OSD from a replaced node.
2022-04-29 11:16:33 -04:00
{
"name": "force",
"required": False,
"helptext": "Force removal even if steps fail.",
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
{
"name": "yes-i-really-mean-it",
"required": True,
"helptext": "Please confirm that 'yes-i-really-mean-it'.",
Add OSD removal force option Ensures a removal can continue even in situations where some step(s) might fail, for instance removing an obsolete OSD from a replaced node.
2022-04-29 11:16:33 -04:00
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def delete(self, osdid, reqargs):
"""
Remove Ceph OSD {osdid}
Note: This task may take up to 30s to complete and return
Warning: This operation may have unintended consequences for the storage cluster; ensure the cluster can support removing the OSD before proceeding
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: osdid
type: string
required: true
description: Path parameter
Add OSD removal force option Ensures a removal can continue even in situations where some step(s) might fail, for instance removing an obsolete OSD from a replaced node.
2022-04-29 11:16:33 -04:00
- in: query
name: force
type: boolean
Fix incorrect default value typos
2024-09-13 11:09:00 -04:00
required: false
Add OSD removal force option Ensures a removal can continue even in situations where some step(s) might fail, for instance removing an obsolete OSD from a replaced node.
2022-04-29 11:16:33 -04:00
description: Force removal even if some step(s) fail
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: yes-i-really-mean-it
type: string
required: true
description: A confirmation string to ensure that the API consumer really means it
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
404:
description: Not found
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
osd_node_detail, retcode = api_helper.ceph_osd_node(osdid)
if retcode == 200:
node = osd_node_detail["node"]
else:
return osd_node_detail, retcode
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
task = run_celery_task(
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
"osd.remove",
Explicitly use kwargs in Celery task calls
2023-11-16 11:55:15 -05:00
osd_id=osdid,
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
force_flag=reqargs.get("force", False),
run_on=node,
)
return (
Return and show task_name
2023-11-16 14:50:02 -05:00
{"task_id": task.id, "task_name": "osd.remove", "run_on": node},
Port OSD on-node tasks to Celery worker system Adds Celery versions of the osd_add, osd_replace, osd_refresh, osd_remove, and osd_db_vg_add functions.
2023-11-09 14:05:15 -05:00
202,
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_OSD_Element, "/storage/ceph/osd/<osdid>")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/osd/<osdid>/state
class API_Storage_Ceph_OSD_State(Resource):
@Authenticator
def get(self, osdid):
"""
Return the current state of OSD {osdid}
---
tags:
- storage / ceph
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: osdid
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
properties:
state:
type: string
description: The current OSD state
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.ceph_osd_state(osdid)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "state",
"choices": ("in", "out"),
"required": True,
"helptext": "A valid state must be specified.",
},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, osdid, reqargs):
"""
Set the current state of OSD {osdid}
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: osdid
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: state
type: string
required: true
description: Set the OSD to this state
responses:
200:
description: OK
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs.get("state", None) == "in":
return api_helper.ceph_osd_in(osdid)
if reqargs.get("state", None) == "out":
return api_helper.ceph_osd_out(osdid)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
abort(400)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_OSD_State, "/storage/ceph/osd/<osdid>/state")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/pool
class API_Storage_Ceph_Pool_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of pools in the cluster
---
tags:
- storage / ceph
definitions:
- schema:
type: object
id: pool
properties:
name:
type: string
description: The name of the pool
Add volume_count to pool API data
2020-12-01 03:39:26 -05:00
volume_count:
type: integer
description: The number of volumes in the pool
Add device class tiers to Ceph pools Allows specifying a particular device class ("tier") for a given pool, for instance SSD-only or NVMe-only. This is implemented with Crush rules on the Ceph side, and via an additional new key in the pool Zookeeper schema which is defaulted to "default".
2021-12-28 20:39:50 -05:00
tier:
type: string
description: The device class/tier of the pool
Add PGs count to pool list
2021-12-28 21:08:04 -05:00
pgs:
type: integer
description: The number of PGs (placement groups) for the pool
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
stats:
type: object
properties:
id:
type: integer
description: The Ceph pool ID
Add additional field and info to Swagger
2021-02-09 01:49:15 -05:00
stored_bytes:
type: integer
description: The stored data size (in bytes, post-replicas)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
free_bytes:
type: integer
Add additional field and info to Swagger
2021-02-09 01:49:15 -05:00
description: The total free space (in bytes. post-replicas)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
used_bytes:
type: integer
Add additional field and info to Swagger
2021-02-09 01:49:15 -05:00
description: The total used space (in bytes, pre-replicas)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
used_percent:
type: number
description: The ratio of used space to free space
num_objects:
type: integer
description: The number of Ceph objects before replication
num_object_clones:
type: integer
description: The total number of cloned Ceph objects
num_object_copies:
type: integer
description: The total number of Ceph objects after replication
num_objects_missing_on_primary:
type: integer
description: The total number of missing-on-primary Ceph objects
num_objects_unfound:
type: integer
description: The total number of unfound Ceph objects
num_objects_degraded:
type: integer
description: The total number of degraded Ceph objects
read_ops:
type: integer
description: The total read operations on the pool (pool-lifetime)
read_bytes:
type: integer
description: The total read bytes on the pool (pool-lifetime)
write_ops:
type: integer
description: The total write operations on the pool (pool-lifetime)
write_bytes:
type: integer
description: The total write bytes on the pool (pool-lifetime)
parameters:
- in: query
name: limit
type: string
required: false
description: A pool name search limit; fuzzy by default, use ^/$ to force exact matches
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/pool'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.ceph_pool_list(reqargs.get("limit", None))
@RequestParser(
[
{
"name": "pool",
"required": True,
"helptext": "A pool name must be specified.",
},
{
"name": "pgs",
"required": True,
"helptext": "A placement group count must be specified.",
},
{
"name": "replcfg",
"required": True,
"helptext": "A valid replication configuration must be specified.",
},
Add device class tiers to Ceph pools Allows specifying a particular device class ("tier") for a given pool, for instance SSD-only or NVMe-only. This is implemented with Crush rules on the Ceph side, and via an additional new key in the pool Zookeeper schema which is defaulted to "default".
2021-12-28 20:39:50 -05:00
{
"name": "tier",
"required": False,
"choices": ("hdd", "ssd", "nvme", "default"),
"helptext": "A valid tier must be specified",
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Create a new Ceph pool
---
tags:
- storage / ceph
parameters:
- in: query
name: pool
type: string
required: true
description: The name of the pool
- in: query
name: pgs
type: integer
required: true
description: The number of placement groups (PGs) for the pool
- in: query
name: replcfg
type: string
required: true
description: The replication configuration (e.g. "copies=3,mincopies=2") for the pool
Add device class tiers to Ceph pools Allows specifying a particular device class ("tier") for a given pool, for instance SSD-only or NVMe-only. This is implemented with Crush rules on the Ceph side, and via an additional new key in the pool Zookeeper schema which is defaulted to "default".
2021-12-28 20:39:50 -05:00
- in: query
name: tier
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: string
Add device class tiers to Ceph pools Allows specifying a particular device class ("tier") for a given pool, for instance SSD-only or NVMe-only. This is implemented with Crush rules on the Ceph side, and via an additional new key in the pool Zookeeper schema which is defaulted to "default".
2021-12-28 20:39:50 -05:00
required: false
description: The device tier for the pool (hdd, ssd, nvme, or default)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_helper.ceph_pool_add(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("pool", None),
reqargs.get("pgs", None),
reqargs.get("replcfg", None),
Add device class tiers to Ceph pools Allows specifying a particular device class ("tier") for a given pool, for instance SSD-only or NVMe-only. This is implemented with Crush rules on the Ceph side, and via an additional new key in the pool Zookeeper schema which is defaulted to "default".
2021-12-28 20:39:50 -05:00
reqargs.get("tier", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_Pool_Root, "/storage/ceph/pool")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/pool/<pool>
class API_Storage_Ceph_Pool_Element(Resource):
@Authenticator
def get(self, pool):
"""
Return information about {pool}
---
tags:
- storage / ceph
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: pool
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/pool'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.ceph_pool_list(pool, is_fuzzy=False)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "pgs",
"required": True,
"helptext": "A placement group count must be specified.",
},
{
"name": "replcfg",
"required": True,
"helptext": "A valid replication configuration must be specified.",
},
Add device class tiers to Ceph pools Allows specifying a particular device class ("tier") for a given pool, for instance SSD-only or NVMe-only. This is implemented with Crush rules on the Ceph side, and via an additional new key in the pool Zookeeper schema which is defaulted to "default".
2021-12-28 20:39:50 -05:00
{
"name": "tier",
"required": False,
"choices": ("hdd", "ssd", "nvme", "default"),
"helptext": "A valid tier must be specified",
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
Lint: F821 undefined name 'reqargs' These were functions that were missing an expected reqargs pass.
2020-11-07 13:28:59 -05:00
def post(self, pool, reqargs):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
"""
Create a new Ceph pool {pool}
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: pool
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: pgs
type: integer
required: true
description: The number of placement groups (PGs) for the pool
- in: query
name: replcfg
type: string
required: true
description: The replication configuration (e.g. "copies=3,mincopies=2") for the pool
Add device class tiers to Ceph pools Allows specifying a particular device class ("tier") for a given pool, for instance SSD-only or NVMe-only. This is implemented with Crush rules on the Ceph side, and via an additional new key in the pool Zookeeper schema which is defaulted to "default".
2021-12-28 20:39:50 -05:00
- in: query
name: tier
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: string
Add device class tiers to Ceph pools Allows specifying a particular device class ("tier") for a given pool, for instance SSD-only or NVMe-only. This is implemented with Crush rules on the Ceph side, and via an additional new key in the pool Zookeeper schema which is defaulted to "default".
2021-12-28 20:39:50 -05:00
required: false
description: The device tier for the pool (hdd, ssd, nvme, or default)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Fix bad calls in pool element
2021-02-17 11:14:50 -05:00
return api_helper.ceph_pool_add(
Add device class tiers to Ceph pools Allows specifying a particular device class ("tier") for a given pool, for instance SSD-only or NVMe-only. This is implemented with Crush rules on the Ceph side, and via an additional new key in the pool Zookeeper schema which is defaulted to "default".
2021-12-28 20:39:50 -05:00
pool,
reqargs.get("pgs", None),
reqargs.get("replcfg", None),
reqargs.get("tier", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Add pool PGs count modification Allows an administrator to adjust the PG count of a given pool. This can be used to increase the PGs (for example after adding more OSDs) or decrease it (to remove OSDs, reduce CPU load, etc.).
2021-12-28 21:41:41 -05:00
@RequestParser(
[
{
"name": "pgs",
"required": True,
"helptext": "A placement group count must be specified.",
},
]
)
@Authenticator
def put(self, pool, reqargs):
"""
Adjust Ceph pool {pool}'s placement group count
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: pool
type: string
required: true
description: Path parameter
Add pool PGs count modification Allows an administrator to adjust the PG count of a given pool. This can be used to increase the PGs (for example after adding more OSDs) or decrease it (to remove OSDs, reduce CPU load, etc.).
2021-12-28 21:41:41 -05:00
- in: query
name: pgs
type: integer
required: true
description: The new number of placement groups (PGs) for the pool
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_helper.ceph_pool_set_pgs(
pool,
reqargs.get("pgs", 0),
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "yes-i-really-mean-it",
"required": True,
"helptext": "Please confirm that 'yes-i-really-mean-it'.",
}
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def delete(self, pool, reqargs):
"""
Remove Ceph pool {pool}
Note: This task may take up to 30s to complete and return
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: pool
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: yes-i-really-mean-it
type: string
required: true
description: A confirmation string to ensure that the API consumer really means it
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.ceph_pool_remove(pool)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_Pool_Element, "/storage/ceph/pool/<pool>")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/volume
class API_Storage_Ceph_Volume_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}, {"name": "pool"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of volumes in the cluster
---
tags:
- storage / ceph
definitions:
- schema:
type: object
id: volume
properties:
name:
type: string
description: The name of the volume
pool:
type: string
description: The name of the pool containing the volume
stats:
type: object
properties:
name:
type: string
description: The name of the volume
id:
type: string
description: The Ceph volume ID
size:
type: string
description: The size of the volume (human-readable values)
objects:
type: integer
description: The number of Ceph objects making up the volume
order:
type: integer
description: The Ceph volume order ID
object_size:
type: integer
description: The size of each object in bytes
snapshot_count:
type: integer
description: The number of snapshots of the volume
block_name_prefix:
type: string
description: The Ceph-internal block name prefix
format:
type: integer
description: The Ceph RBD volume format
features:
type: array
items:
type: string
description: The Ceph RBD feature
op_features:
type: array
items:
type: string
description: The Ceph RBD operational features
flags:
type: array
items:
type: string
description: The Ceph RBD volume flags
create_timestamp:
type: string
description: The volume creation timestamp
access_timestamp:
type: string
description: The volume access timestamp
modify_timestamp:
type: string
description: The volume modification timestamp
parameters:
- in: query
name: limit
type: string
required: false
description: A volume name search limit; fuzzy by default, use ^/$ to force exact matches
- in: query
name: pool
type: string
required: false
description: A pool to limit the search to
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/volume'
"""
return api_helper.ceph_volume_list(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("pool", None), reqargs.get("limit", None)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "volume",
"required": True,
"helptext": "A volume name must be specified.",
},
{
"name": "pool",
"required": True,
"helptext": "A valid pool name must be specified.",
},
{
"name": "size",
"required": True,
Adjust wording for volume create too
2023-10-03 09:42:23 -04:00
"helptext": "A volume size in bytes (B implied or with SI suffix k/M/G/T) must be specified.",
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
},
Add safety check for 80% full size Adds a check that a volume creation or resize won't violate the 80% full rule for the storage cluster. This ensures a cluster won't get too full if a storage volume fills up. Also adds a force flag throughout the pipeline to override this check, should an administrator really want to do so. Closes #177
2024-02-02 10:13:46 -05:00
{
"name": "force",
"required": False,
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Create a new Ceph volume
---
tags:
- storage / ceph
parameters:
- in: query
name: volume
type: string
required: true
description: The name of the volume
- in: query
name: pool
type: integer
required: true
description: The name of the pool to contain the volume
- in: query
name: size
type: string
required: true
Adjust wording for volume create too
2023-10-03 09:42:23 -04:00
description: The volume size, in bytes (B implied) or with a single-character SI suffix (k/M/G/T)
Add safety check for 80% full size Adds a check that a volume creation or resize won't violate the 80% full rule for the storage cluster. This ensures a cluster won't get too full if a storage volume fills up. Also adds a force flag throughout the pipeline to override this check, should an administrator really want to do so. Closes #177
2024-02-02 10:13:46 -05:00
- in: query
name: force
type: boolean
required: false
Fix incorrect default value typos
2024-09-13 11:09:00 -04:00
default: false
Add safety check for 80% full size Adds a check that a volume creation or resize won't violate the 80% full rule for the storage cluster. This ensures a cluster won't get too full if a storage volume fills up. Also adds a force flag throughout the pipeline to override this check, should an administrator really want to do so. Closes #177
2024-02-02 10:13:46 -05:00
description: Force action if volume creation would violate 80% full soft cap on the pool
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_helper.ceph_volume_add(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("pool", None),
reqargs.get("volume", None),
reqargs.get("size", None),
Fix bug where force_flag is a string
2024-08-20 10:10:33 -04:00
bool(strtobool(reqargs.get("force", "False"))),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_Volume_Root, "/storage/ceph/volume")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/volume/<pool>/<volume>
class API_Storage_Ceph_Volume_Element(Resource):
@Authenticator
def get(self, pool, volume):
"""
Return information about volume {volume} in pool {pool}
---
tags:
- storage / ceph
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: pool
type: string
required: true
description: Path parameter
- in: path
name: volume
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/volume'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.ceph_volume_list(pool, volume, is_fuzzy=False)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "size",
"required": True,
"helptext": "A volume size in bytes (or with k/M/G/T suffix) must be specified.",
Add safety check for 80% full size Adds a check that a volume creation or resize won't violate the 80% full rule for the storage cluster. This ensures a cluster won't get too full if a storage volume fills up. Also adds a force flag throughout the pipeline to override this check, should an administrator really want to do so. Closes #177
2024-02-02 10:13:46 -05:00
},
{
"name": "force",
"required": False,
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, pool, volume, reqargs):
"""
Create a new Ceph volume {volume} in pool {pool}
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: pool
type: string
required: true
description: Path parameter
- in: path
name: volume
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: size
type: string
required: true
description: The volume size in bytes (or with a metric suffix, i.e. k/M/G/T)
Add safety check for 80% full size Adds a check that a volume creation or resize won't violate the 80% full rule for the storage cluster. This ensures a cluster won't get too full if a storage volume fills up. Also adds a force flag throughout the pipeline to override this check, should an administrator really want to do so. Closes #177
2024-02-02 10:13:46 -05:00
- in: query
name: force
type: boolean
required: false
Fix incorrect default value typos
2024-09-13 11:09:00 -04:00
default: false
Add safety check for 80% full size Adds a check that a volume creation or resize won't violate the 80% full rule for the storage cluster. This ensures a cluster won't get too full if a storage volume fills up. Also adds a force flag throughout the pipeline to override this check, should an administrator really want to do so. Closes #177
2024-02-02 10:13:46 -05:00
description: Force action if volume creation would violate 80% full soft cap on the pool
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Add safety check for 80% full size Adds a check that a volume creation or resize won't violate the 80% full rule for the storage cluster. This ensures a cluster won't get too full if a storage volume fills up. Also adds a force flag throughout the pipeline to override this check, should an administrator really want to do so. Closes #177
2024-02-02 10:13:46 -05:00
return api_helper.ceph_volume_add(
pool, volume, reqargs.get("size", None), reqargs.get("force", False)
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Add safety check for 80% full size Adds a check that a volume creation or resize won't violate the 80% full rule for the storage cluster. This ensures a cluster won't get too full if a storage volume fills up. Also adds a force flag throughout the pipeline to override this check, should an administrator really want to do so. Closes #177
2024-02-02 10:13:46 -05:00
@RequestParser(
[
{"name": "new_size"},
{"name": "new_name"},
{"name": "force", "required": False},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def put(self, pool, volume, reqargs):
"""
Update the size or name of Ceph volume {volume} in pool {pool}
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: pool
type: string
required: true
description: Path parameter
- in: path
name: volume
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
Fix bug in API specification
2024-09-30 20:51:49 -04:00
name: new_size
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
type: string
required: false
description: The new volume size in bytes (or with a metric suffix, i.e. k/M/G/T); must be greater than the previous size (shrinking not supported)
- in: query
name: new_name
type: string
required: false
description: The new volume name
Add safety check for 80% full size Adds a check that a volume creation or resize won't violate the 80% full rule for the storage cluster. This ensures a cluster won't get too full if a storage volume fills up. Also adds a force flag throughout the pipeline to override this check, should an administrator really want to do so. Closes #177
2024-02-02 10:13:46 -05:00
- in: query
name: force
type: boolean
required: false
Fix incorrect default value typos
2024-09-13 11:09:00 -04:00
default: false
Add safety check for 80% full size Adds a check that a volume creation or resize won't violate the 80% full rule for the storage cluster. This ensures a cluster won't get too full if a storage volume fills up. Also adds a force flag throughout the pipeline to override this check, should an administrator really want to do so. Closes #177
2024-02-02 10:13:46 -05:00
description: Force action if new volume size would violate 80% full soft cap on the pool
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs.get("new_size", None) and reqargs.get("new_name", None):
Lint: E202 whitespace before '}'
2020-11-07 12:57:42 -05:00
return {"message": "Can only perform one modification at once"}, 400
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs.get("new_size", None):
Add safety check for 80% full size Adds a check that a volume creation or resize won't violate the 80% full rule for the storage cluster. This ensures a cluster won't get too full if a storage volume fills up. Also adds a force flag throughout the pipeline to override this check, should an administrator really want to do so. Closes #177
2024-02-02 10:13:46 -05:00
return api_helper.ceph_volume_resize(
pool, volume, reqargs.get("new_size"), reqargs.get("force", False)
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs.get("new_name", None):
return api_helper.ceph_volume_rename(pool, volume, reqargs.get("new_name"))
Lint: E202 whitespace before '}'
2020-11-07 12:57:42 -05:00
return {"message": "At least one modification must be specified"}, 400
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def delete(self, pool, volume):
"""
Remove Ceph volume {volume} from pool {pool}
Note: This task may take up to 30s to complete and return depending on the size of the volume
---
tags:
- storage / ceph
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: pool
type: string
required: true
description: Path parameter
- in: path
name: volume
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.ceph_volume_remove(pool, volume)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(
API_Storage_Ceph_Volume_Element, "/storage/ceph/volume/<pool>/<volume>"
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Add dedicated volume scan endpoint Allows an imported volume to be scanned for stats independently. Designed to be used as part of a snapshot import via API, to allow the "create" to happen before the real import (to check for available space, etc.) and then run this import after when the RBD volume actually exists.
2024-09-03 20:30:18 -04:00
# /storage/ceph/volume/<pool>/<volume>/scan
class API_Storage_Ceph_Volume_Element_Scan(Resource):
@Authenticator
def post(self, pool, volume):
"""
Scan a Ceph volume {volume} in pool {pool} for stats (after import)
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: pool
type: string
required: true
description: Path parameter
- in: path
name: volume
type: string
required: true
description: Path parameter
Add dedicated volume scan endpoint Allows an imported volume to be scanned for stats independently. Designed to be used as part of a snapshot import via API, to allow the "create" to happen before the real import (to check for available space, etc.) and then run this import after when the RBD volume actually exists.
2024-09-03 20:30:18 -04:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_helper.ceph_volume_scan(pool, volume)
api.add_resource(
API_Storage_Ceph_Volume_Element_Scan, "/storage/ceph/volume/<pool>/<volume>/scan"
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/volume/<pool>/<volume>/clone
class API_Storage_Ceph_Volume_Element_Clone(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "new_volume",
"required": True,
"helptext": "A new volume name must be specified.",
Add size validations for volume clones Adds the same validations as a volume add or resize to volume clones, to ensure there is enough free space for them.
2024-02-02 10:29:34 -05:00
},
{
"name": "force",
"required": False,
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, pool, volume, reqargs):
"""
Clone Ceph volume {volume} in pool {pool}
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: pool
type: string
required: true
description: Path parameter
- in: path
name: volume
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: new_volume
type: string
required: true
description: The name of the new cloned volume
Add size validations for volume clones Adds the same validations as a volume add or resize to volume clones, to ensure there is enough free space for them.
2024-02-02 10:29:34 -05:00
- in: query
name: force
type: boolean
required: false
Fix incorrect default value typos
2024-09-13 11:09:00 -04:00
default: false
Add size validations for volume clones Adds the same validations as a volume add or resize to volume clones, to ensure there is enough free space for them.
2024-02-02 10:29:34 -05:00
description: Force action if clone volume size would violate 80% full soft cap on the pool
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_helper.ceph_volume_clone(
Add size validations for volume clones Adds the same validations as a volume add or resize to volume clones, to ensure there is enough free space for them.
2024-02-02 10:29:34 -05:00
pool, reqargs.get("new_volume", None), volume, reqargs.get("force", None)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(
API_Storage_Ceph_Volume_Element_Clone, "/storage/ceph/volume/<pool>/<volume>/clone"
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Support uploading disk images to volumes in API Addresses #68
2020-02-09 13:43:48 -05:00
# /storage/ceph/volume/<pool>/<volume>/upload
class API_Storage_Ceph_Volume_Element_Upload(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "image_format",
"required": True,
"location": ["args"],
"helptext": "A source image format must be specified.",
Fix uploading of non-raw image files Adds a new API query parameter to define the file size, which is then used for the temporary image. This is required for, at least VMDK, files to work properly in qemu-img convert.
2023-09-29 16:13:08 -04:00
},
{
"name": "file_size",
"required": False,
"location": ["args"],
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Support uploading disk images to volumes in API Addresses #68
2020-02-09 13:43:48 -05:00
@Authenticator
Support converting types during upload Allow the user to specify other, non-raw files and upload them, performing a conversion with qemu-img convert and a temporary block device as a shim (since qemu-img can't use FIFOs). Also ensures that the target volume exists before proceeding. Addresses #68
2020-02-09 19:43:07 -05:00
def post(self, pool, volume, reqargs):
Support uploading disk images to volumes in API Addresses #68
2020-02-09 13:43:48 -05:00
"""
Upload a disk image to Ceph volume {volume} in pool {pool}
Just describe the body in words
2020-02-09 21:08:27 -05:00
The body must be a form body containing a file that is the binary contents of the image.
Support uploading disk images to volumes in API Addresses #68
2020-02-09 13:43:48 -05:00
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: pool
type: string
required: true
description: Path parameter
- in: path
name: volume
type: string
required: true
description: Path parameter
Support uploading disk images to volumes in API Addresses #68
2020-02-09 13:43:48 -05:00
- in: query
Support converting types during upload Allow the user to specify other, non-raw files and upload them, performing a conversion with qemu-img convert and a temporary block device as a shim (since qemu-img can't use FIFOs). Also ensures that the target volume exists before proceeding. Addresses #68
2020-02-09 19:43:07 -05:00
name: image_format
type: string
required: true
description: The type of source image file
enum:
- raw
- vmdk
- qcow2
- qed
- vdi
- vpc
Fix uploading of non-raw image files Adds a new API query parameter to define the file size, which is then used for the temporary image. This is required for, at least VMDK, files to work properly in qemu-img convert.
2023-09-29 16:13:08 -04:00
- in: query
name: file_size
type: integer
required: false
Mention file_size as bytes
2023-10-03 09:39:19 -04:00
description: The size of the image file, in bytes, if {image_format} is not "raw"
Support uploading disk images to volumes in API Addresses #68
2020-02-09 13:43:48 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_helper.ceph_volume_upload(
Fix uploading of non-raw image files Adds a new API query parameter to define the file size, which is then used for the temporary image. This is required for, at least VMDK, files to work properly in qemu-img convert.
2023-09-29 16:13:08 -04:00
pool,
volume,
reqargs.get("image_format", None),
reqargs.get("file_size", None),
Support uploading disk images to volumes in API Addresses #68
2020-02-09 13:43:48 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(
API_Storage_Ceph_Volume_Element_Upload,
"/storage/ceph/volume/<pool>/<volume>/upload",
)
Support uploading disk images to volumes in API Addresses #68
2020-02-09 13:43:48 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/snapshot
class API_Storage_Ceph_Snapshot_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "pool"},
{"name": "volume"},
{"name": "limit"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of snapshots in the cluster
---
tags:
- storage / ceph
definitions:
- schema:
type: object
id: snapshot
properties:
snapshot:
type: string
description: The name of the snapshot
volume:
type: string
description: The name of the volume
pool:
type: string
description: The name of the pool
parameters:
- in: query
name: limit
type: string
required: false
description: A volume name search limit; fuzzy by default, use ^/$ to force exact matches
- in: query
name: pool
type: string
required: false
description: A pool to limit the search to
- in: query
name: volume
type: string
required: false
description: A volume to limit the search to
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/snapshot'
"""
return api_helper.ceph_volume_snapshot_list(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("pool", None),
reqargs.get("volume", None),
reqargs.get("limit", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "snapshot",
"required": True,
"helptext": "A snapshot name must be specified.",
},
{
"name": "volume",
"required": True,
"helptext": "A volume name must be specified.",
},
{
"name": "pool",
"required": True,
"helptext": "A pool name must be specified.",
},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Create a new Ceph snapshot
---
tags:
- storage / ceph
parameters:
- in: query
name: snapshot
type: string
required: true
description: The name of the snapshot
- in: query
name: volume
type: string
required: true
description: The name of the volume
- in: query
name: pool
type: integer
required: true
description: The name of the pool
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_helper.ceph_volume_snapshot_add(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("pool", None),
reqargs.get("volume", None),
reqargs.get("snapshot", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Storage_Ceph_Snapshot_Root, "/storage/ceph/snapshot")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /storage/ceph/snapshot/<pool>/<volume>/<snapshot>
class API_Storage_Ceph_Snapshot_Element(Resource):
@Authenticator
def get(self, pool, volume, snapshot):
"""
Return information about snapshot {snapshot} of volume {volume} in pool {pool}
---
tags:
- storage / ceph
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: pool
type: string
required: true
description: Path parameter
- in: path
name: volume
type: string
required: true
description: Path parameter
- in: path
name: snapshot
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/snapshot'
404:
description: Not found
schema:
type: object
id: Message
"""
return api_helper.ceph_volume_snapshot_list(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
pool, volume, snapshot, is_fuzzy=False
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
@Authenticator
def post(self, pool, volume, snapshot):
"""
Create a new Ceph snapshot {snapshot} of volume {volume} in pool {pool}
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: pool
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
type: string
required: true
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
description: Path parameter
- in: path
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
name: volume
type: string
required: true
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
description: Path parameter
- in: path
name: snapshot
type: string
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
required: true
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.ceph_volume_snapshot_add(pool, volume, snapshot)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "new_name",
"required": True,
"helptext": "A new name must be specified.",
}
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def put(self, pool, volume, snapshot, reqargs):
"""
Update the name of Ceph snapshot {snapshot} of volume {volume} in pool {pool}
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: pool
type: string
required: true
description: Path parameter
- in: path
name: volume
type: string
required: true
description: Path parameter
- in: path
name: snapshot
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: new_name
type: string
required: false
description: The new snaoshot name
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_helper.ceph_volume_snapshot_rename(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
pool, volume, snapshot, reqargs.get("new_name", None)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
@Authenticator
def delete(self, pool, volume, snapshot):
"""
Remove Ceph snapshot {snapshot} of volume {volume} from pool {pool}
Note: This task may take up to 30s to complete and return depending on the size of the snapshot
---
tags:
- storage / ceph
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: pool
type: string
required: true
description: Path parameter
- in: path
name: volume
type: string
required: true
description: Path parameter
- in: path
name: snapshot
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_helper.ceph_volume_snapshot_remove(pool, volume, snapshot)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(
API_Storage_Ceph_Snapshot_Element,
"/storage/ceph/snapshot/<pool>/<volume>/<snapshot>",
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Add support for rolling back snapshots We supported creating snapshots, but not doing anything with them. This removes the manual task of restoring a snapshot and replace it with a PVC abstraction of rolling back to a snapshot. While Ceph recommends cloning a snapshot instead of rolling back, due to the time taken, in our usecase I don't think that is an optimal strategy, as it will leave dangling clones that we'd then have to manage. Closes #183
2024-05-13 15:22:03 -04:00
# /storage/ceph/snapshot/<pool>/<volume>/<snapshot>/rollback
class API_Storage_Ceph_Snapshot_Rollback_Element(Resource):
@Authenticator
def post(self, pool, volume, snapshot):
"""
Roll back an RBD volume {volume} in pool {pool} to snapshot {snapshot}
WARNING: This action cannot be done on an active RBD volume. All IO MUST be stopped first.
---
tags:
- storage / ceph
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: pool
Add support for rolling back snapshots We supported creating snapshots, but not doing anything with them. This removes the manual task of restoring a snapshot and replace it with a PVC abstraction of rolling back to a snapshot. While Ceph recommends cloning a snapshot instead of rolling back, due to the time taken, in our usecase I don't think that is an optimal strategy, as it will leave dangling clones that we'd then have to manage. Closes #183
2024-05-13 15:22:03 -04:00
type: string
required: true
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
description: Path parameter
- in: path
Add support for rolling back snapshots We supported creating snapshots, but not doing anything with them. This removes the manual task of restoring a snapshot and replace it with a PVC abstraction of rolling back to a snapshot. While Ceph recommends cloning a snapshot instead of rolling back, due to the time taken, in our usecase I don't think that is an optimal strategy, as it will leave dangling clones that we'd then have to manage. Closes #183
2024-05-13 15:22:03 -04:00
name: volume
type: string
required: true
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
description: Path parameter
- in: path
name: snapshot
type: string
Add support for rolling back snapshots We supported creating snapshots, but not doing anything with them. This removes the manual task of restoring a snapshot and replace it with a PVC abstraction of rolling back to a snapshot. While Ceph recommends cloning a snapshot instead of rolling back, due to the time taken, in our usecase I don't think that is an optimal strategy, as it will leave dangling clones that we'd then have to manage. Closes #183
2024-05-13 15:22:03 -04:00
required: true
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
description: Path parameter
Add support for rolling back snapshots We supported creating snapshots, but not doing anything with them. This removes the manual task of restoring a snapshot and replace it with a PVC abstraction of rolling back to a snapshot. While Ceph recommends cloning a snapshot instead of rolling back, due to the time taken, in our usecase I don't think that is an optimal strategy, as it will leave dangling clones that we'd then have to manage. Closes #183
2024-05-13 15:22:03 -04:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_helper.ceph_volume_snapshot_rollback(pool, volume, snapshot)
api.add_resource(
API_Storage_Ceph_Snapshot_Rollback_Element,
"/storage/ceph/snapshot/<pool>/<volume>/<snapshot>/rollback",
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
##########################################################
# Provisioner API
##########################################################
Format based on updated Black
2023-09-12 16:41:02 -04:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner
class API_Provisioner_Root(Resource):
@Authenticator
def get(self):
"""
Unused endpoint
"""
abort(404)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_Root, "/provisioner")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/template
class API_Provisioner_Template_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of all templates
---
tags:
- provisioner / template
definitions:
- schema:
type: object
id: all-templates
properties:
system-templates:
type: array
items:
$ref: '#/definitions/system-template'
network-templates:
type: array
items:
$ref: '#/definitions/network-template'
storage-templates:
type: array
items:
$ref: '#/definitions/storage-template'
parameters:
- in: query
name: limit
type: string
required: false
description: A template name search limit; fuzzy by default, use ^/$ to force exact matches
responses:
200:
description: OK
schema:
$ref: '#/definitions/all-templates'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.template_list(reqargs.get("limit", None))
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_Template_Root, "/provisioner/template")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/template/system
class API_Provisioner_Template_System_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of system templates
---
tags:
- provisioner / template
definitions:
- schema:
type: object
id: system-template
properties:
id:
type: integer
description: Internal provisioner template ID
name:
type: string
description: Template name
vcpu_count:
type: integer
description: vCPU count for VM
vram_mb:
type: integer
description: vRAM size in MB for VM
serial:
type: boolean
description: Whether to enable serial console for VM
vnc:
type: boolean
description: Whether to enable VNC console for VM
vnc_bind:
type: string
description: VNC bind address when VNC console is enabled
node_limit:
type: string
description: CSV list of node(s) to limit VM assignment to
node_selector:
type: string
description: Selector to use for VM node assignment on migration/move
node_autostart:
type: boolean
description: Whether to start VM with node ready state (one-time)
Support per-VM migration type selectors Allow a VM to specify its migration type as a default choice. The valid options are "default" (i.e. behave as now), "live" which forces a live migration only, and "shutdown" which forces a shutdown migration only. The new option is treated as a VM meta option and is set to default if not found.
2020-10-29 11:31:32 -04:00
migration_method:
type: string
description: The preferred migration method (live, shutdown, none)
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
migration_max_downtime:
type: integer
description: The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
parameters:
- in: query
name: limit
type: string
required: false
description: A template name search limit; fuzzy by default, use ^/$ to force exact matches
responses:
200:
description: OK
schema:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: array
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
items:
$ref: '#/definitions/system-template'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.list_template_system(reqargs.get("limit", None))
@RequestParser(
[
{"name": "name", "required": True, "helptext": "A name must be specified."},
{
"name": "vcpus",
"required": True,
"helptext": "A vcpus value must be specified.",
},
{
"name": "vram",
"required": True,
"helptext": "A vram value in MB must be specified.",
},
{
"name": "serial",
"required": True,
"helptext": "A serial value must be specified.",
},
{
"name": "vnc",
"required": True,
"helptext": "A vnc value must be specified.",
},
{"name": "vnc_bind"},
{"name": "node_limit"},
{"name": "node_selector"},
{"name": "node_autostart"},
{"name": "migration_method"},
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
{"name": "migration_max_downtime"},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Create a new system template
---
tags:
- provisioner / template
parameters:
- in: query
name: name
type: string
required: true
description: Template name
- in: query
name: vcpus
type: integer
required: true
description: vCPU count for VM
- in: query
name: vram
type: integer
required: true
description: vRAM size in MB for VM
- in: query
name: serial
type: boolean
required: true
description: Whether to enable serial console for VM
- in: query
name: vnc
type: boolean
required: true
description: Whether to enable VNC console for VM
- in: query
name: vnc_bind
type: string
required: false
description: VNC bind address when VNC console is enabled
- in: query
name: node_limit
type: string
required: false
description: CSV list of node(s) to limit VM assignment to
- in: query
name: node_selector
type: string
required: false
description: Selector to use for VM node assignment on migration/move
- in: query
name: node_autostart
type: boolean
required: false
description: Whether to start VM with node ready state (one-time)
Support per-VM migration type selectors Allow a VM to specify its migration type as a default choice. The valid options are "default" (i.e. behave as now), "live" which forces a live migration only, and "shutdown" which forces a shutdown migration only. The new option is treated as a VM meta option and is set to default if not found.
2020-10-29 11:31:32 -04:00
- in: query
name: migration_method
type: string
required: false
description: The preferred migration method (live, shutdown, none)
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
- in: query
name: migration_max_downtime
type: integer
required: false
description: The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
# Validate arguments
try:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
vcpus = int(reqargs.get("vcpus"))
Lint: E722 do not use bare 'except'
2020-11-06 18:55:10 -05:00
except Exception:
Lint: E202 whitespace before '}'
2020-11-07 12:57:42 -05:00
return {"message": "A vcpus value must be an integer"}, 400
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
try:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
vram = int(reqargs.get("vram"))
Lint: E722 do not use bare 'except'
2020-11-06 18:55:10 -05:00
except Exception:
Lint: E202 whitespace before '}'
2020-11-07 12:57:42 -05:00
return {"message": "A vram value must be an integer"}, 400
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# Cast boolean arguments
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if bool(strtobool(reqargs.get("serial", "false"))):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
serial = True
else:
serial = False
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if bool(strtobool(reqargs.get("vnc", "false"))):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
vnc = True
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
vnc_bind = reqargs.get("vnc_bind", None)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
else:
vnc = False
vnc_bind = None
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs.get("node_autostart", None) and bool(
strtobool(reqargs.get("node_autostart", "false"))
):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
node_autostart = True
else:
node_autostart = False
return api_provisioner.create_template_system(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("name"),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
vcpus,
vram,
serial,
vnc,
vnc_bind,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("node_limit", None),
reqargs.get("node_selector", None),
Support per-VM migration type selectors Allow a VM to specify its migration type as a default choice. The valid options are "default" (i.e. behave as now), "live" which forces a live migration only, and "shutdown" which forces a shutdown migration only. The new option is treated as a VM meta option and is set to default if not found.
2020-10-29 11:31:32 -04:00
node_autostart,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("migration_method", None),
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
reqargs.get("migration_max_downtime", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_Template_System_Root, "/provisioner/template/system")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/template/system/<template>
class API_Provisioner_Template_System_Element(Resource):
@Authenticator
def get(self, template):
"""
Return information about system template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/system-template'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.list_template_system(template, is_fuzzy=False)
@RequestParser(
[
{
"name": "vcpus",
"required": True,
"helptext": "A vcpus value must be specified.",
},
{
"name": "vram",
"required": True,
"helptext": "A vram value in MB must be specified.",
},
{
"name": "serial",
"required": True,
"helptext": "A serial value must be specified.",
},
{
"name": "vnc",
"required": True,
"helptext": "A vnc value must be specified.",
},
{"name": "vnc_bind"},
{"name": "node_limit"},
{"name": "node_selector"},
{"name": "node_autostart"},
{"name": "migration_method"},
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
{"name": "migration_max_downtime"},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, template, reqargs):
"""
Create a new system template {template}
---
tags:
- provisioner / template
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: vcpus
type: integer
required: true
description: vCPU count for VM
- in: query
name: vram
type: integer
required: true
description: vRAM size in MB for VM
- in: query
name: serial
type: boolean
required: true
description: Whether to enable serial console for VM
- in: query
name: vnc
type: boolean
required: true
description: Whether to enable VNC console for VM
- in: query
name: vnc_bind
type: string
required: false
description: VNC bind address when VNC console is enabled
- in: query
name: node_limit
type: string
required: false
description: CSV list of node(s) to limit VM assignment to
- in: query
name: node_selector
type: string
required: false
description: Selector to use for VM node assignment on migration/move
- in: query
name: node_autostart
type: boolean
required: false
description: Whether to start VM with node ready state (one-time)
Support per-VM migration type selectors Allow a VM to specify its migration type as a default choice. The valid options are "default" (i.e. behave as now), "live" which forces a live migration only, and "shutdown" which forces a shutdown migration only. The new option is treated as a VM meta option and is set to default if not found.
2020-10-29 11:31:32 -04:00
- in: query
name: migration_method
type: string
required: false
description: The preferred migration method (live, shutdown, none)
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
- in: query
name: migration_max_downtime
type: integer
required: false
description: The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
# Validate arguments
try:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
vcpus = int(reqargs.get("vcpus"))
Lint: E722 do not use bare 'except'
2020-11-06 18:55:10 -05:00
except Exception:
Lint: E202 whitespace before '}'
2020-11-07 12:57:42 -05:00
return {"message": "A vcpus value must be an integer"}, 400
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
try:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
vram = int(reqargs.get("vram"))
Lint: E722 do not use bare 'except'
2020-11-06 18:55:10 -05:00
except Exception:
Lint: E202 whitespace before '}'
2020-11-07 12:57:42 -05:00
return {"message": "A vram value must be an integer"}, 400
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# Cast boolean arguments
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if bool(strtobool(reqargs.get("serial", False))):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
serial = True
else:
serial = False
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if bool(strtobool(reqargs.get("vnc", False))):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
vnc = True
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
vnc_bind = reqargs.get("vnc_bind", None)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
else:
vnc = False
vnc_bind = None
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if reqargs.get("node_autostart", None) and bool(
strtobool(reqargs.get("node_autostart", False))
):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
node_autostart = True
else:
node_autostart = False
return api_provisioner.create_template_system(
template,
vcpus,
vram,
serial,
vnc,
vnc_bind,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("node_limit", None),
reqargs.get("node_selector", None),
Support per-VM migration type selectors Allow a VM to specify its migration type as a default choice. The valid options are "default" (i.e. behave as now), "live" which forces a live migration only, and "shutdown" which forces a shutdown migration only. The new option is treated as a VM meta option and is set to default if not found.
2020-10-29 11:31:32 -04:00
node_autostart,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("migration_method", None),
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
reqargs.get("migration_max_downtime", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "vcpus"},
{"name": "vram"},
{"name": "serial"},
{"name": "vnc"},
{"name": "vnc_bind"},
{"name": "node_limit"},
{"name": "node_selector"},
{"name": "node_autostart"},
{"name": "migration_method"},
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
{"name": "migration_max_downtime"},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
Allow modification of system templates Closes #82
2020-02-18 16:18:27 -05:00
def put(self, template, reqargs):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
"""
Allow modification of system templates Closes #82
2020-02-18 16:18:27 -05:00
Modify an existing system template {template}
---
tags:
- provisioner / template
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: template
type: string
required: true
description: Path parameter
Allow modification of system templates Closes #82
2020-02-18 16:18:27 -05:00
- in: query
name: vcpus
type: integer
description: vCPU count for VM
- in: query
name: vram
type: integer
description: vRAM size in MB for VM
- in: query
name: serial
type: boolean
description: Whether to enable serial console for VM
- in: query
name: vnc
type: boolean
description: Whether to enable VNC console for VM
- in: query
name: vnc_bind
type: string
description: VNC bind address when VNC console is enabled
- in: query
name: node_limit
type: string
description: CSV list of node(s) to limit VM assignment to
- in: query
name: node_selector
type: string
description: Selector to use for VM node assignment on migration/move
- in: query
name: node_autostart
type: boolean
description: Whether to start VM with node ready state (one-time)
Support per-VM migration type selectors Allow a VM to specify its migration type as a default choice. The valid options are "default" (i.e. behave as now), "live" which forces a live migration only, and "shutdown" which forces a shutdown migration only. The new option is treated as a VM meta option and is set to default if not found.
2020-10-29 11:31:32 -04:00
- in: query
name: migration_method
type: string
description: The preferred migration method (live, shutdown, none)
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
- in: query
name: migration_max_downtime
type: integer
description: The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime
Allow modification of system templates Closes #82
2020-02-18 16:18:27 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
"""
Allow modification of system templates Closes #82
2020-02-18 16:18:27 -05:00
return api_provisioner.modify_template_system(
template,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("vcpus", None),
reqargs.get("vram", None),
reqargs.get("serial", None),
reqargs.get("vnc", None),
reqargs.get("vnc_bind"),
reqargs.get("node_limit", None),
reqargs.get("node_selector", None),
reqargs.get("node_autostart", None),
reqargs.get("migration_method", None),
Add live migrate max downtime selector meta field Adds a new flag to VM metadata to allow setting the VM live migration max downtime. This will enable very busy VMs that hang live migration to have this value changed.
2024-01-10 16:13:31 -05:00
reqargs.get("migration_max_downtime", None),
Allow modification of system templates Closes #82
2020-02-18 16:18:27 -05:00
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def delete(self, template):
"""
Remove system template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.delete_template_system(template)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(
API_Provisioner_Template_System_Element, "/provisioner/template/system/<template>"
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/template/network
class API_Provisioner_Template_Network_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of network templates
---
tags:
- provisioner / template
definitions:
- schema:
type: object
id: network-template-net
properties:
id:
type: integer
description: Internal provisioner template ID
network_template:
type: integer
description: Internal provisioner network template ID
vni:
type: integer
description: PVC network VNI
- schema:
type: object
id: network-template
properties:
id:
type: integer
description: Internal provisioner template ID
name:
type: string
description: Template name
mac_template:
type: string
description: MAC address template for VM
networks:
type: array
items:
$ref: '#/definitions/network-template-net'
parameters:
- in: query
name: limit
type: string
required: false
description: A template name search limit; fuzzy by default, use ^/$ to force exact matches
responses:
200:
description: OK
schema:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: array
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
items:
$ref: '#/definitions/network-template'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.list_template_network(reqargs.get("limit", None))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "name",
"required": True,
"helptext": "A template name must be specified.",
},
{"name": "mac_template"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Create a new network template
---
tags:
- provisioner / template
parameters:
- in: query
name: name
type: string
required: true
description: Template name
- in: query
name: mac_template
type: string
required: false
description: MAC address template
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_provisioner.create_template_network(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("name", None), reqargs.get("mac_template", None)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_Template_Network_Root, "/provisioner/template/network")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/template/network/<template>
class API_Provisioner_Template_Network_Element(Resource):
@Authenticator
def get(self, template):
"""
Return information about network template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/network-template'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.list_template_network(template, is_fuzzy=False)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "mac_template"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, template, reqargs):
"""
Create a new network template {template}
---
tags:
- provisioner / template
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: mac_template
type: string
required: false
description: MAC address template
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_provisioner.create_template_network(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
template, reqargs.get("mac_template", None)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
@Authenticator
def delete(self, template):
"""
Remove network template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.delete_template_network(template)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(
API_Provisioner_Template_Network_Element, "/provisioner/template/network/<template>"
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/template/network/<template>/net
class API_Provisioner_Template_Network_Net_Root(Resource):
@Authenticator
def get(self, template):
"""
Return a list of networks in network template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: array
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
items:
$ref: '#/definitions/network-template-net'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
templates = api_provisioner.list_template_network(template, is_fuzzy=False)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
if templates:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return templates["networks"]
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
else:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return {"message": "Template not found."}, 404
@RequestParser(
[
{
"name": "vni",
"required": True,
"helptext": "A valid VNI must be specified.",
Permit duplicate VNIs in templates with flag Supports niche usecases whereby a network template should contain the same VNI(s) more than once.
2024-02-09 12:12:04 -05:00
},
{
"name": "permit_duplicate",
"required": False,
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
Lint: F821 undefined name 'template'
2020-11-07 13:30:32 -05:00
def post(self, template, reqargs):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
"""
Create a new network in network template {template}
---
tags:
- provisioner / template
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: vni
type: integer
required: false
description: PVC network VNI
Permit duplicate VNIs in templates with flag Supports niche usecases whereby a network template should contain the same VNI(s) more than once.
2024-02-09 12:12:04 -05:00
- in: query
name: permit_duplicate
type: boolean
required: false
description: Bypass checks to permit duplicate VNIs for niche usecases
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_provisioner.create_template_network_element(
Permit duplicate VNIs in templates with flag Supports niche usecases whereby a network template should contain the same VNI(s) more than once.
2024-02-09 12:12:04 -05:00
template, reqargs.get("vni", None), reqargs.get("permit_duplicate", False)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(
API_Provisioner_Template_Network_Net_Root,
"/provisioner/template/network/<template>/net",
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/template/network/<template>/net/<vni>
class API_Provisioner_Template_Network_Net_Element(Resource):
@Authenticator
def get(self, template, vni):
"""
Return information about network {vni} in network template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
- in: path
name: vni
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/network-template-net'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
vni_list = api_provisioner.list_template_network(template, is_fuzzy=False)[
"networks"
]
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
for _vni in vni_list:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if int(_vni["vni"]) == int(vni):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return _vni, 200
abort(404)
Permit duplicate VNIs in templates with flag Supports niche usecases whereby a network template should contain the same VNI(s) more than once.
2024-02-09 12:12:04 -05:00
@RequestParser(
[
{
"name": "permit_duplicate",
"required": False,
}
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
Permit duplicate VNIs in templates with flag Supports niche usecases whereby a network template should contain the same VNI(s) more than once.
2024-02-09 12:12:04 -05:00
def post(self, template, vni, reqargs):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
"""
Create a new network {vni} in network template {template}
---
tags:
- provisioner / template
Permit duplicate VNIs in templates with flag Supports niche usecases whereby a network template should contain the same VNI(s) more than once.
2024-02-09 12:12:04 -05:00
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: template
type: string
required: true
description: Path parameter
- in: path
name: vni
type: string
required: true
description: Path parameter
Permit duplicate VNIs in templates with flag Supports niche usecases whereby a network template should contain the same VNI(s) more than once.
2024-02-09 12:12:04 -05:00
- in: query
name: permit_duplicate
type: boolean
required: false
description: Bypass checks to permit duplicate VNIs for niche usecases
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Permit duplicate VNIs in templates with flag Supports niche usecases whereby a network template should contain the same VNI(s) more than once.
2024-02-09 12:12:04 -05:00
return api_provisioner.create_template_network_element(
template, vni, reqargs.get("permit_duplicate", False)
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def delete(self, template, vni):
"""
Remove network {vni} from network template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
- in: path
name: vni
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.delete_template_network_element(template, vni)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(
API_Provisioner_Template_Network_Net_Element,
"/provisioner/template/network/<template>/net/<vni>",
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/template/storage
class API_Provisioner_Template_Storage_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of storage templates
---
tags:
- provisioner / template
definitions:
- schema:
type: object
id: storage-template-disk
properties:
id:
type: integer
description: Internal provisioner disk ID
storage_template:
type: integer
description: Internal provisioner storage template ID
pool:
type: string
description: Ceph storage pool for disk
disk_id:
type: string
description: Disk identifier
disk_size_gb:
type: string
description: Disk size in GB
mountpoint:
type: string
description: In-VM mountpoint for disk
filesystem:
type: string
description: Filesystem for disk
filesystem_args:
type: array
items:
type: string
description: Filesystem mkfs arguments
- schema:
type: object
id: storage-template
properties:
id:
type: integer
description: Internal provisioner template ID
name:
type: string
description: Template name
disks:
type: array
items:
$ref: '#/definitions/storage-template-disk'
parameters:
- in: query
name: limit
type: string
required: false
description: A template name search limit; fuzzy by default, use ^/$ to force exact matches
responses:
200:
description: OK
schema:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: array
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
items:
$ref: '#/definitions/storage-template'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.list_template_storage(reqargs.get("limit", None))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "name",
"required": True,
"helptext": "A template name must be specified.",
}
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Create a new storage template
---
tags:
- provisioner / template
parameters:
- in: query
name: name
type: string
required: true
description: Template name
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.create_template_storage(reqargs.get("name", None))
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_Template_Storage_Root, "/provisioner/template/storage")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/template/storage/<template>
class API_Provisioner_Template_Storage_Element(Resource):
@Authenticator
def get(self, template):
"""
Return information about storage template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/storage-template'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.list_template_storage(template, is_fuzzy=False)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, template):
"""
Create a new storage template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.create_template_storage(template)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def delete(self, template):
"""
Remove storage template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.delete_template_storage(template)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(
API_Provisioner_Template_Storage_Element, "/provisioner/template/storage/<template>"
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/template/storage/<template>/disk
class API_Provisioner_Template_Storage_Disk_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, template, reqargs):
"""
Return a list of disks in network template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: array
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
items:
$ref: '#/definitions/storage-template-disk'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
templates = api_provisioner.list_template_storage(template, is_fuzzy=False)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
if templates:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return templates["disks"]
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
else:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return {"message": "Template not found."}, 404
@RequestParser(
[
{
"name": "disk_id",
"required": True,
"helptext": "A disk identifier in sdX or vdX format must be specified.",
},
{
"name": "pool",
"required": True,
"helptext": "A storage pool must be specified.",
},
{"name": "source_volume"},
{"name": "disk_size"},
{"name": "filesystem"},
{"name": "filesystem_arg", "action": "append"},
{"name": "mountpoint"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, template, reqargs):
"""
Create a new disk in storage template {template}
---
tags:
- provisioner / template
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: template
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: disk_id
type: string
required: true
description: Disk identifier in "sdX"/"vdX" format (e.g. "sda", "vdb", etc.)
- in: query
name: pool
type: string
required: true
description: ceph storage pool for disk
- in: query
name: source_volume
type: string
required: false
description: Source storage volume; not compatible with other options
- in: query
name: disk_size
type: integer
required: false
description: Disk size in GB; not compatible with source_volume
- in: query
name: filesystem
type: string
required: false
description: Filesystem for disk; not compatible with source_volume
- in: query
name: filesystem_arg
type: string
required: false
description: Filesystem mkfs argument in "-X=foo" format; may be specified multiple times to add multiple arguments
- in: query
name: mountpoint
type: string
required: false
description: In-VM mountpoint for disk; not compatible with source_volume
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_provisioner.create_template_storage_element(
template,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("disk_id", None),
reqargs.get("pool", None),
reqargs.get("source_volume", None),
reqargs.get("disk_size", None),
reqargs.get("filesystem", None),
reqargs.get("filesystem_arg", []),
reqargs.get("mountpoint", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(
API_Provisioner_Template_Storage_Disk_Root,
"/provisioner/template/storage/<template>/disk",
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/template/storage/<template>/disk/<disk_id>
class API_Provisioner_Template_Storage_Disk_Element(Resource):
@Authenticator
def get(self, template, disk_id):
"""
Return information about disk {disk_id} in storage template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
- in: path
name: disk_id
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/storage-template-disk'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
disk_list = api_provisioner.list_template_storage(template, is_fuzzy=False)[
"disks"
]
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
for _disk in disk_list:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if _disk["disk_id"] == disk_id:
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
return _disk, 200
abort(404)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "pool",
"required": True,
"helptext": "A storage pool must be specified.",
},
{"name": "source_volume"},
{"name": "disk_size"},
{"name": "filesystem"},
{"name": "filesystem_arg", "action": "append"},
{"name": "mountpoint"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, template, disk_id, reqargs):
"""
Create a new disk {disk_id} in storage template {template}
Alternative to "POST /provisioner/template/storage/<template>/disk?disk_id=<disk_id>"
---
tags:
- provisioner / template
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: template
type: string
required: true
description: Path parameter
- in: path
name: disk_id
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: pool
type: string
required: true
description: ceph storage pool for disk
- in: query
name: source_volume
type: string
required: false
description: Source storage volume; not compatible with other options
- in: query
name: disk_size
type: integer
required: false
description: Disk size in GB; not compatible with source_volume
- in: query
name: filesystem
type: string
required: false
description: Filesystem for disk; not compatible with source_volume
- in: query
name: filesystem_arg
type: string
required: false
description: Filesystem mkfs argument in "-X=foo" format; may be specified multiple times to add multiple arguments
- in: query
name: mountpoint
type: string
required: false
description: In-VM mountpoint for disk; not compatible with source_volume
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_provisioner.create_template_storage_element(
template,
disk_id,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("pool", None),
reqargs.get("source_volume", None),
reqargs.get("disk_size", None),
reqargs.get("filesystem", None),
reqargs.get("filesystem_arg", []),
reqargs.get("mountpoint", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
@Authenticator
def delete(self, template, disk_id):
"""
Remove disk {disk_id} from storage template {template}
---
tags:
- provisioner / template
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: template
type: string
required: true
description: Path parameter
- in: path
name: disk_id
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.delete_template_storage_element(template, disk_id)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(
API_Provisioner_Template_Storage_Disk_Element,
"/provisioner/template/storage/<template>/disk/<disk_id>",
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/userdata
class API_Provisioner_Userdata_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of userdata documents
---
tags:
- provisioner
definitions:
- schema:
type: object
id: userdata
properties:
id:
type: integer
description: Internal provisioner ID
name:
type: string
description: Userdata name
userdata:
type: string
description: Raw userdata configuration document
parameters:
- in: query
name: limit
type: string
required: false
description: A userdata name search limit; fuzzy by default, use ^/$ to force exact matches
responses:
200:
description: OK
schema:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: array
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
items:
$ref: '#/definitions/userdata'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.list_userdata(reqargs.get("limit", None))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "name", "required": True, "helptext": "A name must be specified."},
{
"name": "data",
"required": True,
"helptext": "A userdata document must be specified.",
},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Create a new userdata document
---
tags:
- provisioner
parameters:
- in: query
name: name
type: string
required: true
description: Userdata name
- in: query
name: data
type: string
required: true
description: Raw userdata configuration document
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_provisioner.create_userdata(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("name", None), reqargs.get("data", None)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_Userdata_Root, "/provisioner/userdata")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/userdata/<userdata>
class API_Provisioner_Userdata_Element(Resource):
@Authenticator
def get(self, userdata):
"""
Return information about userdata document {userdata}
---
tags:
- provisioner
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: userdata
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/userdata'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.list_userdata(userdata, is_fuzzy=False)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "data",
"required": True,
"helptext": "A userdata document must be specified.",
}
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, userdata, reqargs):
"""
Create a new userdata document {userdata}
---
tags:
- provisioner
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: userdata
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: data
type: string
required: true
description: Raw userdata configuration document
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.create_userdata(userdata, reqargs.get("data", None))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "data",
"required": True,
"helptext": "A userdata document must be specified.",
}
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def put(self, userdata, reqargs):
"""
Update userdata document {userdata}
---
tags:
- provisioner
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: userdata
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: data
type: string
required: true
description: Raw userdata configuration document
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.update_userdata(userdata, reqargs.get("data", None))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def delete(self, userdata):
"""
Remove userdata document {userdata}
---
tags:
- provisioner
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: userdata
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.delete_userdata(userdata)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_Userdata_Element, "/provisioner/userdata/<userdata>")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/script
class API_Provisioner_Script_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of scripts
---
tags:
- provisioner
definitions:
- schema:
type: object
id: script
properties:
id:
type: integer
description: Internal provisioner script ID
name:
type: string
description: Script name
script:
type: string
description: Raw Python script document
parameters:
- in: query
name: limit
type: string
required: false
description: A script name search limit; fuzzy by default, use ^/$ to force exact matches
responses:
200:
description: OK
schema:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: array
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
items:
$ref: '#/definitions/script'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.list_script(reqargs.get("limit", None))
@RequestParser(
[
{
"name": "name",
"required": True,
"helptext": "A script name must be specified.",
},
{
"name": "data",
"required": True,
"helptext": "A script document must be specified.",
},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Create a new script
---
tags:
- provisioner
parameters:
- in: query
name: name
type: string
required: true
description: Script name
- in: query
name: data
type: string
required: true
description: Raw Python script document
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_provisioner.create_script(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("name", None), reqargs.get("data", None)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_Script_Root, "/provisioner/script")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/script/<script>
class API_Provisioner_Script_Element(Resource):
@Authenticator
def get(self, script):
"""
Return information about script {script}
---
tags:
- provisioner
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: script
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/script'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.list_script(script, is_fuzzy=False)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "data",
"required": True,
"helptext": "A script document must be specified.",
}
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
Lint: F821 undefined name 'reqargs' These were functions that were missing an expected reqargs pass.
2020-11-07 13:28:59 -05:00
def post(self, script, reqargs):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
"""
Create a new script {script}
---
tags:
- provisioner
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: script
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: data
type: string
required: true
description: Raw Python script document
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.create_script(script, reqargs.get("data", None))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "data",
"required": True,
"helptext": "A script document must be specified.",
}
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def put(self, script, reqargs):
"""
Update script {script}
---
tags:
- provisioner
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: script
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: data
type: string
required: true
description: Raw Python script document
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.update_script(script, reqargs.get("data", None))
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def delete(self, script):
"""
Remove script {script}
---
tags:
- provisioner
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: script
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.delete_script(script)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_Script_Element, "/provisioner/script/<script>")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
# /provisioner/profile
class API_Provisioner_OVA_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}])
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of OVA sources
---
tags:
- provisioner
definitions:
- schema:
type: object
id: ova
properties:
id:
type: integer
description: Internal provisioner OVA ID
name:
type: string
description: OVA name
volumes:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: array
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
items:
type: object
properties:
disk_id:
type: string
description: Disk identifier
disk_size_gb:
type: string
description: Disk size in GB
pool:
type: string
description: Pool containing the OVA volume
volume_name:
type: string
description: Storage volume containing the OVA image
volume_format:
type: string
description: OVA image format
parameters:
- in: query
name: limit
type: string
required: false
description: An OVA name search limit; fuzzy by default, use ^/$ to force exact matches
responses:
200:
description: OK
schema:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: array
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
items:
$ref: '#/definitions/ova'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_ova.list_ova(reqargs.get("limit", None))
@RequestParser(
[
{
"name": "pool",
"required": True,
"location": ["args"],
"helptext": "A storage pool must be specified.",
},
{
"name": "name",
"required": True,
"location": ["args"],
"helptext": "A VM name must be specified.",
},
{
"name": "ova_size",
"required": True,
"location": ["args"],
"helptext": "An OVA size must be specified.",
},
]
)
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
@Authenticator
def post(self, reqargs):
"""
Upload an OVA image to the cluster
The API client is responsible for determining and setting the ova_size value, as this value cannot be determined dynamically before the upload proceeds.
---
tags:
- provisioner
parameters:
- in: query
name: pool
type: string
required: true
description: Storage pool name
- in: query
name: name
type: string
required: true
description: OVA name on the cluster (usually identical to the OVA file name)
- in: query
name: ova_size
type: string
required: true
description: Size of the OVA file in bytes
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_ova.upload_ova(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("pool", None),
reqargs.get("name", None),
reqargs.get("ova_size", None),
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_OVA_Root, "/provisioner/ova")
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
# /provisioner/ova/<ova>
class API_Provisioner_OVA_Element(Resource):
@Authenticator
def get(self, ova):
"""
Return information about OVA image {ova}
---
tags:
- provisioner
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: ova
type: string
required: true
description: Path parameter
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/ova'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_ova.list_ova(ova, is_fuzzy=False)
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "pool",
"required": True,
"location": ["args"],
"helptext": "A storage pool must be specified.",
},
{
"name": "ova_size",
"required": True,
"location": ["args"],
"helptext": "An OVA size must be specified.",
},
]
)
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
@Authenticator
def post(self, ova, reqargs):
"""
Upload an OVA image to the cluster
The API client is responsible for determining and setting the ova_size value, as this value cannot be determined dynamically before the upload proceeds.
---
tags:
- provisioner
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: ova
type: string
required: true
description: Path parameter
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
- in: query
name: pool
type: string
required: true
description: Storage pool name
- in: query
name: ova_size
type: string
required: true
description: Size of the OVA file in bytes
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_ova.upload_ova(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("pool", None),
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
ova,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("ova_size", None),
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
)
@Authenticator
def delete(self, ova):
"""
Remove ova {ova}
---
tags:
- provisioner
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: ova
type: string
required: true
description: Path parameter
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_ova.delete_ova(ova)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_OVA_Element, "/provisioner/ova/<ova>")
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/profile
class API_Provisioner_Profile_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser([{"name": "limit"}])
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def get(self, reqargs):
"""
Return a list of profiles
---
tags:
- provisioner
definitions:
- schema:
type: object
id: profile
properties:
id:
type: integer
description: Internal provisioner profile ID
name:
type: string
description: Profile name
script:
type: string
description: Script name
system_template:
type: string
description: System template name
network_template:
type: string
description: Network template name
storage_template:
type: string
description: Storage template name
userdata:
type: string
description: Userdata template name
arguments:
type: array
items:
type: string
description: Script install() function keyword arguments in "arg=data" format
parameters:
- in: query
name: limit
type: string
required: false
description: A profile name search limit; fuzzy by default, use ^/$ to force exact matches
responses:
200:
description: OK
schema:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
type: array
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
items:
$ref: '#/definitions/profile'
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.list_profile(reqargs.get("limit", None))
@RequestParser(
[
{
"name": "name",
"required": True,
"helptext": "A profile name must be specified.",
},
{
"name": "profile_type",
"required": True,
"helptext": "A profile type must be specified.",
},
Add OVA script support 1. Ensure that system_template and script are not nullable in the DB. 2. Ensure that the CLI and API enforce the above and clean up CLI arguments for profile add. 3. Ensure that, before uploading OVAs, a 'default_ova' provisioning script is present. 4. Use the 'default_ova' script for new OVA uploads. 5. Ensure that OVA details are properly added to the vm_data dict in the provisioner vmbuilder.
2022-10-06 10:27:08 -04:00
{
"name": "system_template",
"required": True,
"helptext": "A system_template must be specified.",
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
{"name": "network_template"},
{"name": "storage_template"},
{"name": "userdata"},
Add OVA script support 1. Ensure that system_template and script are not nullable in the DB. 2. Ensure that the CLI and API enforce the above and clean up CLI arguments for profile add. 3. Ensure that, before uploading OVAs, a 'default_ova' provisioning script is present. 4. Use the 'default_ova' script for new OVA uploads. 5. Ensure that OVA details are properly added to the vm_data dict in the provisioner vmbuilder.
2022-10-06 10:27:08 -04:00
{
"name": "script",
"required": True,
"helptext": "A script must be specified.",
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
{"name": "ova"},
{"name": "arg", "action": "append"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Create a new profile
---
tags:
- provisioner
parameters:
- in: query
name: name
type: string
required: true
description: Profile name
- in: query
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
name: profile_type
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
type: string
required: true
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
description: Profile type
enum:
- provisioner
- ova
- in: query
name: script
type: string
Add OVA script support 1. Ensure that system_template and script are not nullable in the DB. 2. Ensure that the CLI and API enforce the above and clean up CLI arguments for profile add. 3. Ensure that, before uploading OVAs, a 'default_ova' provisioning script is present. 4. Use the 'default_ova' script for new OVA uploads. 5. Ensure that OVA details are properly added to the vm_data dict in the provisioner vmbuilder.
2022-10-06 10:27:08 -04:00
required: true
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
description: Script name
- in: query
name: system_template
type: string
Add OVA script support 1. Ensure that system_template and script are not nullable in the DB. 2. Ensure that the CLI and API enforce the above and clean up CLI arguments for profile add. 3. Ensure that, before uploading OVAs, a 'default_ova' provisioning script is present. 4. Use the 'default_ova' script for new OVA uploads. 5. Ensure that OVA details are properly added to the vm_data dict in the provisioner vmbuilder.
2022-10-06 10:27:08 -04:00
required: true
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
description: System template name
- in: query
name: network_template
type: string
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
required: false
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
description: Network template name
- in: query
name: storage_template
type: string
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
required: false
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
description: Storage template name
- in: query
name: userdata
type: string
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
required: false
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
description: Userdata template name
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
- in: query
name: ova
type: string
required: false
description: OVA image source
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: arg
type: string
description: Script install() function keywork argument in "arg=data" format; may be specified multiple times to add multiple arguments
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_provisioner.create_profile(
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("name", None),
reqargs.get("profile_type", None),
reqargs.get("system_template", None),
reqargs.get("network_template", None),
reqargs.get("storage_template", None),
reqargs.get("userdata", None),
reqargs.get("script", None),
reqargs.get("ova", None),
reqargs.get("arg", []),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_Profile_Root, "/provisioner/profile")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/profile/<profile>
class API_Provisioner_Profile_Element(Resource):
@Authenticator
def get(self, profile):
"""
Return information about profile {profile}
---
tags:
- provisioner
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: profile
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
$ref: '#/definitions/profile'
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.list_profile(profile, is_fuzzy=False)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "profile_type",
"required": True,
"helptext": "A profile type must be specified.",
},
Add OVA script support 1. Ensure that system_template and script are not nullable in the DB. 2. Ensure that the CLI and API enforce the above and clean up CLI arguments for profile add. 3. Ensure that, before uploading OVAs, a 'default_ova' provisioning script is present. 4. Use the 'default_ova' script for new OVA uploads. 5. Ensure that OVA details are properly added to the vm_data dict in the provisioner vmbuilder.
2022-10-06 10:27:08 -04:00
{
"name": "system_template",
"required": True,
"helptext": "A system_template must be specified.",
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
{"name": "network_template"},
{"name": "storage_template"},
{"name": "userdata"},
Add OVA script support 1. Ensure that system_template and script are not nullable in the DB. 2. Ensure that the CLI and API enforce the above and clean up CLI arguments for profile add. 3. Ensure that, before uploading OVAs, a 'default_ova' provisioning script is present. 4. Use the 'default_ova' script for new OVA uploads. 5. Ensure that OVA details are properly added to the vm_data dict in the provisioner vmbuilder.
2022-10-06 10:27:08 -04:00
{
"name": "script",
"required": True,
"helptext": "A script must be specified.",
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
{"name": "ova"},
{"name": "arg", "action": "append"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, profile, reqargs):
"""
Create a new profile {profile}
---
tags:
- provisioner
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: profile
type: string
required: true
description: Path parameter
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
- in: query
name: profile_type
type: string
required: true
description: Profile type
enum:
- provisioner
- ova
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: script
type: string
required: true
description: Script name
- in: query
name: system_template
type: string
required: true
description: System template name
- in: query
name: network_template
type: string
Add OVA script support 1. Ensure that system_template and script are not nullable in the DB. 2. Ensure that the CLI and API enforce the above and clean up CLI arguments for profile add. 3. Ensure that, before uploading OVAs, a 'default_ova' provisioning script is present. 4. Use the 'default_ova' script for new OVA uploads. 5. Ensure that OVA details are properly added to the vm_data dict in the provisioner vmbuilder.
2022-10-06 10:27:08 -04:00
required: false
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
description: Network template name
- in: query
name: storage_template
type: string
Add OVA script support 1. Ensure that system_template and script are not nullable in the DB. 2. Ensure that the CLI and API enforce the above and clean up CLI arguments for profile add. 3. Ensure that, before uploading OVAs, a 'default_ova' provisioning script is present. 4. Use the 'default_ova' script for new OVA uploads. 5. Ensure that OVA details are properly added to the vm_data dict in the provisioner vmbuilder.
2022-10-06 10:27:08 -04:00
required: false
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
description: Storage template name
- in: query
name: userdata
type: string
Add OVA script support 1. Ensure that system_template and script are not nullable in the DB. 2. Ensure that the CLI and API enforce the above and clean up CLI arguments for profile add. 3. Ensure that, before uploading OVAs, a 'default_ova' provisioning script is present. 4. Use the 'default_ova' script for new OVA uploads. 5. Ensure that OVA details are properly added to the vm_data dict in the provisioner vmbuilder.
2022-10-06 10:27:08 -04:00
required: false
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
description: Userdata template name
Complete implementation of OVA handling Add functions for uploading, listing, and removing OVA images to the API and CLI interfaces. Includes improved parsing of the OVF and creation of a system_template and profile for each OVA. Also modifies some behaviour around profiles, making most components option at creation to support both profile types (and incomplete profiles generally). Implementation part 2/3 - remaining: OVA VM creation References #71
2020-02-17 22:52:49 -05:00
- in: query
name: ova
type: string
required: false
description: OVA image source
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: arg
type: string
description: Script install() function keywork argument in "arg=data" format; may be specified multiple times to add multiple arguments
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_provisioner.create_profile(
profile,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("profile_type", None),
reqargs.get("system_template", None),
reqargs.get("network_template", None),
reqargs.get("storage_template", None),
reqargs.get("userdata", None),
reqargs.get("script", None),
reqargs.get("ova", None),
reqargs.get("arg", []),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{"name": "system_template"},
{"name": "network_template"},
{"name": "storage_template"},
{"name": "userdata"},
{"name": "script"},
{"name": "arg", "action": "append"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def put(self, profile, reqargs):
"""
Modify profile {profile}
---
tags:
- provisioner
parameters:
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
- in: path
name: profile
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
- in: query
name: script
type: string
required: false
description: Script name
- in: query
name: system_template
type: string
required: false
description: System template name
- in: query
name: network_template
type: string
required: false
description: Network template name
- in: query
name: storage_template
type: string
required: false
description: Storage template name
- in: query
name: userdata
type: string
required: false
description: Userdata template name
- in: query
name: arg
type: string
description: Script install() function keywork argument in "arg=data" format; may be specified multiple times to add multiple arguments
responses:
200:
description: OK
schema:
type: object
id: Message
400:
description: Bad request
schema:
type: object
id: Message
"""
return api_provisioner.modify_profile(
profile,
Lint: E261 at least two spaces before inline comment
2020-11-07 13:11:03 -05:00
None, # Can't modify the profile type
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("system_template", None),
reqargs.get("network_template", None),
reqargs.get("storage_template", None),
reqargs.get("userdata", None),
reqargs.get("script", None),
Lint: E261 at least two spaces before inline comment
2020-11-07 13:11:03 -05:00
None, # Can't modify the OVA
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
reqargs.get("arg", []),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
@Authenticator
def delete(self, profile):
"""
Remove profile {profile}
---
tags:
- provisioner
Correct formatting of OpenAPI Swagger specs
2024-10-19 02:17:51 -04:00
parameters:
- in: path
name: profile
type: string
required: true
description: Path parameter
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
200:
description: OK
schema:
type: object
id: Message
404:
description: Not found
schema:
type: object
id: Message
"""
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return api_provisioner.delete_profile(profile)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_Profile_Element, "/provisioner/profile/<profile>")
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Lint: E302 expected 2 blank lines, found X
2020-11-07 14:45:24 -05:00
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
# /provisioner/create
class API_Provisioner_Create_Root(Resource):
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
@RequestParser(
[
{
"name": "name",
"required": True,
"helptext": "A VM name must be specified.",
},
{
"name": "profile",
"required": True,
"helptext": "A profile name must be specified.",
},
{"name": "define_vm"},
{"name": "start_vm"},
{"name": "arg", "action": "append"},
]
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
@Authenticator
def post(self, reqargs):
"""
Create a new virtual machine
Note: Starts a background job in the pvc-provisioner-worker Celery worker while returning a task ID; the task ID can be used to query the "GET /provisioner/status/<task_id>" endpoint for the job status
---
tags:
- provisioner
parameters:
- in: query
name: name
type: string
required: true
description: Virtual machine name
- in: query
name: profile
type: string
required: true
description: Profile name
- in: query
name: define_vm
type: boolean
required: false
description: Whether to define the VM on the cluster during provisioning
- in: query
name: start_vm
type: boolean
required: false
description: Whether to start the VM after provisioning
Allow specifying arbitrary script_args on CLI Allow the specifying of arbitrary provisioner script install() args on the provisioner create CLI, either overriding or adding additional per-VM arguments to those found in the profile. Reference example is setting a "vm_fqdn" on a per-run basis. Closes #100
2020-07-08 13:18:12 -04:00
- in: query
name: arg
type: string
description: Script install() function keywork argument in "arg=data" format; may be specified multiple times to add multiple arguments
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
responses:
Update responses for Celery tasks
2024-09-13 11:47:04 -04:00
202:
description: Accepted
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
schema:
Add proper response schema for 202 responses
2024-10-01 13:25:11 -04:00
type: object
description: The Celery job information of the task
id: CeleryTask
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
400:
description: Bad request
schema:
type: object
id: Message
"""
# Verify that the profile is valid
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
_list, code = api_provisioner.list_profile(
reqargs.get("profile", None), is_fuzzy=False
)
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
if code != 200:
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
return {
"message": 'Profile "{}" is not valid.'.format(reqargs.get("profile"))
}, 400
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if bool(strtobool(reqargs.get("define_vm", "true"))):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
define_vm = True
else:
define_vm = False
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
if bool(strtobool(reqargs.get("start_vm", "true"))):
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
start_vm = True
else:
start_vm = False
Use custom task IDs for Celery tasks Full UUIDs were obnoxiously long, so switch to using just the first 8-character section of a UUID instead. Keeps the list nice and short, makes them easier to copy, and is just generally nicer. Could this cause uniqueness problems? Perhaps, but I don't see that happening nearly frequently enough to matter.
2023-11-16 13:22:14 -05:00
task = run_celery_task(
Rework Flask API to route Celery tasks manually Avoids needing to define any of these tasks here; they can all be defined in the pvcworkerd code.
2023-11-30 00:40:09 -05:00
"provisioner.create",
Explicitly use kwargs in Celery task calls
2023-11-16 11:55:15 -05:00
vm_name=reqargs.get("name", None),
profile_name=reqargs.get("profile", None),
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
define_vm=define_vm,
Allow specifying arbitrary script_args on CLI Allow the specifying of arbitrary provisioner script install() args on the provisioner create CLI, either overriding or adding additional per-VM arguments to those found in the profile. Reference example is setting a "vm_fqdn" on a per-run basis. Closes #100
2020-07-08 13:18:12 -04:00
start_vm=start_vm,
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
script_run_args=reqargs.get("arg", []),
Port remaining tasks to new task handler Move the create_vm and run_benchmark tasks to use the new Celery subsystem, handlers, and wait command. Remove the obsolete, dedicated API endpoints. Standardize the CLI client and move the repeated handler code into a separate common function.
2023-11-16 01:57:56 -05:00
run_on="primary",
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
)
return (
Return and show task_name
2023-11-16 14:50:02 -05:00
{
"task_id": task.id,
"task_name": "provisioner.create",
Port VM autobackups into pvcworkerd with snaps Moves VM autobackups from being in-CLI to being handled by the pvcworkerd system on the primary coordinator. Turns the CLI autobackup command into an actual API client endpoint rather than having its logic in the CLI. In addition, modifies the new autobackup to leverage the new "pvc vm snapshot" function set, just with special snapshot names. This helps automate this within the new snapshot scaffolding.
2024-08-23 17:01:31 -04:00
"run_on": f"{get_primary_node()} (primary)",
Return and show task_name
2023-11-16 14:50:02 -05:00
},
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
202,
Port remaining tasks to new task handler Move the create_vm and run_benchmark tasks to use the new Celery subsystem, handlers, and wait command. Remove the obsolete, dedicated API endpoints. Standardize the CLI client and move the repeated handler code into a separate common function.
2023-11-16 01:57:56 -05:00
{"Location": Api.url_for(api, API_Tasks_Element, task_id=task.id)},
Further split API so only Flask can be loaded
2020-02-08 20:36:53 -05:00
)
Lint: E305 expected 2 blank lines after class or function definition, found X
2020-11-07 13:17:49 -05:00
Reformat code with Black code formatter Unify the code style along PEP and Black principles using the tool.
2021-11-06 03:02:43 -04:00
api.add_resource(API_Provisioner_Create_Root, "/provisioner/create")