anwarchk / spring-cloud-pipelines

Codebase containing Concourse and Jenkins opinionated pipelines

Spring Cloud Pipelines

Documentation Authors: Marcin Grzejszczak

Spring, Spring Boot and Spring Cloud are tools that allow developers speed up the time of creating new business features. It’s common knowledge however that the feature is only valuable if it’s in production. That’s why companies spend a lot of time and resources on building their own deployment pipelines.

This project tries to solve the following problems:

• Creation of a common deployment pipeline

• Propagation of good testing & deployment practices

• Speed up the time required to deploy a feature to production

A common way of running, configuring and deploying applications lowers support costs and time needed by new developers to blend in when they change projects.

Introduction

In the following section we will describe in more depth the rationale behind the presented opinionated pipeline. We will go through each deployment step and describe it in details.

Project setup

.
├── common
├── concourse
├── docs
└── jenkins

In the common folder you can find all the Bash scripts containing the pipeline logic. These scripts are reused by both Concourse and Jenkins pipelines.

In the concourse folder you can find all the necessary scripts and setup to run Concourse demo.

In the docs section you have the whole documentation of the project.

In the jenkins folder you can find all the necessary scripts and setup to run Jenkins demo.

How to use it?

This repository can be treated as a template for your pipeline. We provide some opinionated implementation that you can alter to suit your needs. The best approach to use it to build your production projects would be to download the Spring Cloud Pipelines repository as ZIP, then init a Git project there and modify it as you wish.

$ curl -LOk https://github.com/spring-cloud/spring-cloud-pipelines/archive/v1.0.0.M4.zip
$ unzip v1.0.0.M6.zip
$ cd spring-cloud-pipelines-v1.0.0.M6
$ git init
$ # modify the pipelines to suit your needs
$ git add .
$ git commit -m "Initial commit"
$ git remote add origin ${YOUR_REPOSITORY_URL}
$ git push origin master

Note	Why aren’t you simply cloning the repo? This is meant to be a seed for building new, versioned pipelines for you. You don’t want to have all of our history dragged along with you, don’t you?

The flow

Let’s take a look at the flow of the opinionated pipeline

Figure 1. Flow in Concourse

Figure 2. Flow in Jenkins

We’ll first describe the overall concept behind the flow and then we’ll split it into pieces and describe every piece independently.

Environments

So we’re on the same page let’s define some common vocabulary. We discern 4 typical environments in terms of running the pipeline.

• build

• test

• stage

• prod

Build environment is a machine where the building of the application takes place. It’s a CI / CD tool worker.

Test is an environment where you can deploy an application to test it. It doesn’t resemble production, we can’t be sure of it’s state (which application is deployed there and in which version). It can be used by multiple teams at the same time.

Stage is an environment that does resemble production. Most likely applications are deployed there in versions that correspond to those deployed to production. Typically databases there are filled up with (obfuscated) production data. Most often this environment is a single, shared one between many teams. In other words in order to run some performance, user acceptance tests you have to block and wait until the environment is free.

Prod is a production environment where we want our tested applications to be deployed for our customers.

Tests

Unit tests - tests that are executed on the application during the build phase. No integrations with databases / HTTP server stubs etc. take place. Generally speaking your application should have plenty of these to have fast feedback if your features are working fine.

Integration tests - tests that are executed on the built application during the build phase. Integrations with in memory databases / HTTP server stubs take place. According to the test pyramid, in most cases you should have not too many of these kind of tests.

Smoke tests - tests that are executed on a deployed application. The concept of these tests is to check the crucial parts of your application are working properly. If you have 100 features in your application but you gain most money from e.g. 5 features then you could write smoke tests for those 5 features. As you can see we’re talking about smoke tests of an application, not of the whole system. In our understanding inside the opinionated pipeline, these tests are executed against an application that is surrounded with stubs.

End to end tests - tests that are executed on a system composing of multiple applications. The idea of these tests is to check if the tested feature works when the whole system is set up. Due to the fact that it takes a lot of time, effort, resources to maintain such an environment and that often those tests are unreliable (due to many different moving pieces like network database etc.) you should have a handful of those tests. Only for critical parts of your business. Since only production is the key verifier of whether your feature works, some companies don’t even want to do those and move directly to deployment to production. When your system contains KPI monitoring and alerting you can quickly react when your deployed application is not behaving properly.

Performance testing - tests executed on an application or set of applications to check if your system can handle big load of input. In case of our opinionated pipeline these tests could be executed either on test (against stubbed environment) or stage (against the whole system)

Testing against stubs

Before we go into details of the flow let’s take a look at the following example.

Figure 3. Two monolithic applications deployed for end to end testing

When having only a handful of applications, performing end to end testing is beneficial. From the operations perspective it’s maintainable for a finite number of deployed instances. From the developers perspective it’s nice to verify the whole flow in the system for a feature.

In case of microservices the scale starts to be a problem:

Figure 4. Many microservices deployed in different versions

The questions arise:

• Should I queue deployments of microservices on one testing environment or should I have an environment per microservice?

  • If I queue deployments people will have to wait for hours to have their tests ran - that can be a problem

• To remove that issue I can have an environment per microservice

  • Who will pay the bills (imagine 100 microservices - each having each own environment).

  • Who will support each of those environments?

  • Should we spawn a new environment each time we execute a new pipeline and then wrap it up or should we have them up and running for the whole day?

• In which versions should I deploy the dependent microservices - development or production versions?

  • If I have development versions then I can test my application against a feature that is not yet on production. That can lead to exceptions on production

  • If I test against production versions then I’ll never be able to test against a feature under development anytime before deployment to production.

One of the possibilities of tackling these problems is to…​ not do end to end tests.

Figure 5. Execute tests on a deployed microservice on stubbed dependencies

If we stub out all the dependencies of our application then most of the problems presented above disappear. There is no need to start and setup infrastructure required by the dependant microservices. That way the testing setup looks like this:

Figure 6. We’re testing microservices in isolation

Such an approach to testing and deployment gives the following benefits (thanks to the usage of Spring Cloud Contract):

• No need to deploy dependant services

• The stubs used for the tests ran on a deployed microservice are the same as those used during integration tests

• Those stubs have been tested against the application that produces them (check Spring Cloud Contract for more information)

• We don’t have many slow tests running on a deployed application - thus the pipeline gets executed much faster

• We don’t have to queue deployments - we’re testing in isolation thus pipelines don’t interfere with each other

• We don’t have to spawn virtual machines each time for deployment purposes

It brings however the following challenges:

• No end to end tests before production - you don’t have the full certainty that a feature is working

• First time the applications will talk in a real way will be on production

Like every solution it has its benefits and drawbacks. The opinionated pipeline allows you to configure whether you want to follow this flow or not.

General view

The general view behind this deployment pipeline is to:

• test the application in isolation

• test the backwards compatibility of the application in order to roll it back if necessary

• allow testing of the packaged app in a deployed environment

• allow user acceptance tests / performance tests in a deployed environment

• allow deployment to production

Obviously the pipeline could have been split to more steps but it seems that all of the aforementioned actions comprise nicely in our opinionated proposal.

CI Server worker prerequisites

Spring Cloud Pipelines uses Bash scripts extensively. Below you can find the list of software that needs to be installed on a CI server worker for the build to pass.

Tip	In the demo setup all of these libraries are already installed.

 apt-get -y install \
    bash \
    git \
    tar \
    zip \
    curl \
    ruby \
    wget \
    unzip \
    python \
    jq

Important

In the Jenkins case you will also need bats and shellcheck. They are not presented in the list since the installed versions by Linux distributions might be old. That’s why this project’s Gradle tasks will download latest versions of both libraries for you.

Pipeline descriptor

Each application can contain a file called sc-pipelines.yml with the following structure:

lowercaseEnvironmentName1:
    services:
        - type: service1Type
          name: service1Name
          coordinates: value
        - type: service2Type
          name: service2Name
          key: value
lowercaseEnvironmentName2:
    services:
        - type: service3Type
          name: service3Name
          coordinates: value
        - type: service4Type
          name: service4Name
          key: value

For a given environment we declare a list of infrastructure services that we want to have deployed. Services have

• type (example: eureka, mysql, rabbitmq, stubrunner) - this value gets then applied to the deployService Bash function

• [KUBERNETES] for mysql you can pass the database name via the database property

• name - name of the service to get deployed

• coordinates - coordinate that allows you to fetch the binary of the service. Examples: It can be a maven coordinate groupid:artifactid:version, docker image organization/nameOfImage, etc.

• arbitrary key value pairs - you can customize the services as you wish

The stubrunner type can also have the useClasspath flag turned on to true or false.

Example:

test:
  services:
    - type: rabbitmq
      name: rabbitmq-github-webhook
    - type: mysql
      name: mysql-github-webhook
    - type: eureka
      name: eureka-github-webhook
      coordinates: com.example.eureka:github-eureka:0.0.1.M1
    - type: stubrunner
      name: stubrunner-github-webhook
      coordinates: com.example.eureka:github-analytics-stub-runner-boot-classpath-stubs:0.0.1.M1
      useClasspath: true
stage:
  services:
    - type: rabbitmq
      name: rabbitmq-github
    - type: mysql
      name: mysql-github
    - type: eureka
      name: github-eureka
      coordinates: com.example.eureka:github-eureka:0.0.1.M1

When the deployment to test or deployment to stage occurs, Spring Cloud Pipelines will:

• for test environment, delete existing services and redeploy the ones from the list

• for stage environment, if the service is not available it will get deployed. Otherwise nothing will happen

Opinionated implementation

For the demo purposes we’re providing Docker Compose setup with Artifactory and Concourse / Jenkins tools. Regardless of the picked CD application for the pipeline to pass one needs either

• [CLOUD FOUNDRY] a Cloud Foundry instance (for example Pivotal Web Services or PCF Dev)

• [KUBERNETES] a Kubernetes cluster (for example Minikube)

• the infrastructure applications deployed to the JAR hosting application (for the demo we’re providing Artifactory).

• Eureka for Service Discovery

• Stub Runner Boot for running Spring Cloud Contract stubs.

Tip	In the demos we’re showing you how to first build the github-webhook project. That’s because the github-analytics needs the stubs of github-webhook to pass the tests. Below you’ll find references to github-analytics project since it contains more interesting pieces as far as testing is concerned.

Build

Figure 7. Build and upload artifacts

In this step we’re generating a version of the pipeline, next we’re running unit, integration and contract tests. Finally we’re:

• publishing a fat jar of the application

• publishing a Spring Cloud Contract jar containing stubs of the application

• [KUBERNETES] uploading a Docker image of the application

