shared pipelines libraries

codes run on groovy sandbox. Sandbox keep watch of all the function called in this library. If anything nefarious in code Jenkins will raise and alert and admin has to approve it whether it can be executed or not.

It can be defined at job level on multipipeline job configuration as shown below

Amazon Machin Images) are used to build instances. They store snapshots of EBS volumes, permissions, and a block device mapping which determines how the instance OS controls the attached volumes.

AMIs can be shared, free or paid and can be copied across AWS Regions.

GLOBAL PIPELINE LIBRARIES

Are trusted library they run without ‘sandbox’ restrictions and may use @Grab. We will look into the following four things to get your hands dirty with the shared library.

1. Create a Shared Library Structure
2. Create Custom Shared Library Code
3. Configure Shared Library In Jenkins Configuration
4. Create Declarative Pipeline as Code With Shared Library.

Let looks at each one in detail.

Create a Shared Library Structure

Note: In this guide, we will be concentrating only on the vars folder for creating your first shared library. src and resources will be covered in the advanced shared library guide.

Jenkins shared library has the following structure. You can get the basic structure and code used in this article from Github -> GitHub – devops81/SharedLibrary

 

All the files under vars are global functions and variables. The file name is the function name. We will be using the filename in our declarative pipeline.

Create Custom Shared Library Code

In this section, we will create the shared library code for Git Checkout functionality.

Generate Pipeline Syntax Using Snippet Generator:

You can create the code snippets that can be used in share library function using the Pipeline Syntax Generator available in Jenkins. This will make our life easier for creating custom library DSL. All the supported pipeline functionality can be generated from the snippet generator.

You can access the syntax generator from your Jenkins on /pipeline-syntax/ path. For example,

Here is the screenshot which shows creating a git checkout pipeline snippet using the pipeline syntax generator.

Number 5 in the screenshot shows the generated snippet. Here is the properly formatted checkout snippet.

checkout([    $class: 'GitSCM',     branches: [[name: '*/master']],     doGenerateSubmoduleConfigurations: false,     extensions: [],     submoduleCfg: [],     userRemoteConfigs: [[url: 'https://github.com/spring-projects/spring-petclinic.git']]    ])

Create a Shared Library For Git Checkout

Lets convert the checkout snippet we generated in the above step to a shared library.

Create a file named gitCheckout.groovy under vars folder.

Here is our Git Checkout shared library code. We have removed all the empty checkout parameters which got generated by default.

def call(Map stageParams) {     checkout([        $class: 'GitSCM',        branches: [[name:  stageParams.branch ]],        userRemoteConfigs: [[ url: stageParams.url ]]    ])  }

Here is the code explanation,

1. def call(Map stageParams) – A simple call function which accepts a Map as an argument. From the pipeline stage, we will pass multiple arguments which get passed as a map to the shared library.

2. stageParams.branch – its the branch parameter which comes from the pipeline stage and we use stageParams to access that variable in the shared library.

Commit the changes and push it to your repository.

Add Github Shared Library Repo to Jenkins

Now that we have a basic git checkout library ready lets add it to Jenkins configurations.

Step 1: Go to Manage Jenkins –> Configure System

Step 2: Find the Global Pipeline Libraries section and add your repo details and configurations as shown below.

 

Use Checkout Library in Declarative Pipeline

We always call the library using the filename under vars. In this case, gitCheckout is the filename created under vars. Here is how we call gitCheckout library from the pipeline or Jenkinsfile

As you can see we are passing branch and url parameter to the Checkout function. Here is the full declarative pipeline code.

 

stage('Git Checkout') {    gitCheckout(        branch: "master",        url: "https://github.com/spring-projects/spring-petclinic.git"

123456stage('Git Checkout') {    gitCheckout(        branch: "master",        url: "https://github.com/spring-projects/spring-petclinic.git"    )}  )}

@Library('jenkins-library@master') _
 
