[WIP] Add mirror gateway definition

apis/docs/v1/docs.md

@@ -49,6 +49,9 @@
     - [Insert.MultiRequest](#payload-v1-Insert-MultiRequest)
     - [Insert.ObjectRequest](#payload-v1-Insert-ObjectRequest)
     - [Insert.Request](#payload-v1-Insert-Request)
+    - [Mirror](#payload-v1-Mirror)
+    - [Mirror.Request](#payload-v1-Mirror-Request)
+    - [Mirror.Target](#payload-v1-Mirror-Target)
     - [Object](#payload-v1-Object)
     - [Object.Blob](#payload-v1-Object-Blob)
     - [Object.Distance](#payload-v1-Object-Distance)
@@ -113,6 +116,9 @@
 - [apis/proto/v1/vald/upsert.proto](#apis_proto_v1_vald_upsert-proto)
     - [Upsert](#vald-v1-Upsert)
 
+- [apis/proto/v1/mirro/mirro.proto](#apis_proto_v1_mirro_mirro-proto)
+    - [Mirror](#mirror-v1-Mirror)
+
 - [Scalar Value Types](#scalar-value-types)
 
 
@@ -676,6 +682,47 @@ Represent the insert request.
 
 
 
+<a name="payload-v1-Mirror"></a>
+
+### Mirror
+Mirror related messages.
+
+
+
+
+
+
+<a name="payload-v1-Mirror-Request"></a>
+
+### Mirror.Request
+Represent the mirror request.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| targets | [Mirror.Target](#payload-v1-Mirror-Target) | repeated | The mirror server targets. |
+
+
+
+
+
+
+<a name="payload-v1-Mirror-Target"></a>
+
+### Mirror.Target
+Represent server information.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| ip | [string](#string) |  | The target ip. |
+| port | [uint32](#uint32) |  | The target port. |
+
+
+
+
+
+
 <a name="payload-v1-Object"></a>
 
 ### Object
@@ -1540,6 +1587,32 @@ Upsert service provides ways to insert/update vectors.
 
 
 
+<a name="apis_proto_v1_mirro_mirro-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+
+## apis/proto/v1/mirro/mirro.proto
+
+
+
+
+
+
+
+
+
+<a name="mirror-v1-Mirror"></a>
+
+### Mirror
+Represent the mirror service.
+
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| Register | [.payload.v1.Mirror.Request](#payload-v1-Mirror-Request) | [.payload.v1.Empty](#payload-v1-Empty) | Register the RPC to register other mirror servers. |
+
+
+
+
+
 ## Scalar Value Types
 
 | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |

apis/grpc/v1/mirror/mirro.pb.go

@@ -0,0 +1,98 @@
+//
+// Copyright (C) 2019-2022 vdaas.org vald team <[email protected]>
+//
+// 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
+//
+//    https://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.
+//
+
+package mirror
+
+import (
+	reflect "reflect"
+
+	payload "github.com/vdaas/vald/apis/grpc/v1/payload"
+	_ "google.golang.org/genproto/googleapis/api/annotations"
+	protoreflect "google.golang.org/protobuf/reflect/protoreflect"
+	protoimpl "google.golang.org/protobuf/runtime/protoimpl"
+)
+
+const (
+	// Verify that this generated code is sufficiently up-to-date.
+	_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
+	// Verify that runtime/protoimpl is sufficiently up-to-date.
+	_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
+)
+
+var File_apis_proto_v1_mirro_mirro_proto protoreflect.FileDescriptor
+
+var file_apis_proto_v1_mirro_mirro_proto_rawDesc = []byte{
+	0x0a, 0x1f, 0x61, 0x70, 0x69, 0x73, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x2f, 0x76, 0x31, 0x2f,
+	0x6d, 0x69, 0x72, 0x72, 0x6f, 0x2f, 0x6d, 0x69, 0x72, 0x72, 0x6f, 0x2e, 0x70, 0x72, 0x6f, 0x74,
+	0x6f, 0x12, 0x09, 0x6d, 0x69, 0x72, 0x72, 0x6f, 0x72, 0x2e, 0x76, 0x31, 0x1a, 0x23, 0x61, 0x70,
+	0x69, 0x73, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x2f, 0x76, 0x31, 0x2f, 0x70, 0x61, 0x79, 0x6c,
+	0x6f, 0x61, 0x64, 0x2f, 0x70, 0x61, 0x79, 0x6c, 0x6f, 0x61, 0x64, 0x2e, 0x70, 0x72, 0x6f, 0x74,
+	0x6f, 0x1a, 0x3d, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x67, 0x6f,
+	0x6f, 0x67, 0x6c, 0x65, 0x61, 0x70, 0x69, 0x73, 0x2f, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x61,
+	0x70, 0x69, 0x73, 0x2f, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x61,
+	0x6e, 0x6e, 0x6f, 0x74, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x73, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f,
+	0x32, 0x60, 0x0a, 0x06, 0x4d, 0x69, 0x72, 0x72, 0x6f, 0x72, 0x12, 0x56, 0x0a, 0x08, 0x52, 0x65,
+	0x67, 0x69, 0x73, 0x74, 0x65, 0x72, 0x12, 0x1a, 0x2e, 0x70, 0x61, 0x79, 0x6c, 0x6f, 0x61, 0x64,
+	0x2e, 0x76, 0x31, 0x2e, 0x4d, 0x69, 0x72, 0x72, 0x6f, 0x72, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65,
+	0x73, 0x74, 0x1a, 0x11, 0x2e, 0x70, 0x61, 0x79, 0x6c, 0x6f, 0x61, 0x64, 0x2e, 0x76, 0x31, 0x2e,
+	0x45, 0x6d, 0x70, 0x74, 0x79, 0x22, 0x1b, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x15, 0x22, 0x10, 0x2f,
+	0x6d, 0x69, 0x72, 0x72, 0x6f, 0x72, 0x2f, 0x72, 0x65, 0x67, 0x69, 0x73, 0x74, 0x65, 0x72, 0x3a,
+	0x01, 0x2a, 0x42, 0x57, 0x0a, 0x1c, 0x6f, 0x72, 0x67, 0x2e, 0x76, 0x64, 0x61, 0x61, 0x73, 0x2e,
+	0x76, 0x61, 0x6c, 0x64, 0x2e, 0x61, 0x70, 0x69, 0x2e, 0x76, 0x31, 0x2e, 0x6d, 0x69, 0x72, 0x72,
+	0x6f, 0x72, 0x42, 0x0a, 0x56, 0x61, 0x6c, 0x64, 0x4d, 0x69, 0x72, 0x72, 0x6f, 0x72, 0x50, 0x01,
+	0x5a, 0x29, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x76, 0x64, 0x61,
+	0x61, 0x73, 0x2f, 0x76, 0x61, 0x6c, 0x64, 0x2f, 0x61, 0x70, 0x69, 0x73, 0x2f, 0x67, 0x72, 0x70,
+	0x63, 0x2f, 0x76, 0x31, 0x2f, 0x6d, 0x69, 0x72, 0x72, 0x6f, 0x72, 0x62, 0x06, 0x70, 0x72, 0x6f,
+	0x74, 0x6f, 0x33,
+}
+
+var file_apis_proto_v1_mirro_mirro_proto_goTypes = []interface{}{
+	(*payload.Mirror_Request)(nil), // 0: payload.v1.Mirror.Request
+	(*payload.Empty)(nil),          // 1: payload.v1.Empty
+}
+var file_apis_proto_v1_mirro_mirro_proto_depIdxs = []int32{
+	0, // 0: mirror.v1.Mirror.Register:input_type -> payload.v1.Mirror.Request
+	1, // 1: mirror.v1.Mirror.Register:output_type -> payload.v1.Empty
+	1, // [1:2] is the sub-list for method output_type
+	0, // [0:1] is the sub-list for method input_type
+	0, // [0:0] is the sub-list for extension type_name
+	0, // [0:0] is the sub-list for extension extendee
+	0, // [0:0] is the sub-list for field type_name
+}
+
+func init() { file_apis_proto_v1_mirro_mirro_proto_init() }
+func file_apis_proto_v1_mirro_mirro_proto_init() {
+	if File_apis_proto_v1_mirro_mirro_proto != nil {
+		return
+	}
+	type x struct{}
+	out := protoimpl.TypeBuilder{
+		File: protoimpl.DescBuilder{
+			GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
+			RawDescriptor: file_apis_proto_v1_mirro_mirro_proto_rawDesc,
+			NumEnums:      0,
+			NumMessages:   0,
+			NumExtensions: 0,
+			NumServices:   1,
+		},
+		GoTypes:           file_apis_proto_v1_mirro_mirro_proto_goTypes,
+		DependencyIndexes: file_apis_proto_v1_mirro_mirro_proto_depIdxs,
+	}.Build()
+	File_apis_proto_v1_mirro_mirro_proto = out.File
+	file_apis_proto_v1_mirro_mirro_proto_rawDesc = nil
+	file_apis_proto_v1_mirro_mirro_proto_goTypes = nil
+	file_apis_proto_v1_mirro_mirro_proto_depIdxs = nil
+}

apis/grpc/v1/mirror/mirro_vtproto.pb.go

@@ -0,0 +1,127 @@
+//
+// Copyright (C) 2019-2022 vdaas.org vald team <[email protected]>
+//
+// 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
+//
+//    https://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.
+//
+
+package mirror
+
+import (
+	context "context"
+
+	payload "github.com/vdaas/vald/apis/grpc/v1/payload"
+	codes "github.com/vdaas/vald/internal/net/grpc/codes"
+	status "github.com/vdaas/vald/internal/net/grpc/status"
+	grpc "google.golang.org/grpc"
+	protoimpl "google.golang.org/protobuf/runtime/protoimpl"
+)
+
+const (
+	// Verify that this generated code is sufficiently up-to-date.
+	_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
+	// Verify that runtime/protoimpl is sufficiently up-to-date.
+	_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
+)
+
+// This is a compile-time assertion to ensure that this generated file
+// is compatible with the grpc package it is being compiled against.
+// Requires gRPC-Go v1.32.0 or later.
+const _ = grpc.SupportPackageIsVersion7
+
+// MirrorClient is the client API for Mirror service.
+//
+// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
+type MirrorClient interface {
+	// Register the RPC to register other mirror servers.
+	Register(ctx context.Context, in *payload.Mirror_Request, opts ...grpc.CallOption) (*payload.Empty, error)
+}
+
+type mirrorClient struct {
+	cc grpc.ClientConnInterface
+}
+
+func NewMirrorClient(cc grpc.ClientConnInterface) MirrorClient {
+	return &mirrorClient{cc}
+}
+
+func (c *mirrorClient) Register(ctx context.Context, in *payload.Mirror_Request, opts ...grpc.CallOption) (*payload.Empty, error) {
+	out := new(payload.Empty)
+	err := c.cc.Invoke(ctx, "/mirror.v1.Mirror/Register", in, out, opts...)
+	if err != nil {
+		return nil, err
+	}
+	return out, nil
+}
+
+// MirrorServer is the server API for Mirror service.
+// All implementations must embed UnimplementedMirrorServer
+// for forward compatibility
+type MirrorServer interface {
+	// Register the RPC to register other mirror servers.
+	Register(context.Context, *payload.Mirror_Request) (*payload.Empty, error)
+	mustEmbedUnimplementedMirrorServer()
+}
+
+// UnimplementedMirrorServer must be embedded to have forward compatible implementations.
+type UnimplementedMirrorServer struct {
+}
+
+func (UnimplementedMirrorServer) Register(context.Context, *payload.Mirror_Request) (*payload.Empty, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method Register not implemented")
+}
+func (UnimplementedMirrorServer) mustEmbedUnimplementedMirrorServer() {}
+
+// UnsafeMirrorServer may be embedded to opt out of forward compatibility for this service.
+// Use of this interface is not recommended, as added methods to MirrorServer will
+// result in compilation errors.
+type UnsafeMirrorServer interface {
+	mustEmbedUnimplementedMirrorServer()
+}
+
+func RegisterMirrorServer(s grpc.ServiceRegistrar, srv MirrorServer) {
+	s.RegisterService(&Mirror_ServiceDesc, srv)
+}
+
+func _Mirror_Register_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+	in := new(payload.Mirror_Request)
+	if err := dec(in); err != nil {
+		return nil, err
+	}
+	if interceptor == nil {
+		return srv.(MirrorServer).Register(ctx, in)
+	}
+	info := &grpc.UnaryServerInfo{
+		Server:     srv,
+		FullMethod: "/mirror.v1.Mirror/Register",
+	}
+	handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+		return srv.(MirrorServer).Register(ctx, req.(*payload.Mirror_Request))
+	}
+	return interceptor(ctx, in, info, handler)
+}
+
+// Mirror_ServiceDesc is the grpc.ServiceDesc for Mirror service.
+// It's only intended for direct use with grpc.RegisterService,
+// and not to be introspected or modified (even as a copy)
+var Mirror_ServiceDesc = grpc.ServiceDesc{
+	ServiceName: "mirror.v1.Mirror",
+	HandlerType: (*MirrorServer)(nil),
+	Methods: []grpc.MethodDesc{
+		{
+			MethodName: "Register",
+			Handler:    _Mirror_Register_Handler,
+		},
+	},
+	Streams:  []grpc.StreamDesc{},
+	Metadata: "apis/proto/v1/mirro/mirro.proto",
+}