nodepool/nodepool/webapp.py
Ian Wienand 89790013f3 Consolidate node_list, add generic filter
node_list takes an argument "detail" which adds a rather arbitrary
list of results to the output.  This comes from the command-line,
where we're trying to keep width under a certain length; but doesn't
make as much sense here (especially for json).

For dashboard type applications, replace this with a simple "fields"
parameter which, if set, will only return those fields it sees in the
common text output function.

Note, this purposely doesn't apply to the JSON output, as it expected
client-side filtering is more appropriate there.  We could also add
generic field support to the command-line tools, if considered
worthwhile.

Add some documentation on all the end-points, and add info about these
parameters.

Change-Id: Ifbf1019b77368124961e7aa28dae403cabe50de1
2018-03-01 11:14:03 +11:00

137 lines
4.2 KiB
Python

# Copyright 2012 Hewlett-Packard Development Company, L.P.
# Copyright 2013 OpenStack Foundation
#
# 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 json
import logging
import threading
import time
from paste import httpserver
import webob
from webob import dec
from nodepool import status
"""Nodepool main web app.
Nodepool supports HTTP requests directly against it for determining
status. These responses are provided as preformatted text for now, but
should be augmented or replaced with JSON data structures.
"""
class Cache(object):
def __init__(self, expiry=1):
self.cache = {}
self.expiry = expiry
def get(self, key):
now = time.time()
if key in self.cache:
lm, value = self.cache[key]
if now > lm + self.expiry:
del self.cache[key]
return None
return (lm, value)
def put(self, key, value):
now = time.time()
res = (now, value)
self.cache[key] = res
return res
class WebApp(threading.Thread):
log = logging.getLogger("nodepool.WebApp")
def __init__(self, nodepool, port=8005, listen_address='0.0.0.0',
cache_expiry=1):
threading.Thread.__init__(self)
self.nodepool = nodepool
self.port = port
self.listen_address = listen_address
self.cache = Cache(cache_expiry)
self.cache_expiry = cache_expiry
self.daemon = True
self.server = httpserver.serve(dec.wsgify(self.app),
host=self.listen_address,
port=self.port, start_loop=False)
def run(self):
self.server.serve_forever()
def stop(self):
self.server.server_close()
def get_cache(self, path, params):
# TODO quick and dirty way to take query parameters
# into account when caching data
if params:
index = path + json.dumps(params.dict_of_lists(), sort_keys=True)
else:
index = path
result = self.cache.get(index)
if result:
return result
if path.endswith('.json'):
out_fmt = 'json'
path = path[:-5]
else:
out_fmt = 'pretty'
zk = self.nodepool.getZK()
if path == '/image-list':
results = status.image_list(zk)
elif path == '/dib-image-list':
results = status.dib_image_list(zk)
elif path == '/node-list':
results = status.node_list(zk,
node_id=params.get('node_id'))
elif path == '/request-list':
results = status.request_list(zk)
else:
return None
fields = None
if params.get('fields'):
fields = params.get('fields').split(',')
output = status.output(results, out_fmt, fields)
return self.cache.put(index, output)
def app(self, request):
result = self.get_cache(request.path, request.params)
if result is None:
raise webob.exc.HTTPNotFound()
last_modified, output = result
if request.path.endswith('.json'):
content_type = 'application/json'
else:
content_type = 'text/plain'
response = webob.Response(body=output,
charset='UTF-8',
content_type=content_type)
response.headers['Access-Control-Allow-Origin'] = '*'
response.cache_control.public = True
response.cache_control.max_age = self.cache_expiry
response.last_modified = last_modified
response.expires = last_modified + self.cache_expiry
return response.conditional_response_app