refactor: rename config folder

Dockerfile

@@ -15,7 +15,7 @@ WORKDIR /pipeline-backend
 COPY --from=build /go/src/internal/db/migration ./internal/db/migration
 COPY --from=build /pipeline-backend-migrate ./
 
-COPY --from=build /go/src/configs ./configs
+COPY --from=build /go/src/config ./config
 COPY --from=build /pipeline-backend ./
 
 ENTRYPOINT ["./pipeline-backend"]

cmd/main/main.go

@@ -22,7 +22,7 @@ import (
 	grpc_zap "github.com/grpc-ecosystem/go-grpc-middleware/logging/zap"
 	grpc_recovery "github.com/grpc-ecosystem/go-grpc-middleware/recovery"
 
-	"github.com/instill-ai/pipeline-backend/configs"
+	"github.com/instill-ai/pipeline-backend/config"
 	"github.com/instill-ai/pipeline-backend/internal/external"
 	"github.com/instill-ai/pipeline-backend/internal/logger"
 	"github.com/instill-ai/pipeline-backend/internal/temporal"
@@ -53,7 +53,7 @@ func main() {
 	defer logger.Sync() //nolint
 	grpc_zap.ReplaceGrpcLoggerV2(logger)
 
-	if err := configs.Init(); err != nil {
+	if err := config.Init(); err != nil {
 		logger.Fatal(err.Error())
 	}
 
@@ -69,8 +69,8 @@ func main() {
 	// Create tls based credential.
 	var creds credentials.TransportCredentials
 	var err error
-	if configs.Config.Server.HTTPS.Cert != "" && configs.Config.Server.HTTPS.Key != "" {
-		creds, err = credentials.NewServerTLSFromFile(configs.Config.Server.HTTPS.Cert, configs.Config.Server.HTTPS.Key)
+	if config.Config.Server.HTTPS.Cert != "" && config.Config.Server.HTTPS.Key != "" {
+		creds, err = credentials.NewServerTLSFromFile(config.Config.Server.HTTPS.Cert, config.Config.Server.HTTPS.Key)
 		if err != nil {
 			logger.Fatal(fmt.Sprintf("failed to create credentials: %v", err))
 		}
@@ -102,7 +102,7 @@ func main() {
 			grpc_recovery.UnaryServerInterceptor(recoveryInterceptorOpt()),
 		)),
 	}
-	if configs.Config.Server.HTTPS.Cert != "" && configs.Config.Server.HTTPS.Key != "" {
+	if config.Config.Server.HTTPS.Cert != "" && config.Config.Server.HTTPS.Key != "" {
 		grpcServerOpts = append(grpcServerOpts, grpc.Creds(creds))
 	}
 
@@ -142,27 +142,27 @@ func main() {
 	}
 
 	var dialOpts []grpc.DialOption
-	if configs.Config.Server.HTTPS.Cert != "" && configs.Config.Server.HTTPS.Key != "" {
+	if config.Config.Server.HTTPS.Cert != "" && config.Config.Server.HTTPS.Key != "" {
 		dialOpts = []grpc.DialOption{grpc.WithTransportCredentials(creds)}
 	} else {
 		dialOpts = []grpc.DialOption{grpc.WithTransportCredentials(insecure.NewCredentials())}
 	}
 
-	if err := pipelinePB.RegisterPipelineServiceHandlerFromEndpoint(ctx, gwS, fmt.Sprintf(":%v", configs.Config.Server.Port), dialOpts); err != nil {
+	if err := pipelinePB.RegisterPipelineServiceHandlerFromEndpoint(ctx, gwS, fmt.Sprintf(":%v", config.Config.Server.Port), dialOpts); err != nil {
 		logger.Fatal(err.Error())
 	}
 
 	httpServer := &http.Server{
-		Addr:    fmt.Sprintf(":%v", configs.Config.Server.Port),
+		Addr:    fmt.Sprintf(":%v", config.Config.Server.Port),
 		Handler: grpcHandlerFunc(grpcS, gwS),
 	}
 
 	// Wait for interrupt signal to gracefully shutdown the server with a timeout of 5 seconds.
 	quitSig := make(chan os.Signal, 1)
 	errSig := make(chan error)
-	if configs.Config.Server.HTTPS.Cert != "" && configs.Config.Server.HTTPS.Key != "" {
+	if config.Config.Server.HTTPS.Cert != "" && config.Config.Server.HTTPS.Key != "" {
 		go func() {
-			if err := httpServer.ListenAndServeTLS(configs.Config.Server.HTTPS.Cert, configs.Config.Server.HTTPS.Key); err != nil {
+			if err := httpServer.ListenAndServeTLS(config.Config.Server.HTTPS.Cert, config.Config.Server.HTTPS.Key); err != nil {
 				errSig <- err
 			}
 		}()

cmd/migration/main.go

@@ -10,10 +10,10 @@ import (
 	_ "github.com/golang-migrate/migrate/v4/database/postgres"
 	_ "github.com/golang-migrate/migrate/v4/source/file"
 
-	"github.com/instill-ai/pipeline-backend/configs"
+	"github.com/instill-ai/pipeline-backend/config"
 )
 
-func checkExist(databaseConfig configs.DatabaseConfig) error {
+func checkExist(databaseConfig config.DatabaseConfig) error {
 	db, err := sql.Open(
 		"postgres",
 		fmt.Sprintf("host=%s user=%s password=%s dbname=postgres port=%d sslmode=disable TimeZone=%s",
@@ -75,11 +75,11 @@ func checkExist(databaseConfig configs.DatabaseConfig) error {
 func main() {
 	migrateFolder, _ := os.Getwd()
 
-	if err := configs.Init(); err != nil {
+	if err := config.Init(); err != nil {
 		panic(err)
 	}
 
-	databaseConfig := configs.Config.Database
+	databaseConfig := config.Config.Database
 
 	if err := checkExist(databaseConfig); err != nil {
 		panic(err)

configs/configs.go → config/config.go

@@ -1,4 +1,4 @@
-package configs
+package config
 
 import (
 	"flag"
@@ -109,7 +109,7 @@ func Init() error {
 	parser := yaml.Parser()
 
 	fs := flag.NewFlagSet(os.Args[0], flag.ExitOnError)
-	fileRelativePath := fs.String("file", "configs/config.yaml", "configuration file")
+	fileRelativePath := fs.String("file", "config/config.yaml", "configuration file")
 	flag.Parse()
 
 	if err := k.Load(file.Provider(*fileRelativePath), parser); err != nil {

configs/models/pipeline.json → config/models/pipeline.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft-07/schema",
-  "$id": "https://github.com/instill-ai/pipeline-backend/blob/main/configs/models/pipeline.json",
+  "$id": "https://github.com/instill-ai/pipeline-backend/blob/main/config/models/pipeline.json",
   "title": "Pipeline",
   "description": "End-to-end data pipeline",
   "type": "object",

docker-compose.yml

@@ -71,7 +71,7 @@ services:
       CFG_DATABASE_USERNAME: postgres
       CFG_DATABASE_PASSWORD: password
     volumes:
-      - ./configs:/pipeline-backend/configs
+      - ./config:/pipeline-backend/config
     entrypoint: ./pipeline-backend-migrate
     depends_on:
       pg_sql:
@@ -96,7 +96,7 @@ services:
     ports:
       - 8081:8081
     volumes:
-      - ./configs:/pipeline-backend/configs
+      - ./config:/pipeline-backend/config
     depends_on:
       - pipeline_backend_migrate
       - mgmt_backend

internal/cache/cache.go

@@ -3,13 +3,13 @@ package cache
 import (
 	"github.com/go-redis/redis/v8"
 
-	"github.com/instill-ai/pipeline-backend/configs"
+	"github.com/instill-ai/pipeline-backend/config"
 )
 
 var Redis *redis.Client
 
 func Init() {
-	Redis = redis.NewClient(&configs.Config.Cache.Redis.RedisOptions)
+	Redis = redis.NewClient(&config.Config.Cache.Redis.RedisOptions)
 }
 
 func Close() {

internal/db/db.go

@@ -9,15 +9,15 @@ import (
 	"gorm.io/gorm"
 	"gorm.io/gorm/schema"
 
-	configs "github.com/instill-ai/pipeline-backend/configs"
+	"github.com/instill-ai/pipeline-backend/config"
 )
 
 var db *gorm.DB
 var once sync.Once
 
 func GetConnection() *gorm.DB {
 	once.Do(func() {
-		databaseConfig := configs.Config.Database
+		databaseConfig := config.Config.Database
 		dsn := fmt.Sprintf("host=%s user=%s password=%s dbname=%s port=%d sslmode=disable TimeZone=%s",
 			databaseConfig.Host,
 			databaseConfig.Username,

internal/external/external.go

@@ -7,7 +7,7 @@ import (
 	"google.golang.org/grpc/credentials"
 	"google.golang.org/grpc/credentials/insecure"
 
-	"github.com/instill-ai/pipeline-backend/configs"
+	"github.com/instill-ai/pipeline-backend/config"
 	"github.com/instill-ai/pipeline-backend/internal/logger"
 
 	connectorPB "github.com/instill-ai/protogen-go/connector/v1alpha"
@@ -22,8 +22,8 @@ func InitUserServiceClient() mgmtPB.UserServiceClient {
 	var clientDialOpts grpc.DialOption
 	var creds credentials.TransportCredentials
 	var err error
-	if configs.Config.MgmtBackend.HTTPS.Cert != "" && configs.Config.MgmtBackend.HTTPS.Key != "" {
-		creds, err = credentials.NewServerTLSFromFile(configs.Config.MgmtBackend.HTTPS.Cert, configs.Config.MgmtBackend.HTTPS.Key)
+	if config.Config.MgmtBackend.HTTPS.Cert != "" && config.Config.MgmtBackend.HTTPS.Key != "" {
+		creds, err = credentials.NewServerTLSFromFile(config.Config.MgmtBackend.HTTPS.Cert, config.Config.MgmtBackend.HTTPS.Key)
 		if err != nil {
 			logger.Fatal(err.Error())
 		}
@@ -32,7 +32,7 @@ func InitUserServiceClient() mgmtPB.UserServiceClient {
 		clientDialOpts = grpc.WithTransportCredentials(insecure.NewCredentials())
 	}
 
-	clientConn, err := grpc.Dial(fmt.Sprintf("%v:%v", configs.Config.MgmtBackend.Host, configs.Config.MgmtBackend.Port), clientDialOpts)
+	clientConn, err := grpc.Dial(fmt.Sprintf("%v:%v", config.Config.MgmtBackend.Host, config.Config.MgmtBackend.Port), clientDialOpts)
 	if err != nil {
 		logger.Fatal(err.Error())
 	}
@@ -47,8 +47,8 @@ func InitConnectorServiceClient() connectorPB.ConnectorServiceClient {
 	var clientDialOpts grpc.DialOption
 	var creds credentials.TransportCredentials
 	var err error
-	if configs.Config.ConnectorBackend.HTTPS.Cert != "" && configs.Config.ConnectorBackend.HTTPS.Key != "" {
-		creds, err = credentials.NewServerTLSFromFile(configs.Config.ConnectorBackend.HTTPS.Cert, configs.Config.ConnectorBackend.HTTPS.Key)
+	if config.Config.ConnectorBackend.HTTPS.Cert != "" && config.Config.ConnectorBackend.HTTPS.Key != "" {
+		creds, err = credentials.NewServerTLSFromFile(config.Config.ConnectorBackend.HTTPS.Cert, config.Config.ConnectorBackend.HTTPS.Key)
 		if err != nil {
 			logger.Fatal(err.Error())
 		}
@@ -57,7 +57,7 @@ func InitConnectorServiceClient() connectorPB.ConnectorServiceClient {
 		clientDialOpts = grpc.WithTransportCredentials(insecure.NewCredentials())
 	}
 
-	clientConn, err := grpc.Dial(fmt.Sprintf("%v:%v", configs.Config.ConnectorBackend.Host, configs.Config.ConnectorBackend.Port), clientDialOpts)
+	clientConn, err := grpc.Dial(fmt.Sprintf("%v:%v", config.Config.ConnectorBackend.Host, config.Config.ConnectorBackend.Port), clientDialOpts)
 	if err != nil {
 		logger.Fatal(err.Error())
 	}
@@ -72,8 +72,8 @@ func InitModelServiceClient() modelPB.ModelServiceClient {
 	var clientDialOpts grpc.DialOption
 	var creds credentials.TransportCredentials
 	var err error
-	if configs.Config.ModelBackend.HTTPS.Cert != "" && configs.Config.ModelBackend.HTTPS.Key != "" {
-		creds, err = credentials.NewServerTLSFromFile(configs.Config.ModelBackend.HTTPS.Cert, configs.Config.ModelBackend.HTTPS.Key)
+	if config.Config.ModelBackend.HTTPS.Cert != "" && config.Config.ModelBackend.HTTPS.Key != "" {
+		creds, err = credentials.NewServerTLSFromFile(config.Config.ModelBackend.HTTPS.Cert, config.Config.ModelBackend.HTTPS.Key)
 		if err != nil {
 			logger.Fatal(err.Error())
 		}
@@ -82,7 +82,7 @@ func InitModelServiceClient() modelPB.ModelServiceClient {
 		clientDialOpts = grpc.WithTransportCredentials(insecure.NewCredentials())
 	}
 
-	clientConn, err := grpc.Dial(fmt.Sprintf("%v:%v", configs.Config.ModelBackend.Host, configs.Config.ModelBackend.Port), clientDialOpts)
+	clientConn, err := grpc.Dial(fmt.Sprintf("%v:%v", config.Config.ModelBackend.Host, config.Config.ModelBackend.Port), clientDialOpts)
 	if err != nil {
 		logger.Fatal(err.Error())
 	}

internal/temporal/temporal.go

@@ -6,7 +6,7 @@ import (
 
 	"go.temporal.io/sdk/client"
 
-	"github.com/instill-ai/pipeline-backend/configs"
+	"github.com/instill-ai/pipeline-backend/config"
 	"github.com/instill-ai/pipeline-backend/internal/logger"
 	"github.com/instill-ai/pipeline-backend/pkg/datamodel"
 	"github.com/instill-ai/x/zapadapter"
@@ -23,7 +23,7 @@ func Init() {
 	// The client is a heavyweight object that should be created once per process.
 	var err error
 
-	clientOpts := configs.Config.Temporal.ClientOptions
+	clientOpts := config.Config.Temporal.ClientOptions
 	clientOpts.Logger = zapadapter.NewZapAdapter(logger)
 
 	c, err = client.NewClient(clientOpts)

pkg/datamodel/jsonschema.go

@@ -22,7 +22,7 @@ func InitJSONSchema() {
 	logger, _ := logger.GetZapLogger()
 
 	var err error
-	PipelineJSONSchema, err = jsonschema.Compile("configs/models/pipeline.json")
+	PipelineJSONSchema, err = jsonschema.Compile("config/models/pipeline.json")
 	if err != nil {
 		logger.Fatal(fmt.Sprintf("%#v\n", err.Error()))
 	}