package proto.canary

Get desktop application:
View/edit binary Protocol Buffers messages

Configuration for the AWS canary integration.

Used in: Canary.ServiceIntegrations

• optional google.protobuf.BoolValue enabled = 1

  Enables/disables Kayenta integration for AWS. If enabled, Kayenta can store canary configuration and archived results in an S3 bucket.

• repeated AwsAccount accounts = 2

  The list of configured accounts.

• optional google.protobuf.BoolValue s3Enabled = 3

  Whether to enable S3 as a persistent store.

Configuration for the AWS account to be used .

Used in: Aws, config.Kayenta.ServiceIntegrations.Aws

• string name = 1

  The name of the account.

• string bucket = 2

  The name of a storage bucket that this account has access to. If you specify a globally unique bucket name that doesn't exist yet, Kayenta creates that bucket for you.

• string region = 3

  The AWS region to use.

• optional google.protobuf.StringValue rootFolder = 4

  The root folder in the chosen bucket in which to store all of the canary service's persistent data. Defaults to `kayenta`.

• string profileName = 5

  The profile name to use when resolving AWS credentials. Typically found in `~/.aws/credentials`. Defaults to `default`.

• string endpoint = 6

  The endpoint used to reach the service implementing the S3 API. Typically you would use this with an S3 clone, like Minio.

• string accessKeyId = 7

  The default access key used to communicate with AWS.

• repeated SupportedType supportedTypes = 8

  If you're enabling S3, include CONFIGURATION_STORE and/or OBJECT_STORE in this list.

Configuration for Spinnaker's automated canary analysis features. See also the [sample Kayenta configuration](https://github.com/spinnaker/kayenta/blob/master/kayenta-web/config/kayenta.yml).

Used in: config.Hal

• optional google.protobuf.BoolValue enabled = 1

  Whether the canary service is enabled.

• optional Canary.ServiceIntegrations serviceIntegrations = 2

  Canary service integrations. To enable Spinnaker's Automated Canary Analysis (ACA) features, you must configure at least one account for each `canary.SupportedType` (`METRICS_STORE`, `CONFIGURATION_STORE`, `OBJECT_STORE`).

• string defaultMetricsAccount = 3

  Name of the metrics account to use by default.

• string defaultMetricsStore = 4

  Name of the metrics store to use by default (for example, `prometheus`, `datadog`).

• optional google.protobuf.BoolValue showAllConfigsEnabled = 5

  Whether to show _all_ canary configs in Deck, or just those scoped to the current application.

• optional google.protobuf.BoolValue templatesEnabled = 6

  Whether to enable custom filter templates for canary configs in Deck.

• string defaultJudge = 7

  The default canary judge. `NetflixACAJudge-v1.0` is currently the only open-source judge available by default.

• string storageAccountName = 8

  Name of storage account to use by default.

Used in: Canary

• optional Aws aws = 1

• optional Datadog datadog = 2

• optional Google google = 3

• optional NewRelic newrelic = 4

• optional Prometheus prometheus = 5

• optional SignalFx signalfx = 6

Configuration for the Datadog canary integration.

Used in: Canary.ServiceIntegrations, config.Kayenta.ServiceIntegrations

• optional google.protobuf.BoolValue enabled = 1

  Whether Datadog is enabled as a metric store provider.

• repeated DatadogAccount accounts = 2

  The list of configured Datadog accounts.

Configuration for a Datadog account.

Used in: Datadog

• string name = 1

  The name of the account.

• optional DatadogAccount.Endpoint endpoint = 2

  Configuration for the Datadog server endpoint.

• string apiKey = 3

  Your organization's unique Datadog API key. See https://app.datadoghq.com/account/settings#api.

• string applicationKey = 4

  Your Datadog application key. See https://app.datadoghq.com/account/settings#api.

Configuration for the Datadog server endpoint.

Used in: DatadogAccount

• string baseUrl = 1

  (Required) The base URL of the Datadog server.

Configuration for the Google Cloud Storage canary integration. If this is enabled, you must also configure at least one `canary.GoogleAccount` with a list of `supportedTypes` that includes `canary.SupportedType.CONFIGURATION_STORE` or `canary.SupportedType.OBJECT_STORE` or both.

Used in: config.Kayenta.ServiceIntegrations

• optional google.protobuf.BoolValue enabled = 1

  Whether Google Cloud Storage is enabled as a backing store to support Spinnaker's automated canary analysis features.

Configuration for the Google canary integration.

Used in: Canary.ServiceIntegrations

• optional google.protobuf.BoolValue enabled = 1

  Whether Google is enabled as a metrics store provider.

• repeated GoogleAccount accounts = 2

  The list of configured accounts.

• optional google.protobuf.BoolValue gcsEnabled = 3

  Whether Google Cloud Storage is enabled as a persistent store.

• optional google.protobuf.BoolValue stackdriverEnabled = 4

  Whether Google Cloud Monitoring (formerly Stackdriver) is enabled as a metrics source.

• int32 metadataCachingIntervalMS = 5

  Number of milliseconds to wait between caching the names of available Cloud Monitoring metric types (used when building canary configs). Defaults to `60000`.

Configuration for a Google account.

Used in: Google, config.Kayenta.ServiceIntegrations.Google

• string name = 1

  The name of the account.

• string jsonPath = 2

  The path to a JSON file containing the service account key that Spinnaker will use to authenticate. You need this only if Spinnaker is not deployed on a Google Compute Engine VM, or if the account needs permissions not afforded to the VM it is running on. See https://cloud.google.com/compute/docs/access/service-accounts for more information.