During this phase we’re executing a Maven build using Maven Wrapper or a Gradle build using Gradle Wrapper , with unit and integration tests. We’re also tagging the repository with dev/${version} format. That way in each subsequent step of the pipeline we’re able to retrieve the tagged version. Also we know exactly which version of the pipeline corresponds to which Git hash.

Once the artifact got built we’re running API compatibility check.

• we’re searching for the latest production deployment

• we’re retrieving the contracts that were used by that deployment

• from the contracts we’re generating API tests to see if the current implementation is fulfilling the HTTP / messaging contracts that the current production deployment has defined (we’re checking backward compatibility of the API)

Test

Figure 8. Smoke test and rollback test on test environment

Here we’re

• starting a RabbitMQ service in PaaS

• deploying Eureka infrastructure application to PaaS

• downloading the fat jar from Nexus and we’re uploading it to PaaS. We want the application to run in isolation (be surrounded by stubs).

Tip	Currently due to port constraints in Cloud Foundry we cannot run multiple stubbed HTTP services in the cloud so to fix this issue we’re running the application with smoke Spring profile on which you can stub out all HTTP calls to return a mocked response

• if the application is using a database then it gets upgraded at this point via Flyway, Liquibase or any other tool once the application gets started

• from the project’s Maven or Gradle build we’re extracting stubrunner.ids property that contains all the groupId:artifactId:version:classifier notation of dependant projects for which the stubs should be downloaded.

• then we’re uploading Stub Runner Boot and pass the extracted stubrunner.ids to it. That way we’ll have a running application in Cloud Foundry that will download all the necessary stubs of our application

• from the checked out code we’re running the tests available under the smoke profile. In the case of GitHub Analytics application we’re triggering a message from the GitHub Webhook application’s stub, that is sent via RabbitMQ to GitHub Analytics. Then we’re checking if message count has increased.

• once the tests pass we’re searching for the last production release. Once the application is deployed to production we’re tagging it with prod/${version} tag. If there is no such tag (there was no production release) there will be no rollback tests executed. If there was a production release the tests will get executed.

• assuming that there was a production release we’re checking out the code corresponding to that release (we’re checking out the tag), we’re downloading the appropriate artifact (either JAR for Cloud Foundry or Docker image for Kubernetes) and we’re uploading it to PaaS. IMPORTANT the old artifact is running against the NEW version of the database.

• we’re running the old smoke tests against the freshly deployed application surrounded by stubs. If those tests pass then we have a high probability that the application is backwards compatible

• the default behaviour is that after all of those steps the user can manually click to deploy the application to a stage environment

Stage

Figure 9. End to end tests on stage environment

Here we’re

• starting a RabbitMQ service in PaaS

• deploying Eureka infrastructure application to PaaS

• downloading the artifact (either JAR for Cloud Foundry or Docker image for Kubernetes) from and we’re uploading it to PaaS.

Next we have a manual step in which:

• from the checked out code we’re running the tests available under the e2e profile. In the case of GitHub Analytics application we’re sending a HTTP message to GitHub Analytic’s endpoint. Then we’re checking if the received message count has increased.

The step is manual by default due to the fact that stage environment is often shared between teams and some preparations on databases / infrastructure have to take place before running the tests. Ideally these step should be fully automatic.

Prod

Figure 10. Deployment to production

The step to deploy to production is manual but ideally it should be automatic.

Important

This step does deployment to production. On production you would assume that you have the infrastructure running. That’s why before you run this step you must execute a script that will provision the services on the production environment. For Cloud Foundry just call tools/cf-helper.sh setup-prod-infra and for Kubernetes tools/k8s-helper.sh setup-prod-infra

Here we’re

• tagging the Git repo with prod/${version} tag

• downloading the application artifact (either JAR for Cloud Foundry or Docker image for Kubernetes)

• we’re doing Blue Green deployment:

• for Cloud Foundry

  • we’re renaming the current instance of the app e.g. fooService to fooService-venerable

  • we’re deploying the new instance of the app under the fooService name

  • now two instances of the same application are running on production

• for Kubernetes

  • we’re deploying a service with the name of the app e.g. fooService

  • we’re doing a deployment with the name of the app with version suffix (with the name escaped to fulfill the DNS name requirements) e.g. fooService-1-0-0-M1-123-456-VERSION

  • all deployments of the same application have the same label name equal to app name e.g. fooService

  • the service is routing the traffic basing on the name label selector

  • now two instances of the same application are running on production

• in the Complete switch over which is a manual step

  • we’re deleting the old instance

  • remember to run this step only after you have confirmed that both instances are working fine!

  • now two instances of the same application are running on production

• in the Rollback to blue which is a manual step

  • we’re routing all the traffic to the old instance

  • in CF we do that by ensuring that blue is running and stopping green

  • in K8S we do that by scaling the number of instances of green to 0

  • this step will set the state of your system to such where most likely some manual intervention should take place (to restart some applications, redeploy them, etc.)

Project opinions

In this section we will go through the assumptions we’ve made in the project structure and project properties.

CF project opinions

We’ve taken the following opinionated decisions for a Cloud Foundry based project:

• application built using Maven or Gradle wrappers

• application deployment to Cloud Foundry

• For Maven (example project):

  • usage of Maven Wrapper

  • settings.xml is parametrized to pass the credentials to push code to Artifactory

    • M2_SETTINGS_REPO_ID - server id for Artifactory / Nexus deployment

    • M2_SETTINGS_REPO_USERNAME - username for Artifactory / Nexus deployment

    • M2_SETTINGS_REPO_PASSWORD - password for Artifactory / Nexus deployment

  • artifacts deployment by ./mvnw clean deploy

  • stubrunner.ids property to retrieve list of collaborators for which stubs should be downloaded

  • repo.with.binaries property - (Injected by the pipeline) will contain the URL to the repo containing binaries (e.g. Artifactory)

  • distribution.management.release.id property - (Injected by the pipeline) ID of the distribution management. Corresponds to server id in settings.xml

  • distribution.management.release.url property - (Injected by the pipeline) Will contain the URL to the repo containing binaries (e.g. Artifactory)

  • running API compatibility tests via the apicompatibility Maven profile

  • latest.production.version property - (Injected by the pipeline) will contain the latest production version for the repo (retrieved from Git tags)

  • running smoke tests on a deployed app via the smoke Maven profile

  • running end to end tests on a deployed app via the e2e Maven profile

• For Gradle (example project check the gradle/pipeline.gradle file):

  • usage of Gradlew Wrapper

  • deploy task for artifacts deployment

  • REPO_WITH_BINARIES env var - (Injected by the pipeline) will contain the URL to the repo containing binaries (e.g. Artifactory)

  • M2_SETTINGS_REPO_USERNAME env var - Username used to send the binary to the repo containing binaries (e.g. Artifactory)

  • M2_SETTINGS_REPO_PASSWORD env var - Password used to send the binary to the repo containing binaries (e.g. Artifactory)

  • running API compatibility tests via the apiCompatibility task

  • latestProductionVersion property - (Injected by the pipeline) will contain the latest production version for the repo (retrieved from Git tags)

  • running smoke tests on a deployed app via the smoke task

  • running end to end tests on a deployed app via the e2e task

  • groupId task to retrieve group id

  • artifactId task to retrieve artifact id

  • currentVersion task to retrieve the current version

  • stubIds task to retrieve list of collaborators for which stubs should be downloaded

Kubernetes project opinions

We’ve taken the following opinionated decisions for a Cloud Foundry based project:

• application built using Maven or Gradle wrappers

• application deployment to Kubernetes

• The produced Java Docker image needs to allow passing of system properties via SYSTEM_PROPS env variable

• For Maven (example project):

  • usage of Maven Wrapper

  • settings.xml is parametrized to pass the credentials to push code to Artifactory and Docker repository

    • M2_SETTINGS_REPO_ID - server id for Artifactory / Nexus deployment

    • M2_SETTINGS_REPO_USERNAME - username for Artifactory / Nexus deployment

    • M2_SETTINGS_REPO_PASSWORD - password for Artifactory / Nexus deployment

    • DOCKER_SERVER_ID - server id for Docker image pushing

    • DOCKER_USERNAME - username for Docker image pushing

    • DOCKER_PASSWORD - password for Docker image pushing

    • DOCKER_EMAIL - email for Artifactory / Nexus deployment

  • DOCKER_REGISTRY_URL env var - (Overridable - defaults to DockerHub) URL of the Docker registry

  • DOCKER_REGISTRY_ORGANIZATION - env var containing the organization where your Docker repo lays

  • artifacts and Docker image deployment by ./mvnw clean deploy

  • stubrunner.ids property to retrieve list of collaborators for which stubs should be downloaded

  • repo.with.binaries property - (Injected by the pipeline) will contain the URL to the repo containing binaries (e.g. Artifactory)

  • distribution.management.release.id property - (Injected by the pipeline) ID of the distribution management. Corresponds to server id in settings.xml

  • distribution.management.release.url property - (Injected by the pipeline) Will contain the URL to the repo containing binaries (e.g. Artifactory)

  • deployment.yml contains the Kubernetes deployment descriptor

  • service.yml contains the Kubernetes service descriptor

  • running API compatibility tests via the apicompatibility Maven profile

  • latest.production.version property - (Injected by the pipeline) will contain the latest production version for the repo (retrieved from Git tags)

  • running smoke tests on a deployed app via the smoke Maven profile

  • running end to end tests on a deployed app via the e2e Maven profile

• For Gradle (example project check the gradle/pipeline.gradle file):

  • usage of Gradlew Wrapper

  • deploy task for artifacts deployment

  • REPO_WITH_BINARIES env var - (Injected by the pipeline) will contain the URL to the repo containing binaries (e.g. Artifactory)

  • M2_SETTINGS_REPO_USERNAME env var - Username used to send the binary to the repo containing binaries (e.g. Artifactory)

  • M2_SETTINGS_REPO_PASSWORD env var - Password used to send the binary to the repo containing binaries (e.g. Artifactory)

  • DOCKER_REGISTRY_URL env var - (Overridable - defaults to DockerHub) URL of the Docker registry

  • DOCKER_USERNAME env var - Username used to send the the Docker image

  • DOCKER_PASSWORD env var - Password used to send the the Docker image

  • DOCKER_EMAIL env var - Email used to send the the Docker image

  • DOCKER_REGISTRY_ORGANIZATION - env var containing the organization where your Docker repo lays

  • deployment.yml contains the Kubernetes deployment descriptor

  • service.yml contains the Kubernetes service descriptor

  • running API compatibility tests via the apiCompatibility task

  • latestProductionVersion property - (Injected by the pipeline) will contain the latest production version for the repo (retrieved from Git tags)

  • running smoke tests on a deployed app via the smoke task

  • running end to end tests on a deployed app via the e2e task

  • groupId task to retrieve group id

  • artifactId task to retrieve artifact id

  • currentVersion task to retrieve the current version

  • stubIds task to retrieve list of collaborators for which stubs should be downloaded

