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

# apaxsoftware/dream-ops

Install and configure the dream-ops command-line interface (dream).


## Commands

### install_cli

This command installs ruby and the dream-ops gem.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `dreamops_version` | string | >= 0.9.0 | The version of the dream-ops gem to use. |
| `ruby_version` | string | 3.4.7 | The version of the ruby to use. |

## Jobs

### deploy_opsworks

Kicks off a opsworks deployment for the specified targets.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `aws_access_key_id` | env_var_name | AWS_ACCESS_KEY_ID | AWS access key id for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. AWS_ACCESS_KEY_ID.
 |
| `aws_region` | env_var_name | AWS_DEFAULT_REGION | AWS region to operate in. Set this to the name of the environment variable you will use to hold this value, i.e. AWS_DEFAULT_REGION. |
| `aws_secret_access_key` | env_var_name | AWS_SECRET_ACCESS_KEY | AWS secret key for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. AWS_SECRET_ACCESS_KEY.
 |
| `dreamops_version` | string | >= 0.9.0 | The version of the dream-ops gem to use. |
| `force_setup` | boolean | false | Always run setup. |
| `ruby_version` | string | 3.4.7 | The version of the ruby to use. |
| `targets` | string |  | Deploy targets separated by whitespace. |

### deploy_solo

Kicks off a chef-solo deployment for the specified targets.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `dreamops_version` | string | >= 0.9.0 | The version of the dream-ops gem to use. |
| `force_setup` | boolean | false | Always run setup. |
| `ruby_version` | string | 3.4.7 | The version of the ruby to use. |
| `ssh_key` | env_var_name |  | The ssh key to use for solo deployments |
| `targets` | string |  | Deploy targets separated by whitespace. |

### deploy_solo_ip_ranges

Kicks off a chef-solo deployment for the specified targets.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `dreamops_version` | string | >= 0.9.0 | The version of the dream-ops gem to use. |
| `force_setup` | boolean | false | Always run setup. |
| `ruby_version` | string | 3.4.7 | The version of the ruby to use. |
| `ssh_key` | env_var_name |  | The ssh key to use for solo deployments |
| `targets` | string |  | Deploy targets separated by whitespace. |

## Examples

### deploy_opsworks

Sample opsworks deployment.


```yaml
version: '2.1'
orbs:
  dream: apaxsoftware/dream-ops@2.1.1
workflows:
  use-my-orb:
    jobs:
      - dream/deploy_opsworks:
          targets: abcdefgh-ijk1-1234-m1n2-opqrstuvwxyz
```

### deploy_solo

Sample chef-solo deployment.


```yaml
version: '2.1'
orbs:
  dream: apaxsoftware/dream-ops@2.1.1
workflows:
  use-my-orb:
    jobs:
      - dream/deploy_solo:
          ssh_key: TEST_SSH_KEY
          targets: ubuntu@1.1.1.1
```