summaryrefslogtreecommitdiff
path: root/content/cockpit/rest-api-plugin.md
diff options
context:
space:
mode:
authorStef Walter <stefw@redhat.com>2015-07-10 18:21:34 +0200
committerStef Walter <stefw@redhat.com>2015-07-10 18:21:34 +0200
commit0633ba044d213d24b32c91484b95cbeb12b03e19 (patch)
tree7369d865a4c5b9a1adf32701bebdfba33fecd195 /content/cockpit/rest-api-plugin.md
parentf1c3b7db24f8e70029918d47d523f3aec2128e1f (diff)
Add tutorial for REST API
Diffstat (limited to 'content/cockpit/rest-api-plugin.md')
-rw-r--r--content/cockpit/rest-api-plugin.md155
1 files changed, 155 insertions, 0 deletions
diff --git a/content/cockpit/rest-api-plugin.md b/content/cockpit/rest-api-plugin.md
new file mode 100644
index 0000000..63256fc
--- /dev/null
+++ b/content/cockpit/rest-api-plugin.md
@@ -0,0 +1,155 @@
+Title: Making REST calls from Javascript in Cockpit
+Date: 2015-07-10
+Category: Cockpit, Linux
+Tags: cockpit, linux
+Slug: making-rest-calls-from-javascript-in-cockpit
+
+[Cockpit is a user interface for servers](http://cockpit-project.org). In [earlier](http://stef.thewalter.net/creating-plugins-for-the-cockpit-user-interface.html) [tutorials](http://stef.thewalter.net/using-dbus-from-javascript-in-cockpit.html) there's a guide on how to add components to Cockpit.
+
+Not all of the [system APIs use DBus](http://stef.thewalter.net/d-bus-is-powerful-ipc.html). So sometimes we find ourselves in a situation where we have to use REST (which is often just treated as another word for HTTP) to talk to certain parts of the system. For example [Docker has a REST API](https://docs.docker.com/reference/api/docker_remote_api/).
+
+For this tutorial you'll need at least Cockpit 0.58. There was one last tweak that helped with the ```superuser``` option you see below. You can install it in [Fedora 22](http://cockpit-project.org/running.html) or [build it from git](https://github.com/cockpit-project/cockpit/blob/master/HACKING.md).
+
+Here we'll make a package called *docker-info* which shows info about the docker daemon. We use the `/info` [docker API](https://docs.docker.com/reference/api/docker_remote_api_v1.18/#display-system-wide-information) to retrieve that info.
+
+I've prepared the [docker-info package here](http://stef.thewalter.net/files/docker-info.tgz). It's just two files. To download them and extract to your current directory, and installs it as a Cockpit package:
+
+ :::text
+ $ wget http://stef.thewalter.net/files/docker-info.tgz -O - | tar -xzf -
+ $ cd docker-info/
+ $ mkdir -p ~/.local/share/cockpit
+ $ ln -snf $PWD ~/.local/share/cockpit/
+
+Previously we [talked about](http://stef.thewalter.net/creating-plugins-for-the-cockpit-user-interface.html) how packages are installed, and what `manifest.json` does so I won't repeat myself here. But to make sure the above worked correctly, you can run the following command. You should see `docker-info` listed in the output:
+
+ :::text
+ $ cockpit-bridge --packages
+ ...
+ docker-info: .../.local/share/cockpit/docker-info
+ ...
+
+If you're logged into Cockpit on this machine, first log out. And log in again. Make sure to log into Cockpit with your current user name, since you installed the package in your home directory. You should now see a new item in the *Tools* menu called *Docker Info*:
+
+![Docker Info tool](images/cockpit-docker-info.png)
+
+After a moment, you should see numbers pop up with some stats about the docker daemon. Now in a terminal try to run something like:
+
+ :::text
+ $ sudo docker run -ti fedora /bin/bash
+
+You should see the numbers update as the container is pulled and started. When you type ```exit``` in the container, you should see the numbers update again. How is this happening? Lets take a look at the `docker-info` HTML:
+
+ :::html
+ <head>
+ <title>Docker Info</title>
+ <meta charset="utf-8">
+ <link href="../base1/cockpit.css" type="text/css" rel="stylesheet">
+ <script src="../base1/jquery.js"></script>
+ <script src="../base1/cockpit.js"></script>
+ </head>
+ <body>
+ <div class="container-fluid">
+ <h2>Docker Daemon Info</h2>
+ <ul>
+ <li>Total Memory: <span id="docker-memory">?</span></li>
+ <li>Go Routines: <span id="docker-routines">?</span></li>
+ <li>File Descriptors: <span id="docker-files">?</span></li>
+ <li>Containers: <span id="docker-containers">?</span></li>
+ <li>Images: <span id="docker-images">?</span></li>
+ </ul>
+ </div>
+
+ <script>
+ var docker = cockpit.http("/var/run/docker.sock", { superuser: "try" });
+
+ function retrieve_info() {
+ var info = docker.get("/info");
+ info.done(process_info);
+ info.fail(print_failure);
+ }
+
+ function process_info(data) {
+ var resp = JSON.parse(data);
+ $("#docker-memory").text(resp.MemTotal);
+ $("#docker-routines").text(resp.NGoroutines);
+ $("#docker-files").text(resp.NFd);
+ $("#docker-containers").text(resp.Containers);
+ $("#docker-images").text(resp.Images);
+ }
+
+ /* First time */
+ retrieve_info();
+
+ var events = docker.get("/events");
+ events.stream(got_event);
+ events.always(print_failure);
+
+ function got_event() {
+ retrieve_info();
+ }
+
+ function print_failure(ex) {
+ console.log(ex);
+ }
+ </script>
+ </body>
+ </html>
+
+First we include `jquery.js` and `cockpit.js`. `cockpit.js` defines the basic API for interacting with the system, as well as Cockpit itself. You can find [detailed documentation here](http://files.cockpit-project.org/guide/latest/api-cockpit.html).
+
+ :::html
+ <script src="../base1/jquery.js"></script>
+ <script src="../base1/cockpit.js"></script>
+
+We also include the cockpit.css file to make sure the look of our tool matches that of Cockpit. The HTML is pretty basic, defining a little list where the info shown.
+
+In the javascript code, first we setup an HTTP client to access docker. Docker listens for HTTP requests on a Unix socket called `/var/run/docker.sock`. In addition the permissions on that socket often require escalated privileges to access, so we tell Cockpit to try to gain `superuser` privileges for this task, but continue anyway if it cannot:
+
+ :::javascript
+ var docker = cockpit.http("/var/run/docker.sock", { superuser: "try" });
+
+First we define how to retrieve info from Docker. We use the REST `/info` API to do this.
+
+ :::javascipt
+ function retrieve_info() {
+ var info = docker.get("/info");
+ info.done(process_info);
+ info.fail(print_failure);
+ }
+
+In a browser you cannot stop and wait until a REST call completes. Anything that doesn't happen instantaneously gets its results reported back to you by [means of callback handlers](http://files.cockpit-project.org/guide/latest/api-cockpit.html#cockpit-http-done). jQuery has a standard interface [called a promise](http://api.jquery.com/deferred.promise/). You add handlers by calling the `.done()` or `.fail()` methods and registering callbacks.
+
+The result of the `/info` call is JSON, and we process it here. This is standard jQuery for filling in text data into the various elements:
+
+ :::javascript
+ function process_info(data) {
+ var resp = JSON.parse(data);
+ $("#docker-memory").text(resp.MemTotal);
+ $("#docker-routines").text(resp.NGoroutines);
+ $("#docker-files").text(resp.NFd);
+ $("#docker-containers").text(resp.Containers);
+ $("#docker-images").text(resp.Images);
+ }
+
+And then we trigger the invocation of our `/info` REST API call.
+
+ :::javascript
+ /* First time */
+ retrieve_info();
+
+Because we want to react to changes in Docker state, we also start a long request to its `/events` API.
+
+ :::javascript
+ var events = docker.get("/events");
+
+The `.get("/events")` call returns a jQuery Promise. When a line of event data arrives, the `.stream()` callback in invoked, and we use it to trigger a reload of the Docker info.
+
+ :::javascript
+ events.stream(got_event);
+ events.always(print_failure);
+
+ function got_event() {
+ retrieve_info();
+ }
+
+This is a simple example, but I hope it helps you get started. There are further REST [javascript calls](http://files.cockpit-project.org/guide/latest/api-cockpit.html#latest-http). Obviously you can also do `POST` and so on.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-01 00:33:02 +0000