Fixes #9840 : Introduce ruby option for trigger

This commit introduces a new option to the core trigger feature: `ruby`.
It can be defined to run ruby code when the trigger is configured to
fire. If you give the ruby block an env and machine argument, the
defined ruby code can use those variables internally.

2018-10-05 12:53:41 -07:00

3.0 KiB

Raw Blame History

layout	page_title	sidebar_current	description
docs	Vagrant Triggers Configuration	triggers-configuration	Documentation of various configuration options for Vagrant Triggers

Configuration

Vagrant Triggers has a few options to define trigger behavior.

Options

The trigger class takes various options.

action (symbol, array) - Expected to be a single symbol value, an array of symbols, or a splat of symbols. The first argument that comes after either before or after when defining a new trigger. Can be any valid Vagrant command. It also accepts a special value :all which will make the trigger fire for every action. An action can be ignored with the ignore setting if desired. These are the valid action commands for triggers:
- destroy
- halt
- provision
- reload
- resume
- suspend
- up
ignore (symbol, array) - Symbol or array of symbols corresponding to the action that a trigger should not fire on.
info (string) - A message that will be printed at the beginning of a trigger.
name (string) - The name of the trigger. If set, the name will be displayed when firing the trigger.
on_error (symbol) - Defines how the trigger should behave if it encounters an error. By default this will be :halt, but can be configured to ignore failures and continue on with :continue.
only_on (string, regex, array) - Limit the trigger to these guests. Values can be a string or regex that matches a guest name.
ruby (block) - A block of Ruby code to be executed. Can only be a Proc type. Two optional arguments may be passed into the given block: env and machine. These options correspond to the environment used, and the machine that the trigger is firing on. If no options are provided to the block, then they will not be available to be used with your Ruby code.
```
ubuntu.trigger.after :up do |trigger|
  trigger.info = "More information"
  trigger.ruby do |env,machine|
    greetings = "hello there #{machine.id}!"
    puts greetings
  end
end
```
run_remote (hash) - A collection of settings to run a inline or remote script with on the guest. These settings correspond to the shell provisioner.
run (hash) - A collection of settings to run a inline or remote script on the host. These settings correspond to the shell provisioner. However, at the moment the only settings run takes advantage of are:
- args
- inline
- path
warn (string) - A warning message that will be printed at the beginning of a trigger.
exit_codes (integer, array) - A set of acceptable exit codes to continue on. Defaults to 0 if option is absent. For now only valid with the run option.
abort (integer,boolean) - An option that will exit the running Vagrant process once the trigger fires. If set to true, Vagrant will use exit code 1. Otherwise, an integer can be provided and Vagrant will it as its exit code when aborting.

3.0 KiB Raw Blame History

Configuration

Options

3.0 KiB

Raw Blame History