Jenkins is a self-contained, open source automation server which can be used to automate all sorts of tasks related to building, testing, and delivering or deploying software.
Jenkins in Blockchain Automation Framework¶
In Blockchain Automation Framework, although Jenkins is not mandatory, we have a single Jenkinsfile as a sample to help you setup CI/CD Pipelines.
- Setup Jenkins with slave configurations. Declare a slave-config called
ansiblewith the Docker Image hyperledgerlabs/baf-build:jenkins.
- A EKS Cluster (Managed on AWS) and its kubeconfig file available and accessible from the Jenkins server.
- AWS user
jenkinswith CLI credentials with access to above EKS Cluster.
- A Hashicorp Vault installation which is accessible from the Jenkins server.
- A Git repo which will be added as multi-branch pipeline on Jenkins (this is a fork of this repo).
- A separate
baf-configurationgit repo where the templated network.yaml for different platforms are stored. Details of this repo needs to be updated in pipeline Stage
Create Configuration File.
The Jenkinsfile is designed to ignore
main branches by default. So, create platform specific branches in your forked repo.
cordafor Opensource Corda
corda-entfor Enterprise Corda
fabricfor Hyperledger Fabric
besufor Hyperledger Besu
indyfor Hyperledger Indy
baf-configuration repo should have the corresponding folders and files as demanded/configured in Stage
Create Configuration File.
Following secrets must be stored in Jenkins which is configured in the environment section. This can be renamed/updated in the Jenkinsfile according to your needs.
sownak-innersource: is the Git Token and password to access the Git repos.
aws_demo_kubeconfig: is the Kubeconfig file for AWS EKS cluster.
jenkins_gitops_key: is the Gitops private key which has Read-Write access to the Git repos.
nexus_user: is the Service User and Password for access to Nexus for Cordapps (only used in Corda).
aws_demo_vault_key: is the private key to enable ssh access to Hashicorp Vault Server.
aws_demo_vault_token: is the Root Token for Hashicorp Vault.
gmaps_key: is the Google Maps API key for frontend (only used when deploying Supplychain application).
aws_jenkins: is the AWS credentials for jenkins user on AWS IAM.
environment variables need to be updated in Jenkinsfile for your own environment
- VAULT_SERVER=[vault server ip address or domain name reachable from this server]
- VAULT_PORT=[vault server port]
- VAULT_BASTION=[vault bastion server address]
- VAULT_PRIVATE_IP=[vault server private ip address]
These can be changed when running manually, the automated Jenkins pipeline always use the default option):
- FORCE_ACTION (default: no) To force rebuild
[ci skip]commits in case of previous failure.
- RESET_ACTION (default: yes) To have the option to NOT reset the network when running the pipeline.
- APIONLY_ACTION (default: no) To run only API test on existing live network in case of previous failure.
- FABRIC_VERSION (default: 1_4_4) To select the Fabric version.
- FABRIC_CONSENSUS (default: raft) To select the Fabric consensus.
- CORDA_VERSION (default: 4_4) To select the Corda Opensource version.
- QUORUM_VERSION (default: 2_5_0) To select the Quorum version (only 2_5_0 is supported for now)
- QUORUM_CONSENSUS (default: ibft) To change the Quorum consensus.
- QUORUM_TM (default: tessera) To change the Quorum Transaction manager.
- INDY_VERSION (default: 1_11_0) To change the Indy version.
- Default Corda Enterprise version is 4_4. This is hardcoded in the jenkinsfile.
- Default Besu settings are: Version 1_4_4, Consensus IBFT, Transaction Manager Orion.
Setup on Jenkins¶
Configure Multi-branch pipeline with the forked repo as the source. In case you create the branches later, scan the pipeline to get new branches on Jenkins.
Checkout SCM: Manually checkout the branch and check for
[ci skip]commits as they are skipped.
Prepare build environment: Creates the build directory and sets up the necessary files for build like gitops.pem, vault.pem, kubeconfig, test jsons. Also creates the ssh-tunnel connection to Hashicorp Vault server.
<branch>-settings: Set env variables CONSENSUS, VERSION and TM based on the branch i.e. based on the DLT platform.
Create Configuration File: Downloads the config file (main network.yaml, addorg.yaml and application.yaml) depending on the BRANCH_NAME, CONSENSUS, VERSION and TM from baf-configuration and adds the secret parameters.
Reset existing network: Resets the network based on application.yaml as that should contain all the orgs.
Deploy network: Deploys the network based on main network.yaml.
Add a new node: Adds a new organization to the above network. This is not enabled for Indy currently.
Deploy Supplychain-App: Deploys the supplychain app. Not enabled for Indy. Corda Enterprise and Besu are in the future roadmap.
Deploy Identity-App: Deploys the Identity app. Only for Indy.
Run SupplyChain API tests: Runs Supplychain API test using newman. This step has a try-catch so that the whole pipeline does not fail if only API tests fail. Re-run the tests manually if only API tests fail. Not enabled for Indy. Corda Enterprise and Besu are in the future roadmap.
Run Identity API tests: Runs Identity API test using newman. This step has a try-catch so that the whole pipeline does not fail if only API tests fail. Re-run the tests manually if only API tests fail. Only for Indy.
Manual Approval for resetting the deployment: Waits for 20 minutes before resetting the network. If you want to keep the network for demo, Abort at this stage.
Reset network again: Resets the network after the 20 minutes is over or you chose to reset. Keeps the network running if the previous step was aborted.