bowl.api module
This module is the web server for running the REST API of bowl.
Created on 14 March 2014
@author: Charlie Lewis
-
class bowl.api.api_add[source]
This class is resposible for adding a service
-
POST()[source]
POSTs the new service being added.
-
class bowl.api.api_connect[source]
This class is resposible for creating a connection to a docker host.
-
GET(host)[source]
creates a connection to a new docker host.
-
class bowl.api.api_delete[source]
This class is resposible for deleting an image.
-
GET(image)[source]
deletes the specified image.
-
class bowl.api.api_disconnect[source]
This class is resposible for disconnecting a connection to a docker host.
-
GET(host)[source]
disconnects the specified docker host.
-
class bowl.api.api_grant[source]
This class is resposible for granting access to a container for a user.
-
GET(user, container)[source]
grants access for the specified user to a container.
-
class bowl.api.api_hosts[source]
This class is resposible for listing the connected docker hosts.
-
GET()[source]
GETs the connected docker hosts.
| Returns: | returns the list of connected docker hosts. |
|---|
-
class bowl.api.api_image_import[source]
This class is resposible for importing an image.
-
POST()[source]
POSTs the image being imported.
-
class bowl.api.api_images[source]
This class is resposible for listing the images.
-
GET()[source]
GETs the images.
| Returns: | returns the list of images. |
|---|
-
class bowl.api.api_info[source]
This class is resposible for giving system-wide information.
-
GET()[source]
GETs the system-wide information and renders it.
| Returns: | returns the information. |
|---|
-
class bowl.api.api_kill[source]
This class is resposible for killing a container.
-
GET(container)[source]
the container to kill.
-
class bowl.api.api_link[source]
This class is resposible for linking a service repository host.
-
GET(repository)[source]
creates a link to a new service repository.
-
class bowl.api.api_list[source]
This class is resposible for listing the running containers.
-
GET()[source]
GETs the list of running containers.
| Returns: | returns the list of running containers. |
|---|
-
class bowl.api.api_login[source]
This class is resposible for logging in.
-
POST()[source]
POSTs the user to login.
-
class bowl.api.api_logout[source]
This class is resposible for logging out.
-
POST()[source]
POSTs the user to logout.
-
class bowl.api.api_logs[source]
This class is resposible for returning logs of a server.
-
GET(container)[source]
GETs the logs of a server.
| Returns: | returns the logs of a server. |
|---|
-
class bowl.api.api_new[source]
This class is resposible for creating a new container.
-
POST()[source]
POSTs the creation of a new container.
-
class bowl.api.api_remove[source]
This class is resposible for removing a container.
-
POST()[source]
POSTs the removal of a container.
-
class bowl.api.api_repo_services[source]
This class is resposible for sending services to the client.
-
GET()[source]
GETs the services and packages them up and serves them up as a static
file.
-
make_tarfile(output_filename, source_dir)[source]
-
class bowl.api.api_repositories[source]
This class is resposible for listing the connected repositories.
-
GET()[source]
GETs the connected repositories.
| Returns: | returns the list of connected repositories. |
|---|
-
class bowl.api.api_revoke[source]
This class is resposible for revokeing access to a container for a user.
-
GET(user, container)[source]
revokes access for the specified user to a container.
-
class bowl.api.api_services[source]
This class is resposible for listing services.
-
GET()[source]
GETs the list of services.
-
class bowl.api.api_snapshot[source]
This class is resposible for snapshotting a container.
-
GET(container)[source]
creates a snapshot of a container.
-
class bowl.api.api_snapshots[source]
This class is resposible for listing snapshots.
-
GET()[source]
GETs the list of snapshots.
-
class bowl.api.api_subtract[source]
This class is resposible for subtracting services.
-
GET(os, version, service_type, name)[source]
GETs the service to subtract.
-
class bowl.api.api_test[source]
This class is resposible for running the tests.
-
GET()[source]
runs the tests.
-
class bowl.api.api_unlink[source]
This class is resposible for unlinking a service repository host.
-
GET(repository)[source]
unlinks the specified service repository.
-
class bowl.api.api_uptime[source]
This class is resposible for returning the uptime of the API server.
-
GET()[source]
GETs the uptime of the API server.
| Returns: | returns the uptime of the API server. |
|---|
-
class bowl.api.api_version[source]
This class is resposible for returning the version of bowl.
-
GET()[source]
GETs the version of bowl.
| Returns: | returns the version of bowl. |
|---|
-
class bowl.api.main(port=8080, host='0.0.0.0')[source]
Bases: object
This class is responsible for initializing the urls and web server.
-
setup()[source]
-
class bowl.api.root[source]
This class is resposible for giving information about the rest server.
-
GET()[source]
GETs the information about the rest server and renders it.
| Returns: | returns the information |
|---|