Mitch Garnaat

Adding an inadequate README file.

Showing 1 changed file with 44 additions and 0 deletions
1 +kappa
2 +=====
3 +
4 +**Kappa** is a command line tool that (hopefully) makes it easier to
5 +deploy, update, and test functions for AWS Lambda.
6 +
7 +There are quite a few steps involved in developing a Lambda function.
8 +You have to:
9 +
10 +* Write the function itself (Javascript only for now)
11 +* Create the IAM roles required by the Lambda function itself (the executing
12 +role) as well as the policy required by whoever is invoking the Lambda
13 +function (the invocation role)
14 +* Compress the function and any dependencies and upload it to AWS Lambda
15 +* Test the function with mock data
16 +* Retrieve the output of the function from CloudWatch Logs
17 +* Add an event source to the function
18 +* View the output of the live function
19 +
20 +Kappa tries to help you with some of this. The IAM roles are created
21 +in a CloudFormation template and kappa takes care of creating, updating, and
22 +deleting the CloudFormation stack. Kappa will also zip up the function and
23 +any dependencies and upload them to AWS Lambda. It also sends test data
24 +to the uploaded function and finds the related CloudWatch log stream and
25 +displays the log events. Finally, it will add the event source to turn
26 +your function on.
27 +
28 +Kappa is a command line tool. The basic command is:
29 +
30 + kappa --config <path to config file> <command>
31 +
32 +Where commands is one of:
33 +
34 +* deploy - deploy the CloudFormation template containing the IAM roles and zip the function and upload it to AWS Lambda
35 +* test - send test data to the new Lambda function
36 +* tail - display the most recent log events for the function
37 +* delete - delete the CloudFormation stack containing the IAM roles and delete the Lambda function
38 +
39 +The ``config file`` is a YAML format file containing all of the information
40 +about your Lambda function.
41 +
42 +An example project based on a Kinesis stream can be found in
43 +``samples/kinesis``.
44 +