Skip to content

Drop app labels from baggage and propagate principal #6791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
istio-testing merged 2 commits into from
Jan 27, 2026
Merged

Drop app labels from baggage and propagate principal #6791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2fe987
Drop app labels from baggage and propagate principal
krinkinmu Jan 27, 2026
b085ff2
Keep backwards compatibility for app.service and app.version baggage …
keithmattix Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions extensions/common/metadata_object.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,8 @@ absl::optional<std::string> WorkloadMetadataObject::owner() const {
return {};
}

std::string WorkloadMetadataObject::identity() const { return identity_; }

WorkloadType fromSuffix(absl::string_view suffix) {
const auto it = ALL_WORKLOAD_TOKENS.find(suffix);
if (it != ALL_WORKLOAD_TOKENS.end()) {
Expand Down Expand Up @@ -260,6 +262,9 @@ google::protobuf::Struct convertWorkloadMetadataToStruct(const WorkloadMetadataO
if (!obj.cluster_name_.empty()) {
(*metadata.mutable_fields())[ClusterMetadataField].set_string_value(obj.cluster_name_);
}
if (!obj.identity_.empty()) {
(*metadata.mutable_fields())[IdentityMetadataField].set_string_value(obj.identity_);
}
auto* labels = (*metadata.mutable_fields())[LabelsMetadataField].mutable_struct_value();
if (!obj.canonical_name_.empty()) {
(*labels->mutable_fields())[CanonicalNameLabel].set_string_value(obj.canonical_name_);
Expand Down Expand Up @@ -306,7 +311,7 @@ std::unique_ptr<WorkloadMetadataObject>
convertStructToWorkloadMetadata(const google::protobuf::Struct& metadata,
const absl::flat_hash_set<std::string>& additional_labels,
const absl::optional<envoy::config::core::v3::Locality> locality) {
absl::string_view instance, namespace_name, owner, workload, cluster, canonical_name,
absl::string_view instance, namespace_name, owner, workload, cluster, identity, canonical_name,
canonical_revision, app_name, app_version, region, zone;
std::vector<std::pair<std::string, std::string>> labels;
for (const auto& it : metadata.fields()) {
Expand All @@ -320,6 +325,8 @@ convertStructToWorkloadMetadata(const google::protobuf::Struct& metadata,
workload = it.second.string_value();
} else if (it.first == ClusterMetadataField) {
cluster = it.second.string_value();
} else if (it.first == IdentityMetadataField) {
identity = it.second.string_value();
} else if (it.first == LabelsMetadataField) {
for (const auto& labels_it : it.second.struct_value().fields()) {
if (labels_it.first == CanonicalNameLabel) {
Expand Down Expand Up @@ -350,7 +357,7 @@ convertStructToWorkloadMetadata(const google::protobuf::Struct& metadata,
}
auto obj = std::make_unique<WorkloadMetadataObject>(
instance, cluster, namespace_name, workload, canonical_name, canonical_revision, app_name,
app_version, parseOwner(owner, workload), "", locality_region, locality_zone);
app_version, parseOwner(owner, workload), identity, locality_region, locality_zone);
obj->setLabels(labels);
return obj;
}
Expand Down Expand Up @@ -445,10 +452,14 @@ convertBaggageToWorkloadMetadata(absl::string_view data, absl::string_view ident
cluster = parts.second;
break;
case BaggageToken::ServiceName:
// canonical name and app name are always the same
canonical_name = parts.second;
app_name = parts.second;
break;
case BaggageToken::ServiceVersion:
// canonical revision and app version are always the same
canonical_revision = parts.second;
app_version = parts.second;
break;
case BaggageToken::AppName:
app_name = parts.second;
Expand Down
2 changes: 2 additions & 0 deletions extensions/common/metadata_object.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ constexpr absl::string_view LocalityZoneBaggageToken = "cloud.availability_zone"
constexpr absl::string_view InstanceMetadataField = "NAME";
constexpr absl::string_view NamespaceMetadataField = "NAMESPACE";
constexpr absl::string_view ClusterMetadataField = "CLUSTER_ID";
constexpr absl::string_view IdentityMetadataField = "IDENTITY";
constexpr absl::string_view OwnerMetadataField = "OWNER";
constexpr absl::string_view WorkloadMetadataField = "WORKLOAD_NAME";
constexpr absl::string_view LabelsMetadataField = "LABELS";
Expand Down Expand Up @@ -131,6 +132,7 @@ class WorkloadMetadataObject : public Envoy::StreamInfo::FilterState::Object,
std::vector<std::pair<absl::string_view, absl::string_view>> serializeAsPairs() const;
absl::optional<std::string> serializeAsString() const override;
absl::optional<std::string> owner() const;
std::string identity() const;
bool hasFieldSupport() const override { return true; }
using Envoy::StreamInfo::FilterState::Object::FieldType;
FieldType getField(absl::string_view) const override;
Expand Down
28 changes: 20 additions & 8 deletions extensions/common/metadata_object_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,19 @@ using Envoy::Protobuf::util::MessageDifferencer;
using ::testing::NiceMock;

TEST(WorkloadMetadataObjectTest, Baggage) {
constexpr absl::string_view identity = "spiffe://cluster.local/ns/default/sa/default";
WorkloadMetadataObject deploy("pod-foo-1234", "my-cluster", "default", "foo", "foo-service",
"v1alpha3", "", "", WorkloadType::Deployment, "", "", "");
"v1alpha3", "", "", WorkloadType::Deployment, identity, "", "");

WorkloadMetadataObject pod("pod-foo-1234", "my-cluster", "default", "foo", "foo-service",
"v1alpha3", "", "", WorkloadType::Pod, "", "", "");
"v1alpha3", "", "", WorkloadType::Pod, identity, "", "");

WorkloadMetadataObject cronjob("pod-foo-1234", "my-cluster", "default", "foo", "foo-service",
"v1alpha3", "foo-app", "v1", WorkloadType::CronJob, "", "", "");
"v1alpha3", "foo-app", "v1", WorkloadType::CronJob, identity, "",
"");

WorkloadMetadataObject job("pod-foo-1234", "my-cluster", "default", "foo", "foo-service",
"v1alpha3", "", "", WorkloadType::Job, "", "", "");
"v1alpha3", "", "", WorkloadType::Job, identity, "", "");

EXPECT_EQ(deploy.serializeAsString(),
absl::StrCat("type=deployment,workload=foo,name=pod-foo-1234,cluster=my-cluster,",
Expand Down Expand Up @@ -66,8 +68,9 @@ void checkStructConversion(const Envoy::StreamInfo::FilterState::Object& data) {
}

TEST(WorkloadMetadataObjectTest, ConversionWithLabels) {
constexpr absl::string_view identity = "spiffe://cluster.local/ns/default/sa/default";
WorkloadMetadataObject deploy("pod-foo-1234", "my-cluster", "default", "foo", "foo-service",
"v1alpha3", "", "", WorkloadType::Deployment, "", "", "");
"v1alpha3", "", "", WorkloadType::Deployment, identity, "", "");
deploy.setLabels({{"label1", "value1"}, {"label2", "value2"}});
auto pb = convertWorkloadMetadataToStruct(deploy);
auto obj1 = convertStructToWorkloadMetadata(pb, {"label1", "label2"});
Expand All @@ -81,10 +84,12 @@ TEST(WorkloadMetadataObjectTest, ConversionWithLabels) {

TEST(WorkloadMetadataObjectTest, Conversion) {
{
constexpr absl::string_view identity = "spiffe://cluster.local/ns/default/sa/default";
const auto r = convertBaggageToWorkloadMetadata(
"k8s.deployment.name=foo,k8s.cluster.name=my-cluster,"
"k8s.namespace.name=default,service.name=foo-service,service.version=v1alpha3,app.name=foo-"
"app,app.version=latest");
"app,app.version=latest",
identity);
EXPECT_EQ(absl::get<absl::string_view>(r->getField("service")), "foo-service");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("revision")), "v1alpha3");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("type")), DeploymentSuffix);
Expand All @@ -94,6 +99,7 @@ TEST(WorkloadMetadataObjectTest, Conversion) {
EXPECT_EQ(absl::get<absl::string_view>(r->getField("cluster")), "my-cluster");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("app")), "foo-app");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("version")), "latest");
EXPECT_EQ(r->identity(), identity);
checkStructConversion(*r);
}

Expand All @@ -108,8 +114,8 @@ TEST(WorkloadMetadataObjectTest, Conversion) {
EXPECT_EQ(absl::get<absl::string_view>(r->getField("name")), "foo-instance-435");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("namespace")), "test");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("cluster")), "my-cluster");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("app")), "");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("version")), "");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("app")), "foo-service");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("version")), "v1beta2");
checkStructConversion(*r);
}

Expand All @@ -124,6 +130,8 @@ TEST(WorkloadMetadataObjectTest, Conversion) {
EXPECT_EQ(absl::get<absl::string_view>(r->getField("name")), "foo-instance-435");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("namespace")), "test");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("cluster")), "my-cluster");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("app")), "foo-service");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("version")), "v1beta4");
checkStructConversion(*r);
}

Expand All @@ -138,6 +146,8 @@ TEST(WorkloadMetadataObjectTest, Conversion) {
EXPECT_EQ(absl::get<absl::string_view>(r->getField("name")), "");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("namespace")), "test");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("cluster")), "my-cluster");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("app")), "foo-service");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("version")), "v1beta4");
checkStructConversion(*r);
}

Expand All @@ -151,6 +161,8 @@ TEST(WorkloadMetadataObjectTest, Conversion) {
EXPECT_EQ(absl::get<absl::string_view>(r->getField("workload")), "foo");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("namespace")), "default");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("cluster")), "");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("app")), "foo-service");
EXPECT_EQ(absl::get<absl::string_view>(r->getField("version")), "v1alpha3");
checkStructConversion(*r);
}

Expand Down