REST API for APEL
The APEL project provides accounting for the Indigo DataCloud project. It is written in Python and uses MySQL.
APEL Cloud Accounting can account for the usage of OpenNebula and OpenStack instances. Accounting "collectors" need to be installed on machines with access to the underlying Cloud infrastructure. The collectors can be found here.
The collectors produce "Usage Records" in the APEL-Cloud v0.2 or v0.4 message formats. Information about these format can be found here.
These records need to be sent as POST requests to the REST endpoint
... is the machine hosting the docker image. A POST request requires an X.509 certificate to authenticate the request. The hostname, which should be the same as the common name (CN) contained in the X.509 certificate, must be listed as a provider here for the request to be authorized.
Accepted records are summarised twice daily. These summaries can be accessed with a GET request to
.../api/v1/cloud/record/summary. Summaries can be filtered using
key=value pairs. See Supported key=value pairs for a list of valid supported
key=value pairs. A GET request requires an IAM access token be included in the request. This token is then sent to the IAM to authenticate the ID of the service requesting access to the summary. This ID needs to be in
yaml/apel_rest_interface.env for access to be authorized. See Authorize new WP5 components to view Summaries for instructions on adding service to
It is currently expected that only the QoS/SLA tool will interact with these summaries.
Features of Version 1.4.0-1
- Accept APEL-Cloud v0.2 and v0.4 usage records via POST requests to the REST endpoint
- Provide access to summaries via GET requests to REST endpoint
Running the docker image on Centos 7 and Ubuntu 16.04
We recommend using the docker image to run the Accounting server and REST interface. As such, having Docker and docker-compose installed is a prerequisite.
See Install Docker Compose for details of how to install docker-compose
Download the source code for the version you wish to deploy, see here for a list of releases and corresponding docker image tag. The source code contains schemas and yaml files needed for deploying via docker.
Register the service as a protected resource with the Indigo Identity Access Management (IAM) service. See here for instructions.
Populate the following variables in
DJANGO_SECRET_KEY: The Django server requires its own "secret". PROVIDERS_URL: Points to the JSON list of Resource Providers IAM_URL: The introspect URL for the IAM repsonsible for token based authN/authZ SERVER_IAM_ID: An IAM ID corresponding to this instance, used to validate tokens. SERVER_IAM_SECRET: An IAM secret corresponding to this instance, used to validate tokens. ALLOWED_FOR_GET: A (Python) list of IAM service IDs allowed to submit GET requests. (e.g. ['ac2f23e0-8103-4581-8014-e0e82c486e36']) ALLOWED_TO_POST: A (Python) list of X.509 HostDNs allowed to submit POST requests, in addition to those listed by the PROVIDERS_URL. (e.g. ['/C=XX/O=XX/OU=XX/L=XX/CN=special_host.test']) BANNED_FROM_POST: A (Python) list of X.509 HostDNs banned from submitting POST requests, even if they are listed by the PROVIDERS_URL. (e.g. ['/C=XX/O=XX/OU=XX/L=XX/CN=banned_host.test']) SERVER_IAM_ID: An IAM ID corresponding to this instance, used to validate tokens. SERVER_IAM_SECRET: An IAM secret corresponding to this instance, used to validate tokens.
Populate the following variables in
MYSQL_ROOT_PASSWORD: The APEL server will use this to communicate with the database. If run_container.sh is deploying the database (which by default it will be), the database root password is set to this. MYSQL_PASSWORD: The APEL server will use this to communicate with the database. If run_container.sh is deploying the database (which by default it will be) the APEL user password is set to this.
MYSQL_PASSWORDwill also need to be added to the password field
Before the REST interface will start, a certificate needs to be added to the container. This can be done by placing a certificate (
apache.crt) and key (
/etc/httpd/ssl/. This directory will be mounted into the container by docker-compose.
root. This is required because this directory gets mounted into the container and it needs to be owned by root for cron jobs in the container to run.
chown -R root docker/etc/cron.d
Launch the containers. It is recommeded to wait 1 minute in order for each container to configure fully before launching the next
docker-compose -f yaml/docker-compose.yaml up -d --force-recreate apel_mysql docker-compose -f yaml/docker-compose.yaml up -d --force-recreate apel_server docker-compose -f yaml/docker-compose.yaml up -d --force-recreate apel_rest_interface
Navigate a web browser to