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

# deployhub/deployhub-orb

DeployHub Integration. This Orb approves, moves, updates microservices, assigns application versions, and deploys objects passing in data between the CircleCI pipeline to DeployHub.


## Commands

### microservice_version_update

Update the microservice or component with git and build data

| Parameter | Type | Default | Description |
|---|---|---|---|
| `dhuser` | env_var_name | DH_USERID | Name of env var storing UserId to access DeployHub |
| `dhpass` | env_var_name | DH_PASSWORD | Name of env var storing dhpass to access DeployHub |
| `dhurl` | env_var_name | DH_SERVERURL | Name of env var storing URL to the DeployHub Server |
| `application` | string |  | Application Name to associate the component to |
| `appversion` | string |  | Application Version to associate the component to |
| `compname` | string |  | Component Name being updated |
| `compversion` | string |  | Component Version being updated |
| `comptype` | string | --docker | Type of component, --docker or --file |
| `helmchart` | string | $COMPONENT_CHARTNAME | Helm Chart Name |
| `registry` | string | $DOCKER_REGISTRY | Docker Registry Name |
| `image` | string | $COMPONENT_IMAGENAME | Image Name |
| `tag` | string | $IMAGE_TAG | Image Tag |
| `imagesha` | string | $(</tmp/digest.txt) | sha of the container |
| `customaction` | string | GLOBAL.HelmChart | Custom Action |

### approve

Approves an Application Version for the current stage of the pipeline

| Parameter | Type | Default | Description |
|---|---|---|---|
| `dhuser` | env_var_name | DH_USERID | Name of env var storing UserId to access DeployHub |
| `dhpass` | env_var_name | DH_PASSWORD | Name of env var storing dhpass to access DeployHub |
| `dhurl` | env_var_name | DH_SERVERURL | Name of env var storing URL to the DeployHub Server |
| `application` | string |  | Application Name to Approve |
| `appversion` | string |  | Application Version to Approve |

### move

Moves an Application Version from the 'from' stage of the pipeline to another stage using the Move Task

| Parameter | Type | Default | Description |
|---|---|---|---|
| `dhuser` | env_var_name | DH_USERID | Name of env var storing UserId to access DeployHub |
| `dhpass` | env_var_name | DH_PASSWORD | Name of env var storing dhpass to access DeployHub |
| `dhurl` | env_var_name | DH_SERVERURL | Name of env var storing URL to the DeployHub Server |
| `application` | string |  | Application Name to Move |
| `appversion` | string |  | Application Version to Move |
| `from_domain` | string |  | Pipeline stage to move from |
| `move_task` | string |  | 'Move Task' used to move the application version to desired stage |

### deploy

Deploys an Application Version to an Environment

| Parameter | Type | Default | Description |
|---|---|---|---|
| `dhuser` | env_var_name | DH_USERID | Name of env var storing UserId to access DeployHub |
| `dhpass` | env_var_name | DH_PASSWORD | Name of env var storing dhpass to access DeployHub |
| `dhurl` | env_var_name | DH_SERVERURL | Name of env var storing URL to the DeployHub Server |
| `application` | string |  | Application Name to Deploy |
| `appversion` | string |  | Application Version to Deploy |
| `environment` | string |  | Environment to Deploy to |

### deploy_component

Deploys an Application Version to an Environment based on a Component

| Parameter | Type | Default | Description |
|---|---|---|---|
| `dhuser` | env_var_name | DH_USERID | Name of env var storing UserId to access DeployHub |
| `dhpass` | env_var_name | DH_PASSWORD | Name of env var storing dhpass to access DeployHub |
| `dhurl` | env_var_name | DH_SERVERURL | Name of env var storing URL to the DeployHub Server |
| `compname` | string |  | Component Name being deployed |
| `compversion` | string |  | Component Version being deployed |

### envscript

Generate the environment variable script from the TOML file

