Adding an analysis provider

This page describes how to add an analysis provider for doing deployment analysis.

To enable Automated deployment analysis feature, you have to set the needed information for Piped to connect to the Analysis Provider.

Currently, PipeCD supports the following providers:

Prometheus

Piped queries the range query endpoint to obtain metrics used to evaluate the deployment.

You need to define the Prometheus server address accessible to Piped.

apiVersion: pipecd.dev/v1beta1
kind: Piped
spec:
  analysisProviders:
    - name: prometheus-dev
      type: PROMETHEUS
      config:
        address: https://your-prometheus.dev

The full list of configurable fields are here.

Datadog

Piped queries the MetricsApi.QueryMetrics endpoint to obtain metrics used to evaluate the deployment.

apiVersion: pipecd.dev/v1beta1
kind: Piped
spec:
  analysisProviders:
    - name: datadog-dev
      type: DATADOG
      config:
        apiKeyFile: /etc/piped-secret/datadog-api-key
        applicationKeyFile: /etc/piped-secret/datadog-application-key

The full list of configurable fields are here.

If you choose Helm as the installation method, we recommend using --set-file to mount the key files while performing the upgrading process.

--set-file secret.data.datadog-api-key={PATH_TO_API_KEY_FILE} \
--set-file secret.data.datadog-application-key={PATH_TO_APPLICATION_KEY_FILE}

Last modified September 24, 2024: Generate v0.49.x docs (#5222) (909fd76a)