KantanCluster (kantan_cluster v0.2.4) View Source
Form a simple Erlang cluster easily in Elixir.
Link to this section Summary
Functions
Connects current node to specified nodes.
Disconnects current node from speficied nodes.
Starts a node and attempts to connect it to specified nodes. Configuration options can be specified as an argument
Stops a node and all the connections.
Link to this section Types
Specs
node_type() :: :longnames | :shortnames
A node type. See Node.start/3
.
Specs
option() :: {:node, binary() | {node_type(), node()}} | {:cookie, atom()} | {:connect_to, node() | [node()]}
Options for a cluster.
:node
- the name of a node that you want to start
- default:
{:longnames, :"xxxx@yyyy.local"}
wherexxxx
is a random string,yyyy
is the hostname of a machine - examples:
"node1"
{:longnames, :"node1@nerves-mn00.local"
}{:shortnames, :"node1@nerves-mn00"
}
:cookie
- Erlang magic cookie to form a cluster
- default: random cookie
:connect_to
- a list of nodes we want our node to be connected with
- default:
[]
Link to this section Functions
Specs
Connects current node to specified nodes.
Specs
Disconnects current node from speficied nodes.
Specs
start([option()]) :: :ok
Starts a node and attempts to connect it to specified nodes. Configuration options can be specified as an argument
KantanCluster.start(
node: "node1",
cookie: :hello,
connect_to: [:"nerves@nerves-mn00.local"]
)
or in your config/config.exs
.
config :kantan_cluster,
node: "node1",
cookie: :hello,
connect_to: [:"nerves@nerves-mn00.local"]
Specs
stop() :: :ok | {:error, :not_allowed | :not_found}
Stops a node and all the connections.