Skip to content

Commit

Permalink
Add docs for Scheduled and PeriodicEffectorPolicy
Browse files Browse the repository at this point in the history
  • Loading branch information
drigodwin committed Sep 14, 2017
1 parent 4e997d5 commit 91484a6
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions guide/blueprints/policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,39 @@ The ConnectionFailureDetector is an HA policy for monitoring an http connection,

### Optimization Policies

#### PeriodicEffector Policy

- org.apache.brooklyn.policy.action.PeriodicEffectorPolicy

The `PeriodicEffectorPolicy` calls an effector with a set of arguments at a specified time and date. The following example
calls a `resize` effector to resize a cluster up to 10 members at 8am and then down to 1 member at 6pm.

- type: org.apache.brooklyn.policy.action.PeriodicEffectorPolicy
brooklyn.config:
effector: resize
args:
desiredSize: 10
period: 1 day
time: 08:00:00
- type: org.apache.brooklyn.policy.action.PeriodicEffectorPolicy
brooklyn.config:
effector: resize
args:
desiredSize: 1
period: 1 day
time: 18:00:00

#### ScheduledEffector Policy

- org.apache.brooklyn.policy.action.ScheduledEffectorPolicy

The `ScheduledEffectorPolicy` calls an effector after a specified interval has expired. The interval can be triggered from a sensor, `SERVICE_UP` by default.
The following example calls a `backup` effector every night at midnight.

- type: org.apache.brooklyn.policy.action.ScheduledEffectorPolicy
brooklyn.config:
effector: backup
time: 00:00:00

#### FollowTheSun Policy

Expand Down

0 comments on commit 91484a6

Please sign in to comment.