Concourse Pipeline

The repository contains an opinionated pipeline that will build and deploy - Github Webhook application.

All in all there are the following projects taking part in the whole microservice setup for this demo.

• Github-Analytics - the app that has a REST endpoint and uses messaging. Our business application.

• Github Webhook - project that emits messages that are used by Github Analytics. Our business application.

• Eureka - simple Eureka Server. This is an infrastructure application.

• Github Analytics Stub Runner Boot - Stub Runner Boot server to be used for tests with Github Analytics. Uses Eureka and Messaging. This is an infrastructure application.

Step by step

If you want to just run the demo as far as possible using PCF Dev and Docker Compose

• Fork repos

• Start Concourse and Artifactory

• Deploy infra to Artifactory

• Start PCF Dev (if you don’t want to use an existing one)

• Setup the fly CLI

• Setup your credentials.yml

• Run the seed job

• Run the github-webhook pipeline

Below you can find optional steps needed to be taken when you want to customize the pipeline

• Setup Jenkins env vars (if you want to use the demo defaults and you’re using Docker Machine just check out the section on how to update the URL to Artifactory)

• Add settings.xml for Jenkins' master (you can skip this if you want to use our defaults)

• Setup Jenkins miscs (JDK installation, Groovy macro processing etc.)

• Setup Jenkins credentials

Fork repos

There are 4 apps that are composing the pipeline

• Github Webhook

• Github Analytics

• Github Eureka

• Github Stub Runner Boot

You need to fork only these. That’s because only then will your user be able to tag and push the tag to repo.

• Github Webhook

• Github Analytics

Start Concourse and Artifactory

Concourse + Artifactory can be run locally. To do that just execute the start.sh script from this repo.

git clone https://github.com/spring-cloud/spring-cloud-pipelines
cd spring-cloud-pipelines/concourse
./setup_docker_compose.sh
./start.sh 192.168.99.100

The setup_docker_compose.sh script should be executed once only to allow generation of keys.

The 192.168.99.100 param is an example of an external URL of Concourse (equal to Docker-Machine ip in this example).

Then Concourse will be running on port 8080 and Artifactory 8081.

Deploy the infra JARs to Artifactory

When Artifactory is running, just execute the tools/deploy-infra.sh script from this repo.

git clone https://github.com/spring-cloud/spring-cloud-pipelines
cd spring-cloud-pipelines/
./tools/deploy-infra.sh

As a result both eureka and stub runner repos will be cloned, built and uploaded to Artifactory.

Start PCF Dev

TIP: You can skip this step if you have CF installed and don’t want to use PCF Dev The only thing you have to do is to set up spaces.

Warning

It’s more than likely that you’ll run out of resources when you reach stage step. Don’t worry! Keep calm and clear some apps from PCF Dev and continue.

You have to download and start PCF Dev. A link how to do it is available here.

The default credentials when using PCF Dev are:

username: user
password: pass
email: user
org: pcfdev-org
space: pcfdev-space
api: api.local.pcfdev.io

You can start the PCF dev like this:

cf dev start

You’ll have to create 3 separate spaces (email admin, pass admin)

cf login -a https://api.local.pcfdev.io --skip-ssl-validation -u admin -p admin -o pcfdev-org

cf create-space pcfdev-test
cf set-space-role user pcfdev-org pcfdev-test SpaceDeveloper
cf create-space pcfdev-stage
cf set-space-role user pcfdev-org pcfdev-stage SpaceDeveloper
cf create-space pcfdev-prod
cf set-space-role user pcfdev-org pcfdev-prod SpaceDeveloper

You can also execute the ./tools/cf-helper.sh setup-spaces to do this.

Setup the fly CLI

If you go to Concourse website you should see sth like this:

   

   

You can click one of the icons (depending on your OS) to download fly, which is the Concourse CLI. Once you’ve downloaded that (and maybe added to your PATH) you can run:

fly --version

If fly is properly installed then it should print out the version.

Setup your credentials.yml

The repo comes with credentials-sample.yml which is set up with sample data (most credentials) are set to be applicable for PCF Dev. Copy this file to a new file credentials.yml (the file is added to .gitignore so don’t worry that you’ll push it with your passwords) and edit it as you wish. For our demo jus setup:

• app-url - url pointing to your forked github-webhook repo

• github-private-key - your private key to clone / tag GitHub repos

• repo-with-binaries - the IP is set to the defaults for Docker Machine. You should update it to point to your setup

If you don’t have a Docker Machine just execute ./whats_my_ip.sh script to get an external IP that you can pass to your repo-with-binaries instead of the default Docker Machine IP.

Below you can see what environment variables are required by the scripts. To the right hand side you can see the default values for PCF Dev that we set in the credentials-sample.yml.

Property Name	Property Description	Default value
PAAS_TEST_API_URL	The URL to the CF Api for TEST env	api.local.pcfdev.io
PAAS_STAGE_API_URL	The URL to the CF Api for STAGE env	api.local.pcfdev.io
PAAS_PROD_API_URL	The URL to the CF Api for PROD env	api.local.pcfdev.io
PAAS_TEST_ORG	Name of the org for the test env	pcfdev-org
PAAS_TEST_SPACE	Name of the space for the test env	pcfdev-space
PAAS_STAGE_ORG	Name of the org for the stage env	pcfdev-org
PAAS_STAGE_SPACE	Name of the space for the stage env	pcfdev-space
PAAS_PROD_ORG	Name of the org for the prod env	pcfdev-org
PAAS_PROD_SPACE	Name of the space for the prod env	pcfdev-space
REPO_WITH_BINARIES	URL to repo with the deployed jars	http://192.168.99.100:8081/artifactory/libs-release-local
M2_SETTINGS_REPO_ID	The id of server from Maven settings.xml	artifactory-local
PAAS_HOSTNAME_UUID	Additional suffix for the route. In a shared environment the default routes can be already taken
APP_MEMORY_LIMIT	How much memory should be used by the infra apps (Eureka, Stub Runner etc.)	256m
JAVA_BUILDPACK_URL	The URL to the Java buildpack to be used by CF	https://github.com/cloudfoundry/java-buildpack.git#v3.8.1
BUILD_OPTIONS	Additional options you would like to pass to the Maven / Gradle build

Build the pipeline

Log in (e.g. for Concourse running at 192.168.99.100 - if you don’t provide any value then localhost is assumed). If you execute this script (it assumes that either fly is on your PATH or it’s in the same folder as the script is):

./login.sh 192.168.99.100

Next run the command to create the pipeline.

./set_pipeline.sh

Then you’ll create a github-webhook pipeline under the docker alias, using the provided credentials.yml file. You can override these values in exactly that order (e.g. ./set-pipeline.sh some-project another-target some-other-credentials.yml)

Run the github-webhook pipeline

   

Step 1: Click Login

   

Step 2: Pick main team

   

Step 3: Log in with concourse user and changeme password

   

Step 4: Your screen should look more or less like this

   

Step 5: Unpause the pipeline by clicking in the top lefr corner and then clicking the play button

   

Step 6: Click 'generate-version'

   

Step 7: Click + sign to start a new build

   

Step 8: The job is pending

   

Step 9: Job is pending in the main screen

   

Step 10: Job is running in the main screen

FAQ

Can I use the pipeline for some other repos?

Sure! Just change the app-url in credentials.yml!

Will this work for ANY project out of the box?

Not really. This is an opinionated pipeline that’s why we took some opinionated decisions like:

• usage of Spring Cloud, Spring Cloud Contract Stub Runner and Spring Cloud Eureka

• application deployment to Cloud Foundry

• For Maven:

  • usage of Maven Wrapper

  • artifacts deployment by ./mvnw clean deploy

  • stubrunner.ids property to retrieve list of collaborators for which stubs should be downloaded

  • running smoke tests on a deployed app via the smoke Maven profile

  • running end to end tests on a deployed app via the e2e Maven profile

• For Gradle (in the github-analytics application check the gradle/pipeline.gradle file):

  • usage of Gradlew Wrapper

  • deploy task for artifacts deployment

  • running smoke tests on a deployed app via the smoke task

  • running end to end tests on a deployed app via the e2e task

  • groupId task to retrieve group id

  • artifactId task to retrieve artifact id

  • currentVersion task to retrieve the current version

  • stubIds task to retrieve list of collaborators for which stubs should be downloaded

This is the initial approach that can be easily changed in the future.

Can I modify this to reuse in my project?

Sure! It’s open-source! The important thing is that the core part of the logic is written in Bash scripts. That way, in the majority of cases, you could change only the bash scripts without changing the whole pipeline. You can check out the scripts here.

Furthermore, if you only want to customize a particular function under common/src/main/bash, you can provide your own function under common/src/main/bash/<some custom identifier> where <some custom identifier> is equal to the value of the CUSTOM_SCRIPT_IDENTIFIER environment variable. For more on this technique, see Override specific project type pipeline functions.

I ran out of resources!!

When deploying the app to stage or prod you can get an exception Insufficient resources. The way to solve it is to kill some apps from test / stage env. To achieve that just call

cf target -o pcfdev-org -s pcfdev-test
cf stop github-webhook
cf stop github-eureka
cf stop stubrunner

You can also execute ./tools/cf-helper.sh kill-all-apps that will remove all demo-related apps deployed to PCF dev.

The rollback step fails due to missing JAR ?!

You must have pushed some tags and have removed the Artifactory volume that contained them. To fix this, just remove the tags

git tag -l | xargs -n 1 git push --delete origin

Can I see the output of a job from the terminal?

Yes! Assuming that pieline name is github-webhook and job name is build-and-upload you can running

fly watch --job github-webhook/build-and-upload -t docker

I clicked the job and it’s constantly pending…​

Don’t worry…​ most likely you’ve just forgotten to click the play button to unpause the pipeline. Click to the top left, expand the list of pipelines and click the play button next to github-webhook.

Another problem that might occur is that you need to have the version branch. Concourse will wait for the version branch to appear in your repo. So in order for the pipeline to start ensure that when doing some git operations you haven’t forgotten to create / copy the version branch too.

The route is already in use

If you play around with Jenkins / Concourse you might end up with the routes occupied

Using route github-webhook-test.local.pcfdev.io
Binding github-webhook-test.local.pcfdev.io to github-webhook...
FAILED
The route github-webhook-test.local.pcfdev.io is already in use.

Just delete the routes

