Module custom-role

init (opts)

Role initialization callback. Called when role is enabled on an instance. Caused either by editing topology or instance restart.

Parameters:

• opts:
  • is_master: (boolean)

stop (opts)

Role shutdown callback. Called when role is disabled on an instance.

Parameters:

• opts:
  • is_master: (boolean)

validate_config (conf_new, conf_old)

Validate clusterwide configuration callback. Called when role is enabled on an instance.

Parameters:

• conf_new: (table)
• conf_old: (table)

apply_config (conf, opts)

Apply clusterwide configuration callback.

Parameters:

• conf: (table) Clusterwide configuration
• opts:
  • is_master: (boolean)

get_issues ()

Announce issues to be shown in the Cartridge WebUI.

The callback should return an array of issues, where every issue is a table with fields level , topic , and message . Like the following:

-- myrole.lua

local function get_issues()
    return {{
        level = 'warning',
        topic = 'myrole',
        message = 'custom issue description',
    }}
end

All fields are optional. Extra fields are ignored.

role_name

Displayed role name. When absent, module name is used instead.

• role_name: (string)

hidden

Hidden role flag. Aren’t listed in cartridge.admin_get_replicasets().roles and therefore in WebUI. Hidden roled are supposed to be a dependency for another role.

• hidden: (boolean)

permanent

Permanent role flag. Permanent roles will be enabled on every instance in cluster. Implies hidden = true .

• permanent: (boolean)