Skip to content

Deployment Destination

Vladislav Alekseev edited this page Sep 22, 2021 · 10 revisions

This model is defined by DeploymentDestination.swift source file.

This model describes a machine that is capable of running Emcee and execute tests. It can be used to describe where to spawn Emcee worker process or where to start shared queue Emcee process.

Fields

host: String

A hostname. Used by Emcee to connect to that host via SSH using port, login and password.

Emcee will also set workerId to be equal to the host. workerId entity is used throughout Emcee everywhere: in analytics, in worker-queue REST APIs, in reports, when configuring per-machine capabilities in queue server configuration (e.g. this machine can run 5 simulators max.)

port: Int

Defines on what port Emcee should look for SSH daemon. Usual value is 22.

username: String

SSH username

authentication: Object

  • to use password auth: {"authentication": {"password": "<YOUR PASS>"}}

  • to use a key at arbitrary location: {"authentication": {"keyPath": "/local/path/to/key"}}

    Note: you will need to have a public key available at /local/path/to/key.pub too. libssh will require its presence. If you won't have the public key next to the private key, Emcee is likely to stuck with message "Enter passphrase for ...".

  • Version 15 and later: to use a key file inside user's ~/.ssh/: {"authentication": {"filename": "key"}}

remoteDeploymentPath: AbsolutePath

Defines absolute remote path. Emcee will use it to upload itself to this path. This path should be readable and writable by the username.