Skip to content
This repository has been archived by the owner on Jan 21, 2022. It is now read-only.

Commit

Permalink
updates to ironworker docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Shannon Coen committed Feb 13, 2014
1 parent f5136b5 commit 29e3631
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 56 deletions.
2 changes: 1 addition & 1 deletion source/docs/dotcom/marketplace/services/ironmq.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Format of credentials in `VCAP_SERVICES` environment variable:
}
~~~

## Language Support
## <a id='language-support'></a>Language Support ##

IronMQ has clients for [a lot of languages][3], and you can always use [the REST API][4] (or write your own!).

Expand Down
76 changes: 21 additions & 55 deletions source/docs/dotcom/marketplace/services/ironworker.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,60 +6,32 @@ IronWorker is a multi-language worker platform that runs tasks in the background

## <a id='managing'></a>Managing Services ##

[Managing services from the command line](../../../using/services/managing-services.html)

### Creating a Service Instance ##

An instance of this service can be provisioned via the CLI with the following command:

<pre class="terminal">
$ cf create-service ironworker
</pre>

### Binding Your Service Instance ##

Bind the service instance to your app with the following command:

<pre class="terminal">
$ cf bind-service
</pre>
To create and bind a service instance, see [Managing services from the command line](../../../using/services/managing-services.html)

## <a id='using'></a>Using Service Instances with your Application ##

* Include this section only if your service is bindable. What is the format of the credentials stored in the VCAP_SERVICES environment variable? *

See [Using Service Instances with your Application](../../adding-a-service.html#using) and [VCAP_SERVICES Environment Variable](../../../using/deploying-apps/environment-variable.html).

Format of credentials in `VCAP_SERVICES` environment variable.
Format of credentials in `VCAP_SERVICES` environment variable:

~~~xml
{
service-foo-n/a: [
{
name: "service-foo-75efc",
label: "service-foo-n/a",
plan: "example-plan",
credentials: {
uri: dbtype://username:password@hostname:port/name
hostname: "foo.example.com"
port: "1234"
name: "asdfjasdf"
username: "QvsXMbJ2rK",
password: "HCDVOYluTv"
ironworker-n/a: [
{
name: "ironworker-test",
label: "ironworker-n/a",
tags: [ ],
plan: "small",
credentials: {
project_id: "52fc1f720738fa0005000009",
token: "yWZKC5kfj521lfZH-jL-R2pyTw0"
}
}
}
]
]
}
~~~

How to Get your Project ID and Token from Cloud Foundry

Add those values to a file called `iron.json` in your app root directory and add iron.json to your .gitignore file.

{
"project_id": "123456789",
"token": "aslkdjflaksuilaks"
}
## <a id='language-support'></a>Language Support ##

## Ruby

Expand All @@ -75,7 +47,7 @@ If you’re building for a Rails application or anything that uses Bundler, add
gem 'iron_worker_ng'
~~~

## Create a worker
### Create a worker ###

First things first, let’s create a worker. Save the following code into a file called `hello_worker.rb`:

Expand Down Expand Up @@ -114,7 +86,7 @@ Or look at the log in HUD.

Now it’s time to put your worker to work!

## Queue up tasks for your worker from your application
### Queue up tasks for your worker from your application ###

Now that we know the worker runs and uploads from your machine. Simply add the following to your `config/environments/development.rb`:

Expand All @@ -141,15 +113,11 @@ Sample Apps in binary, dotnet, go, java, node, php, python, and ruby!

[IronWorker Examples on GitHub](https://github.com/iron-io/iron_worker_examples)

### Next steps
## <a id='next-steps'></a>Next steps ##

This is just the tip of the iceberg. IronWorker has a robust API that allows for a lot more interaction with your workers. You may want to try:
This is just the tip of the iceberg. IronWorker has [a robust API](http://dev.iron.io/worker/) that allows for a lot more interaction with your workers.

You can also check out some example workers:

* We have a [full repository][6] of IronWorker examples for Rails on Github.

### Troubleshooting
## <a id='troubleshooting'></a>Troubleshooting ##

When trying to troubleshoot a worker, the best first step is to try and run the worker locally. If the worker runs locally, it should run on the cloud. You can also access your worker logs through the Iron.io HUD. These logs will show you any errors thrown or debug messages you log while the worker is running.

Expand All @@ -161,20 +129,18 @@ You can view and analyze all your workers from the HUD...

![ironworkers on the hud][1]

## Share your projects with other people
## <a id='share'></a>Share your projects with other people ##

Each of your projects can be shared with coworkers and friends. It's easy and just takes a few seconds. They'll get an invite to signup for Iron.io for free and have automatic access to the project once completed.
![Sharing your Iron Worker Project][2]

## <a id='support'></a>Support ##

Provider Support Instructions

- [Dev Center](http:www.dev.iron.io)
- [Live Public Support](http://get.iron.io/chat)
- [Iron.io on GitHub](https://github.com/iron-io)
- [Frequently Asked Questions](http://dev.iron.io/faq)
- [Report an Issue](https://github.com/iron-io/issues/issues)

[1]: http://www.iron.io/assets/screenshots/home-scrnshot-worker-1.png
[2]: https://d2oawfjgoy88bd.cloudfront.net/523a211b2cdcf276fb5dae02/523a211c2cdcf276fb5dae04/528be904888b9d471f460281.png?Expires=1384987278&Signature=Bt8WG1evom8MFsh1rLSWqF2KFBK1c6l4tGWjuaTRMbw~jvDYBQY6QvdyCKB29Q2TkjvIb0n5rX9XvWWTEti5MFCJYKHwpKdjcdePk9vv0OhBU0vRCdfwotpPNemnkfQ5DvBBJXb7FxH3cWbN~3TiZnlmB0gMXlbnDtciLoakbgjkALTZsy1nBrAapUQ6VQWqjA9B6~Kb6gBTBP~2Ep8BN63970GtgR5ecBtx1OnsCFFrnFAodzfbUzcPj8AMONSsNjIowLbYPNP8OEePl89Z2U~lXQa7lcvWMAnlV8rzz6Ftvno5C8Ly~YS2C52N~3Zj9Lm-vD9QY4gX7M9-lzjoKg__&Key-Pair-Id=APKAJHEJJBIZWFB73RSA
[2]: https://d2oawfjgoy88bd.cloudfront.net/523a211b2cdcf276fb5dae02/523a211c2cdcf276fb5dae04/528be904888b9d471f460281.png?Expires=1384987278&Signature=Bt8WG1evom8MFsh1rLSWqF2KFBK1c6l4tGWjuaTRMbw~jvDYBQY6QvdyCKB29Q2TkjvIb0n5rX9XvWWTEti5MFCJYKHwpKdjcdePk9vv0OhBU0vRCdfwotpPNemnkfQ5DvBBJXb7FxH3cWbN~3TiZnlmB0gMXlbnDtciLoakbgjkALTZsy1nBrAapUQ6VQWqjA9B6~Kb6gBTBP~2Ep8BN63970GtgR5ecBtx1OnsCFFrnFAodzfbUzcPj8AMONSsNjIowLbYPNP8OEePl89Z2U~lXQa7lcvWMAnlV8rzz6Ftvno5C8Ly~YS2C52N~3Zj9Lm-vD9QY4gX7M9-lzjoKg__&Key-Pair-Id=APKAJHEJJBIZWFB73RSA

0 comments on commit 29e3631

Please sign in to comment.