caviar.domain

Domain module.

class caviar.domain.Domain(engine, name, admin_host, admin_port, running, restart_required)

Bases: object

Domain.

Parameters:engine (caviar.engine.Engine) – Underlying engine.
name

Domain name.

Return type:str
admin_port

Administrator port.

Return type:str
manage(admin_user, admin_password)

Manage this domain.

Ensure it is running and without requiring to be restarted, and update its state.

Parameters:
  • admin_user (str) – Name of the administrator user.
  • admin_password (str) – Password of the administrator user.
Return type:

ManagedDomain
Returns:

The managed domain.
class caviar.domain.ManagedDomain(context)

Bases: object

Managed domain.

Parameters:context (ManagedDomainContext) – Managed domain context.
nodes()

Available nodes.

Return type:iter
Returns:Iterator that yields available nodes.
create_node(name, allocator_name)

Create a node on this domain.

Parameters:
  • name (str) – Node name.
  • allocator_name (str) – Node allocator name.
Return type:

node.Node
Returns:

The created node.
clusters()

Available clusters.

Return type:iter
Returns:Iterator that yields available clusters.
create_cluster(name)
class caviar.domain.ManagedDomainContext(engine, domain_name, admin_port, admin_user, admin_password)

Bases: object

Managed domain context.

Parameters:
  • engine (caviar.engine.Engine) – Underlying engine.
  • domain_name (str) – Domain name.
  • admin_port (str) – Administrator port.
  • admin_user (str) – Administrator user name.
  • admin_password (str) – Administrator password.
node_dir

Node directory.

Return type:str
management()

Domain management for this context.

Return type:caviar.engine.management.Management
Returns:Domain management.
prepare_node(allocator_name, name)

Prepare an allocated node.

Parameters:
  • allocator_name (str) – Node allocator name.
  • name (str) – Node name.
Return type:

str
Returns:

Node allocator host.
class caviar.domain.Environment(engine)

Bases: object

GlassFish environment.

Parameters:engine (caviar.engine.Engine) – GlassFish engine.
domains()

Available domains.

Return type:iter
Returns:Iterator that yields available domains.
create_domain(name, admin_user, admin_password)

Create a domain.

Parameters:
  • name (str) – Domain name.
  • admin_user (str) – Administrator user name.
  • admin_password (str) – Administrator user password.
Return type:

Domain
Returns:

The created domain.
close()

Close this environment.

Shutdown the engine.

caviar.domain.environment(machinery_module_name, machinery_params, mgmt_public_key_path, mgmt_private_key_path, master_password, log_out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>, ssh_module_name='caviar.provider.ssh.paramiko', das_server_name='das', node_alloc_server_prefix='nodealloc')

Restore the specified environment.

Parameters:
  • machinery_module_name (str) – Machinery module name.
  • machinery_params (dict) – Machinery parameters.
  • mgmt_public_key_path (str) – Management public key path.
  • mgmt_private_key_path (str) – Management private key path.
  • master_password (str) – Used master password.
  • log_out (fileobj) – Logging output.
Return type:

Environment
Returns:

The restored environment.