Skip to content

Commit f1642be

Browse files
committed
Add back comments about the requirements for attribute naming that were originally on the AttributeDescriptor message
1 parent 54b8a75 commit f1642be

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

mixer/v1/config/cfg.proto

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,18 @@ message AttributeManifest {
153153
istio.mixer.v1.config.descriptor.ValueType value_type = 2;
154154
}
155155
// The set of attributes this Istio component will be responsible for producing at runtime.
156-
// We map from attribute name to the attribute's specification. Attribute names must be
157-
// unique across all manifests in the configuration.
156+
// We map from attribute name to the attribute's specification. The name of an attribute,
157+
// which is how attributes are referred to in aspect configuration, must conform to:
158+
//
159+
// Name = IDENT { SEPARATOR IDENT };
160+
//
161+
// Where `IDENT` must match the regular expression `[a-z][a-z0-9]+` and `SEPARATOR` must
162+
// match the regular expression `[.-]`.
163+
//
164+
// Attribute names must be unique within a single Istio deployment. The set of canonical
165+
// attributes are described at https://istio.io/docs/reference/attribute-vocabulary.html.
166+
// Attributes not in that list should be named with a component-specific suffix such as
167+
// request.count-my.component
158168
map<string, AttributeInfo> attributes = 3;
159169
}
160170

0 commit comments

Comments
 (0)