Skip to content

Commit 46be44e

Browse files
committed
Add documentation floe:// and manageiq:// methods
1 parent 27b81fb commit 46be44e

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

managing_providers/_topics/embedded_workflows.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ You can create and use embedded workflows as needed to not only change parts of
159159

160160
Workflows must be authored in Amazon State Languages (ASL) format. As part of authoring a workflow, you (or your users) can build container images that are able to perform any tasks that are required in any language that you like. You can use these images during Task states in your workflows.
161161

162-
1. Define the code for the workflow. If your workflow requires the use of any credentials or parameters to be specified, ensure that they are passed in the code.
162+
* Define the code for the workflow. If your workflow requires the use of any credentials or parameters to be specified, ensure that they are passed in the code.
163163

164164
Within the workflow code, you need to specify the states that your workflow requires, including any next steps. For `Task` type steps in the workflow, a docker container is called. The container defines what happens for that Task state. For example, a docker container can run to clone a template. If your states require parameters or credentials, you can specify them in your state definitions.
165165

@@ -174,12 +174,40 @@ Workflows must be authored in Amazon State Languages (ASL) format. As part of au
174174
- ItemReader
175175
- ResultWriter
176176

177-
2. Build the docker containers that are required for the workflow.
177+
* Build the docker containers that are required for the workflow.
178178

179179
When you have the code for your task resource written, you need to bundle it into a docker image. You can bundle the code by creating a standard [Dockerfile](https://docs.docker.com/engine/reference/builder/) and building the image (https://docs.docker.com/engine/reference/commandline/build/). Then, you can push the image to a [registry](https://docs.docker.com/engine/reference/commandline/push/), which makes the image available to be used by {{ site.data.product.title_short }}. When you have pushed your images to an image registry, you can add the registry to {{ site.data.product.title_short }}.
180180

181181
Pull secrets for containers are used differently between appliances and the OpenShift Container Platform (OCP). These differences are outlined in the following sections.
182182

183+
* Use "builtin" runner methods from floe or manageiq
184+
185+
In addition to the `docker://` runner which can run any container you want, there are also builtin runner methods for some common tasks like executing an http call or sending an email.
186+
187+
* floe://http - Execute any HTTP action
188+
189+
Parameters:
190+
* Method
191+
* Url
192+
* Headers
193+
* QueryParameters
194+
* Body
195+
* Ssl
196+
* Options
197+
* Proxy
198+
* manageiq://email - Send an email using the configured SMTP server
199+
200+
Parameters:
201+
* To
202+
* From
203+
* Subject
204+
* Cc
205+
* Bcc
206+
* Body
207+
* Attachment
208+
* manageiq://embedded_ansible - Execute an ansible playbook with EmbeddedAnsible
209+
* manageiq://provision_execute - Execute an MiqProvision task
210+
183211
#### Running an Embedded Workflow on Appliances
184212

185213
* On appliances, `podman` is used to execute the container so use [podman login](https://docs.podman.io/en/stable/markdown/podman-login.1.html) as the `manageiq` user.

0 commit comments

Comments
 (0)