Skip to content

Commit

Permalink
aws_iam: deprecate extension and mark for future deletion (#37596)
Browse files Browse the repository at this point in the history
Fixes #36910

Signed-off-by: Greg Greenway <[email protected]>
  • Loading branch information
ggreenway authored Dec 11, 2024
1 parent b846d18 commit a4b06fd
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 2 deletions.
1 change: 1 addition & 0 deletions api/envoy/config/grpc_credential/v3/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ licenses(["notice"]) # Apache 2

api_proto_package(
deps = [
"//envoy/annotations:pkg",
"//envoy/config/core/v3:pkg",
"@com_github_cncf_xds//udpa/annotations:pkg",
],
Expand Down
14 changes: 12 additions & 2 deletions api/envoy/config/grpc_credential/v3/aws_iam.proto
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ syntax = "proto3";

package envoy.config.grpc_credential.v3;

import "envoy/annotations/deprecation.proto";
import "udpa/annotations/status.proto";
import "udpa/annotations/versioning.proto";
import "validate/validate.proto";
Expand All @@ -14,6 +15,11 @@ option (udpa.annotations.file_status).package_version_status = ACTIVE;

// [#protodoc-title: Grpc Credentials AWS IAM]
// Configuration for AWS IAM Grpc Credentials Plugin
// .. warning::
//
// This extension is deprecated and will be deleted in a future Envoy release, no
// later than Envoy 1.35, but possibly sooner.
//
// [#extension: envoy.grpc_credentials.aws_iam]

message AwsIamConfig {
Expand All @@ -25,12 +31,16 @@ message AwsIamConfig {
// of the Grpc endpoint.
//
// Example: appmesh
string service_name = 1 [(validate.rules).string = {min_len: 1}];
string service_name = 1 [
deprecated = true,
(validate.rules).string = {min_len: 1},
(envoy.annotations.deprecated_at_minor_version) = "3.0"
];

// The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the Grpc
// endpoint. If unspecified, the extension will use the value in the ``AWS_REGION`` environment
// variable.
//
// Example: us-west-2
string region = 2;
string region = 2 [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
}
4 changes: 4 additions & 0 deletions changelogs/current.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -341,3 +341,7 @@ deprecated:
change: |
metadata :ref:`metadata <envoy_v3_api_field_config.rbac.v3.Permission.metadata>` is now deprecated in the
favor of :ref:`sourced_metadata <envoy_v3_api_field_config.rbac.v3.Permission.sourced_metadata>`.
- area: aws_iam
change: |
The :ref:`aws_iam extension <envoy_v3_api_msg_config.grpc_credential.v3.AwsIamConfig>` is deprecated and will be
deleted from Envoy in a future release, no later than Envoy 1.35, but possibly sooner.

0 comments on commit a4b06fd

Please sign in to comment.