Back Matter

Search in book...
Toggle Font Controls
Create new playlist

Name your new playlist

Playlist description (optional)
Sign In

Email address

Password

Forgot Password?

or

Continue with Facebook

Continue with Google
Sign Up

Full Name

Email address

Confirm Email Address

Password

or

Continue with Facebook

Continue with Google

Appendix

Setting up a Docker Host

In the following section, you’ll set up a Docker host on Ubuntu. You’ll install the stable community edition (CE) of Docker. The Docker host that you’ll set up using the steps described in this section should be used only for practicing the exercises and examples in the current book. The following steps should not be used to set up a production Docker host.

Prerequisites

Before we begin, make sure you have the following things ready :

You’ll need a machine with at least 4 GB of memory (the more, the better) and a multi-core processor.
Depending on how you manage the infrastructure in your team, the machine could be an instance on a cloud platform (such as AWS or Digital Ocean) or a bare metal machine, or it could be a VM (on Wmware vSphere, Virtual Box, or any other server virtualization software).
The machine should have Ubuntu 16.04 or higher installed on it.
Check for admin privileges ; the installation might ask for admin credentials.

Set up the Repository

In the following section, you’ll first set up the repository to use before installing Docker. Follow the below steps:

1.
Update the apt package index:
sudo apt-get update
2.
Install packages to allow apt to use a repository over HTTPS:
sudo apt-get install apt-transport-https ca-certificates curl software-properties-common
3.
Add docker’s official GPG key:
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
4.
Verify that you now have the key with the fingerprint "9DC8 5822 9FC7 DD38 854A E2D8 8D81 803C 0EBF CD88" by searching for the last eight characters of the fingerprint.
sudo apt-key fingerprint 0EBFCD88

output
pub   4096R/0EBFCD88 2017-02-22
Key fingerprint = 9DC8 5822 9FC7 DD38 854A  E2D8 8D81 803C 0EBF CD88
uid   Docker Release (CE deb) <[email protected]>
sub   4096R/F273FCD8 2017-02-22
5.
Set up the stable repository. The following command automatically detects your Ubuntu OS distribution and sets up the appropriate Docker repository.
sudo add-apt-repository "deb [arch=amd64]
https://download.docker.com/linux/ubuntu
$(lsb_release -cs) stable"

Install Docker

Next, let’s install the community edition of Docker.

1.
Update the apt package index.
sudo apt-get update
2.
Install the latest version of Docker CE.
sudo apt-get install docker-ce
3.
Verify that Docker CE is installed correctly by running the hello-world image.
sudo docker run hello-world

Output
Unable to find image 'hello-world:latest' locally
latest: Pulling from library/hello-world
d1725b59e92d: Pull complete
Digest: sha256:0add3ace90ecb4adbf7777e9aacf18357296e799f81cabc9fde470971e499788
Status: Downloaded newer image for hello-world:latest
Hello from Docker!
.
.
.

Enabling Docker Remote API (Critical)

The Docker remote API allows external applications to communicate with the Docker server using REST APIs . Jenkins (through the Docker Plugin) uses the docker remote API to communicate with a docker host.

To enable the Docker remote API on your Docker host, you’ll need to modify Docker’s configuration file. Depending on your OS version and the way you have installed Docker on your machine, you might need to choose the right configuration file to modify. Shown here are two methods that work on Ubuntu. Try them one by one.

Modifying the docker.conf File

Follow these steps to modify the docker.conf file :

1.
Log in to your docker server; make sure you have sudo privileges.
2.
Execute the following command to edit the file docker.conf :

sudo nano /etc/init/docker.conf

3.
Inside the docker.conf file, go to the line containing "DOCKER_OPTS=" .

You’ll find "DOCKER_OPTS=" variable at multiple places inside the docker.conf file. Use the DOCKER_OPTS= that is available under the pre-start script or script section.

4.
Set the value of DOCKER_OPTS as shown here. Do not copy and paste; type it all in a single line.
DOCKER_OPTS='-H tcp://0.0.0.0:4243 -H unix:///var/run/docker.sock'

The above setting binds the Docker server to the UNIX socket as well on TCP port 4243.

"0.0.0.0" makes Docker engine accept connections from anywhere. If you would like your Docker server to accept connections only from your Jenkins server, then replace "0.0.0.0" with your Jenkins Server IP.

5.
Restart the Docker server using the following command:
sudo service docker restart
6.
To check if the configuration has worked, execute the following command. It lists all the images currently present on your Docker server.
curl -X GET http://<Docker Server IP>:4243/images/json
7.
If this command does not return a meaningful output, try the next method.

Modifying the docker.service File

Follow these steps to modify the docker.service file :

1.
Execute the following command to edit the docker.service file.
sudo nano /lib/systemd/system/docker.service
2.
Inside the docker.service file, go to the line containing ExecStart= and set its value as shown here. Do not copy and paste; type it all in a single line.
ExecStart=/usr/bin/dockerd -H fd:// -H tcp://0.0.0.0:4243

The above setting binds the docker server to the UNIX socket as well on TCP port 4243.

"0.0.0.0" makes the Docker engine accept connections from anywhere. If you would like your Docker server to accept connections only from your Jenkins server, then replace "0.0.0.0" with your Jenkins Server IP.

