-
Notifications
You must be signed in to change notification settings - Fork 140
/
managing_errands.html.md.erb
78 lines (41 loc) · 4.74 KB
/
managing_errands.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
---
title: Managing Errands in Ops Manager
owner: Ops Manager
---
This topic describes product errands used in <%= vars.platform_name %> and how to configure them in Ops Manager.
Errands are scripts that can run at the beginning and at the end of an installed product’s availability time.
You can use Ops Manager to adjust whether and when these errands run.
Product tiles include two types of errands:
* **Post-deploy errands** run after the product installs but before Ops Manager makes the product available for use. One example is an errand that publishes a newly-installed service to the Services Marketplace.
* **Pre-delete errands** run after an operator chooses to delete the product but before Ops Manager actually deletes it. One example is a clean-up task that removes all data objects used by the errand.
When you click **Review Pending Changes**, then **Apply Changes** in Ops Manager, BOSH either creates a VM for each errand that runs or co-locates errands on existing VMs.
Tile developers determine where BOSH deploys the errands for their product.
<%= vars.app_runtime_full %> provides several post-deploy errands including smoke tests, Apps Manager, notification, <%= vars.platform_name %> Account, and autoscaling errands. For more information about <%= vars.app_runtime_abbr %> errands, see the [Configuring <%= vars.app_runtime_abbr %>](configure-pas.html) topic.
For information about the errands associated with any other <%= vars.platform_name %> product, see the documentation provided with the product tile.
## <a id="rules"></a> Errand Run Rules
Operators can configure two different run rules for errands: **On** and **Off**. These rules control when Ops Manager executes the errand.
When the errand is configured to be **On**, then it always runs, even if there are no changes to the product manifest. When the errand is configured to be **Off**, it never runs.
### <a id="defaults"></a> Ops Manager Defaults and Tile Defaults
By default, Ops Manager applies the **On** rule to all errands.
For any errand, the tile developer can override these Ops Manager defaults with their own tile-specific defaults defined in the tile [property blueprints](https://docs.pivotal.io/tiledev/property-reference.html#property-blueprints).
## <a id="modify"></a> Configure Run Rules in Ops Manager
You can configure the run rules for errands in two places in Ops Manager. The [Errands](#errands_pane) pane saves your configuration and applies the configuration to future installations. The [Pending Changes](#changes-view) view applies the rules only to the next time you run an Ops Manager install, without saving them.
### <a id="errands-pane"></a> Errands Pane: Persistent Rules
Product tiles for <%= vars.app_runtime_abbr %> and other <%= vars.platform_name %> products have an **Errands** pane that configures the run rules for the product's errands and saves the settings for later.
The **Errands** pane lists all errands for the product and lets you select **On** or **Off**. The [default](#defaults) option differs depending on the errand, and reflects the default setting used by Ops Manager for the errand or any tile-specific default that overrides it.
<%= image_tag("errands-on.png") %>
To configure the run rules for a tile, do the following:
1. Navigate to Ops Manager and click the tile to open it.
1. Under the **Settings** tab, open the **Errands** pane.
1. Use the dropdowns to configure the run rule choice for each errand: **On** or **Off**.
1. Click **Save** to save the configuration values and return to the Installation Dashboard.
1. Click **Review Pending Changes**, then **Apply Changes** to redeploy the tile with the new settings.
### <a id="changes-view"></a> Pending Changes: One-Time Rules
Ops Manager lets you quickly configure one-time errand run rules for any product queued up for installation:
1. Navigate to Ops Manager. The **Pending Changes** section at top right shows products that Ops Manager has yet to install or update.
1. Under **Pending Changes**, click the product you wish to configure. A list of errands associated with the product appears.
<%= image_tag("pending_view_errands.png") %>
1. Use the dropdowns to configure the [run rule](#rules) choice for each errand: **On** or **Off**. Ops Manager applies these settings once you click **Review Pending Changes**, then **Apply Changes** to install the product, but does not save the settings for future installations.
1. Click **Review Pending Changes**, then **Apply Changes** to redeploy the tile.
## <a id="related"></a> Related Links
If you are a product developer and want to learn more about adding errands to your product tile for <%= vars.platform_name %>, see the [Errands](https://docs.pivotal.io/tiledev/tile-errands.html) topic in the _<%= vars.platform_name %> Tile Developer Guide_.