​
Introduction

This document provides a guide to set up integration with Raven platform and your CI tool to automate Raven receiving image build metadata from your image build pipelines. This guide is intended for build engineers and DevOps engineers, who are responsible for setting up and managing the image build pipelines.

​
Pre-requisites

Before proceeding with the Raven CI Integration, ensure you have completed the following prerequisites:
  1. You have the Raven agent token available.
    1. Please contact Raven if you don’t have this token available.

​
Set Up

The Raven CI step needs access to the image being built on the CI platform via the CI pipeline. CI platforms usually delete the image after pushing the image to its repository, thus it is essential to add the Raven step in between the docker build and docker push stages. Examples - 
stages:
  - test
  - build
  - deploy
  - release
variables:
  RAVEN_CI_IMAGE: "releases.cloud.raven.io/raven-public/ravenci"
  RAVEN_CI_TAG: "latest"
docker-image:
  stage: build
  image: docker:latest
  services:
    - docker:dind
  dependencies:
    - raven-ci
  script:
    - docker buildx create --use
    - docker buildx build -t ${DOCKER_IMAGE_NAME}:${DOCKER_TAG} --load -f ./Dockerfile . 
    - printenv | grep CI | sort > cienv
    - docker run --rm -v /var/run/docker.sock:/var/run/docker.sock --entrypoint /bin/sh --env-file=./cienv -e RAVEN_TOKEN=$RAVEN_TOKEN ${ECR_REPOSITORY}/ravenci -c 'DOCKER_HOST="" ravenci scan --images-from="1h" --max-images=10 --pretty'
    - docker push ${DOCKER_IMAGE_NAME}:${DOCKER_TAG}

​
Data Privacy

The Raven Platform integration with your CI tool only collects and persists the metadata related to the images being built via the image build pipelines. Raven does not collect any sensitive data such as passwords from your CI pipeline environments.