yes | cf delete-route local.pcfdev.io -n github-webhook-test
yes | cf delete-route local.pcfdev.io -n github-eureka-test
yes | cf delete-route local.pcfdev.io -n stubrunner-test
yes | cf delete-route local.pcfdev.io -n github-webhook-stage
yes | cf delete-route local.pcfdev.io -n github-eureka-stage
yes | cf delete-route local.pcfdev.io -n github-webhook-prod
yes | cf delete-route local.pcfdev.io -n github-eureka-prod

You can also execute the ./tools/cf-helper.sh delete-routes

I’m unauthorized to deploy infrastructure jars

Most likely you’ve forgotten to update your local settings.xml with the Artifactory’s setup. Check out this section of the docs and update your settings.xml.

Jenkins Pipeline (Common)

In this section we will present the common setup of Jenkins for any platform. We will also provide answers to most frequently asked questions.

Project setup

.
├── declarative-pipeline
│   └── Jenkinsfile-sample.groovy
├── jobs
│   ├── jenkins_pipeline_empty.groovy
│   ├── jenkins_pipeline_jenkinsfile_empty.groovy
│   ├── jenkins_pipeline_sample.groovy
│   └── jenkins_pipeline_sample_view.groovy
├── seed
│   ├── init.groovy
│   ├── jenkins_pipeline.groovy
│   ├── k8s
│   └── settings.xml
└── src
    ├── main
    └── test

In the declarative-pipeline you can find a definition of a Jenkinsfile-sample.groovy declarative pipeline. It’s used together with the Blueocean UI.

In the jobs folder you have all the seed jobs that will generate pipelines.

• jenkins_pipeline_empty.groovy - is a template of a pipeline with empty steps using the Jenkins Job DSL plugin

• jenkins_pipeline_jenkinsfile_empty.groovy - is a template of a pipeline with empty steps using the Pipeline plugin

• jenkins_pipeline_sample.groovy - is an opinionated implementation using the Jenkins Job DSL plugin

• jenkins_pipeline_sample_view.groovy - builds the views for the pipelines

In the seed folder you have the init.groovy file which is executed when Jenkins starts. That way we can configure most of Jenkins options for you (adding credentials, JDK etc.). jenkins_pipeline.groovy contains logic to build a seed job (that way you don’t have to even click that job - we generate it for you). Under the k8s folder there are all the configuration files required for deployment to a Kubernetes cluster.

In the src folder you have production and test classes needed for you to build your own pipeline. Currently we have tests only cause the whole logic resides in the jenkins_pipeline_sample file.

Optional customization steps

All the steps below are not necessary to run the demo. They are needed only when you want to do some custom changes.

Deploying infra jars to a different location

It’s enough to set the ARTIFACTORY_URL environmental variable before executing tools/deploy-infra.sh. Example for deploying to Artifactory at IP 192.168.99.100

git clone https://github.com/spring-cloud/spring-cloud-pipelines
cd spring-cloud-pipelines/
ARTIFACTORY_URL="http://192.168.99.100:8081/artifactory/libs-release-local" ./tools/deploy-infra.sh

Setup settings.xml for Maven deployment

Tip	If you want to use the default connection to the Docker version of Artifactory you can skip this step

So that ./mvnw deploy works with Artifactory from Docker we’re already copying the missing settings.xml file for you. It looks more or less like this:

<?xml version="1.0" encoding="UTF-8"?>
<settings>
	<servers>
		<server>
			<id>${M2_SETTINGS_REPO_ID}</id>
			<username>${M2_SETTINGS_REPO_USERNAME}</username>
			<password>${M2_SETTINGS_REPO_PASSWORD}</password>
		</server>
		<server>
			<id>${DOCKER_SERVER_ID}</id>
			<username>${DOCKER_USERNAME}</username>
			<password>${DOCKER_PASSWORD}</password>
			<configuration>
				<email>${DOCKER_EMAIL}</email>
			</configuration>
		</server>
	</servers>
</settings>

As you can see the file is parameterized. In Maven it’s enough to pass to ./mvnw command the proper system property to override that value. For example to pass a different docker email you’d have to call ./mvnw -DDOCKER_EMAIL=[email protected] and the value gets updated.

If you want to use your own version of Artifactory / Nexus you have to update the file (it’s in seed/settings.xml).

Setup Jenkins env vars

If you want to only play around with the demo that we’ve prepared you have to set ONE variable which is the REPOS variable. That variable needs to consists of comma separated list of URLs to repositories containing business apps. So you should pass your forked repos URLs.

You can do it in the following ways:

• globally via Jenkins global env vars (then when you run the seed that variable will be taken into consideration and proper pipelines will get built)

• modify the seed job parameters (you’ll have to modify the seed job configuration and change the REPOS property)

• provide the repos parameter when running the seed job

For the sake of simplicity let’s go with the last option.

Important