pipeline {
agent any
stages {
stage('Git Checkout') {
steps {
gitCheckout(
branch: "main",
url: "https://github.com/spring-projects/spring-petclinic.git"
)
}
}
}
}

 
Like gitCheckout, you can create all your pipeline steps a shared library and you don’t have to repeat your common functionalities in all your pipelines.

SEND RESUME –

resume@devops81.com

Position :-

Network & Security Engineer

Job Description

• Graduate or postgraduate
• Should have good knowledge about network & security, Cloud & Datacenter experience will be preferred.
• Candidate should know the network, BGP, Switches, Routers, Firewall, vFirewalls etc
• Candidate should be worked on Fortinet, SOPHOS, Sonicwall, Cisco etc.
• Should have hands-on experience on network & security

Core/Must Have Skills

• Expertise in Ansible to used as deployment tool
• Expertise in scripting YAML , POWERSHELL , BATCH
• Expertise in automating build and deployment of different application Java , Angular , .Net based application
• Have goods hands-on writing pipeline as script in Bamboo , Jenkins
• Have good exposure to source code management like GIT
• Have exposure to work in cloud based CI/CD solution either Azure or AWS

Work Location

• Noida ( Residing in & around Noida Only )

SEND RESUME –

resume@devops81.com

Roles Summary and Role Description

Looking for DevOps Engineer with Core Java having 5 to 8 years of professional experience who has proven experience with CI/CD tools (preferably jenkins), build tools like maven, ant and automation configuration tools like Chef, Ansible etc.As a DevOps Engineer you will be be supporting the jobs in lower environments, configuring the new Jenkins jobs, writing scripts for automating the configuration etc, configuring jobs on cloud platform like AWS and Azure.

Core/Must Have Skills

• Expertise in Ansible to used as deployment tool
• Expertise in scripting YAML , POWERSHELL , BATCH
• Expertise in automating build and deployment of different application Java , Angular , .Net based application
• Have goods hands-on writing pipeline as script in Bamboo , Jenkins
• Have good exposure to source code management like GIT
• Have exposure to work in cloud based CI/CD solution either Azure or AWS

Work Location

Reporting and project location will be Noida Utter Pradesh but candidate can work remotely.

Work Location

ABOUT AWS CODE ARTIFACT

AWS CodeArtifact is a fully managed artifact repository service that makes it easy for organizations of any size to securely store, publish, and share software packages used in their software development process. CodeArtifact can be configured to automatically fetch software packages and dependencies from public artifact repositories so developers have access to the latest versions. CodeArtifact works with commonly used package managers and build tools like Maven, Gradle, npm, yarn, twine, pip, and NuGet making it easy to integrate into existing development workflows.

LAUNCHING AWS CLOUDSHELL

Note all the commands mentioned under this article will be executed from the CLOUDSHELL so we should launch cloudshell with user which is having requried rights on CODEARTIFACT service.

STEPS INVOLVED IN CREATING A CODEARTIFACT REPOSITORY AND RESOLVING DEPENDENCY

creation of domain

AWS CodeArtifact domain is a resource for codeartifact of AWS. CodeArtifact domains make it easier to manage multiple repositories across an ograginizatio. we can use a domain to apply permission across mulitple repositories owned by diffreent AWS accounts. Repositories are aggregated into a higher-level entity known as a domain. All package assets and metadata are stored in the domain, but they are consumed through repositories.

create a codeartifact domain command

aws codeartifact create-domain –domain my-domain

creating repository under above created domain

RUN FOLLOWING COMMANDS IN SEQUENCE TO

• Create a domain
• Create repository under the above domain
• Create upstream repository for our above created repository
• Add external connection to the npm public repository
• Using CLI to install the npm package

COMMANDS WHICH NEEDS TO BE EXECUTED

1) Create a domain:
aws codeartifact create-domain –domain my-domain

2) Create a repository in your domain:
aws codeartifact create-repository –domain my-domain –repository my-repo

3) Create an upstream repository for your my-repo repository:
aws codeartifact create-repository –domain my-domain –repository npm-store

