edeliver v1.2.9 Edeliver.Relup.Instructions.Info

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 upgarde $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

Summary

Functions

arguments(instructions, config)

Specs

arguments(%Edeliver.Relup.Instructions{changed_modules: term, down_instructions: term, down_version: term, up_instructions: term, up_version: term}, %ReleaseManager.Config{dev: term, env: term, erl: term, name: term, package: term, relx_config: term, upgrade?: term, verbosity: term, version: term}) :: term

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

call_this(arguments \\ [])

Specs

call_this(arguments :: [term]) ::
  Instruction.instruction |
  Instruction.instructions

Calls the run/1 function of this module

from the relup file during hot code upgrade

dependencies()

Specs

dependencies :: [instruction_module :: atom]

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

insert_where()

Specs

insert_where :: Instruction.insert_fun

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)

Specs

modify_relup(instructions :: Edeliver.Relup.Instructions.t, config :: %ReleaseManager.Config{dev: term, env: term, erl: term, name: term, package: term, relx_config: term, upgrade?: term, verbosity: term, version: term}, up_message :: String.t, down_message :: String.t, insert_where :: Instruction.insert_fun) :: Edeliver.Relup.Instructions.t
run(message)

Specs

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 upgarde $RELEASE command.