The DeployHub CircleCI Deployment Orb
DeployHub integrates with CircleCI to provide 100% repeatable continuous deployments across the entire CircleCI pipeline. Using the CircleCI DeployHub Orb will allow you to drive the continuous deployments, with DeployHub doing the heavy lifting, without custom, one-off deployment scripts. DeployHub matures your CircleCI pipeline to break down the wall to production updates. DeployHub provides reports and insights for individuals on the production control side of the house. This transparency gives the production control teams what they need to accept faster, more iterative software updates. Instead of having deployment scripts for each state in your pipeline, the DeployHub Circle CI Deployment Orb creates a release process that includes cataloging, publishing, packaging and deploying software updates on an agile ‘iterative’ basis in a repeatable way. You no longer need to perform monolithic releases, (the norm for scripted solutions) or manage different scripts for different versions and environments.
And while you are thinking this will break the budget in terms of cost, let me stop you there. DeployHub is an open source solution, hosted for free by DeployHub Inc. You can start with a single project and begin learning how much faster you can move when you fully automate (dump the scripts) software deployments.
We already use Scripts for Deployments
Yes, we hear that a lot. So lets explain why you would choose an automation tool over scripts. First of all Packaging and Versioning. DeployHub uses an Application to package together Components. Applications and Components have Versions. Because of DeployHub’s versioning capability, you can do incremental deployments moving away from the old style monolithic approach. Now if you are just updating a Jar or War file, you can always just copy the new file over. Agreed. A script can do that. But an Application is more than just a binary, and a deployment is more than just a copy. With DeployHub you can include in your package as a Deployment:
- Database Updates
- Environment Variables
- Infrastructure Changes
And unlike a simple copy, your full stack deployment package can be rolled forward, rolled back or even jump versions. So when production is 5 versions behind and you want it up to the most recent release, DeployHub does that incrementally (including the database updates), reducing the time and risk associated to the release. DeployHub’s reports show what has changed providing an audit trail that makes even the grumpiest production control team happy.
Site Reliability and Microservices
As we move into Microservices and Site Reliability, the concepts of monolithic releases will go away. We will instead welcome a new era of software development that focuses on small changes, microservices, instead of a complete application. For this reason, DeployHub allows you to Catalog, Publish, and Share microservices across a domain driven design. So with DeployHub, you can start deploying your updates incrementally, and begin seeing your software updates as changes to individual Components. DeployHub will always show you what your monolithic equivalent looks like, but your releases will finally be agile.
DeployHub Tasks and The CircleCI Deployment Orb
The DeployHub CircleCI Orb calls DeployHub to perform:
- ApproveJob- Allows CircleCI to call DeployHub’s approval process to approve an Application Version to be moved to the next stage of the pipeline. The Approval occurs as the UserID is passed from CircleCI to DeployHub. Depending on your DeployHub configuration, you may need to call the ApproveJob. This may happen if an approval gate is defined in DeployHub. CircleCI will pass the Application Version and the Move Task to DeployHub.
- MoveJob – Executes the DeployHub Move Task which promotes or demotes an Application Version to a different pipeline state.
- DeployJob- Deploys an Application Version to a specified environment. CircleCI will pass the Application Version Name and Environment to DeployHub.
- Note: Future release will include the ability to automatically update a component version to initiate a new application version.
You do not need to use the ApproveJob or MoveJob tasks. The use of these tasks is determined by how you define DeployHub. DeployHub has an Approval process as well as a Move Process that tracks where an Application Version is in the Pipeline. You would generally perform a Move and then a Deploy. The DeployJob is the main DeployHub task that needs to be called.
Two-Way Communication and Shared Logging
DeployHub and CircleCI have a two way logging communication. The DeployHub CircleCI Deployment Orb includes the ability for all logs about software deployments to be reported in both solutions. CircleCI can report to DeployHub when deployments are ready to be executed, with DeployHub reporting back the status of the deployment. For most users, Circle CI remains their primary location to find results and logs.
Image 1: Job Executions for the Workflow
Image 2: Deployment Execution Results
Continuous Feedback Loop
On the production side of the equation, Ops teams use DeployHub to manage Environments and view reports. These reports include a full Continuous Feedback Loop that shows the full ‘Value Stream’ starting at your Build Job and showing what Application Components were updated and what end targets to which they were deployed.
Image 3: Feedback Loop Showing Build to Endpoint
Full Application Release Automation
Anyone exploring the use of tools such as Xebia XLDeploy, Harness or IBM UDeploy should take a close look at using DeployHub Team or Pro. DeployHub provides full application release automation functionality, without the use of agents or the high cost. DeployHub Team and Pro are available as a SaaS or on Premise. You can sign-up for or download DeployHub Team at www.DeployHub.com
And if you want to participate in the open source project, you can sign-up at www.deployhubproject.io
Installing the CircleCI Deployment Orb
To start using the DeployHub CircleCI Deployment Orb, you will need to create a .circleci/config.yml to define your workflow to CircleCI for that project. That workflow will define calls to the DeployHub jobs and define the variables such as Application Version, Environment, UserID and Password that will be passed to the DeployHub CircleCI Orb.
Image 4: Configuration File with Approve, Move and Deploy Steps
For a full description, go to the CircleCI orb registry