If you’re choosing the global envs, you HAVE to remove the other approach (e.g. if you set the global env for REPOS, please remove that property in the seed job

Seed properties

Click on the seed job and pick Build with parameters. Then as presented in the screen below (you’ll have far more properties to set) just modify the REPOS property by providing the comma separated list of URLs to your forks. Whatever you set will be parsed by the seed job and passed to the generated Jenkins jobs.

Tip	This is very useful when the repos you want to build differ. E.g. use different JDK. Then some seeds can set the JDK_VERSION param to one version of Java installation and the others to another one.

Example screen:

In the screenshot we could parametrize the REPOS and REPO_WITH_BINARIES params.

Global envs

Important

This section is presented only for informational purposes - for the sake of demo you can skip it

You can add env vars (go to configure Jenkins → Global Properties) for the following properties (example with defaults for PCF Dev):

Example screen:

Set Git email / user

Since our pipeline is setting the git user / name explicitly for the build step you’d have to go to Configure of the build step and modify the Git name / email. If you want to set it globally you’ll have to remove the section from the build step and follow these steps to set it globally.

You can set Git email / user globally like this:

   

Step 1: Click 'Manage Jenkins'

   

Step 2: Click 'Configure System'

   

Step 3: Fill out Git user information

   

Add Jenkins credentials for GitHub

The scripts will need to access the credential in order to tag the repo.

You have to set credentials with id: git.

Below you can find instructions on how to set a credential (e.g. for Cloud Foundry cf-test credential but remember to provide the one with id git).

   

Step 1: Click 'Credentials, System'

   

Step 2: Click 'Global Credentials'

   

Step 3: Click 'Add credentials'

   

Step 4: Fill out the user / password and provide the git credential ID (in this example cf-test)

   

Testing Jenkins scripts

./gradlew clean build

Warning

The ran test only checks if your scripts compile.

How to work with Jenkins Job DSL plugin

Check out the tutorial. Provide the link to this repository in your Jenkins installation.

Warning

Remember that views can be overridden that’s why the suggestion is to contain in one script all the logic needed to build a view for a single project (check out that spring_cloud_views.groovy is building all the spring-cloud views).

Docker Image

If you would like to run the pre-configured Jenkins image somewhere other than your local machine, we have an image you can pull and use on DockerHub. The latest tag corresponds to the latest snapshot build. You can also find tags corresponding to stable releases that you can use as well.

Jenkins Pipeline (Cloud Foundry)

Important

In this chapter we assume that you perform deployment of your application to Cloud Foundry PaaS

The Spring Cloud Pipelines repository contains job definitions and the opinionated setup pipeline using Jenkins Job Dsl plugin. Those jobs will form an empty pipeline and a sample, opinionated one that you can use in your company.

All in all there are the following projects taking part in the whole microservice setup for this demo.

• Github-Analytics - the app that has a REST endpoint and uses messaging. Our business application.

• Github Webhook - project that emits messages that are used by Github Analytics. Our business application.

• Eureka - simple Eureka Server. This is an infrastructure application.

• Github Analytics Stub Runner Boot - Stub Runner Boot server to be used for tests with Github Analytics. Uses Eureka and Messaging. This is an infrastructure application.

Step by step

This is a guide for Jenkins JOB Dsl based pipeline.

If you want to just run the demo as far as possible using PCF Dev and Docker Compose

• Fork repos

• Start Jenkins and Artifactory

• Deploy infra to Artifactory

• Start PCF Dev (if you don’t want to use an existing one)

• Run the seed job

• Run the github-webhook pipeline

Fork repos

There are 4 apps that are composing the pipeline

• Github Webhook

• Github Analytics

• Github Eureka

• Github Stub Runner Boot

You need to fork only these. That’s because only then will your user be able to tag and push the tag to repo.

• Github Webhook

• Github Analytics

Start Jenkins and Artifactory

Jenkins + Artifactory can be ran locally. To do that just execute the start.sh script from this repo.

git clone https://github.com/spring-cloud/spring-cloud-pipelines
cd spring-cloud-pipelines/jenkins
./start.sh yourGitUsername yourGitPassword yourForkedGithubOrg

Then Jenkins will be running on port 8080 and Artifactory 8081. The provided parameters will be passed as env variables to Jenkins VM and credentials will be set in your set. That way you don’t have to do any manual work on the Jenkins side. In the above parameters, the third parameter could be yourForkedGithubOrg or yourGithubUsername. Also the REPOS env variable will contain your GitHub org in which you have the forked repos.

Deploy the infra JARs to Artifactory

When Artifactory is running, just execute the tools/deploy-infra.sh script from this repo.

git clone https://github.com/spring-cloud/spring-cloud-pipelines
cd spring-cloud-pipelines/
./tools/deploy-infra.sh

As a result both eureka and stub runner repos will be cloned, built and uploaded to Artifactory.

Start PCF Dev

Tip	You can skip this step if you have CF installed and don’t want to use PCF Dev The only thing you have to do is to set up spaces.

Warning

It’s more than likely that you’ll run out of resources when you reach stage step. Don’t worry! Keep calm and clear some apps from PCF Dev and continue.

You have to download and start PCF Dev. A link how to do it is available here.

The default credentials when using PCF Dev are:

username: user
password: pass
email: user
org: pcfdev-org
space: pcfdev-space
api: api.local.pcfdev.io

You can start the PCF dev like this:

cf dev start

You’ll have to create 3 separate spaces (email admin, pass admin)

cf login -a https://api.local.pcfdev.io --skip-ssl-validation -u admin -p admin -o pcfdev-org

cf create-space pcfdev-test
cf set-space-role user pcfdev-org pcfdev-test SpaceDeveloper
cf create-space pcfdev-stage
cf set-space-role user pcfdev-org pcfdev-stage SpaceDeveloper
cf create-space pcfdev-prod
cf set-space-role user pcfdev-org pcfdev-prod SpaceDeveloper

You can also execute the ./tools/cf-helper.sh setup-spaces to do this.

Run the seed job

We already create the seed job for you but you’ll have to run it. When you do run it you have to provide some properties. By default we create a seed that has all the properties options, but you can delete most of it. If you set the properties as global env variables you have to remove them from the seed.

Anyways, to run the demo just provide in the REPOS var the comma separated list of URLs of the 2 aforementioned forks of github-webhook and `github-analytics'.

   

Step 1: Click the 'jenkins-pipeline-seed-cf' job for Cloud Foundry and jenkins-pipeline-seed-k8s for Kubernetes

   

Step 2: Click the 'Build with parameters'

   

Step 3: The REPOS parameter should already contain your forked repos (you’ll have more properties than the ones in the screenshot)

   

Step 4: This is how the results of seed should look like

Run the github-webhook pipeline

We already create the seed job for you but you’ll have to run it. When you do run it you have to provide some properties. By default we create a seed that has all the properties options, but you can delete most of it. If you set the properties as global env variables you have to remove them from the seed.

Anyways, to run the demo just provide in the REPOS var the comma separated list of URLs of the 2 aforementioned forks of github-webhook and github-analytics.

   

Step 1: Click the 'github-webhook' view

   

Step 2: Run the pipeline

   

Important

If your build fails on the deploy previous version to stage due to missing jar, that means that you’ve forgotten to clear the tags in your repo. Typically that’s due to the fact that you’ve removed the Artifactory volume with deployed JAR whereas a tag in the repo is still pointing there. Check out this section on how to remove the tag.

   

Step 3: Click the manual step to go to stage (remember about killing the apps on test env). To do this click the ARROW next to the job name

   

Important

Most likely you will run out of memory so when reaching the stage environment it’s good to kill all apps on test. Check out the FAQ section for more details!

   

Step 4: The full pipeline should look like this

   

Declarative pipeline & Blue Ocean

You can also use the declarative pipeline approach with the Blue Ocean UI. Here is a step by step guide to run a pipeline via this approach.

The Blue Ocean UI is available under the blue/ URL. E.g. for Docker Machine based setup http://192.168.99.100:8080/blue.

   

Step 1: Open Blue Ocean UI and click on github-webhook-declarative-pipeline

   

Step 2: Your first run will look like this. Click Run button

   

Step 3: Enter parameters required for the build and click run

   

Step 4: A list of pipelines will be shown. Click your first run.

   

Step 5: State if you want to go to production or not and click Proceed

   

Step 6: The build is in progress…​

   

Step 7: The pipeline is done!

   

Important

There is no possibility of restarting pipeline from specific stage, after failure. Please check out this issue for more information

Warning

Currently there is no way to introduce manual steps in a performant way. Jenkins is blocking an executor when manual step is required. That means that you’ll run out of executors pretty fast. You can check out this issue for and this StackOverflow question for more information.

Jenkins Cloud Foundry customization

 All the steps below are not necessary to run the demo. They are needed only
when you want to do some custom changes.

All env vars

The env vars that are used in all of the jobs are as follows:

Property Name	Property Description	Default value
PAAS_TEST_API_URL	The URL to the CF Api for TEST env	api.local.pcfdev.io
PAAS_STAGE_API_URL	The URL to the CF Api for STAGE env	api.local.pcfdev.io
PAAS_PROD_API_URL	The URL to the CF Api for PROD env	api.local.pcfdev.io
PAAS_TEST_ORG	Name of the org for the test env	pcfdev-org
PAAS_TEST_SPACE	Name of the space for the test env	pcfdev-space
PAAS_STAGE_ORG	Name of the org for the stage env	pcfdev-org
PAAS_STAGE_SPACE	Name of the space for the stage env	pcfdev-space
PAAS_PROD_ORG	Name of the org for the prod env	pcfdev-org
PAAS_PROD_SPACE	Name of the space for the prod env	pcfdev-space
REPO_WITH_BINARIES	URL to repo with the deployed jars	http://artifactory:8081/artifactory/libs-release-local
M2_SETTINGS_REPO_ID	The id of server from Maven settings.xml	artifactory-local
JDK_VERSION	The name of the JDK installation	jdk8
PIPELINE_VERSION	What should be the version of the pipeline (ultimately also version of the jar)	1.0.0.M1-${GROOVY,script ="new Date().format('yyMMdd_HHmmss')"}-VERSION
GIT_EMAIL	The email used by Git to tag repo	[email protected]
GIT_NAME	The name used by Git to tag repo	Pivo Tal
PAAS_HOSTNAME_UUID	Additional suffix for the route. In a shared environment the default routes can be already taken
AUTO_DEPLOY_TO_STAGE	Should deployment to stage be automatic	false
AUTO_DEPLOY_TO_PROD	Should deployment to prod be automatic	false
API_COMPATIBILITY_STEP_REQUIRED	Should api compatibility step be required	true
DB_ROLLBACK_STEP_REQUIRED	Should DB rollback step be present	true
DEPLOY_TO_STAGE_STEP_REQUIRED	Should deploy to stage step be present	true
APP_MEMORY_LIMIT	How much memory should be used by the infra apps (Eureka, Stub Runner etc.)	256m
JAVA_BUILDPACK_URL	The URL to the Java buildpack to be used by CF	https://github.com/cloudfoundry/java-buildpack.git#v3.8.1
BUILD_OPTIONS	Additional options you would like to pass to the Maven / Gradle build
BINARY_EXTENSION	Extension of the binary uploaded to Artifactory / Nexus. Example: change this to war for WAR artifacts	jar

Jenkins Credentials

In your scripts we reference the credentials via IDs. These are the defaults for credentials

Property Name	Property Description	Default value
GIT_CREDENTIAL_ID	Credential ID used to tag a git repo	git
GIT_SSH_CREDENTIAL_ID	SSH credential ID used to tag a git repo	gitSsh
GIT_USE_SSH_KEY	if true will pick to use the SSH credential id	false
REPO_WITH_BINARIES_CREDENTIAL_ID	Credential ID used for the repo with jars	repo-with-binaries
PAAS_TEST_CREDENTIAL_ID	Credential ID for CF Test env access	cf-test
PAAS_STAGE_CREDENTIAL_ID	Credential ID for CF Stage env access	cf-stage
PAAS_PROD_CREDENTIAL_ID	Credential ID for CF Prod env access	cf-prod

If you already have in your system a credential to for example tag a repo you can use it by passing the value of the property GIT_CREDENTIAL_ID

Tip	Check out the cf-helper script for all the configuration options!

Jenkins Pipeline (Kubernetes)

Important

In this chapter we assume that you perform deployment of your application to Kubernetes PaaS

The Spring Cloud Pipelines repository contains job definitions and the opinionated setup pipeline using Jenkins Job Dsl plugin. Those jobs will form an empty pipeline and a sample, opinionated one that you can use in your company.

All in all there are the following projects taking part in the whole microservice setup for this demo.

• Github-Analytics - the app that has a REST endpoint and uses messaging. Our business application.

• Github Webhook - project that emits messages that are used by Github Analytics. Our business application.

• Eureka - simple Eureka Server. This is an infrastructure application.

• Github Analytics Stub Runner Boot - Stub Runner Boot server to be used for tests with Github Analytics. Uses Eureka and Messaging. This is an infrastructure application.

Step by step

This is a guide for Jenkins JOB Dsl based pipeline.

If you want to just run the demo as far as possible using PCF Dev and Docker Compose

• Fork repos

• Start Jenkins and Artifactory

• Deploy infra to Artifactory

• Start Minikube (if you don’t want to use an existing one)

• Run the seed job

• Run the github-webhook pipeline

Fork repos

There are 4 apps that are composing the pipeline

• Github Webhook

• Github Analytics

• Github Eureka

• Github Stub Runner Boot

You need to fork only these. That’s because only then will your user be able to tag and push the tag to repo.

• Github Webhook

• Github Analytics

Start Jenkins and Artifactory

Jenkins + Artifactory can be ran locally. To do that just execute the start.sh script from this repo.

git clone https://github.com/spring-cloud/spring-cloud-pipelines
cd spring-cloud-pipelines/jenkins
./start.sh yourGitUsername yourGitPassword yourForkedGithubOrg yourDockerRegistryOrganization yourDockerRegistryUsername yourDockerRegistryPassword yourDockerRegistryEmail

Then Jenkins will be running on port 8080 and Artifactory 8081. The provided parameters will be passed as env variables to Jenkins VM and credentials will be set in your set. That way you don’t have to do any manual work on the Jenkins side. In the above parameters, the third parameter could be yourForkedGithubOrg or yourGithubUsername. Also the REPOS env variable will contain your GitHub org in which you have the forked repos.

You need to pass the credentials for the Docker organization (by default we will search for the Docker images at Docker Hub) so that the pipeline will be able to push images to your org.

Deploy the infra JARs to Artifactory

When Artifactory is running, just execute the tools/deploy-infra.sh script from this repo.

git clone https://github.com/spring-cloud/spring-cloud-pipelines
cd spring-cloud-pipelines/
./tools/deploy-infra-k8s.sh

As a result both eureka and stub runner repos will be cloned, built, uploaded to Artifactory and their docker images will be built.

Important

Your local Docker process will be reused by the Jenkins instance running in Docker. That’s why you don’t have to push these images to Docker Hub. On the other hand if you run this sample in a remote Kubernetes cluster the driver will not be shared by the Jenkins workers so you can consider pushing these Docker images to Docker Hub too.

Kubernetes CLI Installation

First you’ll need to install the kubectl CLI.

Script Installation

You can use the tools/k8s-helper.sh script to install kubectl. Just call

$ ./tools/minikube-helper download-kubectl

and then the kubectl will get downloaded

Manual Installation

Example for OSX

$ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/darwin/amd64/kubectl
$ chmod +x ./kubectl
$ sudo mv ./kubectl /usr/local/bin/kubectl

Example for Linux

$ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl
$ chmod +x ./kubectl
$ sudo mv ./kubectl /usr/local/bin/kubectl

Check out this page for more information.

Kubernetes Cluster setup

We need a cluster of Kubernetes. The best choice will be Minikube.

Tip	You can skip this step if you have Kubernetes cluster installed and don’t want to use Minikube The only thing you have to do is to set up spaces.

Warning

It’s more than likely that you’ll run out of resources when you reach stage step. Don’t worry! Keep calm and clear some apps from Minikube and continue.

Script Installation

You can use the tools/k8s-helper.sh script to install Minikube. Just call

$ ./tools/minikube-helper download-minikube

and then the Minikube cluster will get downloaded

Manual Installation

Example for OSX

$ curl -Lo minikube https://storage.googleapis.com/minikube/releases/v0.20.0/minikube-darwin-amd64 && chmod +x minikube && sudo mv minikube /usr/local/bin/

Feel free to leave off the sudo mv minikube /usr/local/bin if you would like to add minikube to your path manually.

Example for Linux

$ curl -Lo minikube https://storage.googleapis.com/minikube/releases/v0.20.0/minikube-linux-amd64 && chmod +x minikube && sudo mv minikube /usr/local/bin/

Feel free to leave off the sudo mv minikube /usr/local/bin if you would like to add minikube to your path manually. Check out this page for more info on the installation.

Run Minikube

Just type in minikube start to start Kubernetes on your local box.

To add the dashboard just execute minikube dashboard

Certificates and Workers

Minikube Certificates and Workers

By default if you install Minikube all the certificates get installed in your ~/.minikube folder. Your kubectl configuration under ~/.kube/config will also get updated to use Minikube.

Manual Certificates and Workers Setup

Important

If you just want to run the default, demo setup you can skip this section

To target a given Kubernetes instance one needs to pass around Certificate Authority key and also user keys.

You can read more about the instructions on how to generate those keys here. Generally speaking if you have a Kubernetes installation (e.g. minikube) this step has already been done for you. Time to reuse those keys on the workers.

Extracted from the official docs.

Configure kubectl to connect to the target cluster using the following commands, replacing several values as indicated:

• Replace ${MASTER_HOST} with the master node address or name used in previous steps

• Replace ${CA_CERT} with the absolute path to the ca.pem created in previous steps

• Replace ${ADMIN_KEY} with the absolute path to the admin-key.pem created in previous steps

• Replace ${ADMIN_CERT} with the absolute path to the admin.pem created in previous steps

$ kubectl config set-cluster default-cluster --server=https://${MASTER_HOST} --certificate-authority=${CA_CERT}
$ kubectl config set-credentials default-admin --certificate-authority=${CA_CERT} --client-key=${ADMIN_KEY} --client-certificate=${ADMIN_CERT}
$ kubectl config set-context default-system --cluster=default-cluster --user=default-admin
$ kubectl config use-context default-system

Generate Minikube namespaces

With the running Minikube cluster we need to generate namespaces. Just execute the ./tools/k8s-helper.sh setup-namespaces to do this.

Run the seed job

We already create the seed job for you but you’ll have to run it. When you do run it you have to provide some properties. By default we create a seed that has all the properties options, but you can delete most of it. If you set the properties as global env variables you have to remove them from the seed.

Anyways, to run the demo just provide in the REPOS var the comma separated list of URLs of the 2 aforementioned forks of github-webhook and `github-analytics'.

   

Step 1: Click the 'jenkins-pipeline-seed-cf' job for Cloud Foundry and jenkins-pipeline-seed-k8s for Kubernetes

   

Step 2: Click the 'Build with parameters'

   

Step 3: The REPOS parameter should already contain your forked repos (you’ll have more properties than the ones in the screenshot)

   

Step 4: This is how the results of seed should look like

Run the github-webhook pipeline

We already create the seed job for you but you’ll have to run it. When you do run it you have to provide some properties. By default we create a seed that has all the properties options, but you can delete most of it. If you set the properties as global env variables you have to remove them from the seed.

Anyways, to run the demo just provide in the REPOS var the comma separated list of URLs of the 2 aforementioned forks of github-webhook and github-analytics.

   

Step 1: Click the 'github-webhook' view

   

Step 2: Run the pipeline

   

Important

If your build fails on the deploy previous version to stage due to missing jar, that means that you’ve forgotten to clear the tags in your repo. Typically that’s due to the fact that you’ve removed the Artifactory volume with deployed JAR whereas a tag in the repo is still pointing there. Check out this section on how to remove the tag.

   

Step 3: Click the manual step to go to stage (remember about killing the apps on test env). To do this click the ARROW next to the job name

   

Important

Most likely you will run out of memory so when reaching the stage environment it’s good to kill all apps on test. Check out the FAQ section for more details!

   

Step 4: The full pipeline should look like this

   

Declarative pipeline & Blue Ocean

You can also use the declarative pipeline approach with the Blue Ocean UI. Here is a step by step guide to run a pipeline via this approach.

The Blue Ocean UI is available under the blue/ URL. E.g. for Docker Machine based setup http://192.168.99.100:8080/blue.

   

Step 1: Open Blue Ocean UI and click on github-webhook-declarative-pipeline

   

Step 2: Your first run will look like this. Click Run button

   

Step 3: Enter parameters required for the build and click run

   

Step 4: A list of pipelines will be shown. Click your first run.

   

Step 5: State if you want to go to production or not and click Proceed

   

Step 6: The build is in progress…​

   

Step 7: The pipeline is done!

   

Important

There is no possibility of restarting pipeline from specific stage, after failure. Please check out this issue for more information

Warning

Currently there is no way to introduce manual steps in a performant way. Jenkins is blocking an executor when manual step is required. That means that you’ll run out of executors pretty fast. You can check out this issue for and this StackOverflow question for more information.

Jenkins Kubernetes customization

Important

All the steps below are not necessary to run the demo. They are needed only when you want to do some custom changes.

All env vars

The env vars that are used in all of the jobs are as follows:

Property Name	Property Description	Default value
DOCKER_REGISTRY_ORGANIZATION	Name of the docker organization to which Docker images should be deployed	scpipelines
DOCKER_REGISTRY_CREDENTIAL_ID	Credential ID used to push Docker images	docker-registry
DOCKER_SERVER_ID	Server ID in settings.xml and Maven builds	docker-repo
DOCKER_EMAIL	Email used to connect to Docker registry` and Maven builds	[email protected]
DOCKER_REGISTRY_ORGANIZATION	URL to Kubernetes cluster for test env	scpipelines
DOCKER_REGISTRY_URL	URL to the docker registry	https://index.docker.io/v1/
PAAS_TEST_API_URL	URL of the API of the Kubernetes cluster for test environment	192.168.99.100:8443
PAAS_STAGE_API_URL	URL of the API of the Kubernetes cluster for stage environment	192.168.99.100:8443
PAAS_PROD_API_URL	URL of the API of the Kubernetes cluster for prod environment	192.168.99.100:8443
PAAS_TEST_CA	Path to the certificate authority for test environment	/usr/share/jenkins/cert/ca.crt
PAAS_STAGE_CA	Path to the certificate authority for stage environment	/usr/share/jenkins/cert/ca.crt
PAAS_PROD_CA	Path to the certificate authority for prod environment	/usr/share/jenkins/cert/ca.crt
PAAS_TEST_CLIENT_CERT	Path to the client certificate for test environment	/usr/share/jenkins/cert/apiserver.crt
PAAS_STAGE_CLIENT_CERT	Path to the client certificate for stage environment	/usr/share/jenkins/cert/apiserver.crt
PAAS_PROD_CLIENT_CERT	Path to the client certificate for prod environment	/usr/share/jenkins/cert/apiserver.crt
PAAS_TEST_CLIENT_KEY	Path to the client key for test environment	/usr/share/jenkins/cert/apiserver.key
PAAS_STAGE_CLIENT_KEY	Path to the client key for stage environment	/usr/share/jenkins/cert/apiserver.key
PAAS_PROD_CLIENT_KEY	Path to the client key for test environment	/usr/share/jenkins/cert/apiserver.key
PAAS_TEST_CLIENT_TOKEN_PATH	Path to the file containing the token for test env
PAAS_STAGE_CLIENT_TOKEN_PATH	Path to the file containing the token for stage env
PAAS_PROD_CLIENT_TOKEN_PATH	Path to the file containing the token for prod env
PAAS_TEST_CLIENT_TOKEN_ID	ID of the credential containing access token for test environment
PAAS_STAGE_CLIENT_TOKEN_ID	ID of the credential containing access token for stage environment
PAAS_PROD_CLIENT_TOKEN_ID	ID of the credential containing access token for prod environment
PAAS_TEST_CLUSTER_NAME	Name of the cluster for test environment	minikube
PAAS_STAGE_CLUSTER_NAME	Name of the cluster for stage environment	minikube
PAAS_PROD_CLUSTER_NAME	Name of the cluster for prod environment	minikube
PAAS_TEST_CLUSTER_USERNAME	Name of the user for test environment	minikube
PAAS_STAGE_CLUSTER_USERNAME	Name of the user for stage environment	minikube
PAAS_PROD_CLUSTER_USERNAME	Name of the user for prod environment	minikube
PAAS_TEST_SYSTEM_NAME	Name of the system for test environment	minikube
PAAS_STAGE_SYSTEM_NAME	Name of the system for stage environment	minikube
PAAS_PROD_SYSTEM_NAME	Name of the system for prod environment	minikube
PAAS_TEST_NAMESPACE	Namespace for test environment	sc-pipelines-test
PAAS_STAGE_NAMESPACE	Namespace for stage environment	sc-pipelines-stage
PAAS_PROD_NAMESPACE	Namespace for prod environment	sc-pipelines-prod
KUBERNETES_MINIKUBE	Will you connect to Minikube?	true
REPO_WITH_BINARIES	URL to repo with the deployed jars	http://artifactory:8081/artifactory/libs-release-local
REPO_WITH_BINARIES_CREDENTIAL_ID	Credential ID used for the repo with jars	repo-with-binaries
M2_SETTINGS_REPO_ID	The id of server from Maven settings.xml	artifactory-local
JDK_VERSION	The name of the JDK installation	jdk8
PIPELINE_VERSION	What should be the version of the pipeline (ultimately also version of the jar)	1.0.0.M1-${GROOVY,script ="new Date().format('yyMMdd_HHmmss')"}-VERSION
GIT_EMAIL	The email used by Git to tag repo	[email protected]
GIT_NAME	The name used by Git to tag repo	Pivo Tal
AUTO_DEPLOY_TO_STAGE	Should deployment to stage be automatic	false
AUTO_DEPLOY_TO_PROD	Should deployment to prod be automatic	false
API_COMPATIBILITY_STEP_REQUIRED	Should api compatibility step be required	true
DB_ROLLBACK_STEP_REQUIRED	Should DB rollback step be present	true
DEPLOY_TO_STAGE_STEP_REQUIRED	Should deploy to stage step be present	true
BUILD_OPTIONS	Additional options you would like to pass to the Maven / Gradle build

Preparing to connect to GCE

Important

Skip this step if you’re not using GCE

In order to use GCE we need to have gcloud running. If you already have the CLI installed, skip this step. If not just execute to have the CLI downloaded and an installer started

$ ./tools/k8s-helper.sh download-gcloud

Next, configure gcloud. Execute gcloud init and log in to your cluster. You will get redirected to a login page, pick the proper Google account and log in.

Pick an existing project or create a new one.

Go to your platform page in GCP and connect to your cluster

$ CLUSTER_NAME=...
$ ZONE=us-east1-b
$ PROJECT_NAME=...
$ gcloud container clusters get-credentials ${CLUSTER_NAME} --zone ${ZONE} --project ${PROJECT_NAME}
$ kubectl proxy

The Kubernetes dashboard will be running at http://localhost:8001/ui/.

We’ll need a Persistent Disk for our Jenkins installation. Let’s create it

$ ZONE=us-east1-b
$ gcloud compute disks create --size=200GB --zone=${ZONE} sc-pipelines-jenkins-disk

Since the disk got created now we need to format it. You can check out the instructions on how to do it here - https://cloud.google.com/compute/docs/disks/add-persistent-disk#formatting

Connecting to a Kubo or GCE cluster

In this section a description of steps required to deploy Jenkins and Artifactory to a Kubernetes cluster deployed via Kubo.

Tip	To see the dashboard just do kubectl proxy and access localhost:8081/ui

• Log in to the cluster

• Deploy Jenkins and Artifactory to the cluster

  • ./tools/k8s-helper.sh setup-tools-infra-vsphere for a cluster deployed on VSphere

  • ./tools/k8s-helper.sh setup-tools-infra-gce for a cluster deployed to GCE

• Forward the ports so that you can access the Jenkins UI from your local machine

$ NAMESPACE=default
$ JENKINS_POD=jenkins-1430785859-nfhx4
$ LOCAL_PORT=32044
$ CONTAINER_PORT=8080
$ kubectl port-forward --namespace=${NAMESPACE} ${JENKINS_POD} ${LOCAL_PORT}:${CONTAINER_PORT}

• Go to Credentials, click System and Global credentials

• Update git, repo-with-binaries and docker-registry credentials

• Run the jenkins-pipeline-k8s-seed seed job and fill it out with the following data

  • Put kubernetes.default:443 here (or KUBERNETES_API:KUBERNETES_PORT)

    • PAAS_TEST_API_URL

    • PAAS_STAGE_API_URL

    • PAAS_PROD_API_URL

  • Put /var/run/secrets/kubernetes.io/serviceaccount/ca.crt data here

    • PAAS_TEST_CA

    • PAAS_STAGE_CA

    • PAAS_PROD_CA

  • Uncheck the Kubernetes Minikube value

  • Clear the following vars

    • PAAS_TEST_CLIENT_CERT

    • PAAS_STAGE_CLIENT_CERT

    • PAAS_PROD_CLIENT_CERT

    • PAAS_TEST_CLIENT_KEY

    • PAAS_STAGE_CLIENT_KEY

    • PAAS_PROD_CLIENT_KEY

  • Set /var/run/secrets/kubernetes.io/serviceaccount/token value to these vars

    • PAAS_TEST_CLIENT_TOKEN_PATH

    • PAAS_STAGE_CLIENT_TOKEN_PATH

    • PAAS_STAGE_CLIENT_TOKEN_PATH

  • Set the cluster name to these vars (you can get it by calling kubectl config current-context)

    • PAAS_TEST_CLUSTER_NAME

    • PAAS_STAGE_CLUSTER_NAME

    • PAAS_PROD_CLUSTER_NAME

  • Set the system name to these vars (you can get it by calling kubectl config current-context)

    • PAAS_TEST_SYSTEM_NAME

    • PAAS_STAGE_SYSTEM_NAME

    • PAAS_PROD_SYSTEM_NAME

  • Update the DOCKER_EMAIL property with your email

  • Update the DOCKER_REGISTRY_ORGANIZATION with your Docker organization name

  • If you don’t want to upload the images to DockerHub update DOCKER_REGISTRY_URL

• Run the pipeline

FAQ

Below you can find the answers to most frequently asked questions.

Pipeline version contains ${PIPELINE_VERSION}

You can check the Jenkins logs and you’ll see

WARNING: Skipped parameter `PIPELINE_VERSION` as it is undefined on `jenkins-pipeline-sample-build`.
	Set `-Dhudson.model.ParametersAction.keepUndefinedParameters`=true to allow undefined parameters
	to be injected as environment variables or
	`-Dhudson.model.ParametersAction.safeParameters=[comma-separated list]`
	to whitelist specific parameter names, even though it represents a security breach

To fix it you have to do exactly what the warning suggests…​ Also ensure that the Groovy token macro processing checkbox is set.

Pipeline version is not passed to the build

You can see that the Jenkins version is properly set but in the build version is still snapshot and the echo "${PIPELINE_VERSION}" doesn’t print anything.

You can check the Jenkins logs and you’ll see

WARNING: Skipped parameter `PIPELINE_VERSION` as it is undefined on `jenkins-pipeline-sample-build`.
	Set `-Dhudson.model.ParametersAction.keepUndefinedParameters`=true to allow undefined parameters
	to be injected as environment variables or
	`-Dhudson.model.ParametersAction.safeParameters=[comma-separated list]`
	to whitelist specific parameter names, even though it represents a security breach

To fix it you have to do exactly what the warning suggests…​

The build times out with pipeline.sh info

Docker compose, docker compose, docker compose…​ The problem is that for some reason, only in Docker, the execution of Java hangs. But it hangs randomly and only the first time you try to execute the pipeline.

The solution to this is to run the pipeline again. If once it suddenly, magically passes then it will pass for any subsequent build.

Another thing that you can try is to run it with plain Docker. Maybe that will help.

Can I use the pipeline for some other repos?

Sure! you can pass REPOS variable with comma separated list of project_name$project_url format. If you don’t provide the PROJECT_NAME the repo name will be extracted and used as the name of the project.

E.g. for REPOS equal to:

https://github.com/spring-cloud-samples/github-analytics,https://github.com/spring-cloud-samples/github-webhook

will result in the creation of pipelines with root names github-analytics and github-webhook.

E.g. for REPOS equal to:

foo$https://github.com/spring-cloud-samples/github-analytics,bar$https://github.com/spring-cloud-samples/atom-feed

will result in the creation of pipelines with root names foo for github-analytics and bar for github-webhook.

Will this work for ANY project out of the box?

Not really. This is an opinionated pipeline that’s why we took some opinionated decisions like:

• usage of Spring Cloud, Spring Cloud Contract Stub Runner and Spring Cloud Eureka

• application deployment to Cloud Foundry

• For Maven:

  • usage of Maven Wrapper

  • artifacts deployment by ./mvnw clean deploy

  • stubrunner.ids property to retrieve list of collaborators for which stubs should be downloaded

  • running smoke tests on a deployed app via the smoke Maven profile

  • running end to end tests on a deployed app via the e2e Maven profile

• For Gradle (in the github-analytics application check the gradle/pipeline.gradle file):

  • usage of Gradlew Wrapper

  • deploy task for artifacts deployment

  • running smoke tests on a deployed app via the smoke task

  • running end to end tests on a deployed app via the e2e task

  • groupId task to retrieve group id

  • artifactId task to retrieve artifact id

  • currentVersion task to retrieve the current version

  • stubIds task to retrieve list of collaborators for which stubs should be downloaded

This is the initial approach that can be easily changed in the future.

Can I modify this to reuse in my project?

Sure! It’s open-source! The important thing is that the core part of the logic is written in Bash scripts. That way, in the majority of cases, you could change only the bash scripts without changing the whole pipeline.

The rollback step fails due to missing JAR ?!

You must have pushed some tags and have removed the Artifactory volume that contained them. To fix this, just remove the tags

git tag -l | xargs -n 1 git push --delete origin

I want to provide a different JDK version

• by default we assume that you have jdk with id jdk8 configured

• if you want a different one just override JDK_VERSION env var and point to the proper one

Tip	The docker image comes in with Java installed at /usr/lib/jvm/java-8-openjdk-amd64. You can go to Global Tools and create a JDK with jdk8 id and JAVA_HOME pointing to /usr/lib/jvm/java-8-openjdk-amd64

To change the default one just follow these steps:

   

Step 1: Click 'Manage Jenkins'

   

Step 2: Click 'Global Tool'

   

Step 3: Click 'JDK Installations'

   

Step 4: Fill out JDK Installation with path to your JDK

   

And that’s it!

Enable Groovy Token Macro Processing

With scripted that but if you needed to this manually then this is how to do it:

   

Step 1: Click 'Manage Jenkins'

   

Step 2: Click 'Configure System'

   

Step 3: Click 'Allow token macro processing'

I want deployment to stage and prod be automatic

No problem, just set the property / env var to true

• AUTO_DEPLOY_TO_STAGE to automatically deploy to stage

• AUTO_DEPLOY_TO_PROD to automatically deploy to prod

I don’t want to test API compativility

No problem, just set the API_COMPATIBILITY_STEP_REQUIRED env variable to false and rerun the seed (you can pick it from the seed job’s properties too).

I can’t tag the repo!

When you get sth like this:

19:01:44 stderr: remote: Invalid username or password.
19:01:44 fatal: Authentication failed for 'https://github.com/marcingrzejszczak/github-webhook/'
19:01:44
19:01:44 	at org.jenkinsci.plugins.gitclient.CliGitAPIImpl.launchCommandIn(CliGitAPIImpl.java:1740)
19:01:44 	at org.jenkinsci.plugins.gitclient.CliGitAPIImpl.launchCommandWithCredentials(CliGitAPIImpl.java:1476)
19:01:44 	at org.jenkinsci.plugins.gitclient.CliGitAPIImpl.access$300(CliGitAPIImpl.java:63)
19:01:44 	at org.jenkinsci.plugins.gitclient.CliGitAPIImpl$8.execute(CliGitAPIImpl.java:1816)
19:01:44 	at hudson.plugins.git.GitPublisher.perform(GitPublisher.java:295)
19:01:44 	at hudson.tasks.BuildStepMonitor$3.perform(BuildStepMonitor.java:45)
19:01:44 	at hudson.model.AbstractBuild$AbstractBuildExecution.perform(AbstractBuild.java:779)
19:01:44 	at hudson.model.AbstractBuild$AbstractBuildExecution.performAllBuildSteps(AbstractBuild.java:720)
19:01:44 	at hudson.model.Build$BuildExecution.post2(Build.java:185)
19:01:44 	at hudson.model.AbstractBuild$AbstractBuildExecution.post(AbstractBuild.java:665)
19:01:44 	at hudson.model.Run.execute(Run.java:1745)
19:01:44 	at hudson.model.FreeStyleBuild.run(FreeStyleBuild.java:43)
19:01:44 	at hudson.model.ResourceController.execute(ResourceController.java:98)
19:01:44 	at hudson.model.Executor.run(Executor.java:404)

most likely you’ve passed a wrong password. Check the credentials section on how to update your credentials.

I’m unauthorized to deploy infrastructure jars

Most likely you’ve forgotten to update your local settings.xml with the Artifactory’s setup. Check out this section of the docs and update your settings.xml.

Signing Artifacts

In some cases it may be required that when performing a release that the artifacts be signed before pushing them to the repository. To do this you will need to import your GPG keys into the Docker image running Jenkins. This can be done by placing a file called public.key containing your public key and a file called private.key containing your private key in the seed directory. These keys will be imported by the init.groovy script that is run when Jenkins starts.

Using SSH keys for git

The seed job checks if an env variable GIT_USE_SSH_KEY is set to true. If that’s the case then env variable GIT_SSH_CREDENTIAL_ID will be chosen as the one that contains the id of the credential that contains SSH private key. By default GIT_CREDENTIAL_ID will be picked as the one that contains username and password to connect to git.

You can set these values in the seed job by filling out the form / toggling a checkbox.

Deploy to stage fails and doesn’t redeploy a service (Kubernetes)

There can be a number of reason but remember that for stage we assume that a sequence of manual steps need to be performed. We don’t redeploy any existing services cause most likely you deliberately have set it up in that way or the other. If in the logs of your application you can see that you can’t connect to a service, first ensure that the service is forwarding traffic to a pod. Next if that’s not the case please delete the service and re-run the step in the pipeline. That way Spring Cloud Pipelines will redeploy the service and the underlying pods.

I ran out of resources!! (Cloud Foundry)

[jenkins-cf-resources]] When deploying the app to stage or prod you can get an exception Insufficient resources. The way to solve it is to kill some apps from test / stage env. To achieve that just call

cf target -o pcfdev-org -s pcfdev-test
cf stop github-webhook
cf stop github-eureka
cf stop stubrunner

You can also execute ./tools/cf-helper.sh kill-all-apps that will remove all demo-related apps deployed to PCF dev.

Deploying to test / stage / prod fails - error finding space (Cloud Foundry)

If you receive a similar exception:

20:26:18 API endpoint:   https://api.local.pcfdev.io (API version: 2.58.0)
20:26:18 User:           user
20:26:18 Org:            pcfdev-org
20:26:18 Space:          No space targeted, use 'cf target -s SPACE'
20:26:18 FAILED
20:26:18 Error finding space pcfdev-test
20:26:18 Space pcfdev-test not found

It means that you’ve forgotten to create the spaces in your PCF Dev installation.

The route is already in use (Cloud Foundry)

If you play around with Jenkins / Concourse you might end up with the routes occupied

Using route github-webhook-test.local.pcfdev.io
Binding github-webhook-test.local.pcfdev.io to github-webhook...
FAILED
The route github-webhook-test.local.pcfdev.io is already in use.

Just delete the routes

yes | cf delete-route local.pcfdev.io -n github-webhook-test
yes | cf delete-route local.pcfdev.io -n github-eureka-test
yes | cf delete-route local.pcfdev.io -n stubrunner-test
yes | cf delete-route local.pcfdev.io -n github-webhook-stage
yes | cf delete-route local.pcfdev.io -n github-eureka-stage
yes | cf delete-route local.pcfdev.io -n github-webhook-prod
yes | cf delete-route local.pcfdev.io -n github-eureka-prod

You can also execute the ./tools/cf-helper.sh delete-routes

How to execute helper scripts against a real CF instance I’m logged into (Cloud Foundry)

Assuming that you’re already logged into the cluster it’s enough to run the helper script with the REUSE_CF_LOGIN=true env variable. Example:

REUSE_CF_LOGIN=true ./tools/cf-helper.sh setup-prod-infra

This script will create the mysql db, rabbit mq service, download and deploy Eureka to the space and organization you’re logged into.

The demo setup (Cloud Foundry)

Github webhook code

Github analytics code

The overview of the demo: Github Webhook listens to HTTP calls and sends a message to Github Analytics

   

For the demo scenario we have two applications. Github Analytics and Github Webhook. Let’s imagine a case where Github is emitting events via HTTP. Github Webhook has an API that could register to such hooks and receive those messages. Once this happens Github Webhook sends a message by RabbitMQ to a channel. Github Analytics is listening to those messages and stores them in a MySQL database.

Gathering metrics: Github Analytics exposes metrics that are polled by Prometheus

   

Github Analytics has its KPIs (Key Performance Indicators) monitored. In the case of that application the KPI is number of issues.

Alerting over metrics: Grafana alerts Slack over Prometheus metrics

   

Let’s assume that if we go below the threshold of X issues then an alert should be sent to Slack.

Deploying production applications to PCF Dev

In the real world scenario we wouldn’t want to automatically provision services like RabbitMQ, MySQL or Eureka each time we deploy a new application to production. Typically production is provisioned manually (using automated solutions). In our case, before you deploy to production you can provision the pcfdev-prod space using the cf-helper.sh. Just call

$ ./cf-helper.sh setup-prod-infra

What will happen is that the CF CLI will login to PCF Dev, target pcfdev-prod space, setup RabbitMQ (under rabbitmq-github name), MySQL (under mysql-github-analytics name) and Eureka (under github-eureka name).

Running Prometheus on CF

You can check out Toshiaki Maki’s code on how to automate Prometheus installation on CF.

Go to https://prometheus.io/download/ and download linux binary. Then call:

cf push sc-pipelines-prometheus -b binary_buildpack -c './prometheus -web.listen-address=:8080' -m 64m

Also localhost:9090 in prometheus.yml should be localhost:8080.

The file should look like this to work with the demo setup (change github-analytics-sc-pipelines.cfapps.io to your github-analytics installation).

# my global config
global:
  scrape_interval:     15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
  evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
  # scrape_timeout is set to the global default (10s).

  # Attach these labels to any time series or alerts when communicating with
  # external systems (federation, remote storage, Alertmanager).
  external_labels:
      monitor: 'codelab-monitor'

# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
rule_files:
  # - "first.rules"
  # - "second.rules"

# A scrape configuration containing exactly one endpoint to scrape:
# Here it's Prometheus itself.
scrape_configs:
  # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
  - job_name: 'prometheus'

    # metrics_path defaults to '/metrics'
    # scheme defaults to 'http'.

    static_configs:
      - targets: ['localhost:8080']

  - job_name: 'demo-app'

    # Override the global default and scrape targets from this job every 5 seconds.
    scrape_interval: 5s

    metrics_path: '/prometheus'
    # scheme defaults to 'http'.

    static_configs:
      - targets: ['github-analytics-sc-pipelines.cfapps.io']

A deployed version for the Spring Cloud Pipelines demo is available here

Running Grafana on CF

You can check out Toshiaki Maki’s code on how to automate Prometheus installation on CF.

Download tarball from https://grafana.com/grafana/download?platform=linux Next set http_port = 8080 in conf/default.ini. Then call

cf push sc-pipelines-grafana -b binary_buildpack -c './bin/grafana-server web' -m 64m

The demo is using Grafana Dashboard with ID 2471.

A deployed version for the Spring Cloud Pipelines demo is available here

The demo setup (Kubernetes)

Github webhook code

Github analytics code

The overview of the demo: Github Webhook listens to HTTP calls and sends a message to Github Analytics

   

For the demo scenario we have two applications. Github Analytics and Github Webhook. Let’s imagine a case where Github is emitting events via HTTP. Github Webhook has an API that could register to such hooks and receive those messages. Once this happens Github Webhook sends a message by RabbitMQ to a channel. Github Analytics is listening to those messages and stores them in a MySQL database.

Gathering metrics: Github Analytics exposes metrics that are polled by Prometheus

   

Github Analytics has its KPIs (Key Performance Indicators) monitored. In the case of that application the KPI is number of issues.

Alerting over metrics: Grafana alerts Slack over Prometheus metrics

   

Let’s assume that if we go below the threshold of X issues then an alert should be sent to Slack.

Deploying production applications to Minikube

In the real world scenario we wouldn’t want to automatically provision services like RabbitMQ, MySQL or Eureka each time we deploy a new application to production. Typically production is provisioned manually (using automated solutions). In our case, before you deploy to production you can provision the sc-pipelines-prod namespace using the k8s-helper.sh. Just call

$ ./k8s-helper.sh setup-prod-infra

Running Prometheus on Kubernetes

Running Grafana on Kubernetes

Building the project

Prerequisites

As prerequisites you need to have shellcheck, bats, jq and ruby installed. If you’re on a Linux machine then bats and shellcheck will be installed for you.

To install the required software on Linux just type the following commands

$ sudo apt-get install -y ruby jq

If you’re on a Mac then just execute these commands to install the missing software

$ brew install jq
$ brew install ruby
$ brew install bats
$ brew install shellcheck

Bats submodules

To make bats work properly we needed to attach Git submodules. To have them initialized either clone with appropriate command

$ git clone --recursive https://github.com/spring-cloud/spring-cloud-pipelines.git

or if you have already cloned the project and are just pulling changes

$ git submodule init
$ git submodule update

If you forget about this step, then Gradle will execute these steps for you.

Build and test

Once you have installed all the prerequisites you can execute

./gradlew clean build

to build and test the project.

Generate docs

To generate docs just run

./gradlew generateDocs

Customizing the project

If you want to pick only pieces (e.g. you’re interested only in Cloud Foundry with Concourse combination) it’s enough to execute this command:

$ ./gradlew customize

You’ll see a screen looking more or less like this:

:customize
  ___          _              ___ _             _   ___ _           _ _
 / __|_ __ _ _(_)_ _  __ _   / __| |___ _  _ __| | | _ (_)_ __  ___| (_)_ _  ___ ___
 \__ \ '_ \ '_| | ' \/ _` | | (__| / _ \ || / _` | |  _/ | '_ \/ -_) | | ' \/ -_|_-<
 |___/ .__/_| |_|_||_\__, |  \___|_\___/\_,_\__,_| |_| |_| .__/\___|_|_|_||_\___/__/
     |_|             |___/                               |_|



Follow the instructions presented in the console or terminate the process to quit (ctrl + c)


=== PAAS TYPE ===
Which PAAS type do you want to use? Options: [CF, K8S, BOTH]
<-------------> 0% EXECUTING
> :customize

Now you need to answer a couple of questions. That way whole files and its pieces will get removed / updated accordingly. If you provide CF and Concourse options thn Kubernetes and Jenkins configuration / folders / pieces of code in the project will get removed.

Releasing the project

Publishing A Docker Image

When doing a release you also need to push a Docker image to Dockerhub. From the project root, run the following commands replacing <version> with the version of the release.

docker login
docker build -t springcloud/spring-cloud-pipeline-jenkins:<version> ./jenkins
docker push springcloud/spring-cloud-pipeline-jenkins:<version>