Codefresh Steps: Reusable Code for Common Operations

This page provides code you can use to perform common operations in the Codefresh CI/CD platform.

healthcheck healthcheck

Simple Step for running different health checks

arguments

CLUSTER - Kubernetes Context Name

DATADOG_API_KEY - Datadog API Key.

DATADOG_APP_KEY - Datadog App Key.

DATADOG_SLO_LIST - String of SLO Names delimited with semi-colon character. Ex. slo-1;slo-2

DEPLOYMENT - Kubernetes Deployment/Statefulset Name

DEPLOY_WAIT - (seconds) Between Deployment Checks, Default 5

JOB - Kubernetes Job Name

KUBE_CONFIG - Location of Kube Config file

METRIC_TIMEOUT - (seconds) Required for Linkerd Type / Time to wait for Prometheus to return metrics, Default 120

NAMESPACE - Kubernetes Namespace of Deployment

PROMETHEUS_URL - Prometheus URL including protocol and port

TESTING_TIMEOUT - (seconds) Required for Kubernetes Type / Timeout for Testing Completion, Default 120

THRESHOLD - Required for Linkerd Type / Percentage represented in 1 - .01 (100% - 1%), Default 1

TOTAL - (seconds) Required for Linkerd Type / Total Time to Continue Testing, Default 300

TYPES - Type of Tests to Run semi-colon delimited.

WAIT - (seconds) Wait between tests, Default 15

    KubernetesDeploymentHealthCheck:
  type: healthcheck
  arguments:
    TYPES: kubernetes_deployment
    CLUSTER: sales-demo@FirstKubernetes
    NAMESPACE: dustinvb-staging
    DEPLOYMENT: example-voting-app-vote
    KUBE_CONFIG: /codefresh/volume/sensitive/.kube/config

    KubernetesStatefulsetHealthCheck:
  type: healthcheck
  arguments:
    TYPES: kubernetes_statefulset
    CLUSTER: sales-demo@FirstKubernetes
    NAMESPACE: dustinvb-staging
    DEPLOYMENT: example-voting-app-vote-statefulset
    KUBE_CONFIG: /codefresh/volume/sensitive/.kube/config

    KubernetesJobHealthCheck:
  type: healthcheck
  arguments:
    TYPES: kubernetes_job
    CLUSTER: sales-demo@FirstKubernetes
    NAMESPACE: dustinvb-staging
    JOB: example-voting-app-vote
    KUBE_CONFIG: /codefresh/volume/sensitive/.kube/config

    KubernetesLinkerdHealthCheck:
  type: healthcheck
  arguments:
    TYPES: 'kubernetes_deployment,linkerd'
    CLUSTER: sales-demo@FirstKubernetes
    NAMESPACE: dustinvb-staging
    DEPLOYMENT: example-voting-app-vote
    KUBE_CONFIG: /codefresh/volume/sensitive/.kube/config
    PROMETHEUS_URL: 'http://10.59.254.185:9090'
    THRESHOLD: 0.99

    KubernetesDeploymentLinkerdHealthCheck:
  type: healthcheck
  arguments:
    TYPES: 'kubernetes_deployment,linkerd'
    CLUSTER: sales-demo@FirstKubernetes
    NAMESPACE: dustinvb-staging
    DEPLOYMENT: example-voting-app-vote
    KUBE_CONFIG: /codefresh/volume/sensitive/.kube/config
    PROMETHEUS_URL: 'http://10.59.254.185:9090'
    THRESHOLD: 0.99

    KubernetesDeploymentLinkerdHealthCheck:
  type: healthcheck
  arguments:
    TYPES: datadog-slo
    DATADOG_API_KEY: '${{DATADOG_API_KEY}}'
    DATADOG_APP_KEY: '${{DATADOG_APP_KEY}}'
    DATADOG_SLO_LIST: 'slo1,slo2,slo3'

github.com

Dustin Van Buskirk

Mar 24, 2022

source