README.md in floe-0.2.3 vs README.md in floe-0.3.0

- old
+ new

@@ -34,10 +34,25 @@ ``` bundle exec ruby exe/floe --workflow examples/workflow.asl --inputs='{"foo": 1}' --docker-runner podman bundle exec ruby exe/floe --workflow examples/workflow.asl --inputs='{"foo": 1}' --docker-runner kubernetes --docker-runner-options namespace=default server=https://k8s.example.com:6443 token=my-token ``` +If your workflow has `Credentials` you can provide a payload that will help resolve those credentials references at runtime. + +For example if your workflow had the following Credentials field with a JSON Path property: +```json +"Credentials": { + "RoleArn.$": "$.roleArn" +} +``` + +You can provide that at runtime via the `--credentials` parameter: + +``` +bundle exec ruby exe/floe --workflow my-workflow.asl --credentials='{"roleArn": "arn:aws:iam::111122223333:role/LambdaRole"}' +``` + ### Ruby Library ```ruby require 'floe' @@ -56,9 +71,21 @@ workflow = Floe::Workflow.load(File.read("workflow.asl")) workflow.run! ``` ### Docker Runner Options + +#### Docker + +Options supported by the Docker docker runner are: + +* `network` - What docker to connect the container to, defaults to `"bridge"`. If you need access to host resources for development you can pass `network=host`. + +#### Podman + +Options supported by the podman docker runner are: + +* `network` - What docker to connect the container to, defaults to `"bridge"`. If you need access to host resources for development you can pass `network=host`. #### Kubernetes Options supported by the kubernetes docker runner are: