Hosts

To define a new host use the host() function. Deployer keeps a list of all defined hosts in the Deployer::get()->hosts collection.

host('example.org');

Each host contains it's own configuration key-value pairs. The host() call defines two important configs: alias and hostname.

hostname - used when connecting to remote host.
alias - used as a key in Deployer::get()->hosts collection.

task('test', function () {
    writeln('The {{alias}} is {{hostname}}');
});

$ dep test
[example.org] The example.org is example.org

We can override hostname via set() method:

host('example.org')
    ->set('hostname', 'example.cloud.google.com');

The hostname will be used for the ssh connection, but the host will be referred to by it's alias when running Deployer.

$ dep test
[example.org] The example.org is example.cloud.google.com

Another important ssh connection parameter is remote_user.

host('example.org')
    ->set('hostname', 'example.cloud.google.com');
    ->set('remote_user', 'deployer');

Now Deployer will connect using something like ssh deployer@example.cloud.google.com to establishing connection.

Also, Deployer's Host class has special setter methods (for better IDE autocompletion).

host('example.org')
    ->setHostname('example.cloud.google.com');
    ->setRemoteUser('deployer');

:::info Config file It is a good practice to keep connection parameters out of deploy.php file, as they can change depending on where the deploy is executed from. Only specify hostname and remote_user and other keep in ~/.ssh/config:

Host *
  IdentityFile ~/.ssh/id_rsa

:::

Host config

Method	Value
`setHostname`	The `hostname`
`setRemoteUser`	The `remote_user`
`setPort`	The `port`
`setConfigFile`	For example, `~/.ssh/config`.
`setIdentityFile`	For example, `~/.ssh/id_rsa`.
`setForwardAgent`	Default: `true`.
`setSshMultiplexing`	Default: `true`.
`setShell`	Default: `bash -ls`.
`setDeployPath`	For example, `~/myapp`.
`setLabels`	Key-value pairs for host selector.
`setSshArguments`	For example, `['-o UserKnownHostsFile=/dev/null']`

Multiple hosts

You can pass multiple hosts to the host function:

host('example.org', 'deployer.org', ...)
    ->setRemoteUser('anton');

Host ranges

If you have a lot of hosts following similar patterns, you can describe them like this rather than listing each hostname:

host('www[01:50].example.org');

For numeric patterns, leading zeros can be included or removed, as desired. Ranges are inclusive.

You can also define alphabetic ranges:

host('db[a:f].example.org');

Localhost

The localhost() function defines a special local host. Deployer will not connect to this host, but will execute commands locally instead.

localhost(); // Alias and hostname will be "localhost".
localhost('ci'); // Alias is "ci", hostname is "localhost".

YAML Inventory

You can use the import() function to keep host definitions in a separate file. For example, inventory.yaml.

import('inventory.yaml');

hosts:
  example.org:
    remote_user: deployer
  deployer.org:
    remote_user: deployer

3.8 KiB Raw Blame History