CNCFCI_GITLAB_CONFIGURATION.md

New cncf.ci Project Gitlab Configuration Setup

GitHub Project Configuration

1. Make crosscloudci/projectname-configuration project -- copy an existing projectname-configuration project (see testproj-configuration example: https://github.com/crosscloudci/testproj-configuration)

2. Edit the cncfci.yml (see testproj-configuration: https://github.com/crosscloudci/testproj-configuration/blob/master/cncfci.yml which is for the testproj example: https://github.com/crosscloudci/testproj)

3. Edit .gitlab-ci.yml to include curl commands and scripts for getting build status, deploys, and tests e.g. envoy-configuration (see https://github.com/crosscloudci/testproj-configuration/blob/master/.gitlab-ci.yml)

4. Optional: write a ci proxy plugin for your ci tool and submit a pull request (see https://github.com/crosscloudci/ex_ci_proxy/blob/master/README.md)

Gitlab Setup

GitLab Pipeline Setup

You need to have admin permissions to do this. Also, if this process is done on the production gitlab server, you'll need to rsync the changes to your other servers or implement the same changes manually in each environment.

In Gitlab you need to complete the following steps.

1. Create a new group

2. Create a new project

3. Set up mirroring (steps and menu items in gitlab)

• Select admin

• Select your project (e.g. jaeger) within the admin interface
• Botuser needs to be in user permissions

 - Add bot user as member (as the master role)

• Impersonate bot user
  • Admin
    • Search for bot, click on bot user

   - Impersonate bot user

• Settings
  • Repository
    • Pull from remote repository
    • Select mirror, add https repo address, select bot user

• Select the project Project
  • You should see that the code is pulled down

    - Stop impersonating the bot user

4. Set up project variables (steps and menu items in gitlab)
   • Settings
     • Pipeline trigger

• add trigger
• make sure a token is created
  • Pipelines

  - Custom ci config path	    
    - e.g. https://raw.githubusercontent.com/crosscloudci/envoy-configuration/master/.gitlab-ci.yml

• Add Secret variables
  • CLOUD
    • e.g. aws
  • ARCH
    • e.g. AMD64
  • PIPELINE_RELEASE_TYPE
    • stable

5. Enable runners (steps and menu items in gitlab)

- settings
  - ci/cd
    - Runner settings
      - Enable all runners for this project

6. Add the project to global configuration yml (e.g. https://github.com/crosscloudci/cncf-configuration/blob/master/cross-cloud.yml)

- Cncf configuration
  - Integration branch
    - Add to cross-cloud.yml
      - Duplicate a project
      - Find logo image e.g. https://d33wubrfki0l68.cloudfront.net/77bb2db951dc11d54851e79e0ca09e3a02b276fa/9c0b7/img/envoy-logo.svg
      - Add to cncf artwork repo
        - Link to cross cloud artwork repo
          - Update the project names e.g. to envoy 
          - Charts are the repo that we get the helm charts from
          - Change timeout for how long your build takes

7. Review pipelines

• Pipelines
  • manually add new to the url (this is a workaround)
    • e.g. https://gitlab.cidev.cncf.ci/envoy/envoy/pipelines/new
      • Select master
      • Select stable (e.g. v1.7.0)
      • Both should be running

Trigger Client

1. Add the new project into the enviroment.rb

2. Get token from trigger (steps and menu items in gitlab)

• Settings
  • CI/CD
    • Pipeline trigger
      • copy token
  • Put in .env for trigger client

Optional CI Setup (legacy manual build -- not using ci-proxy )

1. Clone the project

git clone yourprojectname

- e.g. git clone https://github.com/envoyproxy/envoy.git

2. Make a note of any ci instructions including scripts for building and publishing images

• e.g. the .circleci/config.yml file outlines lots of shell scripts that refer to a docker dependencies image and build image

3. Replicate the builds

• e.g. use docker to replicate a build image using the previously viewed ci
• you probably want to pin your image
• update the script not to push
• images will be local after build
• publish to gitlab directory

4. Create a script that builds head

5. Create a script that builds stable

How to Debug

1. Add a sleep to the .gitlab-ci.yml script
2. ssh [email protected]
3. Click on compile job

Gitlab yml common issues

• If .gitlab-ci.yml does not refresh:
  • Go to pipelines
  • Copy/cut the gitlab.yml and save an empty url
  • Paste the url in again and save it