crossbar.edge.node

Submodules

• crossbar.edge.node.docker
• crossbar.edge.node.management
• crossbar.edge.node.node

Classes

FabricNode	Crossbar.io node personality.
FabricNodeControllerSession	This is the central node controller for CF nodes.

Package Contents

class FabricNode(personality, cbdir=None, reactor=None, native_workers=None, options=None)

Bases: crossbar.node.node.Node

Crossbar.io node personality.

DEFAULT_CONFIG_PATH = 'edge/node/config/bare.json'

NODE_CONTROLLER

_add_extra_controller_components(controller_config)

_add_worker_role(worker_auth_role, options)

_bridge_session = None

_check_for_activation_file = None

_configure_native_worker_connections(worker_logname, worker_id, worker)

_configure_native_worker_container(worker_logname, worker_id, worker)

_configure_native_worker_hostmonitor(worker_logname, worker_id, worker)

_configure_native_worker_router(worker_logname, worker_id, worker)

_configure_native_worker_xbrmm(worker_logname, worker_id, worker)

_displayed_pairing_message = False

_enable_docker = None

_extend_worker_args(args, options)

_has_management_config = False

_local_config_applied = False

_maker_no = 1

_management_realm = None

_management_url = None

_manager = None

_manager_runner = None

_node_extra = None

_node_id = None

_realm = 'crossbar'

_set_shutdown_triggers(controller_options)

_was_management_connected = False

_watchdog()

_watchdog_looper = None

boot(use_activation_file=True, use_default_fabric=False)

load_config(configfile=None)

Check and load the node configuration from:

• from .crossbar/config.json or

• from built-in (empty) default configuration

This is the _second_ function being called after the Node has been instantiated.

IMPORTANT: this function is run _before_ start of Twisted reactor!

start(node_id=None)

Starts this node. This will start a node controller and then spawn new worker processes as needed.

The node keys (load_keys) and configuration (load_config) has to be loaded before starting the node.

This is the _third_ function being called after the Node has been instantiated.

class FabricNodeControllerSession(node)

Bases: crossbar.node.controller.NodeController

This is the central node controller for CF nodes.

It derives of the node controller base class in CB and adds the following functionality exposed to CFC:

• can manage a host Docker daemon

_docker_client = None

_ensure_docker()

_shutdown(restart=False, mode=None)

backlog_docker_container(container_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerbacklog_container

create_docker_container(image, config={}, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockercreate_container

delete_docker_image(image_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerdelete_image

destroy_docker_container(container_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerremove_container

fs_docker_get(id, path, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerfsget

fs_docker_open(id, path, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerfsopen

fs_docker_put(id, path, data, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerfsput

get_docker_container(container_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerget_container

get_docker_containers(details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerget_containers

get_docker_df(details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerget_df

get_docker_image(image_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerget_image

get_docker_images(details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerget_images

get_docker_info(details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerget_info

get_docker_ping(details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerget_ping

get_docker_version(details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerget_version

get_status(details=None)

Return basic information about this node.

Returns:

Information on the Crossbar.io node.

Return type:

dict

keystroke_docker_container(container_id, data, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerkeystroke_container

log

onConnect()

Implements autobahn.wamp.interfaces.ISession.onConnect()

onUserError(fail, msg)

Implements autobahn.wamp.interfaces.ISession.onUserError()

pause_docker_container(container_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerpause_container

prune_docker_images(filter, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerprune_image

remove_docker_image(image_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerremove_image

request_docker_tty(id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerrequest_tty`

restart_docker_container(container_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerrestart_container

shell_docker_container(container_id, tty_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockershell_container

start_docker_container(container_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerstart_container

stop_docker_container(container_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerstop_container

unpause_docker_container(container_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerunpause_container

watch_docker_container(container_id, tty_id, details=None)

https://github.com/crossbario/crossbar-fabric-public/blob/master/docs/api/Management-API.md#crossbarfabriccenterremotedockerwatch_container