Autopilot Config Files

Table of Contents

• autopilot.proto

  • AutopilotProject
  • MetricsQuery
  • Parameter
  • Phase
    
    
    
    

• autopilot-operator.proto

  • AutopilotOperator

  • MeshProvider

Top

autopilot.proto

The following Schema defines the structure of the autopilot.yaml configuration file.

This file is used to generate and re-generate the project structure, as well as execute tasks related to build and deployment. It can be consumed both via the ap CLI as well as in codegen packages.

AutopilotProject

The AutopilotProject file is the root configuration file for the project itself.

This file will be used to build and deploy the autopilot operator. It is loaded automatically by the autopilot CLI. Its default location is ‘autopilot.yaml’

MetricsQuery

MetricsQueries extend the query options available to workers. MetricsQueries are accessible to workers via generated client code that lives in /pkg/metrics

The following MetricsQuery:

name: success-rate
parameters:
- Name
- Namespace
- Interval
queryTemplate: |
    sum(
        rate(
            envoy_cluster_upstream_rq{
                kubernetes_namespace="{{ .Namespace }}",
                kubernetes_pod_name=~"{{ .Name }}-[0-9a-zA-Z]+(-[0-9a-zA-Z]+)",
                envoy_response_code!~"5.*"
            }[{{ .Interval }}]
        )
    )
    /
    sum(
        rate(
            envoy_cluster_upstream_rq{
                kubernetes_namespace="{{ .Namespace }}",
                kubernetes_pod_name=~"{{ .Name }}-[0-9a-zA-Z]+(-[0-9a-zA-Z]+)"
            }[{{ .Interval }}]
        )
    )
    * 100

would produce the following metrics Interface:

type CanaryDeploymentMetrics interface {
    metrics.Client
    GetIstioSuccessRate(ctx context.Context, Namespace, Name, Interval string) (*metrics.QueryResult, error)
    GetIstioRequestDuration(ctx context.Context, Namespace, Name, Interval string) (*metrics.QueryResult, error)
    GetEnvoySuccessRate(ctx context.Context, Namespace, Name, Interval string) (*metrics.QueryResult, error)
    GetEnvoyRequestDuration(ctx context.Context, Namespace, Name, Interval string) (*metrics.QueryResult, error)
}

Parameter

Custom Parameters allow code to be generated for inputs/outputs that are not built-in to Autopilot. These types must be Kubernetes-compatible Go structs.

Phase

MeshProviders provide an interface to monitoring and managing a specific mesh.

Autopilot does not abstract the mesh API - Autopilot developers must still reason able about Provider-specific CRDs. Autopilot’s job is to abstract operational concerns such as discovering control plane configuration and monitoring metrics.

custom inputs can be defined in the autopilot.yaml | | outputs | []string | repeated | the set of outputs for this phase the inputs will be propagated to k8s storage (etcd) by the scheduler.

custom outputs can be defined in the autopilot.yaml |

Top

autopilot-operator.proto

autopilot-operator.proto defines the API Schema for the autopilot-operator.yaml configuration file. this file provides the bootstrap configuration that is loaded to the operator at boot-time/runtime

AutopilotOperator

The AutopilotOperator file is the bootstrap Configuration file for the Operator. It is stored and mounted to the operator as a Kubernetes ConfigMap. The Operator will hot-reload when the configuration file changes. Default name is ‘autopilot-operator.yaml’ and should be stored in the project root.

MeshProvider

MeshProviders provide an interface to monitoring and managing a specific mesh. Autopilot does not abstract the mesh API - Autopilot developers must still reason able about Provider-specific CRDs. Autopilot’s job is to abstract operational concerns such as discovering control plane configuration and monitoring metrics.