quickstart.md

Quick Start Guide

This guide leads you to start using CI/CD operator, with simple pull-request/push examples. The contents are as follows.

• You need
• Create bot account and token
• Create IntegrationConfig
• Create Pull Request
• Merge Pull Request
• Release

You need...

• Git repository (either GitHub or GitLab)
• K8s cluster for the jobs to run

Create bot account and token

1. Create account/token

DO NOT make pull requests using the bot account. Race can happen on labelling.

• For GitHub

  • Create a new bot account
  • Create an access token for the bot account
    https://github.com/settings/tokens > Generate a new token
    Scope:
    • repo
    • admin:repo_hook
    • read:user
    • user:email

• For GitLab

  • Create a new bot account
  • Create an access token for the bot account https://gitlab.com/-/profile/personal_access_tokens
    Scope:
    • api
    • read_user

2. Copy generated token and store it as a secret

apiVersion: v1
kind: Secret
metadata:
  name: bot-token
stringData:
  token: <TOKEN>

Create IntegrationConfig

apiVersion: cicd.tmax.io/v1
kind: IntegrationConfig
metadata:
  name: tutorial-config
spec:
  git:
    type: gitlab # If you are using github, use 'github'
    apiUrl: http://gitlab.my.domain # Private gitlab's base url
    repository: my/repository
    token:
      valueFrom:
        secretKeyRef:
          name: bot-token
          key: token
  jobs:
    preSubmit: # Jobs to be executed on PullRequest
      - name: test
        image: golang:1.14
        script: go test ./...
    postSubmit: # Jobs to be executed on Push/Tag
      - name: image
        image: quay.io/buildah/stable
        script: |
          buildah bud --tls-verify=false --storage-driver=vfs --format docker -f ./Dockerfile -t $IMAGE_URL:${CI_HEAD_REF#refs/heads/} .
          buildah push --tls-verify=false --storage-driver=vfs $IMAGE_URL:${CI_HEAD_REF#refs/tags/} docker://$IMAGE_URL:${CI_HEAD_REF#refs/heads/}
        env:
          - name: IMAGE_URL
            value: my-repository/my-image
        securityContext:
          privileged: true
        when:
          branch:
            - master

Check if the webhook is registered for the repository. Check if the conditions of the created IntegrationConfig object are true.

Create Pull Request/Merge Request

1. Create a new branch from master branch
2. Create a new commit for the branch & push it
3. Create PullRequest (for GitHub) or MergeRequest (for GitLab) of the branch to master
4. Check IntegrationJob generation

   kubectl get integrationjob

5. Check PullRequest/MergeRequest details page to see if test job is running.

Merge Pull Request/Merge Request

1. Merge the PullRequest/MergeRequest to master
2. Check IntegrationJob generation

   kubectl get integrationjob

3. Check commit details page to see if image job is running.