rds.proto 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. syntax = "proto3";
  2. package envoy.api.v2;
  3. import "envoy/api/v2/discovery.proto";
  4. import "google/api/annotations.proto";
  5. import "envoy/annotations/resource.proto";
  6. import "udpa/annotations/migrate.proto";
  7. import "udpa/annotations/status.proto";
  8. import public "envoy/api/v2/route.proto";
  9. option java_package = "io.envoyproxy.envoy.api.v2";
  10. option java_outer_classname = "RdsProto";
  11. option java_multiple_files = true;
  12. option go_package = "github.com/envoyproxy/go-control-plane/envoy/api/v2;apiv2";
  13. option java_generic_services = true;
  14. option (udpa.annotations.file_migrate).move_to_package = "envoy.service.route.v3";
  15. option (udpa.annotations.file_status).package_version_status = FROZEN;
  16. // [#protodoc-title: RDS]
  17. // The resource_names field in DiscoveryRequest specifies a route configuration.
  18. // This allows an Envoy configuration with multiple HTTP listeners (and
  19. // associated HTTP connection manager filters) to use different route
  20. // configurations. Each listener will bind its HTTP connection manager filter to
  21. // a route table via this identifier.
  22. service RouteDiscoveryService {
  23. option (envoy.annotations.resource).type = "envoy.api.v2.RouteConfiguration";
  24. rpc StreamRoutes(stream DiscoveryRequest) returns (stream DiscoveryResponse) {
  25. }
  26. rpc DeltaRoutes(stream DeltaDiscoveryRequest) returns (stream DeltaDiscoveryResponse) {
  27. }
  28. rpc FetchRoutes(DiscoveryRequest) returns (DiscoveryResponse) {
  29. option (google.api.http).post = "/v2/discovery:routes";
  30. option (google.api.http).body = "*";
  31. }
  32. }
  33. // Virtual Host Discovery Service (VHDS) is used to dynamically update the list of virtual hosts for
  34. // a given RouteConfiguration. If VHDS is configured a virtual host list update will be triggered
  35. // during the processing of an HTTP request if a route for the request cannot be resolved. The
  36. // :ref:`resource_names_subscribe <envoy_api_field_DeltaDiscoveryRequest.resource_names_subscribe>`
  37. // field contains a list of virtual host names or aliases to track. The contents of an alias would
  38. // be the contents of a *host* or *authority* header used to make an http request. An xDS server
  39. // will match an alias to a virtual host based on the content of :ref:`domains'
  40. // <envoy_api_field_route.VirtualHost.domains>` field. The *resource_names_unsubscribe* field
  41. // contains a list of virtual host names that have been :ref:`unsubscribed
  42. // <xds_protocol_unsubscribe>` from the routing table associated with the RouteConfiguration.
  43. service VirtualHostDiscoveryService {
  44. option (envoy.annotations.resource).type = "envoy.api.v2.route.VirtualHost";
  45. rpc DeltaVirtualHosts(stream DeltaDiscoveryRequest) returns (stream DeltaDiscoveryResponse) {
  46. }
  47. }
  48. // [#not-implemented-hide:] Not configuration. Workaround c++ protobuf issue with importing
  49. // services: https://github.com/google/protobuf/issues/4221 and protoxform to upgrade the file.
  50. message RdsDummy {
  51. }