Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

gdp / README-CAAPI.md @ master

History | View | Annotate | Download (2.45 KB)

1 7f982ac3 Eric Allman
% Other Interfaces To The Global Dataplane
2 b2714365 Eric Allman
3 7f982ac3 Eric Allman
***This documentation is out of date as of 2018-12-07.***
4 b2714365 Eric Allman
5
There are some other interfaces to the GDP, generally referred to
6
as CAAPIs (Common Access APIs).  For the most part these are lightly
7
documented.
8
9 3bfb8d8e Rick Pratt
The RESTful Interface
10 7f982ac3 Eric Allman
=====================
11 3bfb8d8e Rick Pratt
12 79c3499d Rick Pratt
The RESTful interface was originally implemented and deployed in
13
support of the Signposts Project, which was demonstrated at the
14
TerraSwarm Annual Meeting held in October 2017. In addition to the
15
Signposts, several other TerraSwarm demonstrations made use of the
16 3bfb8d8e Rick Pratt
RESTful GDP Gateway deployment.
17
18 79c3499d Rick Pratt
The RESTful gateway provided access to the GDP v1 Network until June
19
2019, when the implementation was adapted and transitioned to the
20
recently deployed GDP v2 Network.
21
22 3bfb8d8e Rick Pratt
If you want to use the deployed RESTful GDP Gateway, please browse to
23 632861ce Eric Allman
the <https://gdp-rest-01.eecs.berkeley.edu/> home page, which will
24 3bfb8d8e Rick Pratt
present hotlinks to the RESTful API (`doc/gdp-rest-interface.html`)
25
and to python client usage example(s). Be advised that gdp-rest-01
26
will not respond to non-SSL-protected (http://) traffic, and requires
27
basic client authentication when executing RESTful actions. Please
28
contact the Swarm Lab for inquires regarding basic client credentials.
29
In addition to programmatic access, you can do GETs from inside a
30
browser such as Firefox or Chrome, but not POSTs.  To use other
31
methods you'll have to use Chrome.  Install the "postman" extension to
32
enable sending of arbitrary methods such as POST and PUT.
33
34
If you want to set up your own RESTful GDP Gateway, please review the
35
gdp-rest-01 server configuration details as documented on the GDP
36
redmine wiki. The production deployment uses a lighttpd server running
37
on Ubuntu 16.04, integrated with an SCGI backend. The gdp-rest daemon
38 79c3499d Rick Pratt
handles requests from SCGI, and leverages gdp-create for log creation.
39 3bfb8d8e Rick Pratt
40
The RESTful GDP Gateway is limited to a RESTful-compatible subset of
41
GDP capabilities, though it provides an easy and rapid way to begin
42
using the GDP. A Web Socket Interface (`gdp-ws') has been deployed on
43
gdp-rest-01 to support access to some non-RESTful GDP functionality
44 79c3499d Rick Pratt
(e.g. log subscriptions) in web browser environments.
45 b2714365 Eric Allman
46
Python Key-Value Store
47 7f982ac3 Eric Allman
======================
48 b2714365 Eric Allman
49
Key-Value lookups can be done in Python using
50
`lang/python/apps/KVstore.py`.  This is a library package for
51
incorporation into larger Python programs.
52
53
<!-- vim: set ai sw=4 sts=4 ts=4 : -->
54 632861ce Eric Allman
55
<!-- Use
56 7f982ac3 Eric Allman
	pandoc -s -o README-CAAPI.html README-CAAPI.md
57 632861ce Eric Allman
to process this to HTML -->