Skip to content

Commit e33634b

Browse files
authored
Merge pull request #50 from pivotal-cf/add-impact-warning-errand-docs
Update the Tile Dev docs for the impact_warning errand property
2 parents 6ecd3b9 + 4cd2b9b commit e33634b

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

tile-errands.html.md.erb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ To configure a colocated errand, define the following properties in the `pre_del
5555
</tr><tr>
5656
<td><code>description: TEXT</code></td>
5757
<td>(Optional) Provide a description for the errand that appears in the tile's <strong>Errand Config</strong> page.</td>
58+
</tr><tr>
59+
<td><code>impact_warning: TEXT</code></td>
60+
<td>(Optional) Provide an impact warning for the operator that appears on OpsManager prior to running the errand on the Review Pending Changes page.</td>
5861
</tr>
5962
</table>
6063

@@ -68,6 +71,7 @@ The following example shows colocated `post_deploy_errands` and `pre_delete_erra
6871
post_deploy_errands:
6972
- name: example-errand
7073
colocated: false
74+
impact_warning: "This is an impact warning for your Post Deploy errand"
7175
- name: example_colocated_errand
7276
colocated: true
7377
run_default: on
@@ -78,6 +82,7 @@ post_deploy_errands:
7882

7983
pre_delete_errands:
8084
- name: example-errand
85+
impact_warning: "This is an impact warning for your Pre Delete errand"
8186
```
8287

8388
The following example shows the colocated errands referenced within the `job_type`:

0 commit comments

Comments
 (0)