aboutsummaryrefslogtreecommitdiffstats
path: root/moonv4/moon_consul/moon_consul/api
diff options
context:
space:
mode:
authorRuan HE <ruan.he@orange.com>2017-07-20 06:42:31 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-07-20 06:42:31 +0000
commitb7c121536061d823b6e2b5063db891405672b259 (patch)
treeff9b1f0f11449c77cad92516c58566917039e387 /moonv4/moon_consul/moon_consul/api
parent6a59009e64f727bcf3c67a8ae45a02e4137bfb99 (diff)
parenta512f3efc3b72ccd0d4d7ccda97833d816836f8d (diff)
Merge "First version of the Consul component"
Diffstat (limited to 'moonv4/moon_consul/moon_consul/api')
-rw-r--r--moonv4/moon_consul/moon_consul/api/__init__.py0
-rw-r--r--moonv4/moon_consul/moon_consul/api/database.py72
-rw-r--r--moonv4/moon_consul/moon_consul/api/generic.py78
-rw-r--r--moonv4/moon_consul/moon_consul/api/messenger.py67
-rw-r--r--moonv4/moon_consul/moon_consul/api/openstack.py63
-rw-r--r--moonv4/moon_consul/moon_consul/api/slave.py72
-rw-r--r--moonv4/moon_consul/moon_consul/api/system.py169
7 files changed, 521 insertions, 0 deletions
diff --git a/moonv4/moon_consul/moon_consul/api/__init__.py b/moonv4/moon_consul/moon_consul/api/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/moonv4/moon_consul/moon_consul/api/__init__.py
diff --git a/moonv4/moon_consul/moon_consul/api/database.py b/moonv4/moon_consul/moon_consul/api/database.py
new file mode 100644
index 00000000..5533b1a5
--- /dev/null
+++ b/moonv4/moon_consul/moon_consul/api/database.py
@@ -0,0 +1,72 @@
+# Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+# This software is distributed under the terms and conditions of the 'Apache-2.0'
+# license which can be found in the file 'LICENSE' in this package distribution
+# or at 'http://www.apache.org/licenses/LICENSE-2.0'.
+"""
+Assignments allow to connect data with elements of perimeter
+
+"""
+
+from flask import request
+from flask_restful import Resource
+# from oslo_config import cfg
+from oslo_log import log as logging
+# from moon_interface.tools import check_auth
+
+__version__ = "0.1.0"
+
+LOG = logging.getLogger(__name__)
+# CONF = cfg.CONF
+
+
+class Database(Resource):
+ """
+ Endpoint for database requests
+ """
+
+ __urls__ = (
+ "/configuration/database",
+ )
+
+ def __init__(self, *args, **kwargs):
+ self.conf = kwargs.get('conf', {})
+
+ # @check_auth
+ def get(self):
+ """Retrieve database configuration
+
+ :return: {
+ "database": {
+ "hostname": "hostname for the main database",
+ "port": "port for the main database",
+ "user": "user for the main database",
+ "password": "password for the main database",
+ "protocol": "protocol to use (eg. mysql+pymysql)",
+ "driver": "driver to use",
+ }
+ }
+ """
+ url = self.conf.DB_URL
+ driver = self.conf.DB_DRIVER
+ hostname = url.split("@")[-1].split(":")[0].split("/")[0]
+ try:
+ port = int(url.split("@")[-1].split(":")[1].split("/")[0])
+ except ValueError:
+ port = None
+ except IndexError:
+ port = None
+ user = url.split("//")[1].split(":")[0]
+ # TODO: password must be encrypted
+ password = url.split(":")[2].split("@")[0]
+ protocol = url.split(":")[0]
+ return {
+ "database": {
+ "hostname": hostname,
+ "port": port,
+ "user": user,
+ "password": password,
+ "protocol": protocol,
+ "driver": driver
+ }
+ }
+
diff --git a/moonv4/moon_consul/moon_consul/api/generic.py b/moonv4/moon_consul/moon_consul/api/generic.py
new file mode 100644
index 00000000..69f25eef
--- /dev/null
+++ b/moonv4/moon_consul/moon_consul/api/generic.py
@@ -0,0 +1,78 @@
+# Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+# This software is distributed under the terms and conditions of the 'Apache-2.0'
+# license which can be found in the file 'LICENSE' in this package distribution
+# or at 'http://www.apache.org/licenses/LICENSE-2.0'.
+"""
+Those API are helping API used to manage the Moon platform.
+"""
+
+from flask_restful import Resource, request
+# from oslo_config import cfg
+from oslo_log import log as logging
+# from moon_utilities.security_functions import call
+import moon_consul.api
+# from moon_utilities.auth import check_auth
+
+__version__ = "0.1.0"
+
+LOG = logging.getLogger(__name__)
+# CONF = cfg.CONF
+
+
+class API(Resource):
+ """
+ Endpoint for API requests
+ """
+
+ __urls__ = (
+ "/api",
+ "/api/",
+ "/api/<string:group_id>",
+ "/api/<string:group_id>/",
+ "/api/<string:group_id>/<string:endpoint_id>")
+
+ # @check_auth
+ def get(self, group_id="", endpoint_id="", user_id=""):
+ """Retrieve all API endpoints or a specific endpoint if endpoint_id is given
+
+ :param group_id: the name of one existing group (ie generic, ...)
+ :param endpoint_id: the name of one existing component (ie Logs, Status, ...)
+ :return: {
+ "group_name": {
+ "endpoint_name": {
+ "description": "a description",
+ "methods": {
+ "get": "description of the HTTP method"
+ },
+ "urls": ('/api', '/api/', '/api/<string:endpoint_id>')
+ }
+ }
+ """
+ __methods = ("get", "post", "put", "delete", "options", "patch")
+ api_list = filter(lambda x: "__" not in x, dir(moon_consul.api))
+ api_desc = dict()
+ for api_name in api_list:
+ api_desc[api_name] = {}
+ group_api_obj = eval("moon_interface.api.{}".format(api_name))
+ api_desc[api_name]["description"] = group_api_obj.__doc__
+ if "__version__" in dir(group_api_obj):
+ api_desc[api_name]["version"] = group_api_obj.__version__
+ object_list = list(filter(lambda x: "__" not in x, dir(group_api_obj)))
+ for obj in map(lambda x: eval("moon_interface.api.{}.{}".format(api_name, x)), object_list):
+ if "__urls__" in dir(obj):
+ api_desc[api_name][obj.__name__] = dict()
+ api_desc[api_name][obj.__name__]["urls"] = obj.__urls__
+ api_desc[api_name][obj.__name__]["methods"] = dict()
+ for _method in filter(lambda x: x in __methods, dir(obj)):
+ docstring = eval("moon_interface.api.{}.{}.{}.__doc__".format(api_name, obj.__name__, _method))
+ api_desc[api_name][obj.__name__]["methods"][_method] = docstring
+ api_desc[api_name][obj.__name__]["description"] = str(obj.__doc__)
+ if group_id in api_desc:
+ if endpoint_id in api_desc[group_id]:
+ return {group_id: {endpoint_id: api_desc[group_id][endpoint_id]}}
+ elif len(endpoint_id) > 0:
+ LOG.error("Unknown endpoint_id {}".format(endpoint_id))
+ return {"error": "Unknown endpoint_id {}".format(endpoint_id)}
+ return {group_id: api_desc[group_id]}
+ return api_desc
+
diff --git a/moonv4/moon_consul/moon_consul/api/messenger.py b/moonv4/moon_consul/moon_consul/api/messenger.py
new file mode 100644
index 00000000..28026baf
--- /dev/null
+++ b/moonv4/moon_consul/moon_consul/api/messenger.py
@@ -0,0 +1,67 @@
+# Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+# This software is distributed under the terms and conditions of the 'Apache-2.0'
+# license which can be found in the file 'LICENSE' in this package distribution
+# or at 'http://www.apache.org/licenses/LICENSE-2.0'.
+"""
+Assignments allow to connect data with elements of perimeter
+
+"""
+
+from flask import request
+from flask_restful import Resource
+# from oslo_config import cfg
+from oslo_log import log as logging
+# from moon_interface.tools import check_auth
+
+__version__ = "0.1.0"
+
+LOG = logging.getLogger(__name__)
+# CONF = cfg.CONF
+
+
+class Messenger(Resource):
+ """
+ Endpoint for messenger requests
+ """
+
+ __urls__ = (
+ "/configuration/messenger",
+ )
+
+ def __init__(self, *args, **kwargs):
+ self.conf = kwargs.get('conf', {})
+
+ # @check_auth
+ def get(self):
+ """Retrieve messenger configuration
+
+ :return: {
+ "messenger": {
+ "hostname": "hostname for the messenger server",
+ "port": "port for the main messenger server",
+ "user": "user for the main messenger server",
+ "password": "password for the main messenger server",
+ "protocol": "protocol to use (eg. rabbit)"
+ }
+ }
+ """
+ url = self.conf.TRANSPORT_URL
+ hostname = url.split("@")[-1].split(":")[0].split("/")[0]
+ try:
+ port = int(url.split("@")[-1].split(":")[1].split("/")[0])
+ except ValueError:
+ port = None
+ user = url.split("//")[1].split(":")[0]
+ # TODO: password must be encrypted
+ password = url.split(":")[2].split("@")[0]
+ protocol = url.split(":")[0]
+ return {
+ "messenger": {
+ "hostname": hostname,
+ "port": port,
+ "user": user,
+ "password": password,
+ "protocol": protocol,
+ }
+ }
+
diff --git a/moonv4/moon_consul/moon_consul/api/openstack.py b/moonv4/moon_consul/moon_consul/api/openstack.py
new file mode 100644
index 00000000..5d776981
--- /dev/null
+++ b/moonv4/moon_consul/moon_consul/api/openstack.py
@@ -0,0 +1,63 @@
+# Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+# This software is distributed under the terms and conditions of the 'Apache-2.0'
+# license which can be found in the file 'LICENSE' in this package distribution
+# or at 'http://www.apache.org/licenses/LICENSE-2.0'.
+"""
+Assignments allow to connect data with elements of perimeter
+
+"""
+
+from flask import request
+from flask_restful import Resource
+# from oslo_config import cfg
+from oslo_log import log as logging
+# from moon_interface.tools import check_auth
+
+__version__ = "0.1.0"
+
+LOG = logging.getLogger(__name__)
+# CONF = cfg.CONF
+
+
+class Keystone(Resource):
+ """
+ Endpoint for Keystone requests
+ """
+
+ __urls__ = (
+ "/configuration/os/keystone",
+ )
+
+ def __init__(self, *args, **kwargs):
+ self.conf = kwargs.get('conf', {})
+
+ # @check_auth
+ def get(self):
+ """Retrieve Keystone configuration
+
+ :return: {
+ "keystone": {
+ "url": "hostname for the Keystone server",
+ "user": "user for the Keystone server",
+ "password": "password for the Keystone server",
+ "domain": "domain to use against Keystone server",
+ "project": "main project to use",
+ "check_token": "yes, no or strict",
+ "server_crt": "certificate to use when using https"
+ }
+ }
+ """
+ # TODO: password must be encrypted
+ # TODO: check_token is a sensitive information it must not be update through the network
+ return {
+ "keystone": {
+ "url": self.conf.KEYSTONE_URL,
+ "user": self.conf.KEYSTONE_USER,
+ "password": self.conf.KEYSTONE_PASSWORD,
+ "domain": self.conf.KEYSTONE_DOMAIN,
+ "project": self.conf.KEYSTONE_PROJECT,
+ "check_token": self.conf.KEYSTONE_CHECK_TOKEN,
+ "server_crt": self.conf.KEYSTONE_SERVER_CRT
+ }
+ }
+
diff --git a/moonv4/moon_consul/moon_consul/api/slave.py b/moonv4/moon_consul/moon_consul/api/slave.py
new file mode 100644
index 00000000..7f8acb28
--- /dev/null
+++ b/moonv4/moon_consul/moon_consul/api/slave.py
@@ -0,0 +1,72 @@
+# Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+# This software is distributed under the terms and conditions of the 'Apache-2.0'
+# license which can be found in the file 'LICENSE' in this package distribution
+# or at 'http://www.apache.org/licenses/LICENSE-2.0'.
+"""
+Assignments allow to connect data with elements of perimeter
+
+"""
+
+from flask import request
+from flask_restful import Resource
+# from oslo_config import cfg
+from oslo_log import log as logging
+# from moon_interface.tools import check_auth
+
+__version__ = "0.1.0"
+
+LOG = logging.getLogger(__name__)
+# CONF = cfg.CONF
+
+
+class Slave(Resource):
+ """
+ Endpoint for slave requests
+ """
+
+ __urls__ = (
+ "/configuration/slave",
+ )
+
+ def __init__(self, *args, **kwargs):
+ self.conf = kwargs.get('conf', {})
+
+ # @check_auth
+ def get(self):
+ """Retrieve slave configuration
+
+ If current server is a slave:
+ :return: {
+ "slave": {
+ "name": "name of the slave",
+ "master_url": "URL of the master",
+ "user": [
+ {
+ "username": "user to be used to connect to the master",
+ "password": "password to be used to connect to the master"
+ }
+ ]
+ }
+ }
+ else:
+ :return: {
+ "slave": {}
+ }
+ """
+ # TODO: password must be encrypted
+ if self.conf.SLAVE_NAME:
+ return {
+ "slave": {
+ "name": self.conf.SLAVE_NAME,
+ "master_url": self.conf.MASTER_URL,
+ "user": [
+ {
+ "username": self.conf.MASTER_LOGIN,
+ "password": self.conf.MASTER_PASSWORD
+ }
+ ]
+ }
+ }
+ else:
+ return {"slave": {}}
+
diff --git a/moonv4/moon_consul/moon_consul/api/system.py b/moonv4/moon_consul/moon_consul/api/system.py
new file mode 100644
index 00000000..e21d9de2
--- /dev/null
+++ b/moonv4/moon_consul/moon_consul/api/system.py
@@ -0,0 +1,169 @@
+# Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+# This software is distributed under the terms and conditions of the 'Apache-2.0'
+# license which can be found in the file 'LICENSE' in this package distribution
+# or at 'http://www.apache.org/licenses/LICENSE-2.0'.
+"""
+Assignments allow to connect data with elements of perimeter
+
+"""
+
+from flask import request
+from flask_restful import Resource
+# from oslo_config import cfg
+from oslo_log import log as logging
+# from moon_interface.tools import check_auth
+
+__version__ = "0.1.0"
+
+LOG = logging.getLogger(__name__)
+# CONF = cfg.CONF
+
+
+class Docker(Resource):
+ """
+ Endpoint for system requests
+ """
+
+ __urls__ = (
+ "/configuration/docker",
+ )
+
+ def __init__(self, *args, **kwargs):
+ self.conf = kwargs.get('conf', {})
+
+ # @check_auth
+ def get(self):
+ """Retrieve docker configuration
+
+ :return: {
+ "docker": {
+ "url": "hostname for the docker server (eg. /var/run/docker.sock)",
+ "port": "port of the server",
+ "user": "user of the server",
+ "password": "password of the server",
+ "protocol": "protocol to use (eg. unix)"
+ }
+ }
+ """
+ url = self.conf.DOCKER_URL
+ # LOG.info(url)
+ # hostname = url.split("@")[-1].split(":")[0].split("/")[0]
+ # try:
+ # port = int(url.split("@")[-1].split(":")[1].split("/")[0])
+ # except ValueError:
+ # port = None
+ # user = url.split("//")[1].split(":")[0]
+ # # TODO: password must be encrypted
+ # try:
+ # password = url.split(":")[2].split("@")[0]
+ # except IndexError:
+ # password = ""
+ # protocol = url.split(":")[0]
+ return {
+ "docker": {
+ "url": self.conf.DOCKER_URL,
+ # "port": port,
+ # "user": user,
+ # "password": password,
+ # "protocol": protocol,
+ }
+ }
+
+
+class Components(Resource):
+ """
+ Endpoint for requests on components
+ """
+
+ __urls__ = (
+ "/configuration/components",
+ "/configuration/components/",
+ "/configuration/components/<string:id_or_name>",
+ )
+
+ def __init__(self, *args, **kwargs):
+ self.conf = kwargs.get('conf', {})
+
+ # @check_auth
+ def get(self, id_or_name=None):
+ """Retrieve component list
+
+ :param id_or_name: ID or name of the component
+
+ :return: {
+ "components": [
+ {
+ "hostname": "hostname of the component",
+ "port": "port of the server in this component",
+ "id": "id of the component",
+ "keystone_id": "Keystone project ID served by this component if needed"
+ },
+ ]
+ }
+ """
+ if id_or_name:
+ for _component in self.conf.COMPONENTS:
+ if id_or_name in (_component["hostname"], _component["id"]):
+ return {
+ "components": [_component, ]
+ }
+ return {"components": []}
+ return {"components": self.conf.COMPONENTS}
+
+ # @check_auth
+ def put(self, id_or_name=None):
+ """Ask for adding a new component
+ The response gives the TCP port to be used
+
+ :param id_or_name: ID or name of the component
+ :request body: {
+ "hostname": "hostname of the new component",
+ "keystone_id": "Keystone ID mapped to that component (if needed)"
+ }
+ :return: {
+ "components": [
+ {
+ "hostname": "hostname of the component",
+ "port": "port of the server in this component",
+ "id": "id of the component",
+ "keystone_id": "Keystone project ID served by this component"
+ }
+ ]
+ }
+ """
+ if not id_or_name:
+ return "Need a name for that component", 400
+ for _component in self.conf.COMPONENTS:
+ if id_or_name in (_component["hostname"], _component["id"]):
+ return "ID already used", 409
+ self.conf.COMPONENTS_PORT_START += 1
+ port = self.conf.COMPONENTS_PORT_START
+ data = request.json
+ new_component = {
+ "hostname": data.get("hostname", id_or_name),
+ "port": port,
+ "id": id_or_name,
+ "keystone_id": data.get("keystone_id", "")
+ }
+ self.conf.COMPONENTS.append(new_component)
+ return {
+ "components": [new_component, ]
+ }
+
+ # @check_auth
+ def delete(self, id_or_name=None):
+ """Delete a component
+
+ :param id_or_name: ID or name of the component
+ :return: {
+ "result": true
+ }
+ """
+ if not id_or_name:
+ return "Need a name for that component", 400
+ for index, _component in enumerate(self.conf.COMPONENTS):
+ if id_or_name in (_component["hostname"], _component["id"]):
+ self.conf.COMPONENTS.pop(index)
+ return {"result": True}
+ return "Cannot find component named {}".format(id_or_name), 403
+