Grpc Credentials File Based Metadata

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

config/grpc_credential/v2alpha/file_based_metadata.proto

This extension may be referenced by the qualified name envoy.grpc_credentials.file_based_metadata

Note

This extension is functional but has not had substantial production burn time, use only with this caveat.

This extension does not operate on the data plane and hence is intended to be robust against untrusted traffic.

Tip

This extension extends and can be used with the following extension category:

Configuration for File Based Metadata Grpc Credentials Plugin

config.grpc_credential.v3.FileBasedMetadataConfig

[config.grpc_credential.v3.FileBasedMetadataConfig proto]

  1. {
  2.   "secret_data": "{...}",
  3.   "header_key": "...",
  4.   "header_prefix": "..."
  5. }

secret_data

(config.core.v3.DataSource) Location or inline data of secret to use for authentication of the Google gRPC connection this secret will be attached to a header of the gRPC connection

header_key

(string) Metadata header key to use for sending the secret data if no header key is set, “authorization” header will be used

header_prefix

(string) Prefix to prepend to the secret in the metadata header if no prefix is set, the default is to use no prefix