398 lines
15 KiB
Python
398 lines
15 KiB
Python
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import glanceclient.exc
|
|
import novaclient.exceptions as nova_exc
|
|
from oslo_utils import timeutils
|
|
import pecan
|
|
from pecan import rest
|
|
import wsme
|
|
from wsme import types as wtypes
|
|
|
|
from magnum.api.controllers import base
|
|
from magnum.api.controllers import link
|
|
from magnum.api.controllers.v1 import collection
|
|
from magnum.api.controllers.v1 import types
|
|
from magnum.api import expose
|
|
from magnum.api import utils as api_utils
|
|
from magnum.api import validation
|
|
from magnum.common import clients
|
|
from magnum.common import exception
|
|
from magnum.common import policy
|
|
from magnum import objects
|
|
|
|
|
|
class BayModelPatchType(types.JsonPatchType):
|
|
pass
|
|
|
|
|
|
class BayModel(base.APIBase):
|
|
"""API representation of a baymodel.
|
|
|
|
This class enforces type checking and value constraints, and converts
|
|
between the internal object model and the API representation of a baymodel.
|
|
"""
|
|
|
|
_coe = None
|
|
|
|
def _get_coe(self):
|
|
return self._coe
|
|
|
|
def _set_coe(self, value):
|
|
if value and self._coe != value:
|
|
self._coe = value
|
|
elif value == wtypes.Unset:
|
|
self._coe = wtypes.Unset
|
|
|
|
uuid = types.uuid
|
|
"""Unique UUID for this baymodel"""
|
|
|
|
name = wtypes.StringType(min_length=1, max_length=255)
|
|
"""The name of the bay model"""
|
|
|
|
coe = wsme.wsproperty(wtypes.text, _get_coe, _set_coe, mandatory=True)
|
|
"""The Container Orchestration Engine for this bay model"""
|
|
|
|
image_id = wsme.wsattr(wtypes.StringType(min_length=1, max_length=255),
|
|
mandatory=True)
|
|
"""The image name or UUID to use as a base image for this baymodel"""
|
|
|
|
flavor_id = wtypes.StringType(min_length=1, max_length=255)
|
|
"""The flavor of this bay model"""
|
|
|
|
master_flavor_id = wtypes.StringType(min_length=1, max_length=255)
|
|
"""The flavor of the master node for this bay model"""
|
|
|
|
dns_nameserver = wtypes.IPv4AddressType()
|
|
"""The DNS nameserver address"""
|
|
|
|
keypair_id = wsme.wsattr(wtypes.StringType(min_length=1, max_length=255),
|
|
mandatory=True)
|
|
"""The name or id of the nova ssh keypair"""
|
|
|
|
external_network_id = wtypes.StringType(min_length=1, max_length=255)
|
|
"""The external network to attach the Bay"""
|
|
|
|
fixed_network = wtypes.StringType(min_length=1, max_length=255)
|
|
"""The fixed network name to attach the Bay"""
|
|
|
|
network_driver = wtypes.StringType(min_length=1, max_length=255)
|
|
"""The name of the driver used for instantiating container networks"""
|
|
|
|
apiserver_port = wtypes.IntegerType(minimum=1024, maximum=65535)
|
|
"""The API server port for k8s"""
|
|
|
|
docker_volume_size = wtypes.IntegerType(minimum=1)
|
|
"""The size in GB of the docker volume"""
|
|
|
|
ssh_authorized_key = wtypes.StringType(min_length=1)
|
|
"""The SSH Authorized Key"""
|
|
|
|
cluster_distro = wtypes.StringType(min_length=1, max_length=255)
|
|
"""The Cluster distro for the bay, ex - coreos, fedora-atomic."""
|
|
|
|
links = wsme.wsattr([link.Link], readonly=True)
|
|
"""A list containing a self link and associated baymodel links"""
|
|
|
|
http_proxy = wtypes.StringType(min_length=1, max_length=255)
|
|
"""http_proxy for the bay """
|
|
|
|
https_proxy = wtypes.StringType(min_length=1, max_length=255)
|
|
"""https_proxy for the bay """
|
|
|
|
no_proxy = wtypes.StringType(min_length=1, max_length=255)
|
|
"""Its comma separated list of ip for which proxies should not
|
|
used in the bay"""
|
|
|
|
registry_enabled = wsme.wsattr(types.boolean, default=False)
|
|
"""Indicates whether the docker registry is enabled"""
|
|
|
|
labels = wtypes.DictType(str, str)
|
|
"""One or more key/value pairs"""
|
|
|
|
tls_disabled = wsme.wsattr(types.boolean, default=False)
|
|
"""Indicates whether the TLS should be disabled"""
|
|
|
|
public = wsme.wsattr(types.boolean, default=False)
|
|
"""Indicates whether the baymodel is public or not."""
|
|
|
|
server_type = wsme.wsattr(wtypes.StringType(min_length=1,
|
|
max_length=255),
|
|
default='vm')
|
|
"""Server type for this bay model """
|
|
|
|
def __init__(self, **kwargs):
|
|
self.fields = []
|
|
for field in objects.BayModel.fields:
|
|
# Skip fields we do not expose.
|
|
if not hasattr(self, field):
|
|
continue
|
|
self.fields.append(field)
|
|
setattr(self, field, kwargs.get(field, wtypes.Unset))
|
|
|
|
@staticmethod
|
|
def _convert_with_links(baymodel, url, expand=True):
|
|
if not expand:
|
|
baymodel.unset_fields_except(['uuid', 'name', 'image_id',
|
|
'apiserver_port', 'coe'])
|
|
|
|
baymodel.links = [link.Link.make_link('self', url,
|
|
'baymodels', baymodel.uuid),
|
|
link.Link.make_link('bookmark', url,
|
|
'baymodels', baymodel.uuid,
|
|
bookmark=True)]
|
|
return baymodel
|
|
|
|
@classmethod
|
|
def convert_with_links(cls, rpc_baymodel, expand=True):
|
|
baymodel = BayModel(**rpc_baymodel.as_dict())
|
|
return cls._convert_with_links(baymodel, pecan.request.host_url,
|
|
expand)
|
|
|
|
@classmethod
|
|
def sample(cls, expand=True):
|
|
sample = cls(
|
|
uuid='27e3153e-d5bf-4b7e-b517-fb518e17f34c',
|
|
name='example',
|
|
image_id='Fedora-k8s',
|
|
flavor_id='m1.small',
|
|
master_flavor_id='m1.small',
|
|
dns_nameserver='8.8.1.1',
|
|
keypair_id='keypair1',
|
|
external_network_id='ffc44e4a-2319-4062-bce0-9ae1c38b05ba',
|
|
fixed_network='private',
|
|
network_driver='libnetwork',
|
|
apiserver_port=8080,
|
|
docker_volume_size=25,
|
|
cluster_distro='fedora-atomic',
|
|
ssh_authorized_key='ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAB',
|
|
coe='kubernetes',
|
|
http_proxy='http://proxy.com:123',
|
|
https_proxy='https://proxy.com:123',
|
|
no_proxy='192.168.0.1,192.168.0.2,192.168.0.3',
|
|
labels={'key1': 'val1', 'key2': 'val2'},
|
|
server_type='vm',
|
|
created_at=timeutils.utcnow(),
|
|
updated_at=timeutils.utcnow(),
|
|
public=False),
|
|
return cls._convert_with_links(sample, 'http://localhost:9511', expand)
|
|
|
|
|
|
class BayModelCollection(collection.Collection):
|
|
"""API representation of a collection of baymodels."""
|
|
|
|
baymodels = [BayModel]
|
|
"""A list containing baymodels objects"""
|
|
|
|
def __init__(self, **kwargs):
|
|
self._type = 'baymodels'
|
|
|
|
@staticmethod
|
|
def convert_with_links(rpc_baymodels, limit, url=None, expand=False,
|
|
**kwargs):
|
|
collection = BayModelCollection()
|
|
collection.baymodels = [BayModel.convert_with_links(p, expand)
|
|
for p in rpc_baymodels]
|
|
collection.next = collection.get_next(limit, url=url, **kwargs)
|
|
return collection
|
|
|
|
@classmethod
|
|
def sample(cls):
|
|
sample = cls()
|
|
sample.baymodels = [BayModel.sample(expand=False)]
|
|
return sample
|
|
|
|
|
|
class BayModelsController(rest.RestController):
|
|
"""REST controller for BayModels."""
|
|
|
|
_custom_actions = {
|
|
'detail': ['GET'],
|
|
}
|
|
|
|
def _get_baymodels_collection(self, marker, limit,
|
|
sort_key, sort_dir, expand=False,
|
|
resource_url=None):
|
|
|
|
limit = api_utils.validate_limit(limit)
|
|
sort_dir = api_utils.validate_sort_dir(sort_dir)
|
|
|
|
marker_obj = None
|
|
if marker:
|
|
marker_obj = objects.BayModel.get_by_uuid(pecan.request.context,
|
|
marker)
|
|
|
|
baymodels = objects.BayModel.list(pecan.request.context, limit,
|
|
marker_obj, sort_key=sort_key,
|
|
sort_dir=sort_dir)
|
|
|
|
return BayModelCollection.convert_with_links(baymodels, limit,
|
|
url=resource_url,
|
|
expand=expand,
|
|
sort_key=sort_key,
|
|
sort_dir=sort_dir)
|
|
|
|
def _get_image_data(self, context, image_ident):
|
|
"""Retrieves os_distro and other metadata from the Glance image.
|
|
|
|
:param image_ident: image id or name of baymodel.
|
|
"""
|
|
try:
|
|
cli = clients.OpenStackClients(context)
|
|
return api_utils.get_openstack_resource(cli.glance().images,
|
|
image_ident, 'images')
|
|
except glanceclient.exc.NotFound:
|
|
raise exception.ImageNotFound(image_id=image_ident)
|
|
except glanceclient.exc.HTTPForbidden:
|
|
raise exception.ImageNotAuthorized(image_id=image_ident)
|
|
|
|
@policy.enforce_wsgi("baymodel")
|
|
@expose.expose(BayModelCollection, types.uuid, int, wtypes.text,
|
|
wtypes.text)
|
|
def get_all(self, marker=None, limit=None, sort_key='id',
|
|
sort_dir='asc'):
|
|
"""Retrieve a list of baymodels.
|
|
|
|
:param marker: pagination marker for large data sets.
|
|
:param limit: maximum number of resources to return in a single result.
|
|
:param sort_key: column to sort results by. Default: id.
|
|
:param sort_dir: direction to sort. "asc" or "desc". Default: asc.
|
|
"""
|
|
return self._get_baymodels_collection(marker, limit, sort_key,
|
|
sort_dir)
|
|
|
|
@policy.enforce_wsgi("baymodel")
|
|
@expose.expose(BayModelCollection, types.uuid, int, wtypes.text,
|
|
wtypes.text)
|
|
def detail(self, marker=None, limit=None, sort_key='id',
|
|
sort_dir='asc'):
|
|
"""Retrieve a list of baymodels with detail.
|
|
|
|
:param marker: pagination marker for large data sets.
|
|
:param limit: maximum number of resources to return in a single result.
|
|
:param sort_key: column to sort results by. Default: id.
|
|
:param sort_dir: direction to sort. "asc" or "desc". Default: asc.
|
|
"""
|
|
# NOTE(lucasagomes): /detail should only work agaist collections
|
|
parent = pecan.request.path.split('/')[:-1][-1]
|
|
if parent != "baymodels":
|
|
raise exception.HTTPNotFound
|
|
|
|
expand = True
|
|
resource_url = '/'.join(['baymodels', 'detail'])
|
|
return self._get_baymodels_collection(marker, limit,
|
|
sort_key, sort_dir, expand,
|
|
resource_url)
|
|
|
|
@policy.enforce_wsgi("baymodel", "get")
|
|
@expose.expose(BayModel, types.uuid_or_name)
|
|
def get_one(self, baymodel_ident):
|
|
"""Retrieve information about the given baymodel.
|
|
|
|
:param baymodel_ident: UUID or logical name of a baymodel.
|
|
"""
|
|
rpc_baymodel = api_utils.get_rpc_resource('BayModel', baymodel_ident)
|
|
return BayModel.convert_with_links(rpc_baymodel)
|
|
|
|
def check_keypair_exists(self, context, keypair):
|
|
"""Checks the existence of the keypair"""
|
|
cli = clients.OpenStackClients(context)
|
|
try:
|
|
cli.nova().keypairs.get(keypair)
|
|
except nova_exc.NotFound:
|
|
raise exception.KeyPairNotFound(keypair=keypair)
|
|
|
|
@policy.enforce_wsgi("baymodel", "create")
|
|
@expose.expose(BayModel, body=BayModel, status_code=201)
|
|
@validation.enforce_network_driver_types_create()
|
|
def post(self, baymodel):
|
|
"""Create a new baymodel.
|
|
|
|
:param baymodel: a baymodel within the request body.
|
|
"""
|
|
baymodel_dict = baymodel.as_dict()
|
|
context = pecan.request.context
|
|
self.check_keypair_exists(context, baymodel_dict['keypair_id'])
|
|
baymodel_dict['project_id'] = context.project_id
|
|
baymodel_dict['user_id'] = context.user_id
|
|
image_data = self._get_image_data(context, baymodel_dict['image_id'])
|
|
if image_data.get('os_distro'):
|
|
baymodel_dict['cluster_distro'] = image_data['os_distro']
|
|
else:
|
|
raise exception.OSDistroFieldNotFound(
|
|
image_id=baymodel_dict['image_id'])
|
|
# check permissions for making baymodel public
|
|
if baymodel_dict['public']:
|
|
if not policy.enforce(context, "baymodel:publish", None,
|
|
do_raise=False):
|
|
raise exception.BaymodelPublishDenied()
|
|
|
|
new_baymodel = objects.BayModel(context, **baymodel_dict)
|
|
new_baymodel.create()
|
|
# Set the HTTP Location Header
|
|
pecan.response.location = link.build_url('baymodels',
|
|
new_baymodel.uuid)
|
|
return BayModel.convert_with_links(new_baymodel)
|
|
|
|
@policy.enforce_wsgi("baymodel", "update")
|
|
@wsme.validate(types.uuid_or_name, [BayModelPatchType])
|
|
@expose.expose(BayModel, types.uuid_or_name, body=[BayModelPatchType])
|
|
@validation.enforce_network_driver_types_update()
|
|
def patch(self, baymodel_ident, patch):
|
|
"""Update an existing baymodel.
|
|
|
|
:param baymodel_ident: UUID or logic name of a baymodel.
|
|
:param patch: a json PATCH document to apply to this baymodel.
|
|
"""
|
|
context = pecan.request.context
|
|
rpc_baymodel = api_utils.get_rpc_resource('BayModel', baymodel_ident)
|
|
try:
|
|
baymodel_dict = rpc_baymodel.as_dict()
|
|
baymodel = BayModel(**api_utils.apply_jsonpatch(
|
|
baymodel_dict,
|
|
patch))
|
|
except api_utils.JSONPATCH_EXCEPTIONS as e:
|
|
raise exception.PatchError(patch=patch, reason=e)
|
|
|
|
# check permissions when updating baymodel public flag
|
|
if rpc_baymodel.public != baymodel.public:
|
|
if not policy.enforce(context, "baymodel:publish", None,
|
|
do_raise=False):
|
|
raise exception.BaymodelPublishDenied()
|
|
|
|
# Update only the fields that have changed
|
|
for field in objects.BayModel.fields:
|
|
try:
|
|
patch_val = getattr(baymodel, field)
|
|
except AttributeError:
|
|
# Ignore fields that aren't exposed in the API
|
|
continue
|
|
if patch_val == wtypes.Unset:
|
|
patch_val = None
|
|
if rpc_baymodel[field] != patch_val:
|
|
rpc_baymodel[field] = patch_val
|
|
|
|
rpc_baymodel.save()
|
|
return BayModel.convert_with_links(rpc_baymodel)
|
|
|
|
@policy.enforce_wsgi("baymodel")
|
|
@expose.expose(None, types.uuid_or_name, status_code=204)
|
|
def delete(self, baymodel_ident):
|
|
"""Delete a baymodel.
|
|
|
|
:param baymodel_ident: UUID or logical name of a baymodel.
|
|
"""
|
|
rpc_baymodel = api_utils.get_rpc_resource('BayModel', baymodel_ident)
|
|
rpc_baymodel.destroy()
|