Skip to content

Add --connect-timeout flag to katib-db-manager #1937

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

Merged
merged 1 commit into from
Aug 22, 2022
Merged

Add --connect-timeout flag to katib-db-manager #1937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion cmd/db-manager/v1beta1/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ WORKDIR /app
COPY --from=build-env /bin/grpc_health_probe /bin/
COPY --from=build-env /go/src/github.com/kubeflow/katib/katib-db-manager /app/
ENTRYPOINT ["./katib-db-manager"]
CMD ["-w", "kubernetes"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this flag not used before?

Copy link
Member Author

@tenzen-y tenzen-y Aug 22, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review! @johnugeorge
Yes, katib-db-manager can not recognize that flag.

$ docker run --platform linux/amd64 -it docker.io/kubeflowkatib/katib-db-manager:v1beta1-9c7d797 -w kubernetes
flag provided but not defined: -w
Usage of ./katib-db-manager:

9 changes: 7 additions & 2 deletions cmd/db-manager/v1beta1/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"fmt"
"net"
"os"
"time"

health_pb "github.com/kubeflow/katib/pkg/apis/manager/health"
api_pb "github.com/kubeflow/katib/pkg/apis/manager/v1beta1"
Expand All @@ -34,7 +35,8 @@ import (
)

const (
port = "0.0.0.0:6789"
port = "0.0.0.0:6789"
defaultConnectTimeout = time.Second * 60
)

var dbIf common.KatibDBInterface
Expand Down Expand Up @@ -87,14 +89,17 @@ func (s *server) Check(ctx context.Context, in *health_pb.HealthCheckRequest) (*
}

func main() {
var connectTimeout time.Duration
flag.DurationVar(&connectTimeout, "connect-timeout", defaultConnectTimeout, "Timeout before calling error during database connection. (e.g. 120s)")
flag.Parse()

var err error
dbNameEnvName := common.DBNameEnvName
dbName := os.Getenv(dbNameEnvName)
if dbName == "" {
klog.Fatal("DB_NAME env is not set. Exiting")
}
dbIf, err = db.NewKatibDBInterface(dbName)
dbIf, err = db.NewKatibDBInterface(dbName, connectTimeout)
if err != nil {
klog.Fatalf("Failed to open db connection: %v", err)
}
Expand Down
10 changes: 9 additions & 1 deletion docs/developer-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ make generate
Below is a list of command-line flags accepted by Katib controller:

| Name | Type | Default | Description |
| ------------------------------- | ------------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|---------------------------------|---------------------------|-------------------------------|------------------------------------------------------------------------------------------------------------------------|
| enable-grpc-probe-in-suggestion | bool | true | Enable grpc probe in suggestions |
| experiment-suggestion-name | string | "default" | The implementation of suggestion interface in experiment controller |
| metrics-addr | string | ":8080" | The address the metric endpoint binds to |
Expand All @@ -68,6 +68,14 @@ Below is a list of command-line flags accepted by Katib controller:
| enable-leader-election | bool | false | Enable leader election for katib-controller. Enabling this will ensure there is only one active katib-controller. |
| leader-election-id | string | "3fbc96e9.katib.kubeflow.org" | The ID for leader election. |

## DB Manager Flags

Below is a list of command-line flags accepted by Katib DB Manager:

| Name | Type | Default | Description |
|-----------------|---------------|---------|---------------------------------------------------------|
| connect-timeout | time.Duration | 60s | Timeout before calling error during database connection |

## Workflow design

Please see [workflow-design.md](./workflow-design.md).
Expand Down
1 change: 0 additions & 1 deletion pkg/db/v1beta1/common/const.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import "time"

const (
ConnectInterval = 5 * time.Second
ConnectTimeout = 60 * time.Second

DBUserEnvName = "DB_USER"
DBNameEnvName = "DB_NAME"
Expand Down
7 changes: 4 additions & 3 deletions pkg/db/v1beta1/db.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,22 @@ package db

import (
"errors"
"time"

"github.com/kubeflow/katib/pkg/db/v1beta1/common"
"github.com/kubeflow/katib/pkg/db/v1beta1/mysql"
"github.com/kubeflow/katib/pkg/db/v1beta1/postgres"
"k8s.io/klog"
)

func NewKatibDBInterface(dbName string) (common.KatibDBInterface, error) {
func NewKatibDBInterface(dbName string, connectTimeout time.Duration) (common.KatibDBInterface, error) {

if dbName == common.MySqlDBNameEnvValue {
klog.Info("Using MySQL")
return mysql.NewDBInterface()
return mysql.NewDBInterface(connectTimeout)
} else if dbName == common.PostgresSQLDBNameEnvValue {
klog.Info("Using Postgres")
return postgres.NewDBInterface()
return postgres.NewDBInterface(connectTimeout)
}
return nil, errors.New("Invalid DB Name")
}
4 changes: 2 additions & 2 deletions pkg/db/v1beta1/mysql/mysql.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ func NewWithSQLConn(db *sql.DB) (common.KatibDBInterface, error) {
return d, nil
}

func NewDBInterface() (common.KatibDBInterface, error) {
db, err := common.OpenSQLConn(dbDriver, getDbName(), common.ConnectInterval, common.ConnectTimeout)
func NewDBInterface(connectTimeout time.Duration) (common.KatibDBInterface, error) {
db, err := common.OpenSQLConn(dbDriver, getDbName(), common.ConnectInterval, connectTimeout)
if err != nil {
return nil, fmt.Errorf("DB open failed: %v", err)
}
Expand Down
6 changes: 3 additions & 3 deletions pkg/db/v1beta1/postgres/postgres.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ func getDbName() string {
common.PostgreSQLDBHostEnvName, common.DefaultPostgreSQLHost)
dbPort := env.GetEnvOrDefault(
common.PostgreSQLDBPortEnvName, common.DefaultPostgreSQLPort)
dbName := env.GetEnvOrDefault(common.DefaultPostgreSQLDatabase,
dbName := env.GetEnvOrDefault(common.PostgreSQLDatabase,
common.DefaultPostgreSQLDatabase)

psqlInfo := fmt.Sprintf("host=%s port=%s user=%s "+
Expand All @@ -59,8 +59,8 @@ func getDbName() string {
return psqlInfo
}

func NewDBInterface() (common.KatibDBInterface, error) {
db, err := common.OpenSQLConn(dbDriver, getDbName(), common.ConnectInterval, common.ConnectTimeout)
func NewDBInterface(connectTimeout time.Duration) (common.KatibDBInterface, error) {
db, err := common.OpenSQLConn(dbDriver, getDbName(), common.ConnectInterval, connectTimeout)
if err != nil {
return nil, fmt.Errorf("DB open failed: %v", err)
}
Expand Down