Updated protobuf definitions (#116)

api: update proto configuration

Signed-off-by: Jakub Dyszkiewicz <[email protected]>

Author: jakubdyszkiewicz

api/pom.xml

@@ -27,6 +27,12 @@
             <version>${grpc.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>com.google.protobuf</groupId>
+            <artifactId>protobuf-java</artifactId>
+            <version>${protobuf.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>javax.annotation</groupId>
             <artifactId>javax.annotation-api</artifactId>
@@ -49,9 +55,9 @@
                 <artifactId>protobuf-maven-plugin</artifactId>
                 <version>0.6.1</version>
                 <configuration>
-                    <protocArtifact>com.google.protobuf:protoc:3.5.1-1:exe:${os.detected.classifier}</protocArtifact>
+                    <protocArtifact>com.google.protobuf:protoc:${protobuf.version}:exe:${os.detected.classifier}</protocArtifact>
                     <pluginId>grpc-java</pluginId>
-                    <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.9.0:exe:${os.detected.classifier}</pluginArtifact>
+                    <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact>
 
                     <useArgumentFile>true</useArgumentFile>
                     <checkStaleness>true</checkStaleness>

api/src/main/proto/envoy/admin/v2alpha/clusters.proto

@@ -28,9 +28,15 @@ message ClusterStatus {
   // Denotes whether this cluster was added via API or configured statically.
   bool added_via_api = 2;
 
-  // The success rate threshold used in the last interval. The threshold is used to eject hosts
-  // based on their success rate. See
-  // :ref:`Cluster outlier detection <arch_overview_outlier_detection>` statistics
+  // The success rate threshold used in the last interval.
+  // If
+  // :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>`
+  // is *false*, all errors: externally and locally generated were used to calculate the threshold.
+  // If
+  // :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>`
+  // is *true*, only externally generated errors were used to calculate the threshold.
+  // The threshold is used to eject hosts based on their success rate. See
+  // :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for details.
   //
   // Note: this field may be omitted in any of the three following cases:
   //
@@ -43,6 +49,23 @@ message ClusterStatus {
 
   // Mapping from host address to the host's current status.
   repeated HostStatus host_statuses = 4;
+
+  // The success rate threshold used in the last interval when only locally originated failures were
+  // taken into account and externally originated errors were treated as success.
+  // This field should be interpretted only when
+  // :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>`
+  // is *true*. The threshold is used to eject hosts based on their success rate.
+  // See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
+  // details.
+  //
+  // Note: this field may be omitted in any of the three following cases:
+  //
+  // 1. There were not enough hosts with enough request volume to proceed with success rate based
+  //    outlier ejection.
+  // 2. The threshold is computed to be < 0 because a negative value implies that there was no
+  //    threshold for that interval.
+  // 3. Outlier detection is not enabled for this cluster.
+  envoy.type.Percent local_origin_success_rate_ejection_threshold = 5;
 }
 
 // Current state of a particular host.
@@ -57,6 +80,14 @@ message HostStatus {
   HostHealthStatus health_status = 3;
 
   // Request success rate for this host over the last calculated interval.
+  // If
+  // :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>`
+  // is *false*, all errors: externally and locally generated were used in success rate
+  // calculation. If
+  // :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>`
+  // is *true*, only externally generated errors were used in success rate calculation.
+  // See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
+  // details.
   //
   // Note: the message will not be present if host did not have enough request volume to calculate
   // success rate or the cluster did not have enough hosts to run through success rate outlier
@@ -65,6 +96,26 @@ message HostStatus {
 
   // The host's weight. If not configured, the value defaults to 1.
   uint32 weight = 5;
+
+  // The hostname of the host, if applicable.
+  string hostname = 6;
+
+  // The host's priority. If not configured, the value defaults to 0 (highest priority).
+  uint32 priority = 7;
+
+  // Request success rate for this host over the last calculated
+  // interval when only locally originated errors are taken into account and externally originated
+  // errors were treated as success.
+  // This field should be interpretted only when
+  // :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>`
+  // is *true*.
+  // See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
+  // details.
+  //
+  // Note: the message will not be present if host did not have enough request volume to calculate
+  // success rate or the cluster did not have enough hosts to run through success rate outlier
+  // ejection.
+  envoy.type.Percent local_origin_success_rate = 8;
 }
 
 // Health status for a host.
@@ -78,6 +129,13 @@ message HostHealthStatus {
   // The host is currently being marked as degraded through active health checking.
   bool failed_active_degraded_check = 4;
 
+  // The host has been removed from service discovery, but is being stabilized due to active
+  // health checking.
+  bool pending_dynamic_removal = 5;
+
+  // The host has not yet been health checked.
+  bool pending_active_hc = 6;
+
   // Health status as reported by EDS. Note: only HEALTHY and UNHEALTHY are currently supported
   // here.
   // TODO(mrice32): pipe through remaining EDS health status possibilities.

api/src/main/proto/envoy/admin/v2alpha/config_dump.proto

@@ -6,9 +6,11 @@ option java_outer_classname = "ConfigDumpProto";
 option java_multiple_files = true;
 option java_package = "io.envoyproxy.envoy.admin.v2alpha";
 
+import "envoy/api/v2/auth/cert.proto";
 import "envoy/api/v2/cds.proto";
 import "envoy/api/v2/lds.proto";
 import "envoy/api/v2/rds.proto";
+import "envoy/api/v2/srds.proto";
 import "envoy/config/bootstrap/v2/bootstrap.proto";
 
 import "google/protobuf/any.proto";
@@ -31,15 +33,15 @@ message ConfigDump {
   // * *clusters*: :ref:`ClustersConfigDump <envoy_api_msg_admin.v2alpha.ClustersConfigDump>`
   // * *listeners*: :ref:`ListenersConfigDump <envoy_api_msg_admin.v2alpha.ListenersConfigDump>`
   // * *routes*:  :ref:`RoutesConfigDump <envoy_api_msg_admin.v2alpha.RoutesConfigDump>`
-  repeated google.protobuf.Any configs = 1 [(gogoproto.nullable) = false];
+  repeated google.protobuf.Any configs = 1;
 }
 
 // This message describes the bootstrap configuration that Envoy was started with. This includes
 // any CLI overrides that were merged. Bootstrap configuration information can be used to recreate
 // the static portions of an Envoy configuration by reusing the output as the bootstrap
 // configuration for another Envoy.
 message BootstrapConfigDump {
-  envoy.config.bootstrap.v2.Bootstrap bootstrap = 1 [(gogoproto.nullable) = false];
+  envoy.config.bootstrap.v2.Bootstrap bootstrap = 1;
 
   // The timestamp when the BootstrapConfig was last updated.
   google.protobuf.Timestamp last_updated = 2;
@@ -54,7 +56,7 @@ message ListenersConfigDump {
   // will be "".
   string version_info = 1;
 
-  // Describes a statically loaded cluster.
+  // Describes a statically loaded listener.
   message StaticListener {
     // The listener config.
     envoy.api.v2.Listener listener = 1;
@@ -79,23 +81,23 @@ message ListenersConfigDump {
   }
 
   // The statically loaded listener configs.
-  repeated StaticListener static_listeners = 2 [(gogoproto.nullable) = false];
+  repeated StaticListener static_listeners = 2;
 
   // The dynamically loaded active listeners. These are listeners that are available to service
   // data plane traffic.
-  repeated DynamicListener dynamic_active_listeners = 3 [(gogoproto.nullable) = false];
+  repeated DynamicListener dynamic_active_listeners = 3;
 
   // The dynamically loaded warming listeners. These are listeners that are currently undergoing
   // warming in preparation to service data plane traffic. Note that if attempting to recreate an
   // Envoy configuration from a configuration dump, the warming listeners should generally be
   // discarded.
-  repeated DynamicListener dynamic_warming_listeners = 4 [(gogoproto.nullable) = false];
+  repeated DynamicListener dynamic_warming_listeners = 4;
 
   // The dynamically loaded draining listeners. These are listeners that are currently undergoing
   // draining in preparation to stop servicing data plane traffic. Note that if attempting to
   // recreate an Envoy configuration from a configuration dump, the draining listeners should
   // generally be discarded.
-  repeated DynamicListener dynamic_draining_listeners = 5 [(gogoproto.nullable) = false];
+  repeated DynamicListener dynamic_draining_listeners = 5;
 }
 
 // Envoy's cluster manager fills this message with all currently known clusters. Cluster
@@ -132,17 +134,17 @@ message ClustersConfigDump {
   }
 
   // The statically loaded cluster configs.
-  repeated StaticCluster static_clusters = 2 [(gogoproto.nullable) = false];
+  repeated StaticCluster static_clusters = 2;
 
   // The dynamically loaded active clusters. These are clusters that are available to service
   // data plane traffic.
-  repeated DynamicCluster dynamic_active_clusters = 3 [(gogoproto.nullable) = false];
+  repeated DynamicCluster dynamic_active_clusters = 3;
 
   // The dynamically loaded warming clusters. These are clusters that are currently undergoing
   // warming in preparation to service data plane traffic. Note that if attempting to recreate an
   // Envoy configuration from a configuration dump, the warming clusters should generally be
   // discarded.
-  repeated DynamicCluster dynamic_warming_clusters = 4 [(gogoproto.nullable) = false];
+  repeated DynamicCluster dynamic_warming_clusters = 4;
 }
 
 // Envoy's RDS implementation fills this message with all currently loaded routes, as described by
@@ -173,8 +175,92 @@ message RoutesConfigDump {
   }
 
   // The statically loaded route configs.
-  repeated StaticRouteConfig static_route_configs = 2 [(gogoproto.nullable) = false];
+  repeated StaticRouteConfig static_route_configs = 2;
 
   // The dynamically loaded route configs.
-  repeated DynamicRouteConfig dynamic_route_configs = 3 [(gogoproto.nullable) = false];
+  repeated DynamicRouteConfig dynamic_route_configs = 3;
+}
+
+// Envoy's scoped RDS implementation fills this message with all currently loaded route
+// configuration scopes (defined via ScopedRouteConfigurationsSet protos). This message lists both
+// the scopes defined inline with the higher order object (i.e., the HttpConnectionManager) and the
+// dynamically obtained scopes via the SRDS API.
+message ScopedRoutesConfigDump {
+  message InlineScopedRouteConfigs {
+    // The name assigned to the scoped route configurations.
+    string name = 1;
+
+    // The scoped route configurations.
+    repeated envoy.api.v2.ScopedRouteConfiguration scoped_route_configs = 2;
+
+    // The timestamp when the scoped route config set was last updated.
+    google.protobuf.Timestamp last_updated = 3;
+  }
+
+  message DynamicScopedRouteConfigs {
+    // The name assigned to the scoped route configurations.
+    string name = 1;
+
+    // This is the per-resource version information. This version is currently taken from the
+    // :ref:`version_info <envoy_api_field_DiscoveryResponse.version_info>` field at the time that
+    // the scoped routes configuration was loaded.
+    string version_info = 2;
+
+    // The scoped route configurations.
+    repeated envoy.api.v2.ScopedRouteConfiguration scoped_route_configs = 3;
+
+    // The timestamp when the scoped route config set was last updated.
+    google.protobuf.Timestamp last_updated = 4;
+  }
+
+  // The statically loaded scoped route configs.
+  repeated InlineScopedRouteConfigs inline_scoped_route_configs = 1;
+
+  // The dynamically loaded scoped route configs.
+  repeated DynamicScopedRouteConfigs dynamic_scoped_route_configs = 2;
+}
+
+// Envoys SDS implementation fills this message with all secrets fetched dynamically via SDS.
+message SecretsConfigDump {
+  // DynamicSecret contains secret information fetched via SDS.
+  message DynamicSecret {
+    // The name assigned to the secret.
+    string name = 1;
+
+    // This is the per-resource version information.
+    string version_info = 2;
+
+    // The timestamp when the secret was last updated.
+    google.protobuf.Timestamp last_updated = 3;
+
+    // The actual secret information.
+    // Security sensitive information is redacted (replaced with "[redacted]") for
+    // private keys and passwords in TLS certificates.
+    envoy.api.v2.auth.Secret secret = 4;
+  }
+
+  // StaticSecret specifies statically loaded secret in bootstrap.
+  message StaticSecret {
+    // The name assigned to the secret.
+    string name = 1;
+
+    // The timestamp when the secret was last updated.
+    google.protobuf.Timestamp last_updated = 2;
+
+    // The actual secret information.
+    // Security sensitive information is redacted (replaced with "[redacted]") for
+    // private keys and passwords in TLS certificates.
+    envoy.api.v2.auth.Secret secret = 3;
+  }
+
+  // The statically loaded secrets.
+  repeated StaticSecret static_secrets = 1;
+
+  // The dynamically loaded active secrets. These are secrets that are available to service
+  // clusters or listeners.
+  repeated DynamicSecret dynamic_active_secrets = 2;
+
+  // The dynamically loaded warming secrets. These are secrets that are currently undergoing
+  // warming in preparation to service clusters or listeners.
+  repeated DynamicSecret dynamic_warming_secrets = 3;
 }

api/src/main/proto/envoy/admin/v2alpha/listeners.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+
+package envoy.admin.v2alpha;
+
+option java_outer_classname = "ListenersProto";
+option java_multiple_files = true;
+option java_package = "io.envoyproxy.envoy.admin.v2alpha";
+
+import "envoy/api/v2/core/address.proto";
+
+// [#protodoc-title: Listeners]
+
+// Admin endpoint uses this wrapper for `/listeners` to display listener status information.
+// See :ref:`/listeners <operations_admin_interface_listeners>` for more information.
+message Listeners {
+  // List of listener statuses.
+  repeated ListenerStatus listener_statuses = 1;
+}
+
+// Details an individual listener's current status.
+message ListenerStatus {
+  // Name of the listener
+  string name = 1;
+
+  // The actual local address that the listener is listening on. If a listener was configured
+  // to listen on port 0, then this address has the port that was allocated by the OS.
+  envoy.api.v2.core.Address local_address = 2;
+}

api/src/main/proto/envoy/admin/v2alpha/memory.proto

@@ -10,7 +10,7 @@ option java_package = "io.envoyproxy.envoy.admin.v2alpha";
 
 // Proto representation of the internal memory consumption of an Envoy instance. These represent
 // values extracted from an internal TCMalloc instance. For more information, see the section of the
-// docs entitled ["Generic Tcmalloc Status"](http://gperftools.github.io/gperftools/tcmalloc.html).
+// docs entitled ["Generic Tcmalloc Status"](https://gperftools.github.io/gperftools/tcmalloc.html).
 message Memory {
 
   // The number of bytes allocated by the heap for Envoy. This is an alias for

api/src/main/proto/envoy/admin/v2alpha/server_info.proto

@@ -114,11 +114,9 @@ message CommandLineOptions {
   // See :option:`--mode` for details.
   Mode mode = 19;
 
-  // See :option:`--max-stats` for details.
-  uint64 max_stats = 20;
-
-  // See :option:`--max-obj-name-len` for details.
-  uint64 max_obj_name_len = 21;
+  // max_stats and max_obj_name_len are now unused and have no effect.
+  uint64 max_stats = 20 [deprecated = true];
+  uint64 max_obj_name_len = 21 [deprecated = true];
 
   // See :option:`--disable-hot-restart` for details.
   bool disable_hot_restart = 22;
@@ -128,4 +126,7 @@ message CommandLineOptions {
 
   // See :option:`--restart-epoch` for details.
   uint32 restart_epoch = 24;
+
+  // See :option:`--cpuset-threads` for details.
+  bool cpuset_threads = 25;
 }

api/src/main/proto/envoy/api/v2/auth/cert.proto

@@ -248,7 +248,7 @@ message CertificateValidationContext {
   google.protobuf.BoolValue require_signed_certificate_timestamp = 6;
 
   // An optional `certificate revocation list
-  // <http://https://en.wikipedia.org/wiki/Certificate_revocation_list>`_
+  // <https://en.wikipedia.org/wiki/Certificate_revocation_list>`_
   // (in PEM format). If specified, Envoy will verify that the presented peer
   // certificate has not been revoked by this CRL. If this DataSource contains
   // multiple CRLs, all of them will be used.