refactor code

Author: reddec

.golangci.yaml

@@ -15,7 +15,13 @@ linters:
     - nlreturn
     - cyclop
     - wrapcheck
+    - funlen
+    - errcheck
   enable-all: true
 linters-settings:
   funlen:
-    lines: 80
+    lines: 80
+  gocognit:
+    min-complexity: 90
+  gocyclo:
+    min-complexity: 50

Dockerfile

@@ -3,7 +3,7 @@ VOLUME /app/backups /app/repos /app/ssl
 WORKDIR /app
 EXPOSE 80 443
 ENV BIND=0.0.0.0:80 DOMAIN=localhost BACKUP=file:///app/backups
-RUN apk add --no-cache git docker-cli docker-compose openssl openssh-client && \
+RUN apk add --no-cache git docker docker-compose openssl openssh-client && \
     mkdir -p /root/.ssh && \
     echo -e 'Host *\n\tUserKnownHostsFile=/dev/null\n\tStrictHostKeyChecking no' > /root/.ssh/config && \
     chmod 400 /root/.ssh

Dockerfile.light

@@ -3,7 +3,7 @@ VOLUME /app/backups /app/repos /app/ssl
 WORKDIR /app
 EXPOSE 80 443
 ENV BIND=0.0.0.0:80 DOMAIN=localhost BACKUP=file:///app/backups
-RUN apk add --no-cache git docker-cli openssl openssh-client && \
+RUN apk add --no-cache git openssl openssh-client && \
     mkdir -p /root/.ssh && \
     echo -e 'Host *\n\tUserKnownHostsFile=/dev/null\n\tStrictHostKeyChecking no' > /root/.ssh/config && \
     chmod 400 /root/.ssh

Makefile

@@ -32,7 +32,6 @@ assemble-docs: build/git-pipe
 	echo '\n\n## Usage\n\n' >> README.md
 	stty rows 1024 cols 1024
 	./build/git-pipe --help | grep '  ' | sed -n -r '/^\s+[a-z]/p' | tail -n +2 | sed -E 's/^\s+([a-z]+)\s+(.*)?/* `\1` - \2/' >> README.md
-	./build/git-pipe --help | grep '  ' | sed -n -r '/^\s+[a-z]/p' | tail -n +2 | sed 's/^/* /'
 	./build/git-pipe --help | grep '  ' | sed -n -r '/^\s+[a-z]/p' | tail -n +2 | awk '{print $$1}' | xargs -n 1 -i sh -c 'echo "\n## {}\n\`\`\`" >> README.md && ./build/git-pipe "{}" --help >> README.md && echo "\`\`\`\n" >> README.md'
 
 README.md: assemble-docs

README.md

@@ -53,6 +53,12 @@ Wait a bit to finish building and go to
 * http://wordpress.wordpress-docker-compose.localhost:8080 - wordpress app
 * http://phpmyadmin.wordpress-docker-compose.localhost:8080 - for phpmyadmin app
 
