Riak tool
Project description
This is a helper script for interacting with Riak.
Word of warning
By using this script you are violating the datamunging warning set by John Vincent in his Riak overview. Proceed at your own risk.
Requirements
Python
[Requests Library](http://docs.python-requests.org/en/latest/user/install/#install)
Helpful: http://docs.python-requests.org/en/latest/user/quickstart
Installation
sudo easy_install riak-cli-tool
or
sudo pip install riak-cli-tool
Secondary Indices
Enstratius makes heavy use of secondary indices. This scrip is supposed to find, save, and utilize existing secondary indices when updating bucket contents that have them in place.
This is not well tested.
Configuration Files
None. You’ll want to add an export statement to your profile:
export riak_host='123.123.123.123'
and make sure it is sourced before attempting to use the utility.
The port is set to 8098.
Commands
List all buckets
THIS IS A BAD IDEA, USUALLY.
es-riak --list-buckets
{
"buckets": [
"content_template",
"configuration_management_system",
"frontend_configuration"
]
}
List all keys in a bucket
THIS IS A BAD IDEA, USUALLY.
es-riak --list-keys -b content_template
{
"keys": [
"passwordChangeSubject",
"optimusEngineEmail",
"changeAccountData_en"
]
}
Save the contents of a bucket/key to a file:
es-riak --save save_file.json -b frontend_configuration -k 1
Saved contents of:
http://172.16.243.131:8098/buckets/frontend_configuration/keys/1
to
save_file.json
Checking the contents of the save file:
cat save_file.json | python -mjson.tool
{
"SCHEMA_VERSION": "0",
"autoProvisionUsers": "true",
"defaultAuthenticationMethod": "NATIVE",
"defaultGroupIds": [],
"forceDefaultAuthentication": "true",
"forceDeny": [],
"masterNetworkId": 1,
"systemName": "Enstratius"
}
Update the contents of a bucket/key by passing in a json file
es-riak --update -b frontend_configuration -k 1 -i input.json
Valid JSON
updating!
Saved contents of:
http://172.16.243.131:8098/buckets/frontend_configuration/keys/1
to
input.json.original
Done.
To view your changes, call:
es-riak --show -b frontend_configuration -k 1
where the file input.json has contents:
cat input.json | python -mjson.tool
{
"SCHEMA_VERSION": "0",
"autoProvisionUsers": "true",
"defaultAuthenticationMethod": "NATIVE",
"defaultGroupIds": [],
"forceDefaultAuthentication": "true",
"forceDeny": [],
"masterNetworkId": 999,
"systemName": "Enstratius"
}
bucket contents post-update:
es-riak --show -b frontend_configuration -k 1
{
"SCHEMA_VERSION": "0",
"autoProvisionUsers": "true",
"defaultAuthenticationMethod": "NATIVE",
"defaultGroupIds": [],
"forceDefaultAuthentication": "true",
"forceDeny": [],
"masterNetworkId": 999,
"systemName": "Enstratius"
}
Validating an input JSON file
Valid JSON:
es-riak --validate -i input.json
Valid JSON
Invalid JSON:
es-riak --validate -i invalid.txt
Invalid JSON
Where the contents of invalid.txt are:
{
"SCHEMA_VERSION": "0",
"autoProvisionUsers": "true",
"defaultAuthenticationMethod": "NATIVE",
"defaultGroupIds": [],
"forceDefaultAuthentication": "true",
"forceDeny": [],
"masterNetworkId": 999,
"systemName":
}
Elevating an API key
You can use this utility to elevate an API key to a “system” key.
es-riak --elevate-api-key -b api_key -k <your_api_access_key>
An example of this type of interaction is shown here:
es-riak --show -b api_key -k DJFLPQSDJAUHLMLPDJIO
{
"SCHEMA_VERSION": "0",
"accessKey": "DJFLPQSDJAUHLMLPDJIO",
"activationTimestamp": 1368202730181,
"billingAccount": 52901,
"customer": 51400,
"description": "test key",
"encryption": "TWO",
"name": "Test",
"network": 50069,
"secretKey": "ee235a772d0def0b069d6364cda6a34e8d6d9eca6afcd94d37770e12c6d6d735df9a75fb64bd0a1cb18911a7ed4744fb"
}
There is no need to issue the show command first, I’m just doing it to highlight the differences.
With this information issue the command:
es-riak --elevate-api-key -b api_key -k DJFLPQSDJAUHLMLPDJIO
There will be no output from this command.
bucket contents post-elevate:
es-riak --show -b api_key -k DJFLPQSDJAUHLMLPDJIO
{
"SCHEMA_VERSION": "0",
"accessKey": "DJFLPQSDJAUHLMLPDJIO",
"activationTimestamp": 1368202730181,
"billingAccount": 52901,
"customer": 51400,
"customerManagementKey": true,
"description": "test key",
"encryption": "TWO",
"name": "Test",
"network": 50069,
"secretKey": "ee235a772d0def0b069d6364cda6a34e8d6d9eca6afcd94d37770e12c6d6d735df9a75fb64bd0a1cb18911a7ed4744fb",
"systemManagementKey": true
}
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.