edeliver v1.2.6 Edeliver.Relup.Instructions.StartSection

This upgrade instruction starts a new section

and logs that info on the node which runs the upgrade and in the upgrade script started by the $APP/bin/$APP upgarde $RELEASE command. Usage:

  Edeliver.Relup.Instructions.StartSection.modify_relup(config, _section = :check)

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

It uses the Edeliver.Relup.Instructions.Info instruction to display the section information.

Summary

Types

insert_fun()

instruction()

instructions()

section()

Functions

modify_relup(instructions, config, section \\ :default)

Types

insert_fun :: (%Edeliver.Relup.Instructions{changed_modules: term, down_instructions: term, down_version: term, up_instructions: term, up_version: term} | instructions, new_instructions :: instruction | instructions -> updated_instructions :: %Edeliver.Relup.Instructions{changed_modules: term, down_instructions: term, down_version: term, up_instructions: term, up_version: term} | instructions)

instruction :: :relup.instruction

instructions :: [instruction]

section ::
  :check |
  :suspend |
  :upgrade |
  :resume |
  :finished

Functions

modify_relup(instructions, config, section \\ :default)

Specs

modify_relup(instructions :: %Edeliver.Relup.Instructions{changed_modules: term, down_instructions: term, down_version: term, up_instructions: term, up_version: term}, config :: %ReleaseManager.Config{dev: term, env: term, erl: term, name: term, package: term, relx_config: term, upgrade?: term, verbosity: term, version: term}, section_or_message :: section | String.t) :: %Edeliver.Relup.Instructions{changed_modules: term, down_instructions: term, down_version: term, up_instructions: term, up_version: term}