| Parameter | Type | Default | Description |
|---|---|---|---|
| `envvars` | string |  | Name of the input environment TOML file |
| `envvars_sh` | string |  | Name of output shell script name |

## Jobs

### approve_job

Approve an Application Version

| Parameter | Type | Default | Description |
|---|---|---|---|
| `dhuser` | env_var_name | DH_USERID | Name of env var storing UserId to access DeployHub |
| `dhpass` | env_var_name | DH_PASSWORD | Name of env var storing dhpass to access DeployHub |
| `dhurl` | env_var_name | DH_SERVERURL | Name of env var storing URL to the DeployHub Server |
| `application` | string |  | Application Name to Approve |
| `appversion` | string |  | Application Version to Approve |

### move_job

Move an Application Version through the pipeline

| Parameter | Type | Default | Description |
|---|---|---|---|
| `dhuser` | env_var_name | DH_USERID | Name of env var storing UserId to access DeployHub |
| `dhpass` | env_var_name | DH_PASSWORD | Name of env var storing dhpass to access DeployHub |
| `dhurl` | env_var_name |  | Name of env var storing URL to the DeployHub Server |
| `application` | string |  | Application Name to move |
| `appversion` | string |  | Application Version to move |
| `from_domain` | string |  | Pipeline stage to move from |
| `move_task` | string |  | 'Move Task' used to move the application version to desired stage |

### deploy_job

Deploy an Application Version to an Environment

| Parameter | Type | Default | Description |
|---|---|---|---|
| `dhuser` | env_var_name | DH_USERID | Name of env var storing UserId to access DeployHub |
| `dhpass` | env_var_name | DH_PASSWORD | Name of env var storing dhpass to access DeployHub |
| `dhurl` | env_var_name | DH_SERVERURL | Name of env var storing URL to the DeployHub Server |
| `application` | string |  | Application Name to Deploy |
| `appversion` | string |  | Application Version to Deploy |
| `environment` | string |  | Environment to Deploy to |

### deploy_component_job

Deploy an Application Version to an Environment based on a Component

| Parameter | Type | Default | Description |
|---|---|---|---|
| `dhuser` | env_var_name | DH_USERID | Name of env var storing UserId to access DeployHub |
| `dhpass` | env_var_name | DH_PASSWORD | Name of env var storing dhpass to access DeployHub |
| `dhurl` | env_var_name | DH_SERVERURL | Name of env var storing URL to the DeployHub Server |
| `compname` | string |  | Component Name being deployed |
| `compversion` | string |  | Component Version being deployed |

### microservice_version_update_job

Update the microservice or component with git and build data

| Parameter | Type | Default | Description |
|---|---|---|---|
| `dhuser` | env_var_name | DH_USERID | Name of env var storing UserId to access DeployHub |
| `dhpass` | env_var_name | DH_PASSWORD | Name of env var storing dhpass to access DeployHub |
| `dhurl` | env_var_name | DH_SERVERURL | Name of env var storing URL to the DeployHub Server |
| `application` | string |  | Application Name to associate the component to |
| `appversion` | string |  | Application Version to associate the component to |
| `compname` | string |  | Component Name being updated |
| `compversion` | string |  | Component Version being updated |
| `comptype` | string | --docker | Type of component, --docker or --file |
| `helmchart` | string | $COMPONENT_CHARTNAME | Helm Chart Name |
| `registry` | string | $DOCKER_REGISTRY | Docker Registry Name |
| `image` | string | $COMPONENT_IMAGENAME | Image Name |
| `tag` | string | $IMAGE_TAG | Image Tag |
| `imagesha` | string | $(</tmp/digest.txt) | sha of the container |
| `customaction` | string | GLOBAL.HelmChart | Custom Action |

### envscript_job

Generate the environment variable script from the TOML file

| Parameter | Type | Default | Description |
|---|---|---|---|
| `envvars` | string |  | Name of the input environment TOML file |
| `envvars_sh` | string |  | Name of output shell script name |

## Executors

### default

Docker image for interacting with DeployHub