GITLab

What are we Providing?

Documentation of CI-CD with GitLab

A file where the pipeline is mentioned, named “.gitlab-ci.yml”, also the name of this file should not be changed

A script (CI-CD_gitlab.sh) is mentioned in .gitlab-ci.yml file and is part of the pipeline which helps in executing the desired job

Overview

GitLab Flow

1. Detect any change in the GIT repository.

2. Clone the repository in the workspace path specified in the script.

3. Zip the directories (API Projects/ Event Processes) inside it.

4. Undeploy/ stop the API Projects/ Event Processes, if running.

5. Import the zipped contents in step 3.

6. Deploy/ start the API Projects/ Event Processes.

7. If any API Project/ Event Process is deleted from the GIT repository, then after step 4, invoke the delete call.

Build Script (CI-CD_gitlab.sh)

• The script is present inside <FIORANO_HOME>/esb/samples/scripts/Gitlab.

• Provide WORKSPACE_PATH, REPO_NAME, CLONE_URL to be cloned till .git.

• Sample CI/CD scripts are provided to automate deployment of Event Processes. In order to do the same for APIProjects, provide the respective cURLs.

Creating a project on GitLab

1. Create an account on Gitlab at https://gitlab.com/users/sign_up

2. Create a new project

3. Click the Projects tab in the left-navigation panel and click the New project button.

4. To create a project, Click the blank project and provide the following information:

   1. Project Name: Name as per preference.

   2. Project deployment target (optional): No deployment Planned

   3. Visibility level: Private

   4. Project Configuration: deselect both

Development Machine

Downloading certificate

Before getting started, download the certificate from the GitLab website by following these steps:

1. Provide the GitLab URL in a web browser (Firefox is used in this instance) and press Enter.

2. Click the icon on the left side of the URL.

3. Click the Connection secure option.

4. Click the More information option

5. In the dialog box, click the View Certificate button.

6. In the window that opens, scroll down and click the PEM cert link against Download under the Miscellaneous section to download the certificate in the PEM format.

7. Add the downloaded gitlab-com.pem certificate file to jssecacerts properties (present at FIORANO_HOME/esb/server/profiles/certs) file using the keystore explorer Software.

Configuring eStudio with GitLab details

1. Open eStudio and login to the enterprise server.

2. Right-click on the Event Process Repository and go to Version Control > Configuration.

3. Give the URL of the repository and finish the configuration

4. Place the .gitlab-ci.yml file toFIORANO_HOME/runtimedata/repository/applications

Development Machine is ready to commit any changes in Event Process Repository to Gitlab

Production Machine

Installing GitLab Runner

Provide the command below:

curl -L "https://packages.gitlab.com/install/repositories/runner/gitlab- runner/script.deb.sh" | sudo bash
sudo apt-get install gitlab-runner

Registering Runner with GitLab

1. Give the command: sudo gitlab-runner register

2. Provide the instance URL = https://gitlab.com

3. Provide the registration token by performing the following actions:

   1. Go to Settings > CI-CD in the left navigation panel.

   2. Click the More option (three dots) near the New project runner button and copy the registration token.

4. Give those tags that need to be mentioned later in the gitlab- ci.yml file

5. After entering these details, go to Project > Settings > CI-CD settings.

The newly registered runner appears under the assigned project runners.

Creating a folder for gitlab-runner

After gitlab-runner is installed and registered, create a folder where the runner can make changes. Because, gitlab-runner needs permission for folders where changes are to be made; it’s unable to assign permission to an existing folder.

1. Create a folder (/gitlabtest) and assign gitlab-runner as the owner of that folder.

2. Specify the name of this folder in the gitlab-ci.yml file.

3. To change the ownership from the user to gitlab-runner, use the command:
   chown gitlab-runner gitlabtest (at filesystem)

4. Now copy the script (CI-CD_gitlab.sh) to the gitlabtest folder (/gitlabtest is the WORKSPACE_PATH)

Creating pipelines

Whenever the flows created in the development machine are deployed in the production machine,

• gitlab will run a pipeline

• gitlab-runner installed in the production machine will execute the jobs

• the pipeline is mentioned in the gitlab-ci.yml file

1. Start the runner using the following command in the terminal:

   gitlab-runner start

2. Start FES and FPS and log in to eStudio.

   1. Runners communicate with GitLab over HTTPS through connections initiated from the Runner to GitLab and never the opposite way, which enables the installation of a Runner behind a firewall. As long as the Runner has outbound access to GitLab.com, it works.

   2. A push command from the development machine initiates a CI/CD job, prompting the GitLab server to add the job to its queue. The runner, during its next poll, picks up the job and executes it on the Production machine. The results, logs, and status are then sent back to the GitLab server by the runner.

   3. As the runner is constantly polling the server, whenever there is a commit from the development machine to GitLab, the pipeline will be triggered automatically by runner.

Viewing Logs of the executed job

When a pipeline is executed, logs are generated. To view logs,

1. Click on pipelines; all the pipelines which are executed (passed or failed) get displayed.

2. Click the link below the commit name under the Pipeline column.

3. Click the Jobs tab in the left navigation panel.

4. Click the deploy-job option on the lower-right part of the panel to see the logs.