Use CircleCI version 2.1 at the top of your .circleci/config.yml file.
1
version: 2.1
Add the orbs
stanza below your version, invoking the orb:
1
2
orbs:
deployhub-orb: deployhub/deployhub-orb@1.79.0
Use deployhub-orb
elements in your existing workflows and jobs.
Opt-in to use of uncertified orbs on your organization’s Security settings page.
Approve an Application Version
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
dhuser | Name of env var storing UserId to access DeployHub | No | DH_USERID | env_var_name |
dhpass | Name of env var storing dhpass to access DeployHub | No | DH_PASSWORD | env_var_name |
dhurl | Name of env var storing URL to the DeployHub Server | No | DH_SERVERURL | env_var_name |
application | Application Name to Approve | Yes | - | string |
appversion | Application Version to Approve | Yes | - | string |
Move an Application Version through the pipeline
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
dhuser | Name of env var storing UserId to access DeployHub | No | DH_USERID | env_var_name |
dhpass | Name of env var storing dhpass to access DeployHub | No | DH_PASSWORD | env_var_name |
dhurl | Name of env var storing URL to the DeployHub Server | Yes | - | env_var_name |
application | Application Name to move | Yes | - | string |
appversion | Application Version to move | Yes | - | string |
from_domain | Pipeline stage to move from | Yes | - | string |
move_task | 'Move Task' used to move the application version to desired stage | Yes | - | string |
Deploy an Application Version to an Environment
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
dhuser | Name of env var storing UserId to access DeployHub | No | DH_USERID | env_var_name |
dhpass | Name of env var storing dhpass to access DeployHub | No | DH_PASSWORD | env_var_name |
dhurl | Name of env var storing URL to the DeployHub Server | No | DH_SERVERURL | env_var_name |
application | Application Name to Deploy | Yes | - | string |
appversion | Application Version to Deploy | Yes | - | string |
environment | Environment to Deploy to | Yes | - | string |
Deploy an Application Version to an Environment based on a Component
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
dhuser | Name of env var storing UserId to access DeployHub | No | DH_USERID | env_var_name |
dhpass | Name of env var storing dhpass to access DeployHub | No | DH_PASSWORD | env_var_name |
dhurl | Name of env var storing URL to the DeployHub Server | No | DH_SERVERURL | env_var_name |
compname | Component Name being deployed | Yes | - | string |
compversion | Component Version being deployed | Yes | - | string |
Update the microservice or component with git and build data
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
dhuser | Name of env var storing UserId to access DeployHub | No | DH_USERID | env_var_name |
dhpass | Name of env var storing dhpass to access DeployHub | No | DH_PASSWORD | env_var_name |
dhurl | Name of env var storing URL to the DeployHub Server | No | DH_SERVERURL | env_var_name |
application | Application Name to associate the component to | No | '' | string |
appversion | Application Version to associate the component to | No | '' | string |
compname | Component Name being updated | Yes | - | string |
compversion | Component Version being updated | Yes | - | string |
comptype | Type of component, --docker or --file | No | '--docker' | string |
helmchart | Helm Chart Name | No | $COMPONENT_CHARTNAME | string |
registry | Docker Registry Name | No | $DOCKER_REGISTRY | string |
image | Image Name | No | $COMPONENT_IMAGENAME | string |
tag | Image Tag | No | $IMAGE_TAG | string |
imagesha | sha of the container | No | $(</tmp/digest.txt) | string |
customaction | Custom Action | No | GLOBAL.HelmChart | string |
Generate the environment variable script from the TOML file
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
envvars | Name of the input environment TOML file | Yes | - | string |
envvars_sh | Name of output shell script name | Yes | - | string |
Update the microservice or component with git and build data
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
dhuser | Name of env var storing UserId to access DeployHub | No | DH_USERID | env_var_name |
dhpass | Name of env var storing dhpass to access DeployHub | No | DH_PASSWORD | env_var_name |
dhurl | Name of env var storing URL to the DeployHub Server | No | DH_SERVERURL | env_var_name |
application | Application Name to associate the component to | No | '' | string |
appversion | Application Version to associate the component to | No | '' | string |
compname | Component Name being updated | Yes | - | string |
compversion | Component Version being updated | Yes | - | string |
comptype | Type of component, --docker or --file | No | '--docker' | string |
helmchart | Helm Chart Name | No | $COMPONENT_CHARTNAME | string |
registry | Docker Registry Name | No | $DOCKER_REGISTRY | string |
image | Image Name | No | $COMPONENT_IMAGENAME | string |
tag | Image Tag | No | $IMAGE_TAG | string |
imagesha | sha of the container | No | $(</tmp/digest.txt) | string |
customaction | Custom Action | No | GLOBAL.HelmChart | string |
Approves an Application Version for the current stage of the pipeline
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
dhuser | Name of env var storing UserId to access DeployHub | No | DH_USERID | env_var_name |
dhpass | Name of env var storing dhpass to access DeployHub | No | DH_PASSWORD | env_var_name |
dhurl | Name of env var storing URL to the DeployHub Server | No | DH_SERVERURL | env_var_name |
application | Application Name to Approve | Yes | - | string |
appversion | Application Version to Approve | Yes | - | string |
Moves an Application Version from the 'from' stage of the pipeline to another stage using the Move Task
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
dhuser | Name of env var storing UserId to access DeployHub | No | DH_USERID | env_var_name |
dhpass | Name of env var storing dhpass to access DeployHub | No | DH_PASSWORD | env_var_name |
dhurl | Name of env var storing URL to the DeployHub Server | No | DH_SERVERURL | env_var_name |
application | Application Name to Move | Yes | - | string |
appversion | Application Version to Move | Yes | - | string |
from_domain | Pipeline stage to move from | Yes | - | string |
move_task | 'Move Task' used to move the application version to desired stage | Yes | - | string |
Deploys an Application Version to an Environment
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
dhuser | Name of env var storing UserId to access DeployHub | No | DH_USERID | env_var_name |
dhpass | Name of env var storing dhpass to access DeployHub | No | DH_PASSWORD | env_var_name |
dhurl | Name of env var storing URL to the DeployHub Server | No | DH_SERVERURL | env_var_name |
application | Application Name to Deploy | Yes | - | string |
appversion | Application Version to Deploy | Yes | - | string |
environment | Environment to Deploy to | Yes | - | string |
Deploys an Application Version to an Environment based on a Component
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
dhuser | Name of env var storing UserId to access DeployHub | No | DH_USERID | env_var_name |
dhpass | Name of env var storing dhpass to access DeployHub | No | DH_PASSWORD | env_var_name |
dhurl | Name of env var storing URL to the DeployHub Server | No | DH_SERVERURL | env_var_name |
compname | Component Name being deployed | Yes | - | string |
compversion | Component Version being deployed | Yes | - | string |
Generate the environment variable script from the TOML file
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
envvars | Name of the input environment TOML file | Yes | - | string |
envvars_sh | Name of output shell script name | Yes | - | string |
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
# This code is licensed from CircleCI to the user under the MIT license.
# See here for details: https://circleci.com/developer/orbs/licensing
version: 2.1
description: >
DeployHub Integration. This Orb approves, moves, updates microservices, assigns application versions, and
deploys objects passing in data between the CircleCI pipeline to DeployHub.
display:
home_url: https://www.deployhub.com/
source_url: https://github.com/DeployHubProject/deployhub-orb
executors:
default:
description: "Docker image for interacting with DeployHub"
docker:
- image: circlecipublic/docker-orb-test
commands:
microservice_version_update:
description: "Update the microservice or component with git and build data"
parameters:
dhuser:
description: "Name of env var storing UserId to access DeployHub"
type: env_var_name
default: DH_USERID
dhpass:
description: "Name of env var storing dhpass to access DeployHub"
type: env_var_name
default: DH_PASSWORD
dhurl:
description: "Name of env var storing URL to the DeployHub Server"
type: env_var_name
default: DH_SERVERURL
application:
description: "Application Name to associate the component to"
type: string
default: ""
appversion:
description: "Application Version to associate the component to"
type: string
default: ""
compname:
description: "Component Name being updated"
type: string
compversion:
description: "Component Version being updated"
type: string
comptype:
description: "Type of component, --docker or --file"
type: string
default: "--docker"
helmchart:
description: "Helm Chart Name"
type: string
default: $COMPONENT_CHARTNAME
registry:
description: "Docker Registry Name"
type: string
default: $DOCKER_REGISTRY
image:
description: "Image Name"
type: string
default: $COMPONENT_IMAGENAME
tag:
description: "Image Tag"
type: string
default: $IMAGE_TAG
imagesha:
description: "sha of the container"
type: string
default: $(</tmp/digest.txt)
customaction:
description: "Custom Action"
type: string
default: "GLOBAL.HelmChart"
steps:
- run:
name: Update microservice or component
command: >
env > /tmp/env_file;
docker run --env-file=/tmp/env_file quay.io/deployhub/compupdate:latest
updatecomp
--dhuser "$<< parameters.dhuser >>"
--dhpass "$<< parameters.dhpass >>"
--dhurl "$<< parameters.dhurl >>"
--appname "<< parameters.application >>"
--appversion "<< parameters.appversion >>"
--appautoinc "Y"
--compname "<< parameters.compname >>"
--compversion "<< parameters.compversion >>"
<< parameters.comptype >>
--compattr "GitCommit:$CIRCLE_SHA1"
--compattr "GitUrl:$CIRCLE_REPOSITORY_URL"
--compattr "GitRepo:$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME"
--compattr "GitBranch:$CIRCLE_BRANCH"
--compattr "GitTag:$CIRCLE_TAG"
--compattr "Chart:<< parameters.helmchart >>"
--compattr "DockerSha:<< parameters.imagesha >>"
--compattr "DockerBuildDate:$(date)"
--compattr "DockerRepo:<< parameters.registry >>/<< parameters.image >>"
--compattr "DockerTag:<< parameters.tag >>"
--compattr "BuildId:$CIRCLE_BUILD_NUM"
--compattr "BuildUrl:$CIRCLE_BUILD_URL"
--compattr "BuildNumber:$CIRCLE_BUILD_NUM"
--compattr "CustomAction:<< parameters.customaction >>"
approve:
description: "Approves an Application Version for the current stage of the pipeline"
parameters:
dhuser:
description: "Name of env var storing UserId to access DeployHub"
type: env_var_name
default: DH_USERID
dhpass:
description: "Name of env var storing dhpass to access DeployHub"
type: env_var_name
default: DH_PASSWORD
dhurl:
description: "Name of env var storing URL to the DeployHub Server"
type: env_var_name
default: DH_SERVERURL
application:
description: "Application Name to Approve"
type: string
appversion:
description: "Application Version to Approve"
type: string
steps:
- run:
name: Approve Application Version
command: >
env > /tmp/env_file;
docker run --env-file=/tmp/env_file quay.io/deployhub/compupdate:latest
approve
--dhuser "$<< parameters.dhuser >>"
--dhpass "$<< parameters.dhpass >>"
--dhurl "$<< parameters.dhurl >>"
--appname "<< parameters.application >>"
--appversion "<< parameters.appversion >>"
move:
description: "Moves an Application Version from the 'from' stage of the pipeline to another stage using the Move Task"
parameters:
dhuser:
description: "Name of env var storing UserId to access DeployHub"
type: env_var_name
default: DH_USERID
dhpass:
description: "Name of env var storing dhpass to access DeployHub"
type: env_var_name
default: DH_PASSWORD
dhurl:
description: "Name of env var storing URL to the DeployHub Server"
type: env_var_name
default: DH_SERVERURL
application:
description: "Application Name to Move"
type: string
appversion:
description: "Application Version to Move"
type: string
from_domain:
description: "Pipeline stage to move from"
type: string
move_task:
description: "'Move Task' used to move the application version to desired stage"
type: string
steps:
- run:
name: Move an Application Version through the pipeline
command: >
env > /tmp/env_file;
docker run --env-file=/tmp/env_file quay.io/deployhub/compupdate:latest
move
--dhuser "$<< parameters.dhuser >>"
--dhpass "$<< parameters.dhpass >>"
--dhurl "$<< parameters.dhurl >>"
--appname "<< parameters.application >>"
--appversion "<< parameters.appversion >>"
--from_domain "<< parameters.from_domain >>"
--task "<< parameters.move_task >>"
deploy:
description: "Deploys an Application Version to an Environment"
parameters:
dhuser:
description: "Name of env var storing UserId to access DeployHub"
type: env_var_name
default: DH_USERID
dhpass:
description: "Name of env var storing dhpass to access DeployHub"
type: env_var_name
default: DH_PASSWORD
dhurl:
description: "Name of env var storing URL to the DeployHub Server"
type: env_var_name
default: DH_SERVERURL
application:
description: "Application Name to Deploy"
type: string
appversion:
description: "Application Version to Deploy"
type: string
environment:
description: "Environment to Deploy to"
type: string
steps:
- run:
name: Deploy Application Version
command: >
env > /tmp/env_file;
docker run --env-file=/tmp/env_file quay.io/deployhub/compupdate:latest
deploy
--dhuser "$<< parameters.dhuser >>"
--dhpass "$<< parameters.dhpass >>"
--dhurl "$<< parameters.dhurl >>"
--appname "<< parameters.application >>"
--appversion "<< parameters.appversion >>"
--deployenv "<< parameters.environment >>"
deploy_component:
description: "Deploys an Application Version to an Environment based on a Component"
parameters:
dhuser:
description: "Name of env var storing UserId to access DeployHub"
type: env_var_name
default: DH_USERID
dhpass:
description: "Name of env var storing dhpass to access DeployHub"
type: env_var_name
default: DH_PASSWORD
dhurl:
description: "Name of env var storing URL to the DeployHub Server"
type: env_var_name
default: DH_SERVERURL
compname:
description: "Component Name being deployed"
type: string
compversion:
description: "Component Version being deployed"
type: string
steps:
- run:
name: Deploy Application Version base on a Component
command: >
env > /tmp/env_file;
docker run --env-file=/tmp/env_file quay.io/deployhub/compupdate:latest
deploy
--dhuser "$<< parameters.dhuser >>"
--dhpass "$<< parameters.dhpass >>"
--dhurl "$<< parameters.dhurl >>"
--compname "<< parameters.compname >>"
--compversion "<< parameters.compversion >>"
envscript:
description: "Generate the environment variable script from the TOML file"
parameters:
envvars:
description: "Name of the input environment TOML file"
type: string
envvars_sh:
description: "Name of output shell script name"
type: string
steps:
- run:
name: Create env script
command: |
docker create -v /home/circleci/project --name envscript quay.io/deployhub/compupdate:latest /bin/true;
docker cp << parameters.envvars >> envscript:/home/circleci/project/envvars.toml;
docker run --volumes-from envscript quay.io/deployhub/compupdate:latest envscript --envvars /home/circleci/project/envvars.toml --envvars_sh /home/circleci/project/bash_env.sh;
docker cp envscript:/home/circleci/project/bash_env.sh /tmp/bash_env.sh;
cat /tmp/bash_env.sh >> << parameters.envvars_sh >>;
jobs:
approve_job:
description: "Approve an Application Version"
parameters:
dhuser:
description: "Name of env var storing UserId to access DeployHub"
type: env_var_name
default: DH_USERID
dhpass:
description: "Name of env var storing dhpass to access DeployHub"
type: env_var_name
default: DH_PASSWORD
dhurl:
description: "Name of env var storing URL to the DeployHub Server"
type: env_var_name
default: DH_SERVERURL
application:
description: "Application Name to Approve"
type: string
appversion:
description: "Application Version to Approve"
type: string
executor: default
steps:
- approve:
dhuser: << parameters.dhuser >>
dhpass: << parameters.dhpass >>
dhurl: << parameters.dhurl >>
application: << parameters.application >>
appversion: << parameters.appversion >>
move_job:
description: "Move an Application Version through the pipeline"
parameters:
dhuser:
description: "Name of env var storing UserId to access DeployHub"
type: env_var_name
default: DH_USERID
dhpass:
description: "Name of env var storing dhpass to access DeployHub"
type: env_var_name
default: DH_PASSWORD
dhurl:
description: "Name of env var storing URL to the DeployHub Server"
type: env_var_name
application:
description: "Application Name to move"
type: string
appversion:
description: "Application Version to move"
type: string
from_domain:
description: "Pipeline stage to move from"
type: string
move_task:
description: "'Move Task' used to move the application version to desired stage"
type: string
executor: default
steps:
- move:
dhuser: << parameters.dhuser >>
dhpass: << parameters.dhpass >>
dhurl: << parameters.dhurl >>
application: << parameters.application >>
appversion: << parameters.appversion >>
from_domain: << parameters.from_domain >>
move_task: << parameters.move_task >>
deploy_job:
description: "Deploy an Application Version to an Environment"
parameters:
dhuser:
description: "Name of env var storing UserId to access DeployHub"
type: env_var_name
default: DH_USERID
dhpass:
description: "Name of env var storing dhpass to access DeployHub"
type: env_var_name
default: DH_PASSWORD
dhurl:
description: "Name of env var storing URL to the DeployHub Server"
type: env_var_name
default: DH_SERVERURL
application:
description: "Application Name to Deploy"
type: string
appversion:
description: "Application Version to Deploy"
type: string
environment:
description: "Environment to Deploy to"
type: string
executor: default
steps:
- deploy:
dhuser: << parameters.dhuser >>
dhpass: << parameters.dhpass >>
dhurl: << parameters.dhurl >>
application: << parameters.application >>
appversion: << parameters.appversion >>
environment: << parameters.environment >>
deploy_component_job:
description: "Deploy an Application Version to an Environment based on a Component"
parameters:
dhuser:
description: "Name of env var storing UserId to access DeployHub"
type: env_var_name
default: DH_USERID
dhpass:
description: "Name of env var storing dhpass to access DeployHub"
type: env_var_name
default: DH_PASSWORD
dhurl:
description: "Name of env var storing URL to the DeployHub Server"
type: env_var_name
default: DH_SERVERURL
compname:
description: "Component Name being deployed"
type: string
compversion:
description: "Component Version being deployed"
type: string
executor: default
steps:
- deploy_component:
dhuser: << parameters.dhuser >>
dhpass: << parameters.dhpass >>
dhurl: << parameters.dhurl >>
compname: << parameters.compname >>
compversion: << parameters.compversion >>
microservice_version_update_job:
description: "Update the microservice or component with git and build data"
parameters:
dhuser:
description: "Name of env var storing UserId to access DeployHub"
type: env_var_name
default: DH_USERID
dhpass:
description: "Name of env var storing dhpass to access DeployHub"
type: env_var_name
default: DH_PASSWORD
dhurl:
description: "Name of env var storing URL to the DeployHub Server"
type: env_var_name
default: DH_SERVERURL
application:
description: "Application Name to associate the component to"
type: string
default: ""
appversion:
description: "Application Version to associate the component to"
type: string
default: ""
compname:
description: "Component Name being updated"
type: string
compversion:
description: "Component Version being updated"
type: string
comptype:
description: "Type of component, --docker or --file"
type: string
default: "--docker"
helmchart:
description: "Helm Chart Name"
type: string
default: $COMPONENT_CHARTNAME
registry:
description: "Docker Registry Name"
type: string
default: $DOCKER_REGISTRY
image:
description: "Image Name"
type: string
default: $COMPONENT_IMAGENAME
tag:
description: "Image Tag"
type: string
default: $IMAGE_TAG
imagesha:
description: "sha of the container"
type: string
default: $(</tmp/digest.txt)
customaction:
description: "Custom Action"
type: string
default: "GLOBAL.HelmChart"
executor: default
steps:
- microservice_version_update:
dhuser: << parameters.dhuser >>
dhpass: << parameters.dhpass >>
dhurl: << parameters.dhurl >>
application: << parameters.application >>
appversion: << parameters.appversion >>
compname: << parameters.compname >>
compversion: << parameters.compversion >>
comptype: << parameters.comptype >>
helmchart: << parameters.helmchart >>
image: << parameters.image >>
imagesha: << parameters.imagesha >>
registry: << parameters.registry >>
tag: << parameters.tag >>
customaction: << parameters.customaction >>
envscript_job:
description: "Generate the environment variable script from the TOML file"
parameters:
envvars:
description: "Name of the input environment TOML file"
type: string
envvars_sh:
description: "Name of output shell script name"
type: string
executor: default
steps:
- envscript:
envvars: << parameters.envvars >>
envvars_sh: << parameters.envvars_sh >>