{"id":3463,"date":"2018-10-05T12:56:34","date_gmt":"2018-10-05T17:56:34","guid":{"rendered":"http:\/\/lisa.rushworth.us\/?p=3463"},"modified":"2018-10-05T12:56:34","modified_gmt":"2018-10-05T17:56:34","slug":"jenkins-creating-a-build-pipeline","status":"publish","type":"post","link":"https:\/\/www.rushworth.us\/lisa\/?p=3463","title":{"rendered":"Jenkins: Creating A Build Pipeline"},"content":{"rendered":"

Prerequisites: <\/strong><\/p>\n

You will need the \u201cGit\u201d plugin (https:\/\/plugins.jenkins.io\/git<\/a>).<\/p>\n

You will need the \u201cGitHub\u201d plugin (https:\/\/plugins.jenkins.io\/github<\/a>)<\/p>\n

Setting Up Access Within GitHub:<\/strong><\/p>\n

Log into GitHub and navigate to your repository. Click the \u201cSettings\u201d tab, then select \u201cDeveloper settings\u201d from the bottom of the left-hand menu. From the Developer Settings page, select \u201cPersonal access tokens\u201d.<\/p>\n

\"\"<\/a><\/p>\n

Click \u201cGenerate new token\u201d to add a token for your Jenkins integration.<\/p>\n

\"\"<\/a><\/p>\n

Provide a description for the token and select permissions \u2013 read access to the repo is sufficient.<\/p>\n

\"\"<\/a><\/p>\n

Save the token and copy the secret text.<\/p>\n

Setting Up Jenkins \u2013 Configuring GitHub Integration<\/strong><\/p>\n

On your Jenkins server, select \u201cManage Jenkins\u201d<\/p>\n

\"\"<\/a><\/p>\n

Select \u201cConfigure System\u201d<\/p>\n

\"\"<\/a><\/p>\n

Scroll down \u2013 possibly a lot \u2013 to the GitHub section. Click on the \u201cAdd GitHub Server\u201d drop-down and select \u201cGitHub Server\u201d<\/p>\n

\"\"<\/a><\/p>\n

Provide a name, the API URL is pre-populated. Next to Credentials, click the drop-down for \u201cAdd\u201d and select \u201cJenkins\u201d.<\/p>\n

\"\"<\/a><\/p>\n

The credential kind is \u201cSecret text\u201d, and \u201cID\u201d is your GitHub user ID. Save the credential<\/p>\n

\"\"<\/a><\/p>\n

Select cred from drop-down and test<\/p>\n

\"\"<\/a><\/p>\n

Hopefully the credentials are verified, you are done.<\/p>\n

\"\"<\/a><\/p>\n

Using Jenkins \u2013 Creating A Basic Pipeline:<\/strong><\/p>\n

Click on \u201cNew Item\u201d, create a new Freestyle project, and give it a descriptive name.<\/p>\n

\"\"<\/a><\/p>\n

Since this is a GitHub project, I\u2019m adding the project URL \u2013 that\u2019s the actual project URL, not the URL for a specific branch or the path to clone the project.<\/p>\n

\"\"<\/a><\/p>\n

As you scroll down, the tab will change to \u201cSource Code Management\u201d. Select \u201cGit\u201d and enter the URL used to clone the repository. If you have not already added credentials, click \u201cAdd\u201d; otherwise select the appropriate credential from the drop-down menu. If you intend to build a branch other<\/em> than master, correct the branch name.<\/p>\n

\"\"<\/a><\/p>\n

Build triggers will depend on what exactly you want to happen. You can trigger new builds based on PRs or push activity. You can schedule a nightly build.<\/p>\n

If there are a lot of changes, you may not wish to re-build the project every single time<\/em> the repo changes. Conversely if the repo rarely changes, nightly builds waste a lot of cycles), etc.<\/p>\n

Using the hook trigger requires that your Jenkins server be Internet-accessible and as such has a non-zero risk of malicious access. You can expose your endpoint through a reverse proxy to have more control over service access. I have also experimented with using GitHub provided metadata, https:\/\/api.github.com\/meta<\/a>, to restrict access to certain subnets. A potential attacker could still proxy their access by attempting to register your<\/em> Jenkins endpoint in their<\/em> GitHub project \u2026 but that\u2019s a narrower attack vector than \u201canyone who can make a web call\u201d.<\/p>\n

If you want to trigger builds based on changes within the GitHub project, you can configure Jenkins to automatically register webhooks or you can manually add the webhook to your project.<\/p>\n

Manual Webhook creation: <\/em>Within your project\u2019s \u201cSettings\u201d tab, select \u201cWebhooks\u201d and then \u201cAdd webhook\u201d.<\/p>\n

\"\"<\/a><\/p>\n

Automatic Webhook creation: <\/em>Manage Jenkins => Configure System. In the GitHub section, click the second<\/em> \u201cAdvanced\u201d button (with a notepad next to it).<\/p>\n

\"\"<\/a><\/p>\n

Click the \u201cAdditional Actions\u201d drop-down menu and select \u201cConvert login and password to token\u201d<\/p>\n

\"\"<\/a><\/p>\n

Enter your credentials and click \u201cCreate token credentials\u201d<\/p>\n

\"\"<\/a><\/p>\n

A message will be displayed confirming the credential.<\/p>\n

\"\"<\/a><\/p>\n

In this case, I will schedule a nightly build of the project. After selecting \u201cBuild periodically\u201d, enter the cron-like expression to control when you want builds to occur. To avoid having a lot<\/em> of project builds initiated at quarter-hour marks, use the modifier \u201cH\u201d to indicate a time range<\/em>. In this example, the build will be triggered some time between 02:00 and 04:59. Since the value of H is a hash of the job name, the build time will be consistent (i.e. the time displayed below the schedule field will be the time used each cycle). This means it is still possible<\/em> to have a number of builds scheduled simultaneously.<\/p>\n

Time, by default, is relative to your Jenkins\u2019 server JVM configuration. <\/em>You can override that setting by adding a TZ directive at the beginning of the schedule field.<\/p>\n

\"\"<\/a><\/p>\n

There are a number of pre-build and post-build actions you can take, and various add-on modules expand this functionality. You can manage builds, Docker containerization, and deployment into Kubernetes clusters from Jenkins build pipelines.<\/p>\n

Once the job has been saved, you can run it immediately by returning to the dashboard. Click the little clock to the right of the item listing.<\/p>\n

\"\"<\/a><\/p>\n

Once a build has been completed, the item\u2019s workspace will contain the build and console output from the build job. If a job fails, console output is a good point to start troubleshooting.<\/p>\n

\"\"<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

Prerequisites: You will need the \u201cGit\u201d plugin (https:\/\/plugins.jenkins.io\/git). You will need the \u201cGitHub\u201d plugin (https:\/\/plugins.jenkins.io\/github) Setting Up Access Within GitHub: Log into GitHub and navigate to your repository. Click the \u201cSettings\u201d tab, then select \u201cDeveloper settings\u201d from the bottom of the left-hand menu. From the Developer Settings page, select \u201cPersonal access tokens\u201d. Click \u201cGenerate new …<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[29],"tags":[304,660,616],"class_list":["post-3463","post","type-post","status-publish","format-standard","hentry","category-technology","tag-automation","tag-ci-cd","tag-jenkins"],"_links":{"self":[{"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/posts\/3463","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=3463"}],"version-history":[{"count":2,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/posts\/3463\/revisions"}],"predecessor-version":[{"id":3486,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/posts\/3463\/revisions\/3486"}],"wp:attachment":[{"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=3463"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=3463"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=3463"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}