9efa908a73
This change makes sure that we out the deployment JSON when performing a deployment rollback.
485 lines
14 KiB
Python
485 lines
14 KiB
Python
import json
|
|
|
|
from dcos.api import http, util
|
|
from dcos.api.errors import DefaultError
|
|
|
|
try:
|
|
from urllib import quote
|
|
except ImportError:
|
|
from urllib.parse import quote
|
|
|
|
logger = util.get_logger(__name__)
|
|
|
|
|
|
def create_client(config):
|
|
"""Creates a Marathon client with the supplied configuration.
|
|
|
|
:param config: configuration dictionary
|
|
:type config: config.Toml
|
|
:returns: Marathon client
|
|
:rtype: dcos.api.marathon.Client
|
|
"""
|
|
return Client(config['marathon.host'], config['marathon.port'])
|
|
|
|
|
|
def _response_to_error(response):
|
|
"""
|
|
:param response: HTTP resonse object
|
|
:type response: requests.Response
|
|
:returns: the error embedded in the response JSON
|
|
:rtype: Error
|
|
"""
|
|
|
|
message = response.json().get('message')
|
|
if message is None:
|
|
errs = response.json().get('errors')
|
|
if errs is None:
|
|
logger.error(
|
|
'Marathon server did not return a message: %s',
|
|
response.json())
|
|
return DefaultError('Unknown error from Marathon')
|
|
|
|
msg = '\n'.join(error['error'] for error in errs)
|
|
return DefaultError('Error(s): {}'.format(msg))
|
|
|
|
return DefaultError('Error: {}'.format(response.json()['message']))
|
|
|
|
|
|
class Client(object):
|
|
"""Class for talking to the Marathon server.
|
|
|
|
:param host: host for the Marathon server
|
|
:type host: str
|
|
:param port: port for the Marathon server
|
|
:type port: int
|
|
"""
|
|
|
|
def __init__(self, host, port):
|
|
self._url_pattern = "http://{host}:{port}/{path}"
|
|
self._host = host
|
|
self._port = port
|
|
|
|
def _create_url(self, path):
|
|
"""Creates the url from the provided path.
|
|
|
|
:param path: url path
|
|
:type path: str
|
|
:returns: constructed url
|
|
:rtype: str
|
|
"""
|
|
|
|
return self._url_pattern.format(
|
|
host=self._host,
|
|
port=self._port,
|
|
path=path)
|
|
|
|
def get_app(self, app_id, version=None):
|
|
"""Returns a representation of the requested application version. If
|
|
version is None the return the latest version.
|
|
|
|
:param app_id: the ID of the application
|
|
:type app_id: str
|
|
:param version: application version as a ISO8601 datetime
|
|
:type version: str
|
|
:returns: the requested Marathon application
|
|
:rtype: (dict, errors.Error)
|
|
"""
|
|
|
|
app_id = normalize_app_id(app_id)
|
|
if version is None:
|
|
url = self._create_url('v2/apps{}'.format(app_id))
|
|
else:
|
|
url = self._create_url(
|
|
'v2/apps{}/versions/{}'.format(app_id, version))
|
|
|
|
response, error = http.get(url, response_to_error=_response_to_error)
|
|
|
|
if error is not None:
|
|
return (None, error)
|
|
|
|
# Looks like Marathon return different JSON for versions
|
|
if version is None:
|
|
return (response.json()['app'], None)
|
|
else:
|
|
return (response.json(), None)
|
|
|
|
def get_app_versions(self, app_id, max_count=None):
|
|
"""Asks Marathon for all the versions of the Application up to a
|
|
maximum count.
|
|
|
|
:param app_id: the ID of the application
|
|
:type app_id: str
|
|
:param max_count: the maximum number of version to fetch
|
|
:type max_count: int
|
|
:returns: a list of all the version of the application
|
|
:rtype: (list of str, errors.Error)
|
|
"""
|
|
|
|
if max_count is not None and max_count <= 0:
|
|
return (
|
|
None,
|
|
DefaultError(
|
|
'Maximum count must be a positive number: {}'.format(
|
|
max_count))
|
|
)
|
|
|
|
app_id = normalize_app_id(app_id)
|
|
|
|
url = self._create_url('v2/apps{}/versions'.format(app_id))
|
|
|
|
response, error = http.get(url, response_to_error=_response_to_error)
|
|
|
|
if error is not None:
|
|
return (None, error)
|
|
|
|
if max_count is None:
|
|
return (response.json()['versions'], None)
|
|
else:
|
|
return (response.json()['versions'][:max_count], None)
|
|
|
|
def get_apps(self):
|
|
"""Get a list of known applications.
|
|
|
|
:returns: list of known applications
|
|
:rtype: (list of dict, errors.Error)
|
|
"""
|
|
|
|
url = self._create_url('v2/apps')
|
|
|
|
response, error = http.get(url, response_to_error=_response_to_error)
|
|
|
|
if error is not None:
|
|
return (None, error)
|
|
|
|
apps = response.json()['apps']
|
|
return (apps, None)
|
|
|
|
def add_app(self, app_resource):
|
|
"""Add a new application.
|
|
|
|
:param app_resource: application resource
|
|
:type app_resource: dict, bytes or file
|
|
:returns: the application description
|
|
:rtype: (dict, errors.Error)
|
|
"""
|
|
|
|
url = self._create_url('v2/apps')
|
|
|
|
# The file type exists only in Python 2, preventing type(...) is file.
|
|
if hasattr(app_resource, 'read'):
|
|
app_json = json.load(app_resource)
|
|
else:
|
|
app_json = app_resource
|
|
|
|
response, error = http.post(url,
|
|
json=app_json,
|
|
response_to_error=_response_to_error)
|
|
|
|
if error is not None:
|
|
return (None, error)
|
|
|
|
return (response.json(), None)
|
|
|
|
def update_app(self, app_id, payload, force=None):
|
|
"""Update an application.
|
|
|
|
:param app_id: the application id
|
|
:type app_id: str
|
|
:param payload: the json payload
|
|
:type payload: dict
|
|
:param force: whether to override running deployments
|
|
:type force: bool
|
|
:returns: the resulting deployment ID
|
|
:rtype: (str, errors.Error)
|
|
"""
|
|
|
|
app_id = normalize_app_id(app_id)
|
|
|
|
if not force:
|
|
params = None
|
|
else:
|
|
params = {'force': 'true'}
|
|
|
|
url = self._create_url('v2/apps{}'.format(app_id))
|
|
|
|
response, error = http.put(url,
|
|
params=params,
|
|
json=payload,
|
|
response_to_error=_response_to_error)
|
|
|
|
if error is not None:
|
|
return (None, error)
|
|
|
|
return (response.json().get('deploymentId'), None)
|
|
|
|
def scale_app(self, app_id, instances, force=None):
|
|
"""Scales an application to the requested number of instances.
|
|
|
|
:param app_id: the ID of the application to scale
|
|
:type app_id: str
|
|
:param instances: the requested number of instances
|
|
:type instances: int
|
|
:param force: whether to override running deployments
|
|
:type force: bool
|
|
:returns: the resulting deployment ID
|
|
:rtype: (bool, errors.Error)
|
|
"""
|
|
|
|
app_id = normalize_app_id(app_id)
|
|
|
|
if not force:
|
|
params = None
|
|
else:
|
|
params = {'force': 'true'}
|
|
|
|
url = self._create_url('v2/apps{}'.format(app_id))
|
|
|
|
response, error = http.put(url,
|
|
params=params,
|
|
json={'instances': int(instances)},
|
|
response_to_error=_response_to_error)
|
|
|
|
if error is not None:
|
|
return (None, error)
|
|
|
|
deployment = response.json()['deploymentId']
|
|
return (deployment, None)
|
|
|
|
def stop_app(self, app_id, force=None):
|
|
"""Scales an application to zero instances.
|
|
|
|
:param app_id: the ID of the application to stop
|
|
:type app_id: str
|
|
:param force: whether to override running deployments
|
|
:type force: bool
|
|
:returns: the resulting deployment ID
|
|
:rtype: (bool, errors.Error)
|
|
"""
|
|
|
|
return self.scale_app(app_id, 0, force)
|
|
|
|
def remove_app(self, app_id, force=None):
|
|
"""Completely removes the requested application.
|
|
|
|
:param app_id: the ID of the application to remove
|
|
:type app_id: str
|
|
:param force: whether to override running deployments
|
|
:type force: bool
|
|
:returns: Error if it failed to remove the app; None otherwise
|
|
:rtype: errors.Error
|
|
"""
|
|
|
|
app_id = normalize_app_id(app_id)
|
|
|
|
if not force:
|
|
params = None
|
|
else:
|
|
params = {'force': 'true'}
|
|
|
|
url = self._create_url('v2/apps{}'.format(app_id))
|
|
|
|
response, error = http.delete(url,
|
|
params=params,
|
|
response_to_error=_response_to_error)
|
|
|
|
if error is not None:
|
|
return error
|
|
|
|
return None
|
|
|
|
def restart_app(self, app_id, force=None):
|
|
"""Performs a rolling restart of all of the tasks.
|
|
|
|
:param app_id: the id of the application to restart
|
|
:type app_id: str
|
|
:param force: whether to override running deployments
|
|
:type force: bool
|
|
:returns: the deployment id and version; Error otherwise
|
|
:rtype: (dict, errors.Error)
|
|
"""
|
|
|
|
app_id = normalize_app_id(app_id)
|
|
|
|
if not force:
|
|
params = None
|
|
else:
|
|
params = {'force': 'true'}
|
|
|
|
url = self._create_url('v2/apps{}/restart'.format(app_id))
|
|
|
|
response, error = http.post(url,
|
|
params=params,
|
|
response_to_error=_response_to_error)
|
|
|
|
if error is not None:
|
|
return (None, error)
|
|
|
|
return (response.json(), None)
|
|
|
|
def get_deployment(self, deployment_id):
|
|
"""Returns a deployment.
|
|
|
|
:param deployment_id: the deployment id
|
|
:type deployment_id: str
|
|
:returns: a deployment
|
|
:rtype: (dict, Error)
|
|
"""
|
|
|
|
url = self._create_url('v2/deployments')
|
|
|
|
response, error = http.get(url,
|
|
response_to_error=_response_to_error)
|
|
|
|
if error is not None:
|
|
return (None, error)
|
|
|
|
deployment = next(
|
|
(deployment for deployment in response.json()
|
|
if deployment_id == deployment['id']),
|
|
None)
|
|
|
|
return (deployment, None)
|
|
|
|
def get_deployments(self, app_id=None):
|
|
"""Returns a list of deployments, optionally limited to an app.
|
|
|
|
:param app_id: the id of the application
|
|
:type app_id: str
|
|
:returns: a list of deployments
|
|
:rtype: list of dict
|
|
"""
|
|
|
|
url = self._create_url('v2/deployments')
|
|
|
|
response, error = http.get(url, response_to_error=_response_to_error)
|
|
|
|
if error is not None:
|
|
return (None, error)
|
|
|
|
if app_id is not None:
|
|
app_id = normalize_app_id(app_id)
|
|
deployments = [
|
|
deployment for deployment in response.json()
|
|
if app_id in deployment['affectedApps']
|
|
]
|
|
else:
|
|
deployments = response.json()
|
|
|
|
return (deployments, None)
|
|
|
|
def _cancel_deployment(self, deployment_id, force):
|
|
"""Cancels an application deployment.
|
|
|
|
:param deployment_id: the deployment id
|
|
:type deployment_id: str
|
|
:param force: if set to `False`, stop the deployment and
|
|
create a new rollback deployment to reinstate the
|
|
previous configuration. If set to `True`, simply stop the
|
|
deployment.
|
|
:type force: bool
|
|
:returns: cancelation deployment
|
|
:rtype: (dict, Error)
|
|
"""
|
|
|
|
if not force:
|
|
params = None
|
|
else:
|
|
params = {'force': 'true'}
|
|
|
|
url = self._create_url('v2/deployments/{}'.format(deployment_id))
|
|
|
|
response, error = http.delete(
|
|
url,
|
|
params=params,
|
|
response_to_error=_response_to_error)
|
|
if error is not None:
|
|
return (None, error)
|
|
|
|
if not force:
|
|
return (response.json(), None)
|
|
else:
|
|
return (None, None)
|
|
|
|
def rollback_deployment(self, deployment_id):
|
|
"""Rolls back an application deployment.
|
|
|
|
:param deployment_id: the deployment id
|
|
:type deployment_id: str
|
|
:returns: cancelation deployment
|
|
:rtype: (dict, Error)
|
|
"""
|
|
|
|
return self._cancel_deployment(deployment_id, False)
|
|
|
|
def stop_deployment(self, deployment_id):
|
|
"""Stops an application deployment.
|
|
|
|
:param deployment_id: the deployment id
|
|
:type deployment_id: str
|
|
:returns: an error if unable to stop the deployment; None otherwise
|
|
:rtype: Error
|
|
"""
|
|
|
|
_, err = self._cancel_deployment(deployment_id, True)
|
|
return err
|
|
|
|
def get_tasks(self, app_id):
|
|
"""Returns a list of tasks, optionally limited to an app.
|
|
|
|
:param app_id: the id of the application to restart
|
|
:type app_id: str
|
|
:returns: a list of tasks
|
|
:rtype: (list of dict, dcos.api.errors.Error)
|
|
"""
|
|
|
|
url = self._create_url('v2/tasks')
|
|
|
|
response, error = http.get(url, response_to_error=_response_to_error)
|
|
if error is not None:
|
|
return (None, error)
|
|
|
|
if app_id is not None:
|
|
app_id = normalize_app_id(app_id)
|
|
tasks = [
|
|
task for task in response.json()['tasks']
|
|
if app_id == task['appId']
|
|
]
|
|
else:
|
|
tasks = response.json()['tasks']
|
|
|
|
return (tasks, None)
|
|
|
|
def get_task(self, task_id):
|
|
"""Returns a task
|
|
|
|
:param task_id: the id of the task
|
|
:type task_id: str
|
|
:returns: a tasks
|
|
:rtype: (dict, dcos.api.errors.Error)
|
|
"""
|
|
|
|
url = self._create_url('v2/tasks')
|
|
|
|
response, error = http.get(url, response_to_error=_response_to_error)
|
|
if error is not None:
|
|
return (None, error)
|
|
|
|
task = next(
|
|
(task for task in response.json()['tasks']
|
|
if task_id == task['id']),
|
|
None)
|
|
|
|
return (task, None)
|
|
|
|
|
|
def normalize_app_id(app_id):
|
|
"""Normalizes the application id.
|
|
|
|
:param app_id: raw application ID
|
|
:type app_id: str
|
|
:returns: normalized application ID
|
|
:rtype: str
|
|
"""
|
|
|
|
return quote('/' + app_id.strip('/'))
|