Skip to content

Commit 6b23769

Browse files
committed
Modify docs to refer to master ironcli command that can be installed as a binary.
The intention is to release a new ironcli when we announce this.
1 parent 4d9751c commit 6b23769

File tree

2 files changed

+12
-23
lines changed

2 files changed

+12
-23
lines changed

docs/aws.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,21 +41,21 @@ Assuming you [packaged this function](./introduction.md) into a Docker image
4141
`iron/s3-write` and pushed it to Docker Hub. Instead of just registering with
4242
IronWorker as:
4343

44-
ironcli register <hub user>/s3-write
44+
iron register <hub user>/s3-write
4545

4646
do this instead:
4747

48-
ironcli register -e AWS_ACCESS_KEY_ID=<access key> \
48+
iron register -e AWS_ACCESS_KEY_ID=<access key> \
4949
-e AWS_SECRET_ACCESS_KEY=<secret key> \
5050
<hub user>/s3-write
5151

52-
Alternatively, if you use `ironcli publish-function`, it will automatically
52+
Alternatively, if you use `iron publish-function`, it will automatically
5353
pick up the environment variables and forward them if valid ones are found.
5454

5555
```sh
5656
export AWS_ACCESS_KEY_ID=<access key>
5757
export AWS_SECRET_ACCESS_KEY=<secret key>
58-
ironcli publish-function -function-name <hub user>/s3-write
58+
iron publish-function -function-name <hub user>/s3-write
5959
```
6060

6161
If you have an existing image with the same name registered with IronWorker,
@@ -222,7 +222,7 @@ With this function ready, we can Dockerize it and publish it to actually try it
222222
out with SNS.
223223

224224
```sh
225-
ironcli lambda create-function -function-name <Docker Hub username>/sns-example -runtime
225+
iron lambda create-function -function-name <Docker Hub username>/sns-example -runtime
226226
nodejs -handler sns.handler sns.js
227227
```
228228

@@ -238,7 +238,7 @@ variables. The values must be your AWS credentials.
238238
AWS_ACCESS_KEY_ID=<access key>
239239
AWS_SECRET_ACCESS_KEY=<secret key>
240240

241-
ironcli publish-function -function-name <Docker Hub username>/sns-example:latest
241+
iron publish-function -function-name <Docker Hub username>/sns-example:latest
242242
```
243243

244244
Visit the published function's code page in the [IronWorker control

docs/getting-started.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,8 @@ This guide will walk you through creating and testing a simple Lambda function.
44

55
We will then upload it to IronWorker and run it.
66

7-
## Prerequisites
8-
9-
TODO: Update these to use real ironcli static build. Also add ironcli
10-
installation instructions.
11-
12-
We are going to use a development branch of `ironcli` instead of the official
13-
release. TODO: `go install` will fail due to (lack of) vendoring.
14-
15-
$ cd $GOPATH
16-
$ go get github.com/iron-io/ironcli
17-
$ cd src/github.com/iron-io/ironcli
18-
$ git checkout -t origin/lambda
19-
$ go install .
7+
We need the the `ironcli` tool for the rest of this guide. You can install it
8+
by following [these instructions](https://github.com/iron-io/ironcli).
209

2110
## Creating the function
2211

@@ -46,7 +35,7 @@ Create an empty directory for your project and save this code in a file called
4635
Now let's use `ironcli`'s Lambda functionality to create a Docker image. We can
4736
then run the Docker image with a payload to execute the Lambda function.
4837

49-
$ ironcli lambda create-function --function-name irontest/node-exec:1 --runtime nodejs --handler node_exec.handler node_exec.js
38+
$ iron lambda create-function --function-name irontest/node-exec:1 --runtime nodejs --handler node_exec.handler node_exec.js
5039
Image output Step 1 : FROM iron/lambda-nodejs
5140
---> 66fb7af42230
5241
Step 2 : ADD node_exec.js ./node_exec.js
@@ -79,7 +68,7 @@ You should now see the generated Docker image.
7968
The `test-function` subcommand can launch the Dockerized function with the
8069
right parameters.
8170

82-
$ ironcli lambda test-function --function-name irontest/node-exec:1 --payload '{ "cmd": "echo Dockerized Lambda" }'
71+
$ iron lambda test-function --function-name irontest/node-exec:1 --payload '{ "cmd": "echo Dockerized Lambda" }'
8372
Dockerized Lambda!
8473

8574
You should see the output. Try changing the command to `date` or something more
@@ -107,7 +96,7 @@ The `publish-function` command first uploads the image to Docker Hub, then
10796
registers it with IronWorker so you can queue tasks or launch a task in
10897
response to a webhook.
10998

110-
$ $GOPATH/bin/ironcli lambda publish-function --function-name irontest/node-exec:1
99+
$ iron lambda publish-function --function-name irontest/node-exec:1
111100
-----> Configuring client
112101
Project '<project name>' with id='<project id>'
113102
-----> Registering worker 'irontest/node-exec'
@@ -121,7 +110,7 @@ page.
121110

122111
We can now run this from the command line.
123112

124-
$ $GOPATH/bin/ironcli worker queue -payload '{ "cmd": "echo Dockerized Lambda" }' -wait irontest/node-exec
113+
$ iron worker queue -payload '{ "cmd": "echo Dockerized Lambda" }' -wait irontest/node-exec
125114
-----> Configuring client
126115
Project '<project name>' with id='<project id>'
127116
-----> Queueing task 'irontest/node-exec'

0 commit comments

Comments
 (0)