Skip to content
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

feat: [networkconnectivity] add PolicyBasedRouting APIs #4636

Merged
merged 2 commits into from
Sep 12, 2023
Merged

feat: [networkconnectivity] add PolicyBasedRouting APIs #4636

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
11b96b0
feat: add PolicyBasedRouting APIs
gcf-owl-bot[bot] Sep 11, 2023
074d12e
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Sep 11, 2023
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
158 changes: 94 additions & 64 deletions ...networkconnectivity/protos/google/cloud/networkconnectivity/v1/policy_based_routing.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2022 Google LLC
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -20,11 +20,13 @@ import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/networkconnectivity/v1/common.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";

option csharp_namespace = "Google.Cloud.NetworkConnectivity.V1";
option go_package = "google.golang.org/genproto/googleapis/cloud/networkconnectivity/v1;networkconnectivity";
option go_package = "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb;networkconnectivitypb";
option java_multiple_files = true;
option java_outer_classname = "PolicyBasedRoutingProto";
option java_package = "com.google.cloud.networkconnectivity.v1";
Expand All @@ -35,39 +37,45 @@ option ruby_package = "Google::Cloud::NetworkConnectivity::V1";
// policies for Layer 4 traffic traversing through the connected service.
service PolicyBasedRoutingService {
option (google.api.default_host) = "networkconnectivity.googleapis.com";
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";

// Lists PolicyBasedRoutes in a given project and location.
rpc ListPolicyBasedRoutes(ListPolicyBasedRoutesRequest) returns (ListPolicyBasedRoutesResponse) {
rpc ListPolicyBasedRoutes(ListPolicyBasedRoutesRequest)
returns (ListPolicyBasedRoutesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/global}/policyBasedRoutes"
};
option (google.api.method_signature) = "parent";
}

