Added README

Author: schmittthomas

README.md

@@ -1,2 +1,79 @@
-# aws-codepipeline-custom-job-worker
-Use this sample to help you develop your own job worker when creating a custom action for AWS CodePipeline. For more information, see Create a Custom Action for a Pipeline. http://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html
+# AWS CodePipeline Job Worker
+Read more about CodePipeline: http://aws.amazon.com/codepipeline/
+
+## Build
+### Dependencies
+Install the following tools to build the AWS CodePipeline Job Worker:
+- Java SE Development Kit 8
+- Apache Ant
+
+### Ant targets
+You can use the following ant targets to build the code:
+```bash
+ant clean    # Cleans the workspace
+ant compile  # Compiles the code
+ant junit    # Runs the unit tests
+ant jar      # Creates the jar file
+ant release  # Default target, which compiles the code, runs the unit tests, creates the jar file and deployment bundle
+```
+
+## Start
+Use the init.d script to start the AWS CodePipeline Job Worker polling for custom actions:
+```bash
+service aws-codepipeline-jobworker start
+```
+
+The script optionally takes the configuration class as a parameter. If you want to run the job worker for third party actions, you can use the following command:
+```bash
+service aws-codepipeline-jobworker start "com.amazonaws.codepipeline.jobworker.configuration.ThirdPartyJobWorkerConfiguration"
+```
+
+You can also specify your own configuration class. It only has to implement the `JobWorkerConfiguration` interface.
+
+## Configuration
+The job worker comes with two pre-defined configuration classes: `CustomActionJobWorkerConfiguration` and `ThirdPartyJobWorkerConfiguration`. Both inherit from the `DefaultJobWorkerConfiguration` to share most of the configuration settings.
+
+You can configure the following settings:
+```java
+// Configure action type the job worker polls for
+public ActionType getActionType() {
+    return new ActionType(
+        "Deploy",          // Action Type Category: Source, Build, Test, Deploy, Invoke
+        "Custom",          // Action Type Owner: Custom or ThirdParty
+        "MyCustomAction",  // Action Type Provider: Name of your action type
+        "1"                // Action Type Version: e.g. "1"
+    );
+}
+
+// How frequently the job worker polls for new jobs
+private static final long POLL_INTERVAL_MS = 5000L; // e.g. every 5 seconds
+
+// Maximum number of worker threads. Indicates how many jobs can be processed in parallel.
+private static final int WORKER_THREADS = 10;
+
+// The AWS region of AWS CodePipeline. The job worker polls for jobs in this region.
+private static final Region AWS_REGION = Region.getRegion(Regions.US_EAST_1);
+```
+
+## Deployment
+The job worker comes with AWS CodeDeploy installation scripts. Set up your application and deployment group in AWS CodeDeploy and run the following command to deploy the agent:
+```bash
+# Replace with your Amazon S3 bucket name
+AMAZON_S3_BUCKET=<your-amazon-s3-bucket>
+# Make sure that you set up your application and deployment group in AWS CodeDeploy
+APPLICATION_NAME=AwsCodePipelineJobWorker
+DEPLOYMENT_GROUP_NAME=Production
+
+# Compile the code and create deployment bundle
+ant release
+
+# Create a tar archive from the build output
+cd build/output
+tar -cf ../AwsCodePipelineJobWorker.tar *
+
+# Upload the deployment bundle to your Amazon S3 bucket.
+aws s3 cp ../AwsCodePipelineJobWorker.tar s3://$AMAZON_S3_BUCKET/AwsCodePipelineJobWorker.tar
+
+# Start the deployment using AWS CodeDeploy
+aws deploy create-deployment --application-name $APPLICATION_NAME --deployment-group-name $DEPLOYMENT_GROUP_NAME --s3-location bucket=$AMAZON_S3_BUCKET,bundleType=tar,key=AwsCodePipelineJobWorker.tar
+```