Lab 4: CI/CD Process - Automate Deployment

Creating a Jenkinsfile and initializing a Git repo

Adding the Mule Maven Plugin configuration to the Mule pom.xml file.

Creating a Pipeline Jenkins job

Creating a post-commit file to automate a Jenkins job process after each git commit

Navigate to the Desktop of the VM. Open up the Git Gui application by clicking the icon that looks like the following:

Select Create New Repository. Insert the location of your project into the Directory field. If you followed the steps in Lab 1 you may use the following path. Note that if you are using your own project the name of the project may differ:

C:/Users/workshop/AnypointStudio/studio-workspace/omni-channel-api

Select the Create button. Your Mule project will be initialized within Git and you will be taken to the Git Gui management console.

Review the unstaged commits then select the Stage Changed button.

Click Yes if given an additional prompt to stage the untracked files.

You will now see the changes moved from Unstaged Changes to Staged Changes. Enter your commit message to be:

Init Git repository

Click the Commit button to commit your project.

Navigate back to the Package Explorer located on the right-side of your Anypoint Studio IDE. Open up the pom.xml file located in the root directory of the project.

Identify the Mule Maven Plugin. Move the cursor inside the <plugin> element. You will add a configuration for your CloudHub deployment on the next step.

Copy & paste the following xml code on this new line within your <plugin> element:

				<configuration>
					<classifier>mule-application-</classifier>
					<cloudhub2Deployment>
						<uri>https://anypoint.mulesoft.com</uri>
						<provider>MC</provider>
						<environment>${cloudhub.environment}</environment>
						<target>Cloudhub-US-West-1</target>
						<muleVersion>${app.runtime}</muleVersion>
						<username>${anypoint.user}</username>
						<password>${anypoint.password}</password>
						<businessGroup>${cloudhub.bg}</businessGroup>
						<applicationName>${cloudhub.app}</applicationName>
						<replicas>1</replicas>
						<vCores>1</vCores>
						<deploymentSettings>
							<http>
								<inbound>
									<publicUrl>${cloudhub.app}.cloudhub.io</publicUrl>
									<forwardSslSession>true</forwardSslSession>
									<lastMileSecurity>true</lastMileSecurity>
								</inbound>
							</http>
						</deploymentSettings>
					</cloudhub2Deployment>
				</configuration>

#Update your <app.runtime> version to 4.4.0 on line 17

Go to the root user folder under C:\Users\workshop\.m2

If you don’t already have a settings.xml file in the folder, create it.

Paste the following code inside your settings file and replacen the ${anypoint.name} and ${anypoint.password} whith your own platform user and password

Open Google Chrome from the Desktop and click the Jenkins bookmark located on the toolbar of the browser. Url should be http://localhost:8080

login with:

You are now on the Jenkins homepage. We need to configure the Anypoint Platform Credentials. We don’t want them to be part of our code, so we are going to add as Credentials.

Under “Stores scoped to Jenkins”, select “Jenkins”. On the next screen, select “Global credentials (unrestricted)”. Finally on the third screen, select “Add Credentials” which is found on the left-navigation column.

Enter your Anypoint Platform username and password in the corresponding fields.

In the “ID” text field enter: deploy-anypoint-user. This is the ID that must match the ID within your Jenkinsfile in your Mule application on line 6.

Select ‘OK’ to finish creating the user.

Go back to the Dashboard.

On the Jenkins homepage, select the link titled “Create a job”.

On the next screen, under “Enter an item name” enter the name of the pipeline. This can be "omni-channel-api" or something similar. Then choose “Pipeline” and select “OK” on the pop-up window at the bottom left of the screen.

Within the Jenkins setup page, scroll to the bottom of the screen to the section labeled “Pipeline”.

On the “Definition” dropdown select the option that says “Pipeline script from SCM”.

On the “SCM” dropdown select the option that says “Git”.

Under “Repositories”, in the “Repository URL” text box enter the path of your repository. Make sure you add the prefix file:// to the directory path. It will look similar to the following:

file://C:/Users/workshop/AnypointStudio/studio-workspace/omni-channel-api

Select your created credentials as the credentials for the pipeline

Now click “Save” at the bottom of the screen. You will be redirected to the home screen of your build pipeline.

From your current page, click the “Jenkins” nav link at the top-left of the screen. It will look like the following:

Click on your Jenkins pipeline link.

Single-click on “Build now”. You will soon see the job kickoff and status information will appear. The build pipeline will now build the Mule application, run the unit tests and then deploy the application into the Sandbox environment. After that completes, the pipeline will then run the unit tests and then deploy the application into Staging.

As the job is running, you can view the log information by clicking the build number and then clicking “Console Output” on the left-nav column.

Figure 1. Pipeline Progress view

You can also view a cleaner UI through the Blue Ocean plugin by clicking “Open Blue Ocean” from the job homepage.

You can also see the Mule applications getting deployed in the Anypoint Studio Runtime Manager by going logging in to https://anypoint.mulesoft.com and navigating to Runtime Manager by clicking the left navigation dropdown.

Within Runtime manager you can view both of the applications being deployed in Sandbox and in Staging. You can switch between Sandbox view and Staging view by clicking on the Sandbox rectangle in the left navigation bar within Runtime Manager.

Within the Windows directory explorer, navigate to the root directory of your Mule application. It will most likely live at this path:

C:/Users/workshop/AnypointStudio/studio-workspace/omni-channel-api

Within the Mule application root directory navigate to .git > hooks. Next, create a new file called post-commit. (no file extension)

Open the post-commit file with a text editor such as Text Edit by right-clicking on the post-commit file and selecting “Open with” and then selecting Notepad.

Copy and paste the following code within the post-commit file then save:

#!/bin/sh
set PATH=%PATH%;"C:\Program Files\Git\bin"
echo %PATH%
sh.exe -x -c "curl 'http://workshop:Anypoint1357!@localhost:8080/job/{BUILD-NAME}/build?token=MULE_WORKSHOP'"

Make sure to replace {BUILD-NAME} with the name of the project build (i.e. omni-channel-api-workshop)

Navigate back to Jenkins management console via Google Chrome web browser.

From the Jenkins job project homepage, select Configure from the left-nav menu.

Scroll down to the section labeled “Build Triggers”.

Select the checkbox for “Trigger builds remotely”.

Within the “Authentication Token” text area enter: MULE_WORKSHOP.

Within your omni-channel-api project in Anypoint Studio, scroll down to the flow labeled: get:\products\search

Drag in a Logger component from the Mule Palette on the right side of the IDE. Your flow should now look like the following:

Within the Logger component, add some text that you would like logged. (i.e. “Hello from the Mule Workshop!”).

Switch to Git Gui. Select Rescan to find the changes to the directory, then Stage Changed to stage the commits. Finally, enter a commit message such as: Added Logger component and click the “Commit” button to commit the changes.

After those changes have been committed, the Jenkins job will automatically trigger. If you navigate back to the Jenkins management console in Google Chrome, you can see the status of the build job.