> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# itinerisltd/tiller-circleci

Deploy Trellis, Bedrock and Sage(optional) via CircleCI

## Commands

### add_ssh_known_hosts

Add SSH known hosts

| Parameter | Type | Default | Description |
|---|---|---|---|
| `known-hosts` | string |  | comma separated hosts you expected to connect include VCS and your remote servers |

### deploy_trellis

Deploy Trellis

| Parameter | Type | Default | Description |
|---|---|---|---|
| `site-env` | string |  | the environment to deploy to, e.g: staging, production, etc |
| `site-name` | string |  | the WordPress site to deploy as defined in wordpress_sites |

### prepare_trellis

Clone the Trellis repo, set up ansible vault password and install ansible galaxy roles

| Parameter | Type | Default | Description |
|---|---|---|---|
| `cache-version` | string | v9 | Change the default cache version if you need to clear the cache for any reason |
| `trellis-branch` | string | master | trellis branch, commit hash or tag |
| `trellis-repo` | string |  | trellis repository. Must be a SSH URL |
| `vault-password` | env_var_name | VAULT_PASSWORD | ansible vault password environment variable name |
| `vault-password-file-name` | string | .vault_pass | ansible vault password file to use. Must be the same one in ansible.cfg |

### print_dependency_versions

Print dependency versions

## Jobs

### deploy

Deploy Trellis, Bedrock and Sage(optional) via CircleCI
Expecting Trellis and Bedrock to be 2 separate repositories https://github.com/roots/trellis/issues/883#issuecomment-329052189
Expecting build steps do not require local Bedrock source code https://github.com/roots/trellis/pull/997 OR https://github.com/roots/trellis/pull/1030


| Parameter | Type | Default | Description |
|---|---|---|---|
| `cache-version` | string | v9 | Change the default cache version if you need to clear the cache for any reason |
| `deploy-command` | string |  | custom deploy command |
| `executor-tag` | string | base | Pick a specific itinerisltd/tiller-circleci image version tag:
https://hub.docker.com/r/itinerisltd/tiller-circleci/tags
 |
| `known-hosts` | string |  | comma separated hosts you expected to connect include VCS and the remote servers
 |
| `setup` | steps |  | Provide any optitonal steps you would like to run prior to deployment |
| `site-env` | string |  | the environment to deploy to, e.g: staging, production, etc. Ignored if using custom deploy command
 |
| `site-name` | string |  | the WordPress site to deploy, as defined in wordpress_sites. Ignored if using custom deploy command
 |
| `trellis-branch` | string | master | trellis branch, commit hash or tag |
| `trellis-repo` | string |  | trellis repository. Must be a SSH URL |
| `vault-password` | env_var_name | VAULT_PASSWORD | ansible vault password environment variable name |
| `vault-password-file-name` | string | .vault_pass | ansible vault password file to use. Must be the same one in ansible.cfg |

## Executors

### default

Uses CircleCI's highly cached convenience images built for CI. Any available tag
from this list can be used:
https://hub.docker.com/r/itinerisltd/tiller-circleci/tags


| Parameter | Type | Default | Description |
|---|---|---|---|
| `tag` | string | base | Pick a specific itinerisltd/tiller-circleci image version tag:
https://hub.docker.com/r/itinerisltd/tiller-circleci/tags
 |