edeliver
edeliver v1.9.0-rc.3

View Source Edeliver.Relup.Instructions.Info (edeliver v1.9.0-rc.3)

This upgrade instruction logs the given info message on the node which runs the upgrade

and in the running upgrade script which was started by the $APP/bin/$APP upgrade $RELEASE command. Usage:

  Edeliver.Relup.Instructions.Info.modify_relup(config,
      _up_message="Synchronizing nodes",
      _down_message="Desynchronizing nodes",
      _insert_where = &append_after_point_of_no_return/2)`

Available sections are:

  • :check -> Checks whether upgrade is possible. Before "point of no return"
  • :suspend -> Suspends processes before the upgrade. Right after the "point of no return"
  • :upgrade -> Runs the upgrade by (un-)loading new(/old) code and updating processes and applications
  • :resume -> Resumes processes after the upgrade that were suspended in the :suspend section.
  • :finished -> The upgrade finished successfully

Link to this section Summary

Functions

arguments(instructions, map)

Callback implementation for Edeliver.Relup.RunnableInstruction.arguments/2.

call_this(arguments \\ [])

Calls the run/1 function of this module

dependencies()

Callback implementation for Edeliver.Relup.RunnableInstruction.dependencies/0.

insert_where()

Callback implementation for Edeliver.Relup.RunnableInstruction.insert_where/0.

modify_relup(instructions, config)

Callback implementation for Edeliver.Relup.Instruction.modify_relup/2.

modify_relup(instructions, config, up_message \\ "", down_message \\ "", insert_where_fun \\ &append_after_point_of_no_return/2)
run(message)

Logs the message on the node which is upgraded

Link to this section Functions

Link to this function

arguments(instructions, map)

View Source 
@spec arguments(
  %Edeliver.Relup.Instructions{
    changed_modules: term(),
    down_instructions: term(),
    down_version: term(),
    up_instructions: term(),
    up_version: term()
  },
  Edeliver.Relup.Config.t()
) :: term()

Callback implementation for Edeliver.Relup.RunnableInstruction.arguments/2.

Link to this function

call_this(arguments \\ [])

View Source 
@spec call_this(arguments :: [term()]) ::
  Instruction.instruction() | Instruction.instructions()

Calls the run/1 function of this module

from the relup file during hot code upgrade

Link to this function

dependencies()

View Source 
@spec dependencies() :: [instruction_module :: atom()]

Callback implementation for Edeliver.Relup.RunnableInstruction.dependencies/0.

Link to this function

insert_where()

View Source 
@spec insert_where() :: Instruction.insert_fun()

Callback implementation for Edeliver.Relup.RunnableInstruction.insert_where/0.

Link to this function

modify_relup(instructions, config)

View Source

Callback implementation for Edeliver.Relup.Instruction.modify_relup/2.

Link to this function

modify_relup(instructions, config, up_message \\ "", down_message \\ "", insert_where_fun \\ &append_after_point_of_no_return/2)

View Source 
@spec modify_relup(
  instructions :: Edeliver.Relup.Instructions.t(),
  config :: Edeliver.Relup.Config.t(),
  up_message :: String.t(),
  down_message :: String.t(),
  insert_where :: Instruction.insert_fun()
) :: Edeliver.Relup.Instructions.t()
Link to this function

run(message)

View Source 
@spec run(message :: String.t()) :: :ok

Logs the message on the node which is upgraded

and in the upgrade script which was started by the $APP/bin/$APP upgrade $RELEASE command.