Skip to content

Commit

Permalink
This closes #213
Browse files Browse the repository at this point in the history
  • Loading branch information
drigodwin committed Sep 16, 2017
2 parents 4e997d5 + b0d1434 commit c3d5e1b
Showing 1 changed file with 43 additions and 1 deletion.
44 changes: 43 additions & 1 deletion guide/blueprints/policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Common uses of a policy include the following:
* invoke effectors (management policies) or,
* cause the entity associated with the policy to emit sensor values (enricher policies).

Entities can have zero or more ``Policy`` instances attached to them.
Entities can have zero or more `Policy` instances attached to them.


Off-the-Shelf Policies
Expand Down Expand Up @@ -100,6 +100,48 @@ 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 policy monitors the
sensor configured by `start.sensor` and will only start when this is set to `true`. The default sensor checked is `service.isUp`,
so that the policy will not execute the effector until the entity is started. 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 at a specific time. The policy monitors the sensor configured by `start.sensor`
and will only execute the effector at the specified time if this is set to `true`.

There are two modes of operation, one based solely on policy configuration where the effector will execute at the time set
using the `time` key or after the duration set using the `wait` key, or by monitoring sensors. The policy monitors the
`scheduler.invoke.now` sensor and will execute the effector immediately when its value changes to `true`.
When the `scheduler.invoke.at` sensor changes, it will set a time in the future when the effector should be executed.

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 c3d5e1b

Please sign in to comment.