3.
Execute the following command to make the Docker demon notice the modified configuration:
sudo systemctl daemon-reload
4.
Restart the Docker server using the below command:
sudo service docker restart
5.
To check if the configuration has worked, execute the following command. It lists all the images currently present on your Docker server.
curl -X GET http://<Docker Server IP>:4243/images/json

Enabling Proxy Compatibility for Jenkins

Sometimes HTTP/HTTPS proxies filter out information used by the default crumb issuer. If, by any chance, you receive a 403 response when submitting a form to Jenkins, checking this option may help. Using this option makes the nonce value easier to forge.

Enabling proxy compatibility may help to solve this issue. Follow these simple steps to enable proxy compatibility:

1.
From the Jenkins Blue Ocean Dashboard, click on Administration link.
2.
On the Manage Jenkins page, click on Configure Global Security.
3.
On the Configure Global Security page navigate to the section CSRF Protection , and select the option Enable proxy compatibility [1] (see Figure A-1 ).

Figure A-1

CSRF Protection settings in Jenkins

Index

A

Activity/Branches tab

additionalBuildArgs

Admin user

Artifactory repository browser

Artifacts tab

Artifacts view

Atom editor

auto-completion and syntax highlighting

file config.cson

language-jenkinsfile package

Auto-completion

in atom editor

in eclipse IDE

B

Bind mount

Bitbucket repository, selection

Blue Ocean, Jenkins

Apache Tomcat

CI/CD tools

vs. Classic Jenkins

conditions

Continuous Delivery tool

dashboard

DevOps tools

features

Jenkins Shared Libraries

Nginx

reverse proxy server

Roadmap page

Visual Pipeline Editor

C

Changes tab

CI/CD pipelines

Classic Jenkins, see Blue Ocean, Jenkins

Complex Pipeline

script steps

Shared Library

Cron trigger

Custom Workspace

D

Declarative directive generator

Declarative Pipeline

agent section

any

dockerfile

docker parameter

label parameter

node parameter

directives ( see Directives)

parallel stages

nested

simple

post section

sequential stages

nested

simple

stages section

steps section

syntax

Declarative programming, definition

Default version field

Description field

Directives

booleanParm parameters

buildDiscarder options

choice parameters

disableConcurrentBuilds options

environment

file parameters

input

newContainerPerStage options

options

preserveStashes options

retry options

skipDefaultCheckout options

stage

string parameters

text parameters

timeout options

timestamps options

tool

triggers

when ( see When directive)

Docker

container

docker image

E

Eclipse IDE

auto-completion, syntax highlighting

Jenkins editor plugin settings

Jenkinsfile validation

Existing pipeline, edit

artifactory

build agent, assign

configuration

installation

report and publish stage

run server

scripted pipeline step

tasks

F

Feature-script-block branch

Freestyle Project

G, H

GitHub repository

access token

selection

GitLab repository

HTTP/HTTPS

server

SSH

Git repository

HTTP/HTTPS

SSH

Global agent

Global pipeline libraries

Groovy scripts

I

Imperative programming, definition

J, K

Jenkinsfile validation

in eclipse IDE

in Visual Studio Code

Jenkins Interface

Jenkins plugins

Jenkins Projects

Jenkins Server

Jenkins Dashboard

plugin suite

restarting and login page

Jenkins Setup Wizard

Jenkins URL

JUnit plugin

JUnit test

L

Legacy SCM

Load implicitly setting

M

Master branch

Modern SCM

Modularized software project

Multiple branches, pipelines

N, O

Name field identifier

Nested parallel stages

Nested sequential stages

P, Q

Performance testing stage

pipeline {} block

Pipeline as Code

Pipeline creation wizard

authentication

Bitbucket repository

credentials viewing

multibranch pipeline

new pipeline button

Pipeline Editor

repository

Git

GitHub

GitLab

Pipeline visualization

artifacts view

features

pipeline flow

re-running

running

tests view

tracing logs

Proxy compatibility

Publish stage

Pull request, pipelines

delete branch

GitHub

Jenkins Shared libraries

master branch

pull requests tab

source code repository

R

Remote API, docker

docker.conf file

docker.service file

REST APIs

Resources directory

S

script {} block

Scripted Pipeline

Script step

Select scopes section

Shared libraries

custom steps

directory structure, Jenkins

global variables

@Library annotation

pipeline, working

retrieving, during pipeline runtime

retrieving, pre-configured settings in Jenkins

Simple parallel stages

Simple sequential stages

Snippet generator

src directory

Stage View

Syntax highlighting

in atom editor

in eclipse IDE

in Visual Studio Code

T

Tests tab

Token description field

U

Upstream trigger

V

vars directory

Visual Pipeline Editor

artifacts

build and test stage

assign

creation

global agent

report and publish stage

assign

creation

save and run button

shell script step

stash step, artifact

steps

test results

un-stash step

Visual Studio Code

declarative Jenkinsfile support extension

file setting.json

Jenkins pipeline Linter Connector extension

syntax highlighting and Jenkinsfile validation

W, X, Y, Z

When directive

allOf option

anyOf option

branch

buildingTag option

changelog option

changeset option

environment option

equals option

expression option

not option

stage agent

tag option

..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.

Table of Contents for Back Matter

Create new playlist

Sign In

Sign Up

Index

A

B

C

D

E

F

G, H

I

J, K

L

M

N, O

P, Q

R

S

T

U

V

W, X, Y, Z

Table of Contents for
Back Matter