dynatraceace/keptn-gitlab-runner repository overview

⁠Deprecation notice

This repository has been deprecated. Dynatrace Cloud Automation⁠ as well as Keptn⁠ Quality Gate CI/CD integrations were combined in the new cloud-automation-tools⁠ repository.

⁠Keptn GitLab Runner

Container image containing logic to integrate quality gates usecases with your GitLab CI Pipelines

⁠Stages

⁠Keptn Init

Keptn needs to be initialized (project, stage, service, SLOs, SLIs, monitoring, ...) to inform Keptn about what is going to be evaluated.

You can add the stage to the .gitlab-ci.yaml file:

prepare_keptn:
  image: dynatraceace/keptn-gitlab-runner:latest
  stage: init
  environment:
    name: test
  variables: 
    KEPTN_PROJECT: simplenode-gitlab
    KEPTN_SERVICE: simplenodeservice
    KEPTN_STAGE: staging
    KEPTN_SOURCE: gitlab
    KEPTN_MONITORING: dynatrace
  script:
    - /keptn/keptn_init.sh
  artifacts:
    paths: 
    - keptn.init.json

The following variables can be set, either on the job, pipeline or global level:

• KEPTN_PROJECT
• KEPTN_SERVICE
• KEPTN_STAGE
• KEPTN_ENDPOINT
• KEPTN_BRIDGE_ENDPOINT

⁠Keptn Eval

Once the tests have been run, this job needs to execute to evaluate the SLOs that were defined.

You can add the stage to the .gitlab-ci.yaml file:

quality_gate:
  image: dynatraceace/keptn-gitlab-runner:latest
  stage: eval
  environment:
    name: test
  variables: 
    KEPTN_LABELS: '[{"label1":"foo"},{"label2":"bar"}]'
  script:
    - /keptn/keptn_eval.sh

The following variables can be set, either on the job, pipeline or global level:

⁠Setting time stamps for evaluation

Evaluation times can be define in one of two ways

1. Using artefact files When using this way, in your test execution, ensure two artifact files get created that contain the time stamps of your test start and end.

   The files that are to be created are keptn.test.starttime and keptn.test.endtime and need to contain the UTC date in the following format: 2021-04-22T15:31:38Z. They can be generated using date --utc +%FT%TZ. In the sample .gitlab-ci.yaml file you can find an example using before_script and after_script blocks. In the artifacts block they will be added for futher use in the next job.

   run-tests:
     extends: .run-jmeter
     before_script: 
       - echo $(date --utc +%FT%TZ) > keptn.test.starttime
     after_script: 
       - echo $(date --utc +%FT%TZ) > keptn.test.endtime
     stage: test   
     environment:
       name: test
     artifacts:
       paths:
       - keptn.test.starttime
       - keptn.test.endtime
   

   Copy

   Set the variable KEPTN_EVAL_MODE to from_file, which is also the default.

2. Setting variables on the stage By setting the variable KEPTN_EVAL_MODE to custom_range, you can use the additional variables KEPTN_EVAL_START and KEPTN_EVAL_END to set start and end times in UTC date in the following format: 2021-04-22T15:31:38Z. They can be generated using date --utc +%FT%TZ

⁠Setting timestamps for evaluation with custom time zone

All variables including time information and expanded at runtime will by default use UTC. A different timezone can be set by adding TZ=<timezone abbreviation⁠ - OR - name in tz database⁠> before date is called. For example:

run-tests:
  extends: .run-jmeter
  before_script: 
    - echo $(TZ=America/New_York date +%FT%TZ) > keptn.test.starttime
  after_script: 
    - echo $(TZ=America/New_York date +%FT%TZ) > keptn.test.endtime
  stage: test   
  environment:
    name: test
  artifacts:
    paths:
    - keptn.test.starttime
    - keptn.test.endtime