Versions Compared

Version Old Version 22 New Version Current
Changes made by

Ashhad Alam

Rohan Dhanwade (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected links that should have been relative instead of absolute.

You can use a CI/CD pipeline for importing the Adeptia Connect objects to a new environment automatically. This CI/CD pipeline uses the Exported ZIP file that you must have created as a prerequisite for import operation, and imports the objects to the target environment.

...

The diagram below represents how the import pipeline works, and automates the import process. 

Image RemovedImage Added

When triggered, the pipeline performs the following sequence of actions.

...

To start with importing the objects, you first need to create an import pipeline having all the required parameters for exporting the objects.

Info
Adeptia provides you with

...

an import pipeline file that you can

...

use to create the pipeline.

After you create the pipeline, you need to trigger the pipeline to perform the import operation.

...

To create the pipeline in Jenkins using the import pipeline provided by Adeptia, follow the steps given below.

  1.  Log in to the Jenkins with admin privileges.

  2.  Select New Item.


  3. Enter a name for the Import pipeline, and then select Pipeline.

  4. Click OK.

  5. Copy the content the content from the provided import provided import pipeline file.

    Expand
    titleImport pipeline


    Code Block
    languagecss
    themeMidnight
    import jenkins.model.Jenkins
import java.nio.file.Path;
import java.nio.file.Paths;
import java.io.File;


/*
    This pipeline used to deploys migration promotion through operations like import, rollback, retain from one build environment to another.

    Pipeline is made up of following steps
    1. Init Perameters
    2. Pull import/retain XML and source solution zip file from GitHub
    3. Upload import/retain XML and source solution zip to k8 shared PVC
    4. Download Helm chart & deploy migration solution (import/retain/rollback)
    5. Download rollback zip from k8 shared PVC
    6. Push rollback zip to GitHub
	7. Clean up workspace

	Pre-requisite
	a) Tools/Plugins needs to install:
		1. Helm
		2. kubectl client
		3. Jenkins
		4. Java 1.8+
	b) OS Linux
	c) Jenkins plugins
		1. Kubernetes
		2. Nexus
		3. Git (git plugin 4.8.3, Git client plugin 3.9.0)
		43. Mask Password
		54. Credentials Binding Plugin (1.27)
		65. Parameter Separator
		76. BlueOcean (Optional)
		
	Usage:
		Steps to create pipeline using jenkinsfile.
		1. Login into the Jenkins GUI with admin privileges.
		2. create a pipeline by choosing New Item > Pipeline.
		3. Copy/past containt of jenkinsfile to Pipeline Definition area.
		4. Uncheck checkbox "Use Groovy Sandbox".
		5. Save the pipeline.
		6. Trigger the pipeline once to initilaize parameters.
		
*/

/*
    Upload file to Kubernetes PVC
 */
def uploadToSharedPVC (NAMESPACE, CLUSTER_CONTEXT, K8_CREDENTIALS_ID, SERVER_URL, SRC_FILE_PATH, TRG_FILE_PATH) {
    echo "Upload file("+SRC_FILE_PATH+")files to K8 shared PVC"
		withKubeConfig([credentialsId: K8_CREDENTIALS_ID, serverUrl: SERVER_URL]) {
					try {
						  wrap([$class: 'MaskPasswordsBuildWrapper', varPasswordPairs: [[NEXUS_PASSWORD:'NEXUS_PASSWORD']]]) {
						  sh '''
							#!/bin/shbash
							kubectl config use-context '''+CLUSTER_CONTEXT+'''
							TRG_FILE_PATH='''+TRG_FILE_PATH+'''
							if [[ ${TRG_FILE_PATH::1} == "/" ]]
								then
								  TRG_FILE_PATH=${TRG_FILE_PATH:1};
								else
								  echo "Forward shash(/) already removed "; fi
							podname=$(kubectl -n '''+NAMESPACE+''' get pods | grep -m 1 autoscaler | awk '{print $1}')
							kubectl -n '''+NAMESPACE+''' cp '''+SRC_FILE_PATH+''' ${podname}:${TRG_FILE_PATH}
							jobname=$(kubectl -n '''+NAMESPACE+''' get jobs | grep -m 1 migration | awk '{print $1}')
							if [[ -n "$jobname" ]]; then
								kubectl -n '''+NAMESPACE+''' delete job ${jobname}
								else 
									echo "Migration resource does not exist"
							fi
											'''
						  }				
						  
						} catch (err) {
								echo "Caught: ${err}. Error in uploading file."
								error("Caught: ${err}")
								currentBuild.result = 'FAILURE'
							}
						}
}

/*
    Download file from Kubernetes PVC
 */
def downloadFromSharedPVC (NAMESPACE, CLUSTER_CONTEXT, K8_CREDENTIALS_ID, SERVER_URL, SRC_FILE_PATH, TRG_FILE_PATH) {
    echo "Download file("+SRC_FILE_PATH+")files from K8 shared PVC"
		withKubeConfig([credentialsId: K8_CREDENTIALS_ID, serverUrl: SERVER_URL]) {
					try {
						sh '''
							#!/bin/shbash
							SRC_FILE_PATH='''+SRC_FILE_PATH+'''
							if [[ ${SRC_FILE_PATH::1} == "/" ]]
								then
								  SRC_FILE_PATH=${SRC_FILE_PATH:1};
								else
								  echo "Forward shash(/) already removed "; fi
							kubectl config use-context '''+CLUSTER_CONTEXT+'''
							podname=$(kubectl -n '''+NAMESPACE+''' get pods | grep -m 1 autoscaler | awk '{print $1}')
							kubectl -n '''+NAMESPACE+''' cp ${podname}:${SRC_FILE_PATH} '''+TRG_FILE_PATH+'''
								'''											
						} catch (err) {
								echo "Caught: ${err}. Error in downloading file from K8 PVC."
								error("Caught: ${err}")
								currentBuild.result = 'FAILURE'
							}
						}
}

/*
    Pull Helm Chart
 */
def pullHelmChart (NEXUS_CREDENTIALS_ID, NEXUS_HELM_HELM_REPO_URL, CHART_NAME) {
    echo "Pull Helm Chart ("+CHART_NAME+") from NexusArtifact repositoryHub"
		withCredentials([usernamePassword(credentialsId: NEXUS_CREDENTIALS_ID, passwordVariable: 'NEXUS_PASSWORD', usernameVariable: 'NEXUS_USERNAME')]) {
					try {
						sh '''#!/bin/hide password field
bash
							wrap([$class: 'MaskPasswordsBuildWrapper', varPasswordPairs: [[NEXUS_PASSWORD:'NEXUS_PASSWORD']]]) {
						sh 'helm repo add adeptia-connect-migration '''+HELM_REPO_URL+'''
							#!/bin/sh
							helm repo add nexushelmrepo '''+NEXUS_HELM_REPO_URL+''' --username '''+NEXUS_USERNAME+''' --password '''+NEXUS_PASSWORD+'''
							helm pull nexushelmrepopull adeptia-connect-migration/'''+CHART_NAME+''' --untar						
							'''
						} 						} catch (errcatch (err) {
								echo "Caught: ${err}. Error in pulling Helm chart from Nexus repo."
								error("Caught: ${err}")
								currentBuild.result = 'FAILURE'
							}
					}
		
}

/*
    Deploy Helm to Kubernetes cluster
 */
def deployToCluster (NAMESPACE, CLUSTER_CONTEXT, K8_CREDENTIALS_ID, DATABASE_CREDENTIALS_ID, SERVER_URL) {
    echo "Deploy Helm chart to Kubernetes cluster"
					try {
						def BACKEND_DB_USERNAME = getUserName(DATABASE_CREDENTIALS_ID);
						def BACKEND_DB_PASSWORD = getPassword(DATABASE_CREDENTIALS_ID);
						withKubeConfig([credentialsId: K8_CREDENTIALS_ID, serverUrl: SERVER_URL]) {
						//hide password field
						wrap([$class: 'MaskPasswordsBuildWrapper', varPasswordPairs: [[password:BACKEND_DB_PASSWORD], [password:BACKEND_DB_USERNAME]]]) { 
						  sh '''	  
							#!/bin/shbash
							kubectl config use-context '''+CLUSTER_CONTEXT+'''
							helm upgrade -i migration migration -f migration/config/values-qa.yaml --set environmentVariables.BACKEND_DB_URL=${BACKEND_DB_URL} --set environmentVariables.BACKEND_DB_USERNAME='''+BACKEND_DB_USERNAME+''' --set environmentVariables.BACKEND_DB_PASSWORD='''+BACKEND_DB_PASSWORD+''' --set environmentVariables.BACKEND_DB_DRIVER_CLASS=${BACKEND_DB_DRIVER_CLASS} --set environmentVariables.BACKEND_DB_TYPE=${BACKEND_DB_TYPE} --set environmentVariables.SOURCE_ZIP_PATH=${SOURCE_ZIP_PATH} --set environmentVariables.MIGRATION_XML_FILE_PATH=${MIGRATION_XML_FILE_PATH} --set environmentVariables.OVERRIDE_USER=${OVERRIDE_USER} --set environmentVariables.OVERRIDE_MODIFIEDBY_USER=${OVERRIDE_MODIFIEDBY_USER} --set environmentVariables.RETAIN_XML_PATH=${RETAIN_XML_PATH} --set environmentVariables.LOG_IDENTIFIER=${LOG_IDENTIFIER} --set environmentVariables.OPERATION=${OPERATION} --set image.tagenvironmentVariables.ROLLBACK_ZIP_PATH=${LATESTROLLBACK_ZIP_TAGPATH} -n '''+NAMESPACE+'''
											'''	
							}
						}
						} catch (err) {
								echo "Caught: ${err}. Error in deploying Helm chart."
								error("Caught: ${err}")
								currentBuild.result = 'FAILURE'
							}
}

/*
    Wait until deployment finish on Kubernetes cluster
 */
def waitUntilDepoymentComplete(NAMESPACE, CLUSTER_CONTEXT, K8_CREDENTIALS_ID, SERVER_URL, POD, time_out) {
    echo "Try to fetch the Fetching pod status"
					try {
						int inter = 5, count = 1;					
						withKubeConfig([credentialsId: K8_CREDENTIALS_ID, serverUrl: SERVER_URL]) {
						sh('kubectl config use-context ${CLUSTER_CONTEXT};')
						while (true) {
								def status = sh script: "kubectl -n ${NAMESPACE} get pods | grep -m 1 ${POD} | awk '{print \$3}' ", returnStdout: true
                                if (status.toString().trim().contains("Completed")) {
                                    break;
                                    }
								else if (status.toString().trim().contains("Error")) {
									error("Caught: Migration deployment failed due to error. Please check migration logs.")
									currentBuild.result = 'FAILURE'
             sleep(inter) 							   echo count+" retry in "+inter*count+" seconds." 							   count++ 							   if ((count)>=((time_out-5)/inter)) { 									error("Caught: Migration deployment is taking more then ideal time. Please check migration logs.")
									currentBuild.result = 'FAILURE'
									break;
							 break;
                                    }
                            }
						}	 						} catch sleep(errinter) {
								   echo count+"Caught: ${err}. Error in fetching pod status."
 retry in "+inter*count+" seconds."
							   count++
							   if ((count)>=((time_out-10)/inter)) {
									error("Caught: ${err} Migration deployment taking more then ideal time. Please check migration logs.")
									currentBuild.result = 'FAILURE'
									}
}break;
							  /* }
   Push soution Zip to GitHub reposirory  */ def pushToGitHub (GIT_BRANCH, GIT_CREDENTIALS_ID, GIT_REPO_URL, FILE_PATH) {     echo "Push file ("+FILE_PATH+") to GitHub repo"}
				withCredentials([gitUsernamePassword(credentialsId: GIT_CREDENTIALS_ID, gitToolName: 'git-tool')]) {
		}			try
{
							sh('sleep 10')
} catch (err) {
								sh('git add '+FILE_PATH)
							sh('git commit -m "auto commit message" ')
							sh('git push ${GIT_REPO_URL} HEAD:'+GIT_BRANCH)
						} catch (err) {echo "Caught: ${err}. Error in fetching pod status. Migration deployment taking more then ideal time. Please check migration logs."
								echo error("Caught: ${err}. Error in pushing file to Github."
								error("Caught: ${err}"")
								currentBuild.result = 'FAILURE'
							}
					}
}

/*
    GeneratePush rollback soution Zip fileto GitHub pathrepository
 */
def convertRollbackZipPath(pushToGitHub (GIT_BRANCH, GIT_CREDENTIALS_ID, GIT_REPO_URL, FILE_PATH) {
					def rollbackZipPath = null
					def Append = "Rollback_"
					 echo "Pushing file ("+FILE_PATH+") to GitHub repo"
				withCredentials([gitUsernamePassword(credentialsId: GIT_CREDENTIALS_ID, gitToolName: 'git-tool')]) {
					try {
						Pathdef pathgitUser = Paths.get(FILE_PATHgetUserName(GIT_CREDENTIALS_ID);
						def fileName=path.getFileName().toString()	sh('sleep 10')
						def parentDir=path.getParent().toString()	sh('git config --global user.name "'+gitUser+'"')
						rollbackZipPath=parentDir + File.separator + Append + fileName
	sh('git config --global user.email "you@example.com"')
							if(isUnix()){sh('git add '+FILE_PATH)
						rollbackZipPath=rollbackZipPath.replace("\\", "/"	sh('git commit -m "auto commit message" ')
							sh('git push ${GIT_REPO_URL} HEAD:'+GIT_BRANCH)
						} catch (err) {
								echo "Caught: ${err}. Error in generatingpushing rollbackfile soution Zip file pathto Github."
								error("Caught: ${err}")
								currentBuild.result = 'FAILURE'
							}
					return rollbackZipPath}
}

/*
    Generate Getrollback usernamesoution fromZip credentialsfile idpath
 */
def getUserNameconvertRollbackZipPath(idFILE_PATH) {
					def userNamerollbackZipPath = null
	withCredentials([usernamePassword(credentialsId: id, passwordVariable: 'PASSWORD', usernameVariable: 'USERNAME')]) {
				def Append = "Rollback_"
					try {
						userNamePath path = USERNAMEPaths.get(FILE_PATH);
						} catch (err) {
def fileName=path.getFileName().toString()
								echo "Caught: ${err}. Error in extracting username from "+id+" ."def parentDir=path.getParent().toString()
						rollbackZipPath=parentDir + File.separator + Append + fileName
								error("Caught: ${err}")
		if(isUnix()){
						rollbackZipPath=rollbackZipPath.replace("\\", "/")
						}
						currentBuild.result = 'FAILURE'} catch (err) {
							}
	}
	return userNameecho "Caught: ${err}. Error in generating rollback soution Zip file path."
								error("Caught: ${err}")
								currentBuild.result = 'FAILURE'
							}
					return rollbackZipPath
}

/*
    Get passwordusername from credentials id
 */
def getPasswordgetUserName(id) {
	def passworduserName = null
	withCredentials([usernamePassword(credentialsId: id, passwordVariable: 'PASSWORD', usernameVariable: 'USERNAME')]) {
					try {
						passworduserName = PASSWORD;USERNAME
						} catch (err) {
								echo "Caught: ${err}. Error in extracting passwordusername from "+id+" ."
								error("Caught: ${err}")
								currentBuild.result = 'FAILURE'
							}
	}
	return passworduserName
}
							
/*
  					 pipeline {Get 	//password Globalfrom defaultcredentials variablesid
 */
def getPassword(id) environment {
		time_outdef password = 100
    }
	parameters{
		//separator(name: 'separator-ce1a9ef5-cd10-4002-a43f-8ae24d9d0bb3', sectionHeader: '''Global Parameters''', sectionHeaderStyle: 'background-color:#eeeee4;font-size:15px;font-weight:normal;text-transform:uppercase;border-color:gray;', separatorStyle: '''font-weight:bold;line-height:1.5em;font-size:1.5em;''')
		string(defaultValue: 'nexus_credentialsId', description: 'Nexus credentials ID configured in Jenkins', name: 'NEXUS_CREDENTIALS_ID', trim: true) 
		string(defaultValue: 'https://nexus.adeptia.com:8443/repository/adeptia-internal-helm', description: 'Nexus Server URL', name: 'NEXUS_HELM_REPO_URL', trim: true) 
		string(defaultValue: 'migration', description: 'Name of Helm chart to be downloaded from Nexus repository', name: 'CHART_NAME', trim: true)
		null
	withCredentials([usernamePassword(credentialsId: id, passwordVariable: 'PASSWORD', usernameVariable: 'USERNAME')]) {
					try {
						password = PASSWORD;
						} catch (err) {
								echo "Caught: ${err}. Error in extracting password from "+id+" ."
								error("Caught: ${err}")
								currentBuild.result = 'FAILURE'
							}
	}
	return password
}
							  
					
pipeline {
	// Global default variables
    environment {
		//manage deployment status timeout
		time_out = 300
    }
	parameters{
		//separator(name: 'separator-ce1a9ef5-cd10-4002-a43f-8ae24d9d0bb3', sectionHeader: '''GitHubHelm Chart Parameters''', sectionHeaderStyle: 'background-color:#eeeee4;font-size:15px;font-weight:normal;text-transform:uppercase;border-color:gray;', separatorStyle: '''font-weight:bold;line-height:1.5em;font-size:1.5em;''') 
		string(defaultValue: 'gitCredential_prathi-adeptia', description: 'GitHubArtifactHub credentialsHelm IDchart configured in JenkinsURL e.g. https://adeptia.github.io/adeptia-connect-migration/charts', name: 'GITHELM_CREDENTIALSREPO_IDURL', trim: true) 
		string(defaultValue: 'https://github.com/prathi-adeptia/migration-defination.git', description: 'GitHub server URLName of Helm chart to be downloaded from ArtifactHub repository e.g. migration', name: 'GITCHART_REPO_URLNAME', trim: true)
		
		string//separator(defaultValuename: 'mainseparator-ce1a9ef5-cd10-4002-a43f-8ae24d9d0bb3', descriptionsectionHeader: '''GitHub Branch nameParameters''', namesectionHeaderStyle: 'GIT_BRANCHbackground-color:#eeeee4;font-size:15px;font-weight:normal;text-transform:uppercase;border-color:gray;', trim: trueseparatorStyle: '''font-weight:bold;line-height:1.5em;font-size:1.5em;''')
		string(defaultValue: 'test/SA_PF_23.zip', description: 'SourceGitHub zipcredentials pathID toconfigured bein downloadedJenkins from GitHub. ege.g. test/SA_PF.zipgitCredential_id', name: 'GIT_SOURCECREDENTIALS_ZIP_PATHID', trim: true) 
		string(defaultValue: 'import.xml', description: 'ImportGitHub xmlserver file path to be downloaded from GitHub. eg. test/import.xmlURL e.g. https://github.com/adeptia/migration-defination.git', name: 'GIT_MIGRATION_XML_FILE_PATHREPO_URL', trim: true)
		string(defaultValue: '', description: 'RetainGitHub xmlBranch file path to be downloaded from GitHub. eg. test/retain.xmlname e.g. main', name: 'GIT_RETAIN_XML_PATHBRANCH', trim: true)

		//separatorstring(namedefaultValue: 'separator-ce1a9ef5-cd10-4002-a43f-8ae24d9d0bb3', sectionHeaderdescription: '''Migration Parameters''', sectionHeaderStyle: 'background-color:#eeeee4;font-size:15px;font-weight:normal;text-transform:uppercase;border-color:gray;', separatorStyle: '''font-weight:bold;line-height:1.5em;font-size:1.5em;''')
		string(defaultValue: 'import', description: 'Location of retain xml file. eg. import or rollbackSource zip path to be downloaded from GitHub. e.g. test/SA_PF.zip', name: 'GIT_SOURCE_ZIP_PATH', trim: true)
		string(defaultValue: '', description: 'Rollback zip path to upload file to GitHub. e.g. test/Rollback_SA_PF.zip. No need to fill this field in case of performing "rollback" operation', name: 'OPERATIONGIT_ROLLBACK_ZIP_PATH', trim: true)
		string(defaultValue: '/shared/migrationtest1/SA_PF_23.zip', ', description: 'MigrationImport sourcexml zipfile path to be downloaded from GitHub. ege.g. /shared/test/SA_PFimport.zipxml', name: 'SOURCE_ZIPGIT_MIGRATION_XML_FILE_PATH', trim: true)
		string(defaultValue: '/shared/migrationtest1/import.xml', description: 'MigrationRetain import/retain xml file path to be downloaded from GitHub. ege.g. /shared/test/importretain.xml', name: 'MIGRATIONGIT_RETAIN_XML_FILE_PATH', trim: true)

		string//separator(defaultValuename: 'IndigoUser:127000000001107055536473900001', description: 'User Id or User name with which all objects will be deployed', name: 'OVERRIDE_USER', trim: trueseparator-ce1a9ef5-cd10-4002-a43f-8ae24d9d0bb3', sectionHeader: '''Migration Parameters''', sectionHeaderStyle: 'background-color:#eeeee4;font-size:15px;font-weight:normal;text-transform:uppercase;border-color:gray;', separatorStyle: '''font-weight:bold;line-height:1.5em;font-size:1.5em;''')
		string(defaultValue: 'IndigoUser:127000000001107055536473900001'', description: 'UserLocation Idof orretain Userxml name which will be reflected in the modified by field of every activity after deploymentfile. e.g. import or rollback', name: 'OVERRIDE_MODIFIEDBY_USEROPERATION', trim: true)
		string(defaultValue: '', description: 'LocationMigration ofsource retainzip xmlpath. filee. egg. $SHARED_PATH$/migrationshared/import/RETAINSA_FILENAMEPF.xmlzip', name: 'RETAINSOURCE_XMLZIP_PATH', trim: true)
		string(defaultValue: '', description: 'Migration logimport/retain identifierxml tofile capture logs in ms environment.', path. e.g. /shared/import.xml', name: 'LOG_IDENTIFIERMIGRATION_XML_FILE_PATH', trim: true)
		
		//separator(namestring(defaultValue: 'separator-ce1a9ef5-cd10-4002-a43f-8ae24d9d0bb3', sectionHeaderdescription: 'User Id or User name with which all objects will be deployed e.g IndigoUser:127000000001107055536473900001''K8 Cluster Parameters''', sectionHeaderStyle: 'background-color:#eeeee4;font-size:15px;font-weight:normal;text-transform:uppercase;border-color:gray;', separatorStyle: '''font-weight:bold;line-height:1.5em;font-size:1.5em;''', name: 'OVERRIDE_USER', trim: true)
		string(defaultValue: '', description: 'User Id or User name which will be reflected in the modified by field of every activity after deployment e.g. IndigoUser:127000000001107055536473900001', name: 'OVERRIDE_MODIFIEDBY_USER', trim: true)
		string(defaultValue: 'k8credentials', description: 'CredentialsLocation IDof configuredretain inxml Jenkins to access K8 cluster.file. e.g. /shared/retain.xml', name: 'K8RETAIN_CREDENTIALSXML_IDPATH', trim: true)
		string(defaultValue: 'https://valuelabs-dev-dns-2ce021bb.hcp.eastus.azmk8s.io:443', description: 'URLLocation toof accessrollback K8zip clusterfile.', name: 'SERVER_URL', trim: true)
		string(defaultValue: 'valuelabs-dev', description: 'Cluster context to access K8 cluster. e.g. /shared/Rollback_SA_PF.zip. No need to fill this field in case of performing "rollback" operation', name: 'CLUSTERROLLBACK_ZIP_CONTEXTPATH', trim: true)
		string(defaultValue: 'anubhav', description: 'K8Migration clusterlog nameidentifier spaceto deploymentcapture wherelogs Connectin microservicesms deployedenvironment.', name: 'NAMESPACELOG_IDENTIFIER', trim: true)
		string(defaultValue
		//separator(name: 'jdbc:sqlserver://adeptia-adeptiaconnectdb.database.windows.net:1433;database=valuelabs-backend-8separator-ce1a9ef5-cd10-4002-a43f-8ae24d9d0bb3', descriptionsectionHeader: '''URLK8 of database backend bind with application.', name: 'BACKEND_DB_URL', trim: trueCluster Parameters''', sectionHeaderStyle: 'background-color:#eeeee4;font-size:15px;font-weight:normal;text-transform:uppercase;border-color:gray;', separatorStyle: '''font-weight:bold;line-height:1.5em;font-size:1.5em;''')
		string(defaultValue: 'databasecredentialid', description: 'Credentials ID configured in Jenkins to access K8 databasecluster.', name: 'DATABASEK8_CREDENTIALS_ID', trim: true)

		string(defaultValue: 'com.microsoft.sqlserver.jdbc.SQLServerDriver', description: 'DriverURL classto of database.', access K8 cluster e.g. https://*******-dns-2ce021bb.hcp.eastus.azmk8s.io:443. You can get the server Url from K8 config file.', name: 'BACKEND_DB_DRIVER_CLASSSERVER_URL', trim: true)
		string(defaultValue: 'SQL-Server', description: 'Database type.Cluster context to access K8 cluster e.g. adeptia-context', name: 'BACKENDCLUSTER_DB_TYPECONTEXT', trim: true)
		}
		
    agent {
        label 'LinuxAgent'
    }
stages {

            
		stage('Init parameters') {
			steps {
					script{
							//Global parameters
							env.LATEST_TAG='80686a8'
					}							
			}
        }
        stage('Checkout files from GitHub') {
  string(defaultValue: '', description: 'K8 cluster name space deployment where Connect microservices deployed e.g. adeptia', name: 'NAMESPACE', trim: true)
		string(defaultValue: '', description: 'URL of database backend bind with application.', name: 'BACKEND_DB_URL', trim: true)
		string(defaultValue: '', description: 'Credentials ID configured in Jenkins to access database.', name: 'DATABASE_CREDENTIALS_ID', trim: true) 
		string(defaultValue: '', description: 'Driver class of database e.g com.microsoft.sqlserver.jdbc.SQLServerDriver.', name: 'BACKEND_DB_DRIVER_CLASS', trim: true)
		string(defaultValue: '', description: 'Database type e.g SQL-Server.', name: 'BACKEND_DB_TYPE', trim: true)
		}
	
    /*
		agent {
        	label steps'LinuxAgent' {	
    }
	*/
	agent any
	
stages {
     script {				 					echo  stage('Checkout xmlfiles and zip from githubGitHub'
	) {
            steps {
                script {				
					echo 'Checkout xml and zip from github'
					checkout([$class: 'GitSCM', branches: [[name: '*/'+GIT_BRANCH]], extensions: [], userRemoteConfigs: [[credentialsId: GIT_CREDENTIALS_ID, url: GIT_REPO_URL]]])
                    
                }
            }
        }
		stage('Upload files to PVC') {
            steps {
                script {					
					echo 'UploadUploading import zip and xml file to shared PVC'
					uploadToSharedPVC (NAMESPACE, CLUSTER_CONTEXT, K8_CREDENTIALS_ID, SERVER_URL, GIT_SOURCE_ZIP_PATH, SOURCE_ZIP_PATH)
					uploadToSharedPVC (NAMESPACE, CLUSTER_CONTEXT, K8_CREDENTIALS_ID, SERVER_URL, GIT_MIGRATION_XML_FILE_PATH, MIGRATION_XML_FILE_PATH)
					//Condition to handle retain feature within import
					if((GIT_RETAIN_XML_PATH.contains(".xml")) && (RETAIN_XML_PATH.contains(".xml"))){
					uploadToSharedPVC (NAMESPACE, CLUSTER_CONTEXT, K8_CREDENTIALS_ID, SERVER_URL, GIT_RETAIN_XML_PATH, RETAIN_XML_PATH)
					}
                }
            }
        }
		stage('Pull Helm Chart & Deploy Migration') {
            steps {
				script {
						echo 'PullPulling Migration Helm Chart'
						pullHelmChart (NEXUS_CREDENTIALS_ID, NEXUS_HELM_REPO_URL, CHART_NAME)


						echo 'DeployDeploying Helm ImportChart'
						deployToCluster (NAMESPACE, CLUSTER_CONTEXT, K8_CREDENTIALS_ID, DATABASE_CREDENTIALS_ID, SERVER_URL)
						timeout(time: env.time_out, unit: "SECONDS"){
						waitUntilDepoymentComplete(NAMESPACE, CLUSTER_CONTEXT, K8_CREDENTIALS_ID, SERVER_URL, 'migration-', env.time_out.toInteger())
						}
				}
            }
        }
		stage('Download Rollback zip') {
            when {
                    expression { params.OPERATION == 'import' }
            }
            steps {
                script {
                    echo 'Download Rollback zip file to shared PVC'
					downloadFromSharedPVC (NAMESPACE, CLUSTER_CONTEXT, K8_CREDENTIALS_ID, SERVER_URL, convertRollbackZipPath(SOURCEROLLBACK_ZIP_PATH), convertRollbackZipPath(GIT_SOURCEROLLBACK_ZIP_PATH))                  
                }
            }
        }
		stage('Push Rollback Zip') {
            when {
                    expression { params.OPERATION == 'import' }
            }
            steps {
                script {
					echo 'Push Rollback Zip to GitHub'
					pushToGitHub (GIT_BRANCH, GIT_CREDENTIALS_ID, GIT_REPO_URL, convertRollbackZipPath(GIT_SOURCEROLLBACK_ZIP_PATH))
                    
                }
            }
        }
		
	}
	post('Clean-up') {
			always {
				echo 'Cleanup workspace'
				cleanWs()
			}
			success {
				echo 'Pipeline succeeded!'
			}
			unstable {
				echo 'Pipeline unstable :/'
			}
			failure {
				echo 'Pipeline failed :('
			}
		}
}



  6. Paste

    In the Pipeline Definition section, paste the copied content

    in the Pipeline Definition section in Jenkins.Uncheck

    and uncheck the Use Groovy Sandbox checkbox.

  7. Click Save.

  8. On the screen that follows, click Build Now.
    As you build the pipeline for the very first time, all the parameters get initialized. The Build Now option now changes to Build with Parameters.

  9. Click Build with Parameters.

    You will see all the parameters and their values inherited from the import pipeline file. 

  10. Change the parameter values as per your requirement.

    Expand
    titleClick here to expand the list of Import parameters
    ParametersValueDescriptionParameters used in Import pipeline

    Nexus

    NEXUS_CREDENTIALS_IDnexus_credentialsId

    Store Github access credentials in Jenkins. Select credential type "Username and password" and create global credentials in Jenkins. Example:

    user: valuelabs

    Pass: password

    Note: Use credentials binding plugin to store credentials in Jenkins. Select credential type "Username and password" and save it. A Credentials ID can be added or configures in Jenkins. Using credential ID, the credentials can be accessible globally in Jenkins.

    NEXUS_

     

    Image Added


    Warning
    titleImportant

    If you are using Jenkins on Windows OS, and have created an agent on Linux OS, you need to do the followings in the export pipeline file.

    1. Uncomment the following code snippet.

    Code Block
    languagecss
    themeMidnight
    /*
		agent {
        	label 'LinuxAgent' 	
    }
	*/

    Where,

    LinuxAgent is the name of the agent that you have created.

    2. Comment the following lines of code.

    Code Block
    languagecss
    themeMidnight
    agent any



  11. Click Save.

  12. On the screen that follows, click Build Now.
    As you build the pipeline for the very first time, all the parameters get initialized. 

  13. Refresh the page.
    The Build Now option now changes to Build with Parameters.

  14. Click Build with Parameters.

    You will see all the parameters inherited from the import pipeline file. 

  15. Enter the parameter values as per your requirement.

    Info
    It is mandatory to provide a valid value for all the Jenkins parameters.


    Store GitHub access credentials in Jenkins. Select credential type "Username and password
    Expand
    titleClick here to expand the list of Import parameters


    ParametersValueDescription

    Helm Chart



    HELM_REPO_URLhttps://
    nexus
    adeptia.
    adeptia
    github.
    com:8443
    io/
    repository/
    adeptia-
    internal
    connect-
    helm
    migration/charts
    Nexus " and create global credentials in Jenkins
    Migration Helm chart repository URL.
    CHART_NAMEmigrationMigration Helm chart name.
    GitHub

    GIT_CREDENTIALS_ID
    		gitCredential_id

    <credential ID generated by Jenkins>

    Credential ID for GitHub in Jenkins.

    Refer to the prerequisites for more details.

    GIT_REPO_URLhttps://github.com/
    prathi-
    adeptia/migration-defination.gitURL of the GitHub repository
    URL
    .
    GIT_BRANCHmainGitHub branch name.
    GIT_SOURCE_ZIP_PATH
    		test/
    import
    SA_PF.
    xmlLocation to pull the import.xml file from
    zipPath of the exported ZIP in the GitHub repository.
    GIT_MIGRATION_XML_FILE_PATHtest/
    SA_PF
    import.
    zipLocation to pull import zip to
    xmlPath of the import.xml file in the GitHub repository.
    GIT_RETAIN_XML_PATHxml/retain.xml
    Retain xml file path to be downloaded from GitHub.MigrationOPERATIONimportSpecify the
    Path of the retain XML file in the GitHub repository.
    GIT_ROLLBACK_ZIP_PATHtest/Rollback_SA_PF.zip

    Path in the GitHub repository where you want to upload the rollback zip.

    Warning
    titleImportant
    Though this parameter is also visible while performing the rollback operation, you are not required to provide a value for this parameter.


    Migration

    OPERATIONexportThe type of operation for which deployment will be performed
    . eg
    .
    export, import, rollbackMIGRATION_XML_FILE_
    SOURCE_ZIP_PATH/shared/migrationtest1/SA_PF.zip
    Import zip path to upload file on shared PVC (K8 cluster)
    Path of the exported ZIP in the PVC.
    ROLLBACK_ZIP_PATH/shared/
    migrationtest1/import.xmlImport.xml path to upload file on shared PVC (K8 cluster)
    Rollback_SA_PF.zip

    Path in the PVC where you want to keep the rollback zip.

    Warning
    titleImportant
    Though this parameter is also visible while performing the rollback operation, you are not required to provide a value for this parameter.


    MIGRATION_XML_FILE_PATH/shared/migrationtest1/import.xmlPath of the import.xml file in the PVC.
    OVERRIDE_USERIndigoUser:127000000001107055536473900001User Id or
    User
    user name of an IT user with which all objects will be deployed.
    OVERRIDE_MODIFIEDBY_USERIndigoUser:127000000001107055536473900001User Id or
    User
    user name which will be reflected in the modified by field of every activity after the deployment.
    RETAIN_XML_PATH/shared/migrationtest1/retain.xml
    Location
    Path of the retain
    xml
    XML file
    . eg. $SHARED_PATH$/migration/import/RETAIN_FILENAME.xml'LOG_IDENTIFIER
    in the PVC.
    LOG_IDENTIFIERTest_Identifier_TagLog identifier to capture logs from MS environment.
    K8 credentials in Jenkins. Select credential type "Secret file" and create global credentials
    Kubernetes Cluster

    K8_CREDENTIALS_ID
    k8credentialsStore K8 cluster access
    <credential ID generated by Jenkins>

    Credential ID for Kubernetes in Jenkins.

     Example:

    user: valuelabs

    Pass: Secret file (Here secret file is k8 .config file)

    Refer to the prerequisites for more details.


    SERVER_URLhttps://
    valuelabs-dev-dns-2ce021bb.hcp.eastus.azmk8s.io:443Kubernetes cluster URL
    <host name of the Kubernetes cluster>:<Port number>URL of the Kubernetes cluster.
    CLUSTER_CONTEXTtest-devKubernetes cluster context.
    NAMESPACEnamespaceKubernetes cluster namespace for deployment.
    Database

    BACKEND_DB_URLjdbc:sqlserver://
    adeptia-adeptiaconnectdb.database.windows.net:1433
    <DB Hostname>:<Port number>;database=
    valuelabs-backend-8
    <Backend Database Name>Backend database URL used in the deployment of migration Helm chart.
    Database
     Database info configured in value.yaml file.
    DATABASE_CREDENTIALS_ID
    databasecredentialidStore database access credentials in Jenkins. Select credential type "Username and password" and create global credentials in Jenkins
    <credential ID generated by Jenkins>

    Credential ID for database in Jenkins.

    Refer to the prerequisites for more details.

    BACKEND_DB_DRIVER_CLASScom.microsoft.sqlserver.jdbc.SQLServerDriverBackend database driver class used in the deployment of migration Helm chart. Database info configured in
    value
    values.yaml file.
    BACKEND_DB_TYPESQL-ServerBackend database
    database
    type used in the deployment of migration Helm chart. Database info configured in
    value
    values.yaml file.
    Parameters used in rollback operation
    Nexus

    Helm Chart

    NEXUS


    HELM_
    CREDENTIALS
    REPO_
    IDnexus_credentialsId

    Store Github access credentials in Jenkins. Select credential type "Username and password" and create global credentials in Jenkins. Example:

    user: valuelabs

    Pass: password

    Note: Use credentials binding plugin to store credentials in Jenkins. Select credential type "Username and password" and save it. A Credentials ID can be added or configures in Jenkins. Using credential ID, the credentials can be accessible globally in Jenkins.

    NEXUS_HELM
    URLhttps://adeptia.github.io/adeptia-connect-migration/chartsMigration Helm chart repository URL.
    CHART_NAMEmigrationMigration Helm chart name.
    GitHub

    GIT_CREDENTIALS_ID

    <credential ID generated by Jenkins>

    Credential ID for GitHub in Jenkins.

    Refer to the prerequisites for more details.

    GIT_REPO_URLhttps://
    nexus
    github.
    adeptia.
    com
    :8443
    /
    repository
    adeptia/
    adeptia-internal-helmNexus Helm chart repository URLCHART_NAMEmigrationHelm chart name.GitHubGIT_CREDENTIALS_IDgitCredential_id

    Store GitHub access credentials in Jenkins. Select credential type "Username and password" and create global credentials in Jenkins.

    GIT_REPO_URLhttps://github.com/prathi-adeptia/migration-defination.gitGitHub repository URL
    migration-defination.gitURL of the GitHub repository.
    GIT_BRANCHmainGitHub branch name.
    GIT_SOURCE_ZIP_PATH
    		test/
    import.xml
    Rolllback_SA_PF.zipLocation
    to pull the import.xml file from
    of the rollback ZIP in GitHub repository.
    GIT_MIGRATION_XML_FILE_PATHtest/
    Rolllback_SA_PF.zipLocation to pull rollback zip to
    import.xmlLocation of the import.xml file in GitHub repository.
    Migration

    OPERATIONrollback
    Specify the
    The type of operation for which deployment will be performed.
     eg. export, import, rollback
    SOURCE_ZIP_PATH/shared/migrationtest1/Rolllback_SA_PF.zip
    Rollback zip path to upload file on shared PVC (K8 cluster)
    Path of the rollback ZIP in the PVC.
    MIGRATION_XML_FILE_PATH/shared/migrationtest1/import.xml
    Import
    Path of the import.xml
    path to upload file on shared PVC (K8 cluster)
    file in the PVC.
    LOG_IDENTIFIERTest_Identifier_TagLog identifier to capture logs from MS environment.
    K8 SERVER_URLhttps://valuelabs-dev-dns-2ce021bb.hcp.eastus.azmk8s.io:443Kubernetes cluster URL
    Kubernetes Cluster

    K8_CREDENTIALS_ID
    k8credentials

    Store K8 cluster access credentials in Jenkins. Select credential type "Secret file" and create global credentials in Jenkins. Example:

    user: valuelabs

    Pass: Secret file (Here secret file is k8 .config file)

    <credential ID generated by Jenkins>

    Credential ID for Kubernetes in Jenkins.

    Refer to the prerequisites for more details.


    SERVER_URLhttps://<host name of the Kubernetes cluster>:<Port number>URL of the Kubernetes cluster.
    CLUSTER_CONTEXTtest-devKubernetes cluster context.
    NAMESPACEnamespaceKubernetes cluster namespace for deployment.
    Database

    BACKEND_DB_URLjdbc:sqlserver://
    adeptia-adeptiaconnectdb.database.windows.net:1433
    <DB Hostname>:<Port number>;database=
    valuelabs-backend-8
    <Backend Database Name>Backend database URL used in the deployment of migration Helm chart.
    Database
     Database info configured in value.yaml file.
    DATABASE_CREDENTIALS_ID
    databasecredentialidStore database access credentials in Jenkins. Select credential type "Username and password" and create global credentials
    <credential ID generated by Jenkins>

    Credential ID for database in Jenkins.

    Refer to the prerequisites for more details.

    BACKEND_DB_DRIVER_CLASScom.microsoft.sqlserver.jdbc.SQLServerDriverBackend database driver class used in the deployment of migration Helm chart. Database info configured in
    value
    values.yaml file.
    BACKEND_DB_TYPESQL-ServerBackend database
    database
    type used in the deployment of migration Helm chart. Database info configured in
    value
    values.yaml file.



  • Click Build to trigger the pipeline.

    Info

    • The objects are imported to the target environment.

    • The rollback ZIP is created and pushed to the GitHub repository. 

    • All the log statements generated by the migration utility during the import process are tagged with a unique identifier. This allows you to search for this unique identifier in the centralized logging system, and fetch all the associated logs.


    • ...

    If you decide upon rolling back the import operation, follow the instructions given belowuse the rollback ZIP created during the import operation.

    Here are the steps to perform the rollback operation.

    1. Log in to Jenkins.
    2. Click Build with Parameters.
    3. Change the values for the following two parameters, and keep the rest of the values as is.
    4. Enter rollback as the value for the OPERATION parameter.

    5. Enter the path of the rollback ZIP in GitHub as the value for GIT_ROLLBACK_ZIP_PATH parameter. This path will be used for pulling the rollback ZIP from GitHub.

      6. Enter the path of the rollback ZIP in PVC as the value for SOURCE_ZIP_PATH parameter. 

      InfoThe rollback ZIP is created at the location where your Exported ZIP is located. 
      The format of rollback ZIP file name is Recovery_<EXPORT_ZIP_NAME>.zip.Click .

    6. Click Build with Parameters.

    7. Enter the values for the following parameters.

      Info
      It is mandatory to provide a valid value for all the Jenkins parameters, except for GIT_ROLLBACK_ZIP_PATH and ROLLBACK_ZIP_PATH.


      Expand
      titleClick here to expand the list of rollback parameters


      Helm Chart



      HELM_REPO_URLhttps://adeptia.github.io/adeptia-connect-migration/chartsMigration Helm chart repository URL.
      CHART_NAMEmigrationName of the Migration Helm chart.
      GitHub

      GIT_CREDENTIALS_ID

      <credential ID generated by Jenkins>

      Credential ID for GitHub in Jenkins.

      Refer to the prerequisites for more details.

      GIT_REPO_URLhttps://github.com/adeptia/migration-defination.gitURL of the GitHub repository.
      GIT_BRANCHmainGitHub branch name.
      GIT_SOURCE_ZIP_PATH
      		test/Rolllback_SA_PF.zip

      Location of the rollback ZIP in GitHub repository.

      GIT_MIGRATION_XML_FILE_PATHtest/import.xmlLocation of the import.xml file in GitHub repository.
      Migration

      OPERATIONrollbackThe type of operation for which deployment will be performed.
      SOURCE_ZIP_PATH/shared/migrationtest1/Rolllback_SA_PF.zip

      Path of the rollback ZIP in the PVC.

      Info
      The rollback ZIP is created at the location where your Exported ZIP is located. 
      The format of rollback ZIP file name is Recovery_<EXPORT_ZIP_NAME>.zip.


      MIGRATION_XML_FILE_PATH/shared/migrationtest1/import.xmlPath of the import.xml file in the PVC.
      LOG_IDENTIFIERTest_Identifier_TagLog identifier to capture logs from MS environment.
      Kubernetes Cluster

      K8_CREDENTIALS_ID<credential ID generated by Jenkins>

      Credential ID for Kubernetes in Jenkins.

      Refer to the prerequisites for more details.


      SERVER_URLhttps://<host name of the Kubernetes cluster>:<Port number>URL of the Kubernetes cluster.
      CLUSTER_CONTEXTtest-devKubernetes cluster context.
      NAMESPACEnamespaceKubernetes cluster namespace for deployment.
      Database

      BACKEND_DB_URLjdbc:sqlserver://<DB Hostname>:<Port number>;database=<Backend Database Name>Backend database URL used in the deployment of migration Helm chart. Database info configured in value.yaml file.
      DATABASE_CREDENTIALS_ID<credential ID generated by Jenkins>

      Credential ID for database in Jenkins.

      Refer to the prerequisites for more details.

      BACKEND_DB_DRIVER_CLASScom.microsoft.sqlserver.jdbc.SQLServerDriverBackend database driver class used in the deployment of migration Helm chart. Database info configured in values.yaml file.
      BACKEND_DB_TYPESQL-ServerBackend database type used in the deployment of migration Helm chart. Database info configured in values.yaml file.



    8. Click Build to roll back the import operation.

      Info
      RetainXmlLocation, OverRideuser, and OverrideModifiedByuser parameters are not applicable in case of rollback.