+## Automatic UI/dashboard
+
+Index page automatically generated for unknown domain. Ex: http://localhost:8080
+
+![image](https://user-images.githubusercontent.com/6597086/127631968-85a8eaa9-1605-4ca0-ba52-7943da536d1a.png)
+
 
 
 ## Supported OS
@@ -70,7 +76,7 @@ Wait a bit to finish building and go to
   *  [ ] OIDC
 * [ ] support dynamic reconfiguration (over API/by file watch + signal)
 * [ ] support GitHub-like webhooks
-* [ ] lazy initialization
+* [ ] lazy initialization (ie: bring up service on request only)
 * [x] path routing as alternative to domain-based
 
 ## Installation
@@ -149,14 +155,13 @@ Flow:
 
 * Deploys all services.
 * All ports in `ports` directive will be linked as sub-domains
-* Root compose file supports optional `x-domain` attribute which overrides domain prefix. Default is repo name (or FQDN)
-  .
-* Each service with at least one port supports an optional `x-domain` attribute which overrides sub-domain. Default is
+* Each service with at least one port supports an optional `domainname` attribute which overrides sub-domain. Default is
   service name.
 * First services with attribute `x-root: yes` or with name `www`, `web`, `gateway` will be additionally exposed without
   sub-domain.
 * All exposed ports will be additionally exposed as sub-sub-domain with port name as the name.
 * Volumes automatically backup-ed and restored (see Backup)
+* Root port for service picked by the same rules as for [docker](#docker)
 
 Domains will be generated as> `<port?>.<x-domain|service>.<x-domain|project>.<root-domain>`
 and `<x-domain|project>.<root-domain>` points to `<first x-root: true|www|web|gateway>`
@@ -190,25 +195,24 @@ Generated mapping (root domain (`-d,--domain,$DOMAIN`) is `localhost`):
 * `api.mini.localhost` - points `api` service to internal port `80`
 * `80.api.mini.localhost` - same
 
-Root domain: `mini.localhost` points to `web` service to internal port `80` (the first service with name `web`, first port
-in array)
+Root domain: `mini.localhost` points to `web` service to internal port `80` (the first service with name `web`, first
+port in array)
 
 
 
 ### Override everything example
 
 ```yaml
 version: '3'
-x-domain: super
 services:
   web:
-    x-domain: index
+    domainname: index
     image: nginx
     ports:
       - 8080:80
       - 8081:9000
   api:
-    x-domain: echo
+    domainname: echo
     x-root: yes
     image: hashicorp/http-echo
     command: -listen :80 -text "web"
@@ -226,8 +230,8 @@ Generated mapping (root domain (`-d,--domain,$DOMAIN`) is `localhost`):
 * `echo.super.localhost` - points `api` service to internal port `80`
 * `80.echo.super.localhost` - same
 
-Root domain: `super.localhost` points to `api` service to internal port `80` (the first service with `x-root: yes`, first
-port in array)
+Root domain: `super.localhost` points to `api` service to internal port `80` (the first service with `x-root: yes`,
+first port in array)
 
 
 ## Backup
@@ -548,6 +552,27 @@ Example how to generate for multiple same clients:
 
     git-pipe jwt -s changeme my-client-1 my-client-2 my-client-3 my-client-4
 
+## Health check
+
+git-pipe supports health checks in single Dockerfile repositories. It will not route traffic to the service until
+container will become healthy.
+
+See [how to define health check in Dockerfile](https://docs.docker.com/engine/reference/builder/#healthcheck).
+
+Example for common HTTP service:
+
+```
+FROM my-service
+EXPOSE 80
+
+
+## ....
+HEALTHCHECK --interval=3s CMD curl -f http://localhost:80/health || exit 1
+
+
+## ...
+```
+
 ## Usage
 
 

_docs/03_docker-compose.md

@@ -4,14 +4,13 @@
 
 * Deploys all services.
 * All ports in `ports` directive will be linked as sub-domains
-* Root compose file supports optional `x-domain` attribute which overrides domain prefix. Default is repo name (or FQDN)
-  .
-* Each service with at least one port supports an optional `x-domain` attribute which overrides sub-domain. Default is
+* Each service with at least one port supports an optional `domainname` attribute which overrides sub-domain. Default is
   service name.
 * First services with attribute `x-root: yes` or with name `www`, `web`, `gateway` will be additionally exposed without
   sub-domain.
 * All exposed ports will be additionally exposed as sub-sub-domain with port name as the name.
 * Volumes automatically backup-ed and restored (see Backup)
+* Root port for service picked by the same rules as for [docker](#docker)
 
 Domains will be generated as> `<port?>.<x-domain|service>.<x-domain|project>.<root-domain>`
 and `<x-domain|project>.<root-domain>` points to `<first x-root: true|www|web|gateway>`
@@ -43,23 +42,22 @@ Generated mapping (root domain (`-d,--domain,$DOMAIN`) is `localhost`):
 * `api.mini.localhost` - points `api` service to internal port `80`
 * `80.api.mini.localhost` - same
 
-Root domain: `mini.localhost` points to `web` service to internal port `80` (the first service with name `web`, first port
-in array)
+Root domain: `mini.localhost` points to `web` service to internal port `80` (the first service with name `web`, first
+port in array)
 
 ## Override everything example
 
 ```yaml
 version: '3'
-x-domain: super
 services:
   web:
-    x-domain: index
+    domainname: index
     image: nginx
     ports:
       - 8080:80
       - 8081:9000
   api:
-    x-domain: echo
+    domainname: echo
     x-root: yes
     image: hashicorp/http-echo
     command: -listen :80 -text "web"
@@ -77,5 +75,5 @@ Generated mapping (root domain (`-d,--domain,$DOMAIN`) is `localhost`):
 * `echo.super.localhost` - points `api` service to internal port `80`
 * `80.echo.super.localhost` - same
 
-Root domain: `super.localhost` points to `api` service to internal port `80` (the first service with `x-root: yes`, first
-port in array)
+Root domain: `super.localhost` points to `api` service to internal port `80` (the first service with `x-root: yes`,
+first port in array)

_docs/11_healthcheck.md

@@ -0,0 +1,16 @@
+# Health check
+
+git-pipe supports health checks in single Dockerfile repositories. It will not route traffic to the service until
+container will become healthy.
+
+See [how to define health check in Dockerfile](https://docs.docker.com/engine/reference/builder/#healthcheck).
+
+Example for common HTTP service:
+
+```
+FROM my-service
+EXPOSE 80
+# ....
+HEALTHCHECK --interval=3s CMD curl -f http://localhost:80/health || exit 1
+# ...
+```

_header.md

@@ -53,6 +53,12 @@ Wait a bit to finish building and go to
 * http://wordpress.wordpress-docker-compose.localhost:8080 - wordpress app
 * http://phpmyadmin.wordpress-docker-compose.localhost:8080 - for phpmyadmin app
 
+## Automatic UI/dashboard
+
+Index page automatically generated for unknown domain. Ex: http://localhost:8080
+
+![image](https://user-images.githubusercontent.com/6597086/127631968-85a8eaa9-1605-4ca0-ba52-7943da536d1a.png)
+
 
 
 ## Supported OS
@@ -70,5 +76,5 @@ Wait a bit to finish building and go to
   *  [ ] OIDC
 * [ ] support dynamic reconfiguration (over API/by file watch + signal)
 * [ ] support GitHub-like webhooks
-* [ ] lazy initialization
+* [ ] lazy initialization (ie: bring up service on request only)
 * [x] path routing as alternative to domain-based

cmd/git-pipe/command_jwt.go

@@ -5,7 +5,7 @@ import (
 	"time"
 
 	"github.com/dgrijalva/jwt-go"
-	"github.com/reddec/git-pipe/router"
+	"github.com/reddec/git-pipe/core/ingress/embedded"
 )
 
 type CommandJWT struct {
@@ -21,7 +21,7 @@ type CommandJWT struct {
 func (cmd *CommandJWT) Execute([]string) error {
 	now := time.Now()
 	for _, name := range cmd.Args.Name {
-		var claims router.JWTClaims
+		var claims embedded.JWTClaims
 		claims.Audience = name
 		claims.Subject = cmd.Group
 		claims.Methods = cmd.Methods