// Gets details of a single PolicyBasedRoute.
rpc GetPolicyBasedRoute(GetPolicyBasedRouteRequest) returns (PolicyBasedRoute) {
rpc GetPolicyBasedRoute(GetPolicyBasedRouteRequest)
returns (PolicyBasedRoute) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/global/policyBasedRoutes/*}"
};
option (google.api.method_signature) = "name";
}

// Creates a new PolicyBasedRoute in a given project and location.
rpc CreatePolicyBasedRoute(CreatePolicyBasedRouteRequest) returns (google.longrunning.Operation) {
rpc CreatePolicyBasedRoute(CreatePolicyBasedRouteRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/global}/policyBasedRoutes"
body: "policy_based_route"
};
option (google.api.method_signature) = "parent,policy_based_route,policy_based_route_id";
option (google.api.method_signature) =
"parent,policy_based_route,policy_based_route_id";
option (google.longrunning.operation_info) = {
response_type: "PolicyBasedRoute"
metadata_type: "OperationMetadata"
};
}

// Deletes a single PolicyBasedRoute.
rpc DeletePolicyBasedRoute(DeletePolicyBasedRouteRequest) returns (google.longrunning.Operation) {
rpc DeletePolicyBasedRoute(DeletePolicyBasedRouteRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/global/policyBasedRoutes/*}"
};
Expand All @@ -83,18 +91,18 @@ service PolicyBasedRoutingService {
// to route their L4 network traffic based on not just destination IP, but also
// source IP, protocol and more. A PBR always take precedence when it conflicts
// with other types of routes.
// Next id: 19
// Next id: 22
message PolicyBasedRoute {
option (google.api.resource) = {
type: "networkconnectivity.googleapis.com/PolicyBasedRoute"
pattern: "projects/{project}/{location}/global/PolicyBasedRoutes/{policy_based_route}"
pattern: "projects/{project}/locations/global/PolicyBasedRoutes/{policy_based_route}"
};

// VM instances to which this policy based route applies to.
message VirtualMachine {
// Optional. A list of VM instance tags to which this policy based route applies to.
// VM instances that have ANY of tags specified here will install this
// PBR.
// Optional. A list of VM instance tags to which this policy based route
// applies to. VM instances that have ANY of tags specified here will
// install this PBR.
repeated string tags = 1 [(google.api.field_behavior) = OPTIONAL];
}

Expand All @@ -116,21 +124,23 @@ message PolicyBasedRoute {
IPV4 = 1;
}

// Optional. The IP protocol that this policy based route applies to. Valid values are
// 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.
// Optional. The IP protocol that this policy based route applies to. Valid
// values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.
string ip_protocol = 1 [(google.api.field_behavior) = OPTIONAL];

// Optional. The source IP range of outgoing packets that this policy based route
// applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
// Optional. The source IP range of outgoing packets that this policy based
// route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
string src_range = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. The destination IP range of outgoing packets that this policy based route
// applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
// Optional. The destination IP range of outgoing packets that this policy
// based route applies to. Default is "0.0.0.0/0" if protocol version is
// IPv4.
string dest_range = 3 [(google.api.field_behavior) = OPTIONAL];

// Required. Internet protocol versions this policy based route applies to. For this
// version, only IPV4 is supported.
ProtocolVersion protocol_version = 6 [(google.api.field_behavior) = REQUIRED];
// Required. Internet protocol versions this policy based route applies to.
// For this version, only IPV4 is supported.
ProtocolVersion protocol_version = 6
[(google.api.field_behavior) = REQUIRED];
}

// Informational warning message.
Expand All @@ -154,70 +164,89 @@ message PolicyBasedRoute {
// Output only. A warning code, if applicable.
Code code = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. Metadata about this warning in key: value format. The key should provides
// more detail on the warning being returned. For example, for warnings
// where there are no results in a list request for a particular zone, this
// key might be scope and the key value might be the zone name. Other
// examples might be a key indicating a deprecated resource and a suggested
// replacement.
// Output only. Metadata about this warning in key: value format. The key
// should provides more detail on the warning being returned. For example,
// for warnings where there are no results in a list request for a
// particular zone, this key might be scope and the key value might be the
// zone name. Other examples might be a key indicating a deprecated resource
// and a suggested replacement.
map<string, string> data = 2 [(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. A human-readable description of the warning code.
string warning_message = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// The other routing cases.
enum OtherRoutes {
// Default value.
OTHER_ROUTES_UNSPECIFIED = 0;

// Use the routes from the default routing tables (system-generated routes,
// custom routes, peering route) to determine the next hop. This will
// effectively exclude matching packets being applied on other PBRs with a
// lower priority.
DEFAULT_ROUTING = 1;
}

// Target specifies network endpoints to which this policy based route applies
// to. If none of the target is specified, the PBR will be installed on all
// network endpoints (e.g. VMs, VPNs, and Interconnects) in the VPC.
oneof target {
// Optional. VM instances to which this policy based route applies to.
VirtualMachine virtual_machine = 18 [(google.api.field_behavior) = OPTIONAL];
VirtualMachine virtual_machine = 18
[(google.api.field_behavior) = OPTIONAL];

// Optional. The interconnect attachments to which this route applies to.
InterconnectAttachment interconnect_attachment = 9 [(google.api.field_behavior) = OPTIONAL];
InterconnectAttachment interconnect_attachment = 9
[(google.api.field_behavior) = OPTIONAL];
}

oneof next_hop {
// Optional. The IP of a global access enabled L4 ILB that should be the next hop to
// handle matching packets. For this version, only next_hop_ilb_ip is
// supported.
// Optional. The IP of a global access enabled L4 ILB that should be the
// next hop to handle matching packets. For this version, only
// next_hop_ilb_ip is supported.
string next_hop_ilb_ip = 12 [(google.api.field_behavior) = OPTIONAL];

// Optional. Other routes that will be referenced to determine the next hop
// of the packet.
OtherRoutes next_hop_other_routes = 21
[(google.api.field_behavior) = OPTIONAL];
}

// Immutable. A unique name of the resource in the form of
// `projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}`
string name = 1 [(google.api.field_behavior) = IMMUTABLE];

// Output only. Time when the PolicyBasedRoute was created.
google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
google.protobuf.Timestamp create_time = 2
[(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. Time when the PolicyBasedRoute was updated.
google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
google.protobuf.Timestamp update_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];

// User-defined labels.
map<string, string> labels = 4;

// Optional. An optional description of this resource. Provide this field when you
// create the resource.
// Optional. An optional description of this resource. Provide this field when
// you create the resource.
string description = 5 [(google.api.field_behavior) = OPTIONAL];

// Required. Fully-qualified URL of the network that this route applies to. e.g.
// projects/my-project/global/networks/my-network.
// Required. Fully-qualified URL of the network that this route applies to.
// e.g. projects/my-project/global/networks/my-network.
string network = 6 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "compute.googleapis.com/Network"
}
(google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
];

// Required. The filter to match L4 traffic.
Filter filter = 10 [(google.api.field_behavior) = REQUIRED];

// Optional. The priority of this policy based route. Priority is used to break ties in
// cases where there are more than one matching policy based routes found. In
// cases where multiple policy based routes are matched, the one with the
// lowest-numbered priority value wins. The default value is 1000. The
// priority value must be from 1 to 65535, inclusive.
// Optional. The priority of this policy based route. Priority is used to
// break ties in cases where there are more than one matching policy based
// routes found. In cases where multiple policy based routes are matched, the
// one with the lowest-numbered priority value wins. The default value is
// 1000. The priority value must be from 1 to 65535, inclusive.
int32 priority = 11 [(google.api.field_behavior) = OPTIONAL];

// Output only. If potential misconfigurations are detected for this route,
Expand All @@ -227,8 +256,8 @@ message PolicyBasedRoute {
// Output only. Server-defined fully-qualified URL for this resource.
string self_link = 15 [(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for
// Policy Based Route resources.
// Output only. Type of this resource. Always
// networkconnectivity#policyBasedRoute for Policy Based Route resources.
string kind = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
}

Expand Down Expand Up @@ -289,19 +318,20 @@ message CreatePolicyBasedRouteRequest {
}
];

// Optional. Unique id for the Policy Based Route to create.
string policy_based_route_id = 2 [(google.api.field_behavior) = OPTIONAL];
// Required. Unique id for the Policy Based Route to create.
string policy_based_route_id = 2 [(google.api.field_behavior) = REQUIRED];

// Required. Initial values for a new Policy Based Route.
PolicyBasedRoute policy_based_route = 3 [(google.api.field_behavior) = REQUIRED];
PolicyBasedRoute policy_based_route = 3
[(google.api.field_behavior) = REQUIRED];

// Optional. An optional request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server will know to ignore
// the request if it has already been completed. The server will guarantee
// that for at least 60 minutes since the first request.
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and t
// he request times out. If you make the request again with the same request
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
Expand All @@ -321,13 +351,13 @@ message DeletePolicyBasedRouteRequest {
}
];

// Optional. An optional request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server will know to ignore
// the request if it has already been completed. The server will guarantee
// that for at least 60 minutes after the first request.
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and t
// he request times out. If you make the request again with the same request
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
Expand Down
Loading