Merge pull request #4 from rzrbld/feature/next-release

- add k8s probes

.gitignore

@@ -11,3 +11,7 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 .DS_Store
+main
+run.sh
+runc.sh
+rung.sh

README.md

@@ -20,14 +20,23 @@ it will bring up:
 after that you can go to `` http://localhost `` and try out
 
 ### Run with docker
-`` docker run rzrbld/adminio-api:0.2 ``
+```
+docker run -d \
+      -p 8080:8080 \
+      -e ADMINIO_HOST_PORT=":8080" \
+      -e MINIO_HOST_PORT="localhost:9000" \
+      -e MINIO_ACCESS="test" \
+      -e MINIO_SECRET="testtest123" \
+      rzrbld/adminio-api:latest
+
+```
 
 ### Run manually
  - [start](https://docs.min.io/) minio server
  - set env variables
- - run ./main form `dist` folder
+ - compile and run ./main form `src` folder
 
-### Env variables
+### Config Env variables
 | Variable   |      Description      |  Default |
 |--------------|:-----------------------:|-----------:|
 | `ADMINIO_HOST_PORT` | which host and port API should listening. This is Iris based API, so you will need to provide 0.0.0.0:8080 for listening on all interfaces | localhost:8080 |
@@ -48,6 +57,7 @@ after that you can go to `` http://localhost `` and try out
 | `ADMINIO_COOKIE_NAME` | name for the session cookie | adminiosessionid |
 | `ADMINIO_AUDIT_LOG_ENABLE` | enable audit log, mae sense if oauth is enabled, othervise set to false | false |
 | `ADMINIO_METRICS_ENABLE` | enable default iris\golang metrics and bucket sizes metric on /metric/ uri path | false |
+| `ADMINIO_PROBES_ENABLE` | enable liveness and readiness probes for k8s installations | false |
 
 ### Supported oauth providers
 
@@ -66,5 +76,5 @@ after that you can go to `` http://localhost `` and try out
  - wso2
 
  ### example config
-prometheus config: `examples/prometheus.yml`
-bucket policy: `examples/policy.xml` 
+ - prometheus config for adminio metrics: `examples/prometheus.yml`
+ - bucket policy: `examples/policy.xml`

src/config/config.go

@@ -22,6 +22,7 @@ var (
 	OauthEnable, _    = strconv.ParseBool(getEnv("ADMINIO_OAUTH_ENABLE", "false"))
 	AuditLogEnable, _ = strconv.ParseBool(getEnv("ADMINIO_AUDIT_LOG_ENABLE", "false"))
 	MetricsEnable, _  = strconv.ParseBool(getEnv("ADMINIO_METRICS_ENABLE", "false"))
+	ProbesEnable, _   = strconv.ParseBool(getEnv("ADMINIO_PROBES_ENABLE", "false"))
 	OauthProvider     = getEnv("ADMINIO_OAUTH_PROVIDER", "github")
 	OauthClientId     = getEnv("ADMINIO_OAUTH_CLIENT_ID", "my-github-oauth-app-client-id")
 	OauthClientSecret = getEnv("ADMINIO_OAUTH_CLIENT_SECRET", "my-github-oauth-app-secret")

src/handlers/probes.go

@@ -0,0 +1,16 @@
+package handlers
+
+import (
+	iris "github.com/kataras/iris/v12"
+	resph "github.com/rzrbld/adminio-api/response"
+)
+
+var Readiness = func(ctx iris.Context) {
+	var res = resph.DefaultResConstructor(ctx, nil)
+	ctx.JSON(res)
+}
+
+var Liveness = func(ctx iris.Context) {
+	var res = resph.DefaultResConstructor(ctx, nil)
+	ctx.JSON(res)
+}

src/main.go

@@ -65,6 +65,11 @@ func main() {
 		app.Get("/metrics", iris.FromStd(promhttp.Handler()))
 	}
 
+	if cnf.ProbesEnable {
+		app.Get("/read", hdl.Readiness)
+		app.Get("/live", hdl.Liveness)
+	}
+
 	v1auth := app.Party("/auth/", crs).AllowMethods(iris.MethodOptions)
 	{
 		v1auth.Get("/logout/", hdl.AuthLogout)