~/jenkins/how-fetch-multiple-credentials-expose-environment-jenkinsfile-pipeline.md

How to Fetch Multiple Credentials and Expose them in Environment using Jenkinsfile pipeline

2 min readOctober 07, 2022by Gorav Singal#cicd#build#jenkins
// TL;DR

Use the environment block with credentials() helper to bind single creds, or nest multiple withCredentials blocks for accessing several credential sets in the same pipeline stage.

How to Fetch Multiple Credentials and Expose them in Environment using Jenkinsfile pipeline

Introduction

In this post, we will see how to fetch multiple credentials and expose them in environment variable.

Jenkinsfile Stage to Fetch Single Credential

There are many types of credentials that can be stored in Jenkins. The most commonly used is the username/password one.

Lets take an example of a stage, where I need to authenticate against an artifactory server.

stages {
  stage('Install requirements') {
      steps {
          withCredentials([[
              $class: 'UsernamePasswordMultiBinding',
              credentialsId: 'MY_API_KEY',
              usernameVariable: 'ARTIFACTORY_USERNAME',
              passwordVariable: 'ARTIFACTORY_PASSWORD']
          ]) {
              sh """
              python3.8 -m pip install virtualenv
              python3.8 -m venv python_env
              source python_env/bin/activate
              python3.8 -m pip install --upgrade pip
              python3.8 -m pip install -r requirements.txt -i https://${ARTIFACTORY_USERNAME}:${ARTIFACTORY_PASSWORD}@artifactory.myorg.com/artifactory/api/pypi/pypi-myorg-release/simple

              deactivate
              """
          }
      } 
  }
}

In above Jenkinsfile, I’m reading credentials from a stored credential in Jenkin with id MY_API_KEY and exposing the username in variable: ARTIFACTORY_USERNAME, and password in variable: ARTIFACTORY_PASSWORD

Jenkinsfile Stage to Fetch Multiple Credentials

There are many cases, where I need to read more than one credentials,

stage('Run deployer') {
  steps {
      echo 'Deploying Artifacts to k8s Env...'

      withCredentials([
          [$class: 'UsernamePasswordMultiBinding', 
          credentialsId:"AZURE_SERVICE_SECRET",
              usernameVariable: 'AZURE_SERVICE_USERNAME', 
              passwordVariable: 'AZURE_SERVICE_SECRET'],
          [$class: 'UsernamePasswordMultiBinding', credentialsId:"MY_API_KEY",
              usernameVariable: 'ARTIFACTORY_USERNAME', 
              passwordVariable: 'ARTIFACTORY_PASSWORD']
      ]) {
          sh """
              sudo curl -LO "https://dl.k8s.io/release/v1.25.2/bin/linux/amd64/kubectl"
              sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
              kubectl version --client

              echo "deploy to env=${params.DeployEnv}, artifact=${params.ArtifactId}, version=${params.Version}"
              
              echo "Preparing runtime env..."
              python3.8 -m pip install virtualenv
              python3.8 -m venv python_env
              source python_env/bin/activate
              python3.8 -m pip install --upgrade pip
              python3.8 -m pip install -r requirements.txt -i https://${ARTIFACTORY_USERNAME}:${ARTIFACTORY_PASSWORD}@artifactory.myorg.com/artifactory/api/pypi/pypi-myorg-release/simple

              echo "Ready to run deployment..."
              python3.8 deploy.py "${params.DeployEnv}" "${params.ArtifactId}" "${params.Version}" "./ethos_deployment"

              deactivate
          """
      }
  }
}

The syntax is the same, it is just that I’ve used multiple credentials id and usage will be the same.

$ subscribe --weekly

One deep dive a week, in your inbox

System design, AI engineering, trading systems and interview prep. Tested code, real numbers. Free, and you can unsubscribe any time.

or read it on gyanbyte.substack.com

Share

Related Posts

Jenkins Pipeline with Jenkinsfile - How To Schedule Job on Cron and Not on Code Commit

Jenkins Pipeline with Jenkinsfile - How To Schedule Job on Cron and Not on Code Commit

Introduction In this post we will see following: How to schedule a job on cron…

Jenkins Pipeline - How to run Automation on Different Environment (Dev/Stage/Prod), with Credentials

Jenkins Pipeline - How to run Automation on Different Environment (Dev/Stage/Prod), with Credentials

Introduction I have an automation script, that I want to run on different…

Jenkinsfile - How to Create UI Form Text fields, Drop-down and Run for Different Conditions

Jenkinsfile - How to Create UI Form Text fields, Drop-down and Run for Different Conditions

Introduction I had to write a CICD system for one of our project. I had to…

How to Git Clone Another Repository from Jenkin Pipeline in Jenkinsfile

How to Git Clone Another Repository from Jenkin Pipeline in Jenkinsfile

Introduction There are some cases, where I need another git repository while…

A Jenkins Groovy Pipeline for Building Python Projects and Pushing to Artifactory

A Jenkins Groovy Pipeline for Building Python Projects and Pushing to Artifactory

Introduction In this post, we will see a sample Jenkin Pipeline Groovy script…

Python Build Quality Gates with Pylint and Unittest Coverage Thresholds

Python Build Quality Gates with Pylint and Unittest Coverage Thresholds

Introduction It is very important to introduce few process so that your code and…

Latest Posts

How to Stay Valuable as a Software Engineer in the AI Era: A Practical Playbook

How to Stay Valuable as a Software Engineer in the AI Era: A Practical Playbook

In the previous article I argued that AI is not killing software engineering…

How to Review AI-Generated Code: A Checklist for Catching What the Model Missed

How to Review AI-Generated Code: A Checklist for Catching What the Model Missed

A few months back I approved a PR that was almost entirely AI-generated. It…

How to Debug AI-Generated Code: Understand First, Fix Last

How to Debug AI-Generated Code: Understand First, Fix Last

In the last article I wrote about reviewing AI code before it goes in. This one…

The Future of Software Engineering: What AI Changes, What Stays, and Where the Jobs Go

The Future of Software Engineering: What AI Changes, What Stays, and Where the Jobs Go

Every few weeks somebody sends me a scary headline — “AI will replace all…

The Transactional Outbox Pattern: Never Lose an Event Again

The Transactional Outbox Pattern: Never Lose an Event Again

This is one of those patterns that looks like nothing until you get burnt once…

Event Sourcing, Explained: Store What Happened, Not Just the Final State

Event Sourcing, Explained: Store What Happened, Not Just the Final State

Here is a question I like to ask in interviews: your bank account shows a…