flocker-api-examples

A repository demonstrating how to use the Flocker REST API using various languages.

Each example expects there to be a running Flocker cluster with TLS authentication setup.

installation

First make sure you have a running Flocker cluster setup - you can read how to do this here

Then, clone this repo:

$ git clone https://github.com/binocarlos/flocker-api-examples
$ cd flocker-api-examples

## configuration

For each of the examples - you can change the following values (either by editing the source files or by setting environment variables):

• CONTROL_SERVICE - the IP address of the Flocker control service
• CONTROL_PORT - the port the control service is listening on
• KEY_FILE - the API key file to use
• CERT_FILE - the API certificate file to use
• CA_FILE - the certificate authority file to use

tests

To run the tests:

$ vagrant up
$ bash runtests.sh
$ vagrant destroy -f

This will use the included Vagrantfile to spin up a 2 node Flocker cluster.

It will then test the output of the examples against an expected output.

success criteria

Each file in the "/_output" folder will contain the output of the tests.

Successful tests will output the following content:

{"deleted": false, "dataset_id": "1458ef38-4ccd-49bb-80bc-8de095f19cdb", "maximum_size": 107374182400, "primary": "5540d6e3-392b-4da0-828a-34b724c5bb80", "metadata": {"name": "example_dataset"}}

For each of the tests, the output will be the same, except for dataset_id, which is the only variable.