Add definitions proto for vocabulary and other definitions #45
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| // Copyright 2017 Google Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| syntax = "proto3"; | ||
|
|
||
| import "mixer/descriptor/attribute_descriptor.proto"; | ||
| import "mixer/descriptor/label_descriptor.proto"; | ||
| import "mixer/descriptor/metric_descriptor.proto"; | ||
| import "mixer/descriptor/quota_descriptor.proto"; | ||
| import "mixer/descriptor/log_entry_descriptor.proto"; | ||
| import "mixer/descriptor/monitored_resource_descriptor.proto"; | ||
| import "mixer/descriptor/principal_descriptor.proto"; | ||
|
|
||
| package istio.mixer.descriptor; | ||
|
|
||
| // Istio Definitions | ||
| // An istio definition proto message may contain some or all definition types. | ||
|
There was a problem hiding this comment. "a definition may contain some or all definitions" isn't clear. Presumably, you mean to say something like The effective set of descriptors understood by Istio is produced through the union of all Definition messages within the configuration state. |
||
| // Messages are combined by runtime to form the effective definition. | ||
| // In many cases attribute definitions (vocabulary) are available as separate messages. | ||
| // Every descriptor proto defined in this package should be represented here. | ||
| // Every proto message in definition has a unique name within the message class. | ||
|
|
||
| // Mixer uses a lookup api to access these definitions. | ||
| // Find(definition_name, definition_type) | ||
|
There was a problem hiding this comment. Presumably, this is actually descriptor_name and descriptor_type, right? |
||
| message Definitions { | ||
|
There was a problem hiding this comment. Considering this holds descriptors, why not call this Descriptors? |
||
| // subject | ||
| string subject = 1; | ||
|
There was a problem hiding this comment. What's this for? The comment is not helpful. |
||
| string revision = 2; | ||
|
There was a problem hiding this comment. What's this for, how is it used, what does it contain? |
||
| // attributes form the attribute vocabulary | ||
| // The effective vocabulary is a union of vocabulary presented by the proxy | ||
| // and additional attributes generated by the mixer. | ||
| repeated istio.mixer.v1.config.descriptor.AttributeDescriptor attributes = 3; | ||
|
There was a problem hiding this comment. Need to update the packages here. There was a problem hiding this comment. I think we should move attribute and vocabulary to istio.attribute. Leave the rest under mixer/somewhere. There was a problem hiding this comment. The Definitions message is intended to hold the definitions of the various 'object types' used by the operator. The set of attributes supported by a deployment is not a property of the configuration state, it is a manifest associated with pieces of code (the proxy in particular). As such, I don't think this field should exist here. |
||
| // labels are analogous to attributes. They are externalized representation of attributes used by aspects. | ||
| repeated istio.mixer.v1.config.descriptor.LabelDescriptor labels = 4; | ||
| // metrics defines available metrics types. | ||
| repeated istio.mixer.v1.config.descriptor.MetricDescriptor metrics = 5; | ||
| // quota defines available quota types. | ||
| repeated istio.mixer.v1.config.descriptor.QuotaDescriptor quotas = 6; | ||
| // logEntries define available log types. | ||
| repeated istio.mixer.v1.config.descriptor.LogEntryDescriptor logEntries = 7; | ||
|
There was a problem hiding this comment. For proto fields, please use _ to separate words instead of camelCase. |
||
| // monitoredResources define monitored resource types. | ||
| repeated istio.mixer.v1.config.descriptor.MonitoredResourceDescriptor monitoredResources = 8; | ||
| // principals define principal types. | ||
| repeated istio.mixer.v1.config.descriptor.PrincipalDescriptor principals = 9; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,7 +14,7 @@ | |
|
|
||
| syntax = "proto3"; | ||
|
|
||
| package istio.mixer.descriptor; | ||
|
|
||
| // Defines a a security principal. | ||
| // | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please rephrase this comment to be in flowing prose with the intended audience to be the consumer of the message. That is, this shouldn't have things like "Every descriptor proto defined in this package should be represented here" as that is a comment for implementers of the package, not for its consumers.