config tips and config distinctions & help reminder

.gitignore

@@ -1,3 +1,14 @@
 /bin
 cover.out
 coverage.txt
+
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Go workspace file
+go.work
+.idea/

README.md

@@ -204,6 +204,6 @@ More ui in [img](./document/img/)
 
 ### Documents
 - [Contributing](./CONTRIBUTING.md), contributing details
-- [Config](./config/app.yaml), your can enable docker/kubernetes in config
+- [Config](config/dev_config.yaml), your can enable docker/kubernetes in config
 - [OAuth](./document/oauth.md)
 - [RBAC](./document/authentication.md)

README_zh.md

@@ -191,6 +191,6 @@ make docker-run-ui
 
 ### 文档
 - [Contributing](./CONTRIBUTING.md)，为此项目提交贡献
-- [Config](./config/app.yaml), 配置对应功能是否开启
+- [Config](config/dev_config.yaml), 配置对应功能是否开启
 - [OAuth](./document/oauth.md)
 - [RBAC](./document/authentication.md)

config/prod_config.yaml

@@ -0,0 +1,45 @@
+server:
+  env: "debug"
+  address: "127.0.0.1"
+  port: 8080
+  gracefulShutdownPeriod: 30
+  rateLimits:
+    - limitType: "server"
+      burst: 500
+      qps: 100
+      cacheSize: 1
+    - limitType: "ip"
+      burst: 50
+      qps: 10
+      cacheSize: 2048
+  jwtSecret: weaveserver
+
+docker:
+  enable: true # enable docker, start dockerd at first
+  host: unix:///var/run/docker.sock
+
+kubernetes:
+  enable: true # set `KUBECONFIG` env or flag --kubeconfig at first
+  watchResources:
+  - "Deployment.v1.apps"
+  - "Pod.v1."
+  - "Namespace.v1."
+
+db:
+  port: 5432 
+  host: "localhost"
+  name: "weave"
+  user: "postgres"
+  password: "123456"
+  migrate: true
+
+redis:
+  enable: true
+  port: 6379 
+  host: "localhost"
+  password: "123456"
+
+oauth:
+  github:
+    clientId: "85db232fde2c9320ece7" # set your client id
+    clientSecret: "" # set your client secret

main.go

@@ -12,8 +12,9 @@ import (
 )
 
 var (
-	printVersion = flag.Bool("v", false, "print version")
-	appConfig    = flag.String("config", "config/app.yaml", "application config path")
+	defaultConfigPath = "config/dev_config.yaml"
+	printVersion      = flag.Bool("v", false, "print version")
+	appConfig         = flag.String("config", defaultConfigPath, "application config path")
 )
 
 // @title           Weave Server API
@@ -45,6 +46,10 @@ func main() {
 		logger.Fatalf("Failed to parse config: %v", err)
 	}
 
+	if *appConfig != defaultConfigPath {
+		version.ConfigPathPrint()
+	}
+
 	s, err := server.New(conf, logger)
 	if err != nil {
 		logger.Fatalf("Init server failed: %v", err)

pkg/version/version.go

@@ -48,3 +48,7 @@ func Print() {
 func Get() *Version {
 	return version
 }
+
+func ConfigPathPrint() {
+	fmt.Println("setting application config path successfully!")
+}