SSH

Emcee client may use SSH to deploy queue server and workers to the machines. You have to explicitly set type to deploy in emceeplan to tell Emcee to deploy itself :

queue:
  type: deploy
  #...

Next, specify deployment configuration for queue and workers in emceeplan defining host, ssh and optional id for workers:

queue:
  type: deploy
  host: localhost
  queuePort: 41000
  ssh:
    username: _emcee
    identity:
      type: publicKey
      keyPath: /Users/YOUR_USER/.ssh/id_ed25519_emcee
  workers:
    - host: localhost
      configuration:
        port: 41001
        numberOfSimulators: 3
      #...

host

FQDN, ip or hostname where queue or worker should be deployed. For instance, worker777.com, 10.8.0.1, localhost.

queuePort

Queue service port. 41000 if not set in emceeplan.

worker.configuration.port

Worker service port. 41001 if not set in emceeplan.

worker.configuration.numberOfSimulators

Specify required simulator count, it's up to you to assess how many of simulators your worker host can run. 3 by default.

ssh

For SSH access you configure username and identity. The latter in turn may be of type publicKey or password.

You should configure ssh identity for queue and this identity will be used for workers by default. You may override ssh configuration for every worker if needed this way:

queue:
  type: deploy
  host: 10.8.0.1
  sshPort: 10022
  #...
  ssh:
    username: some_user_0
    identity: #...
  workers:
    - host: 10.8.0.2
      sshPort: 22
      ssh:
        username: some_user_1
        identity: #...
      #...
    - host: 10.8.0.3
      ssh:
        username: some_user_2
        identity: #...
      #...

Adjust sshPort for queue or worker deployments if you need to port-forwart into internal network.

public key authentication

  ssh:
    username: _emcee
    identity:
      type: publicKey
      keyPath: /Users/YOUR_USER/.ssh/id_ed25519_emcee
  #...

Modern MacOS does not support rsa keys. id_ed25519 or dsa are recommended instead

If you encounter problems with ssh deployment check private key file permissions

password authentication

  ssh:
    username: _emcee
    identity:
      type: password
      password: YOUR_PASSWORD
  #...

worker id

Setting worker id actually affects only analytics and logs, so use it to increase system observability.

If omit hostname will be used as worker id.