GRPC: Rename Manager to DBManager service (#1279)

* Rename Manager to DBManager in gRPC * Update git ignore
kubeflow · Jul 25, 2020 · 27658a7 · 27658a7
1 parent 9320b4e
commit 27658a7
Show file tree

Hide file tree

Showing 22 changed files with 259 additions and 498 deletions.
diff --git a/.gitignore b/.gitignore
@@ -66,4 +66,5 @@ ehthumbs_vista.db
 $RECYCLE.BIN/
 
 /katib-controller
-/katib-manager
+/katib-db-manager
+/katib-ui
diff --git a/cmd/db-manager/v1beta1/main.go b/cmd/db-manager/v1beta1/main.go
@@ -91,7 +91,7 @@ func main() {
 	size := 1<<31 - 1
 	klog.Infof("Start Katib manager: %s", port)
 	s := grpc.NewServer(grpc.MaxRecvMsgSize(size), grpc.MaxSendMsgSize(size))
-	api_pb.RegisterManagerServer(s, &server{})
+	api_pb.RegisterDBManagerServer(s, &server{})
 	health_pb.RegisterHealthServer(s, &server{})
 	reflection.Register(s)
 	if err = s.Serve(listener); err != nil {

diff --git a/cmd/metricscollector/v1beta1/file-metricscollector/main.go b/cmd/metricscollector/v1beta1/file-metricscollector/main.go
@@ -102,7 +102,7 @@ func main() {
 		klog.Fatalf("could not connect: %v", err)
 	}
 	defer conn.Close()
-	c := api.NewManagerClient(conn)
+	c := api.NewDBManagerClient(conn)
 	ctx := context.Background()
 	var metricList []string
 	if len(*metricNames) != 0 {

diff --git a/cmd/metricscollector/v1beta1/tfevent-metricscollector/main.py b/cmd/metricscollector/v1beta1/tfevent-metricscollector/main.py
@@ -1,7 +1,6 @@
 import grpc
 import argparse
 import api_pb2
-import api_pb2_grpc
 from pns import WaitOtherMainProcesses
 from tfevent_loader import MetricsCollector
 from logging import getLogger, StreamHandler, INFO
@@ -45,7 +44,7 @@ def parse_options():
     channel = grpc.beta.implementations.insecure_channel(
         manager_server[0], int(manager_server[1]))
 
-    with api_pb2.beta_create_Manager_stub(channel) as client:
+    with api_pb2.beta_create_DBManager_stub(channel) as client:
         logger.info("In " + opt.trial_name + " " +
                     str(len(observation_log.metric_logs)) + " metrics will be reported.")
         client.ReportObservationLog(api_pb2.ReportObservationLogRequest(

diff --git a/pkg/apis/manager/README.md b/pkg/apis/manager/README.md
@@ -1,8 +1,8 @@
-# Katib API
+# Katib GRPC API
 
 Katib offers the following APIs:
 
-- Manager service is an API for core component.
+- DBManager service is an API for DB services (in v1alpha3 named Manager service).
 - Suggestion service is an API for Suggestion services.
 - EarlyStopping service is an API for EarlyStopping services.
 

diff --git a/pkg/apis/manager/v1beta1/api.pb.go b/pkg/apis/manager/v1beta1/api.pb.go
diff --git a/pkg/apis/manager/v1beta1/api.pb.gw.go b/pkg/apis/manager/v1beta1/api.pb.gw.go
diff --git a/pkg/apis/manager/v1beta1/api.proto b/pkg/apis/manager/v1beta1/api.proto
@@ -1,5 +1,5 @@
 /**
- * Katib API v1beta1
+ * Katib GRPC API v1beta1
  */
 syntax = "proto3";
 
@@ -8,12 +8,9 @@ package api.v1.beta1;
 import "google/api/annotations.proto";
 
 /**
- * Service for Main API for Katib
- * For each RPC service, we define mapping to HTTP REST API method.
- * The mapping includes the URL path, query parameters and request body.
- * https://cloud.google.com/service-infrastructure/docs/service-management/reference/rpc/google.api#http
+ * DBManager service defines APIs to manage Katib database.
  */
-service Manager {
+service DBManager {
     /** 
      * Report a log of Observations for a Trial.
      * The log consists of timestamp and value of metric.
@@ -33,6 +30,9 @@ service Manager {
     rpc DeleteObservationLog(DeleteObservationLogRequest) returns (DeleteObservationLogReply);
 }
 
+/**
+ * Suggestion service defines APIs to manage Katib Suggestion objects.
+ */
 service Suggestion {
     rpc GetSuggestions(GetSuggestionsRequest) returns (GetSuggestionsReply);
     rpc ValidateAlgorithmSettings(ValidateAlgorithmSettingsRequest) returns (ValidateAlgorithmSettingsReply);

diff --git a/pkg/apis/manager/v1beta1/gen-doc/api.md b/pkg/apis/manager/v1beta1/gen-doc/api.md
@@ -43,8 +43,8 @@
     - [ParameterType](#api.v1.beta1.ParameterType)
     - [TrialStatus.TrialConditionType](#api.v1.beta1.TrialStatus.TrialConditionType)
 
+    - [DBManager](#api.v1.beta1.DBManager)
     - [EarlyStopping](#api.v1.beta1.EarlyStopping)
-    - [Manager](#api.v1.beta1.Manager)
     - [Suggestion](#api.v1.beta1.Suggestion)
 
 - [Scalar Value Types](#scalar-value-types)
@@ -55,7 +55,7 @@
 <p align="right"><a href="#top">Top</a></p>
 
 ## api.proto
-Katib API v1beta1
+Katib GRPC API v1beta1
 
 
 <a name="api.v1.beta1.AlgorithmSetting"></a>
@@ -645,34 +645,31 @@ Types of value for HyperParameter.
 
 
 
-<a name="api.v1.beta1.EarlyStopping"></a>
+<a name="api.v1.beta1.DBManager"></a>
 
-### EarlyStopping
-TODO: This feature is not yet fully implemented.
+### DBManager
+DBManager service defines APIs to manage Katib database.
 
 | Method Name | Request Type | Response Type | Description |
 | ----------- | ------------ | ------------- | ------------|
+| ReportObservationLog | [ReportObservationLogRequest](#api.v1.beta1.ReportObservationLogRequest) | [ReportObservationLogReply](#api.v1.beta1.ReportObservationLogReply) | Report a log of Observations for a Trial. The log consists of timestamp and value of metric. Katib store every log of metrics. You can see accuracy curve or other metric logs on UI. |
+| GetObservationLog | [GetObservationLogRequest](#api.v1.beta1.GetObservationLogRequest) | [GetObservationLogReply](#api.v1.beta1.GetObservationLogReply) | Get all log of Observations for a Trial. |
+| DeleteObservationLog | [DeleteObservationLogRequest](#api.v1.beta1.DeleteObservationLogRequest) | [DeleteObservationLogReply](#api.v1.beta1.DeleteObservationLogReply) | Delete all log of Observations for a Trial. |
 
 
-<a name="api.v1.beta1.Manager"></a>
+<a name="api.v1.beta1.EarlyStopping"></a>
 
-### Manager
-Service for Main API for Katib
-For each RPC service, we define mapping to HTTP REST API method.
-The mapping includes the URL path, query parameters and request body.
-https://cloud.google.com/service-infrastructure/docs/service-management/reference/rpc/google.api#http
+### EarlyStopping
+TODO: This feature is not yet fully implemented.
 
 | Method Name | Request Type | Response Type | Description |
 | ----------- | ------------ | ------------- | ------------|
-| ReportObservationLog | [ReportObservationLogRequest](#api.v1.beta1.ReportObservationLogRequest) | [ReportObservationLogReply](#api.v1.beta1.ReportObservationLogReply) | Report a log of Observations for a Trial. The log consists of timestamp and value of metric. Katib store every log of metrics. You can see accuracy curve or other metric logs on UI. |
-| GetObservationLog | [GetObservationLogRequest](#api.v1.beta1.GetObservationLogRequest) | [GetObservationLogReply](#api.v1.beta1.GetObservationLogReply) | Get all log of Observations for a Trial. |
-| DeleteObservationLog | [DeleteObservationLogRequest](#api.v1.beta1.DeleteObservationLogRequest) | [DeleteObservationLogReply](#api.v1.beta1.DeleteObservationLogReply) | Delete all log of Observations for a Trial. |
 
 
 <a name="api.v1.beta1.Suggestion"></a>
 
 ### Suggestion
-
+Suggestion service defines APIs to manage Katib Suggestion objects.
 
 | Method Name | Request Type | Response Type | Description |
 | ----------- | ------------ | ------------- | ------------|