syntax = "proto3";

package v1;

import "google/protobuf/any.proto";
import "model.proto";
import "routing.proto";

option go_package = "github.com/polarismesh/specification/source/go/api/v1/traffic_manage";
option java_package = "com.tencent.polaris.specification.api.v1.traffic.manage";
option java_outer_classname = "LaneProto";

// 流量入口
message TrafficEntry {
  // 标记流量入口类型
  // type == "polarismesh.cn/gateway/spring-cloud-gateway", 则 selector 为
  // ServiceGatewaySelector type == "polarismesh.cn/service, 则 selector 为
  // ServiceSelector
  string type = 1;
  google.protobuf.Any selector = 2;
}

// 微服务网关入口定义
message ServiceGatewaySelector {
  string namespace = 1;
  string service = 2;
  // 决定要不要部份
  map<string, MatchString> labels = 3;
}

// 普通服务入口定义
message ServiceSelector {
  string namespace = 1;
  string service = 2;
  // 决定要不要部份
  map<string, MatchString> labels = 3;
}

// 泳道组实体定义
message LaneGroup {
  // 泳道组 ID
  string id = 1;
  // 泳道组名称
  string name = 2;
  // 泳道组内的流量入口信息
  repeated TrafficEntry entries = 3;
  // 在泳道组内的服务列表信息
  repeated DestinationGroup destinations = 4;
  // 泳道组描述信息
  string revision = 7;
  // 泳道组描述信息
  string description = 8;
  // 泳道组的创建时间
  string ctime = 9;
  // 泳道组的更新时间
  string mtime = 10;
  // 泳道组内的流量入口信息
  repeated LaneRule rules = 11;
  // 泳道组标签信息
  map<string, string> metadata = 12;
  // 基线实例的过滤策略，默认为不带有标签KEY的实例属于该泳道
  enum BaselineFilterStrategy {
    // 带有标签KEY的实例属于该泳道
    NOT_MATCH_KEY = 0;
    // 匹配上KEY和VALUE的实例才属于该泳道
    NOT_MATCH_KEY_VALUES = 1;
  }
  BaselineFilterStrategy baselineFilterStrategy = 13 [ json_name = "baseline_filter_strategy" ];

  // 操作标志位
  bool editable = 20 [ json_name = "editable" ];
  bool deleteable = 21 [ json_name = "deleteable" ];
}

// TrafficMatchRule 流量匹配规则
message TrafficMatchRule {
  // 流量匹配规则，判断哪些流量需要进入泳道
  repeated SourceMatch arguments = 4;
  // 多个 SourceMatch 之间的判断关系
  enum TrafficMatchMode {
    // 与模式
    AND = 0;
    // 或模式
    OR = 1;
  }
  TrafficMatchMode matchMode = 14;
}

// 泳道规则
message LaneRule {
  string id = 1;
  string name = 2;
  // 所属泳道组的名称
  string group_name = 3;
  // 流量匹配规则
  TrafficMatchRule traffic_match_rule = 4;
  // 保存这个泳道的默认实例标签
  string default_label_value = 5;
  // 泳道规则是否启用
  bool enable = 6;
  enum LaneMatchMode {
    // 严格匹配模式
    STRICT = 0;
    // 宽松匹配模式
    PERMISSIVE = 1;
  }
  LaneMatchMode match_mode = 7;
  // revision routing version
  string revision = 8;
  // ctime create time of the rules
  string ctime = 9;
  // mtime modify time of the rules
  string mtime = 10;
  // etime enable time of the rules
  string etime = 11;
  // priority rules priority
  uint32 priority = 12;
  // description simple description rules
  string description = 13;
  // 属于该泳道的实例标签值，只要匹配上其中一个标签，就代表这个实例属于这个泳道
  // 如果为空，则使用default_label_value
  repeated string label_values = 14;
  // 属于该泳道的实例标签KEY，默认为lane
  string label_key = 15;
}