4) Add an external connection to the npm public repository to your npm-store repository:
aws codeartifact associate-external-connection –domain my-domain –repository npm-store –external-connection “public:npmjs”

5) Associate the npm-store repository as an upstream repository to the my-repo repository:
aws codeartifact update-repository –repository my-repo –domain my-domain –upstreams repositoryName=npm-store

6) Configure the npm package manager with your my-repo repository (fetches an authorization token from CodeArtifact using your AWS credentials):
aws codeartifact login –tool npm –repository my-repo –domain my-domain

7) Use the npm CLI to install an npm package. For example, to install the popular npm package express, use the following command, if we don’t specify a version, this command will install the latest version available in the external repo:
npm install express

(express is a Node.js web application framework used to develop web and mobile applications)

8) View the package you just installed in your my-repo repository:
aws codeartifact list-packages –domain my-domain –repository my-repo

Once all above command completes successfully we can go and check in console our newly created domains and repository should be present there.

DOMAINS

REPOSITORIES

About AWS CodeStar

AWS CodeStar enables you to quickly develop, build, and deploy applications on AWS. AWS CodeStar provides a unified user interface, enabling you to easily manage your software development activities in one place. With AWS CodeStar, you can set up your entire continuous delivery toolchain in minutes, allowing you to start releasing code faster. AWS CodeStar makes it easy for your whole team to work together securely, allowing you to easily manage access and add owners, contributors, and viewers to your projects. Each AWS CodeStar project comes with a project management dashboard, including an integrated issue tracking capability powered by Atlassian JIRA Software.

GENERATE KEYPAIR

Click on AWS KeyPair option and generate a new key pair which we will be using in our configuration or AWS CODESTAR.

DEPLOYING A HTML WEBSITE USING AWS CODESTAR IDE

From EC2 services just open AWS CodeStar , click on CREATE PROJECT option.

Under next screen click on Create Service Role

After choosing the service role click templates option and choose HTML5 click Next.

Under next screen give required details about the CodeStar project setup.

• Project name
• Project repository (AWS CodeCommit)
• EC2 Configuration details
  • Instance type
  • VPC
  • Subnet details
  • Key pair name

Once all project details care provide click on next and the click on Create Project option.

AWS CodeStart first time project creation takes some 5-10 minutes of time so we have to wait till the project  creation gets completed. Once the project is completed it should show Project Provisioned.

Under Provisioned AWS Codestart project we should get below tabs.

IDE , REPOSITORY , PIPELINE , MONITORING , ISSUES

Click on pipeline tab it should show first pipeline is deployed and success status for (Source , Build and Deploy)

At Top click on VIEW APPLICATION option

It should take us to the newly HTML application deployed.

DOING A SAMPLE COMMIT TO CHECK AUTO BUILD AND DEPLOYMENT

Go to codecommit repository under AWS CodeStar change the line number 61 to “Testing Sample Commit for Auto build and Deploy” commit the changes.

Once the new code is deployed automatically we can browse the application an see the changes.

Jenkins pipeline as code to take database backup of mysql at scheduled time

GENERATE GITHUB TOKEN

Go to developer settings and generate Personal access token.

Settings >> Developer settings >> Personal access token

UPDATE TOKEN UNDER JENKINS

Go to credential manager under jenkins

Under credential manager create token based credential with name git-cred-token under password put the credential we have just generated , click on save.

PIPELINE CREATION UNDER JENKINS

Now come to Jenkins choose New Item then choose project type as Pipeline.

Under Pipeline configuration page and under Pipeline tab choose options as below

SCM :- git
Repository URL GitHub – devops81/dbbackupscript can fork this repository

Credentials :- Choose the credential git-cred-token which we generated above

Click on save it should complete the job creation.

Come back to the project page and click on Build Now it should ask for parameters as database name whose backup required to be taken.

Choose the database whose backup required to be taken click on build now option internally it should call the Jenkinsfile under the GITHUB repository.

Once the pipeline is success it should be shown as below.

Database backup should be created at designated location.