Skip to content

Commit c1bf769

Browse files
committed
Clean up some documentation links.
1 parent 65a9448 commit c1bf769

File tree

5 files changed

+23
-40
lines changed

5 files changed

+23
-40
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,16 @@ Contributing to Lambda
33

44
### Prerequisites
55

6-
This has only been tested on OSX and Linux.
6+
These workflows have been tested on Linux and Mac. You must have a:
77

8-
* Working Go 1.5 onwards installation.
9-
* Working [Docker](http://docker.com) installation.
10-
* GNU Make.
8+
- Working `make` command
9+
- Working [Go][go] >=1.5 installation,
10+
- Working [Glide][glide] installation,
11+
- Working [Docker][docker] installation.
12+
13+
[go]: http://golang.org
14+
[glide]: http://glide.sh
15+
[docker]: http://www.docker.com
1116

1217
To work on Java code, you'll need a working JDK and [Apache Maven](http://maven.apache.org).
1318
For node.js, any version of node >=0.10.0 will do.

docs/getting-started.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,8 @@ We will then upload it to IronWorker and run it.
66

77
## Prerequisites
88

9-
These workflows have been tested on Linux and Mac. You must have a:
10-
11-
- Working [Go][go] >=1.5 installation,
12-
- Working [Glide][glide] installation,
13-
- Working [Docker][docker] installation.
14-
15-
[go]: http://golang.org
16-
[glide]: http://glide.sh
17-
[docker]: http://www.docker.com
9+
TODO: Update these to use real ironcli static build. Also add ironcli
10+
installation instructions.
1811

1912
We are going to use a development branch of `ironcli` instead of the official
2013
release. TODO: `go install` will fail due to (lack of) vendoring.
@@ -53,7 +46,7 @@ Create an empty directory for your project and save this code in a file called
5346
Now let's use `ironcli`'s Lambda functionality to create a Docker image. We can
5447
then run the Docker image with a payload to execute the Lambda function.
5548

56-
$ $GOPATH/bin/ironcli lambda create-function --function-name irontest/node-exec:1 --runtime nodejs --handler node_exec.handler node_exec.js
49+
$ ironcli lambda create-function --function-name irontest/node-exec:1 --runtime nodejs --handler node_exec.handler node_exec.js
5750
Image output Step 1 : FROM iron/lambda-nodejs
5851
---> 66fb7af42230
5952
Step 2 : ADD node_exec.js ./node_exec.js
@@ -67,8 +60,8 @@ then run the Docker image with a payload to execute the Lambda function.
6760

6861
As you can see, this is very similar to creating a Lambda function using the
6962
`aws` CLI tool. We name the function as we would name other Docker images. The
70-
`1` indicates the version. You can use any string. This way you can make
71-
changes to your code and tell IronWorker to run the newer code. The handler is
63+
`1` indicates the version. You can use any string. This way you can configure
64+
your deployment environment to use different versions. The handler is
7265
the name of the function to run, in the form that nodejs expects
7366
(`module.function`). Where you would package the files into a `.zip` to upload
7467
to Lambda, we just pass the list of files to `ironcli`. If you had node
@@ -86,7 +79,7 @@ You should now see the generated Docker image.
8679
The `test-function` subcommand can launch the Dockerized function with the
8780
right parameters.
8881

89-
$ $GOPATH/bin/ironcli lambda test-function --function-name irontest/node-exec:1 --payload '{ "cmd": "echo Dockerized Lambda" }'
82+
$ ironcli lambda test-function --function-name irontest/node-exec:1 --payload '{ "cmd": "echo Dockerized Lambda" }'
9083
Dockerized Lambda!
9184

9285
You should see the output. Try changing the command to `date` or something more
@@ -148,8 +141,3 @@ Code page.
148141

149142
$ curl -X POST -d '{ "cmd": "echo Dockerized Lambda" }' '<webhook URL>'
150143

151-
---
152-
153-
TODO:
154-
NOTE to devs: Perhaps prefetch Lambda function runners on to certain machines?
155-

docs/introduction.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ easy to write containerized applications that will run anywhere without having
2222
to fiddle with Docker and get the various runtimes set up. Instead you can just
2323
write a simple function and have an "executable" ready to go.
2424

25-
TODO
26-
2725
## How does it work?
2826

2927
We provide base Docker images for the various runtimes that AWS Lambda
@@ -38,14 +36,15 @@ The Docker container has to be run with a certain configuration, described
3836

3937
## Next steps
4038

41-
Write and package your Lambda functions with our [Getting started
39+
Write, package and run your Lambda functions with our [Getting started
4240
guide](./getting-started.md). [Here is the environment](./environment.md) that
4341
Lambda provides. `ironcli lambda` lists the commands to work with Lambda
4442
functions locally.
4543

46-
There is a short guide to [using Lambda with IronWorker](./ironworker.md).
47-
Non-AWS Lambda functions do have the disadvantage of not having deep
48-
integration with other AWS services. Much of the push-based actions can be
49-
solved by redirecting the event through [SNS and using webhooks](./sns.md).
50-
AWS APIs are of course available for use through the AWS SDK available to the
51-
function. We explain how to deal with authentication in [this guide](./aws.md).
44+
The Docker environment required to run Lambda functions is described
45+
[here](./docker.md).
46+
47+
Non-AWS Lambda functions can continue to interact with AWS services. [Working
48+
with AWS](./aws.md) describes how to access AWS credentials, interact with
49+
services like S3 and how to launch a Lambda function due a notification from
50+
SNS.

docs/ironworker.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/toc.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)