• string bucket = 3

  The name of a Cloud Storage bucket that this account has access to. If you specify a globally unique bucket name that doesn't exist yet, Kayenta creates that bucket for you.

• string bucketLocation = 4

  Where to create the new bucket. This is only required if the bucket you specify doesn't exist yet. See https://cloud.google.com/storage/docs/managing-buckets#manage-class-location.

• optional google.protobuf.StringValue rootFolder = 5

  The root-level folder, in the specified bucket, in which to store all the canary service's persistent data. Defaults to `kayenta`.

• string project = 6

  (Required) The Google Cloud Platform project the canary service will use to consume Cloud Storage and Cloud Monitoring data.

• repeated SupportedType supportedTypes = 7

  For Google Cloud Monitoring (formerly Stackdriver) use METRICS_STORE. For Google Cloud Storage, use CONFIGURATION_STORE and OBJECT_STORE. All three can be a list of `supportedTypes` in the same account, or each in a separate account.

Configuration for the New Relic canary integration.

Used in: Canary.ServiceIntegrations, config.Kayenta.ServiceIntegrations

• optional google.protobuf.BoolValue enabled = 1

  Whether New Relic is enabled as a metric store provider.

• repeated NewRelicAccount accounts = 2

  The list of configured accounts.

Configuration for a New Relic account.

Used in: NewRelic

• string name = 1

  The name of the account.

• optional NewRelicAccount.Endpoint endpoint = 2

  Configuration for the New Relic Insights server endpoint.

• string apiKey = 3

  (Required) Your account's unique New Relic Insights API key. See https://docs.newrelic.com/docs/insights/insights-api/get-data/query-insights-event-data-api.

• string applicationKey = 4

  (Required) Your New Relic account ID. See https://docs.newrelic.com/docs/accounts/install-new-relic/account-setup/account-id.

Configuration for the New Relic Insights server endpoint.

Used in: NewRelicAccount

• string baseUrl = 1

  The base URL to the New Relic Insights server.

Configuration for the Prometheus canary integration.

Used in: Canary.ServiceIntegrations, config.Kayenta.ServiceIntegrations

• optional google.protobuf.BoolValue enabled = 1

  Whether Prometheus is enabled as a metric store provider.

• repeated PrometheusAccount accounts = 2

  The list of configured accounts.

• int32 metadataCachingIntervalMS = 3

  Number of milliseconds to wait between caching the names of available metric types (used when building canary configs). Defaults to 60000.

Configuration for a Prometheus account. For authentication, you must provide either `usernamePasswordFile` or `username` and `password`.

Used in: Prometheus

• string name = 1

  The name of the account.

• optional PrometheusAccount.Endpoint endpoint = 2

  Configuration for the Prometheus server endpoint.

• string username = 3

  A basic-auth username.

• string password = 4

  A basic-auth password.

• string usernamePasswordFile = 5

  The path to a file containing the basic-auth username and password in the format `${username}:${password}`.

Configuration for the Prometheus server endpoint.

Used in: PrometheusAccount

• string baseUrl = 1

  (Required) The base URL of the Prometheus server.

Configuration for the S3 canary integration. If enabled, you must also configure at least one `canary.AwsAccount` with a list of `supportedTypes` that includes `canary.SupportedType.CONFIGURATION_STORE` and/or `canary.SupportedType.OBJECT_STORE`.

Used in: config.Kayenta.ServiceIntegrations

• optional google.protobuf.BoolValue enabled = 1

  Whether S3 is enabled as a backing store to support Spinnaker's automated canary analysis features.

Configuration for the SignalFx canary integration.

Used in: Canary.ServiceIntegrations, config.Kayenta.ServiceIntegrations

• optional google.protobuf.BoolValue enabled = 1

  Whether SignalFx is enabled as a metric store provider.

• repeated SignalFxAccount accounts = 2

  The list of configured accounts.

Used in: SignalFx

• string name = 1

  The name of the account.

• string accessToken = 2

  (Required) The SignalFx access token.

• optional SignalFxAccount.Endpoint endpoint = 3

  The SignalFx server endpoint.

• string defaultScopeKey = 4

  The scope key, which is used to distinguish between base and canary deployments. If omitted, each request must supply the `_scope_key` param in extended scope params.

• string defaultLocationKey = 5

  The location key, which is used to filter by deployment region. If omitted, each request must supply the `_location_key` if it is needed.

The SignalFx server endpoint.

Used in: SignalFxAccount

• string baseUrl = 1

  The base URL to the SignalFx server. Defaults to https://stream.signalfx.com

Configuration for the Google Cloud Monitoring (formerly Stackdriver) canary integration. If enabled, you must also configure at least one `canary.GoogleAccount` with a list of `supportedTypes` that includes `canary.SupportedType.METRICS_STORE`.

Used in: config.Kayenta.ServiceIntegrations

• optional google.protobuf.BoolValue enabled = 1

  Whether the Cloud Monitoring integration is enabled.

• int32 metadataCachingIntervalMS = 2

  Number of milliseconds to wait between caching the names of available Cloud Monitoring metric types (used when building canary configs). Defaults to 60000.

Used in: AwsAccount, GoogleAccount

• UNSPECIFIED = 0

  Unspecified. Do not directly use, instead omit the field.

• METRICS_STORE = 1

• CONFIGURATION_STORE = 2

• OBJECT_STORE = 3