htplbc/drone-helm3

Helm3 plugin for Drone CI

drone-helm3

Drone plugin for Helm3.

Helm Version: 3.3.4
Kubectl Version: 1.19.2

Drone settings

Example:

- name: deploy app
  image: bitsbeats/drone-helm3
  settings:
    kube_api_server: kube.example.com
    kube_token: { from_secret: kube_token }

    chart: ./path-to/chart
    release: release-name
    namespace: namespace-name
    timeout: 20m
    helm_repos:
      - bitnami=https://charts.bitnami.com/bitnami
    envsubst: true
    values:
      - app.environment=awesome
      - app.tag=${DRONE_TAG/v/}
      - app.commit=${DRONE_COMMIT_SHA}

Note: If you enable envsubst make sure to surrount your variables like ${variable}, $variable will not work.

An always up2date version of the availible config options can be viewed on the source on the Config struct here.

Deploying to EKS

Example:

- name: deploy app
  image: bitsbeats/drone-helm3
  environment:
    AWS_DEFAULT_REGION: us-east-1  
  settings:
    kube_api_server: kube.example.com
    eks_cluster: my-eks-cluster

    chart: ./path-to/chart
    release: release-name
    namespace: namespace-name
    timeout: 20m
    helm_repos:
      - bitnami=https://charts.bitnami.com/bitnami
    envsubst: true
    values:
      - app.environment=awesome
      - app.tag=${DRONE_TAG/v/}
      - app.commit=${DRONE_COMMIT_SHA}

Role Based EKS Access Example:

- name: deploy app
  image: bitsbeats/drone-helm3
  environment:
    AWS_DEFAULT_REGION: us-east-1  
  settings:
    kube_api_server: kube.example.com
    eks_cluster: my-eks-cluster
    eks_role_arn: arn:aws:iam::[ACCOUNT ID HERE]:role/[ROLE HERE]

    chart: ./path-to/chart
    release: release-name
    namespace: namespace-name
    timeout: 20m
    helm_repos:
      - bitnami=https://charts.bitnami.com/bitnami
    envsubst: true
    values:
      - app.environment=awesome
      - app.tag=${DRONE_TAG/v/}
      - app.commit=${DRONE_COMMIT_SHA}

Note: Depending on your setup you might also need to pass AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY to the environment.

Monitoring

Its possible to monitor your builds and rollbacks using prometheus and prometheus-pushgateway. To enable specify the pushgateway_url setting.

Example alertrule:

          - alert: Helm3RolloutFailed
            expr: |
              drone_helm3_build_status{status!="success"}
            labels:
              severity: critical
            annotations:
              summary: >-
                Helm3 was unable to deploy {{ $labels.repo }} as
                {{ $labels.release }} into namespace {{ $labels.namespace }}
              action: >-
                Validate the `deploy` step of the last drone ci run for this
                repository. Either the build has *failed entirely* or the
                `helm test` did fail. For more information on tests see
                https://github.com/bitsbeats/drone-helm3/#monitoring

Helm Tests

Helm tests are special Pods that have the "helm.sh/hook": test annotation set. If the command in the docker container returns an exitcode > 0 the drone step will be marked as failed. See the Helm documentation.

In addition you can set the test_rollback setting to run helm rollback if the tests fail.