pipeline status

Introduction

This repository contains the CinCan pilot environment that constructs from two main services Concourse CI and Gitlab CE. Concourse CI is used for creating, executing and managing the CinCan CI pipelines whereas Gitlab CE stores samples to be analyzed, found artifacts, results, logs etc. Every component of the service is run in a separate Docker container which makes the environment easy to deploy and destroy without affecting the host system.

The full list of components:

Prerequisites

  • Docker >= 17.12.0
  • Docker Compose > 1.17.1
  • Ensure that your system has more than 6 GB memory
  • Ensure that your system has more than 4 GB free disk space

Deploying the pilot environment

# Clone the repository
git clone https://gitlab.com/CinCan/environment
# Change directory
cd ./environment
# Run the script (requires root privileges)
sudo bash build.sh -e BUILD_PATH=/path/to (default: /opt/cincan)
# Change directory
cd /path/to/build
# Build the environment using Docker Compose
docker-compose up -d db \
                     ci \
                     worker \
                     gitlab \
                     dns (optional)

The Gitlab will take some time to get up (~5 minutes). When it's up and running, you can move on to setting up a pipeline. You can follow the starting process using following command:

docker logs gitlab.cincan.io --follow

Setting up a pipeline

You can list all pipelines that have a setup script, by typing sudo bash setup-pipeline.sh

sudo bash setup-pipeline.sh  

[+] Cloning the pipelines.git

    This script executes setup.sh from pipelines/<PIPELINE>
    Usage: sudo bash setup-pipeline.sh <PIPELINE>

Available pipelines:
pdf-pipeline
document-pipeline

Currently, there are two pilot pipelines with quick setup: pdf-pipeline, and the more advanced document-pipeline.

For example, to setup the document-pipeline, follow these setup steps:

  1. Set up the pilot environment

  2. sudo bash setup-pipeline.sh pdf-pipeline

  3. The script will ask to login and to set up the pipeline to concourse. You can alternatively manually run the commands, see PIPELINE-README.

  4. Login to https://172.20.0.3 to see the pipeline work. (Or https://concourse.cincan.io if proxy is enabled)

  5. Type in username and password when prompted.

  6. The script will ask to login and to set up the pipeline to concourse. You can alternatively manually run the commands, see PIPELINE-README.

  7. Login to https://172.20.0.3 to see the pipeline work (or https://concourse.cincan.io if using dns)

How to stop and remove the whole pilot environment

cd /path/to/build
docker-compose down --volumes --rmi all && rm -rf /path/to

Read more

Read more about the pilot environment installation options from the wiki
Read more about the pdf-pipeline here.
Read more about the document-pipeline here.