10 Commits

Author SHA1 Message Date
537285b0b1 chore: clean workflow 2022-02-13 16:04:55 +01:00
d23068be44 docs: update license 2022-02-13 15:55:00 +01:00
c88402491b add access logs 2022-02-13 15:50:07 +01:00
36f93ee1a6 chore: update linter 2022-02-13 15:17:14 +01:00
752a8492c7 docs: add cacert flag 2022-02-13 15:13:36 +01:00
cfac507e9c docs: improve documentation 2022-02-13 15:08:26 +01:00
9a05fd8b8d docs: improve examples 2022-02-13 14:58:02 +01:00
24e337834f docs: add example with compose ft. flags (#51)
Co-authored-by: Fernandez Ludovic <ldez@users.noreply.github.com>
2022-02-13 14:53:08 +01:00
c36625cb56 chore: clean the start of the server 2021-12-03 18:55:03 +01:00
a067f0ee4c fix: rename WHOAMI_PORT to WHOAMI_PORT_NUMBER
k8s creates env var based on service name,
then WHOAMI_PORT exists and contains a URL instead of a number.
2021-12-03 18:49:47 +01:00
7 changed files with 146 additions and 63 deletions

View File

@ -4,8 +4,6 @@ on:
push: push:
branches: branches:
- master - master
tags:
- v*
pull_request: pull_request:
jobs: jobs:
@ -15,8 +13,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
env: env:
GO_VERSION: 1.17 GO_VERSION: 1.17
GOLANGCI_LINT_VERSION: v1.43.0 GOLANGCI_LINT_VERSION: v1.44.0
SEIHON_VERSION: v0.8.5
CGO_ENABLED: 0 CGO_ENABLED: 0
steps: steps:
@ -59,22 +56,3 @@ jobs:
- name: Make Image - name: Make Image
run: make image run: make image
# Install Docker image multi-arch builder
- name: Install seihon ${{ env.SEIHON_VERSION }}
if: startsWith(github.ref, 'refs/tags/v')
run: |
curl -sSfL https://raw.githubusercontent.com/ldez/seihon/master/godownloader.sh | sh -s -- -b $(go env GOPATH)/bin ${SEIHON_VERSION}
seihon --version
- name: Docker Login
if: startsWith(github.ref, 'refs/tags/v')
env:
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
run: |
echo "${DOCKER_PASSWORD}" | docker login --username "${DOCKER_USERNAME}" --password-stdin
- name: Deploy Docker Images (seihon)
if: startsWith(github.ref, 'refs/tags/v')
run: make publish-images

44
.github/workflows/release.yml vendored Normal file
View File

@ -0,0 +1,44 @@
name: "Release a tag"
on:
push:
tags:
- v*
jobs:
release:
name: Release Process
runs-on: ubuntu-latest
env:
GO_VERSION: 1.17
SEIHON_VERSION: v0.9.0
CGO_ENABLED: 0
steps:
# https://github.com/marketplace/actions/setup-go-environment
- name: Set up Go ${{ env.GO_VERSION }}
uses: actions/setup-go@v2
with:
go-version: ${{ env.GO_VERSION }}
# https://github.com/marketplace/actions/checkout
- name: Check out code
uses: actions/checkout@v2
with:
fetch-depth: 0
# Install Docker image multi-arch builder
- name: Install seihon ${{ env.SEIHON_VERSION }}
run: |
curl -sSfL https://raw.githubusercontent.com/ldez/seihon/master/godownloader.sh | sh -s -- -b $(go env GOPATH)/bin ${SEIHON_VERSION}
seihon --version
- name: Docker Login
env:
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
run: |
echo "${DOCKER_PASSWORD}" | docker login --username "${DOCKER_USERNAME}" --password-stdin
- name: Deploy Docker Images (seihon)
run: make publish-images

1
.gitignore vendored
View File

@ -1,3 +1,4 @@
.idea .idea
vendor/ vendor/
/whoami /whoami
dist/

View File

@ -38,6 +38,7 @@ linters:
- forbidigo - forbidigo
- varnamelen - varnamelen
- nilnil - nilnil
- ifshort
issues: issues:
exclude-use-default: false exclude-use-default: false

View File

@ -186,8 +186,8 @@
same "printed page" as the copyright notice for easier same "printed page" as the copyright notice for easier
identification within third-party archives. identification within third-party archives.
Copyright [2015-2018] [Containous] Copyright [2015-2019] [Containous]
Copyright [2020] [Traefik Labs] Copyright [2020-2022] [Traefik Labs]
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.

View File

@ -3,27 +3,54 @@
[![Docker Pulls](https://img.shields.io/docker/pulls/traefik/whoami.svg)](https://hub.docker.com/r/traefik/whoami/) [![Docker Pulls](https://img.shields.io/docker/pulls/traefik/whoami.svg)](https://hub.docker.com/r/traefik/whoami/)
[![Build Status](https://github.com/traefik/whoami/workflows/Main/badge.svg?branch=master)](https://github.com/traefik/whoami/actions) [![Build Status](https://github.com/traefik/whoami/workflows/Main/badge.svg?branch=master)](https://github.com/traefik/whoami/actions)
Tiny Go webserver that prints os information and HTTP request to output Tiny Go webserver that prints OS information and HTTP request to output.
## Usage ## Usage
### Paths ### Paths
- `/data?size=n[&unit=u]`: creates a response with a size `n`. The unit of measure, if specified, accepts the following values: `KB`, `MB`, `GB`, `TB` (optional, default: bytes). #### `/[?wait=d]`
- `/echo`: webSocket echo.
- `/bench`: always return the same response (`1`). Returns the whoami information (request and network information).
- `/[?wait=d]`: returns the whoami information (request and network information). The optional `wait` query parameter can be provided to tell the server to wait before sending the response. The duration is expected in Go's [`time.Duration`](https://golang.org/pkg/time/#ParseDuration) format (e.g. `/?wait=100ms` to wait 100 milliseconds).
- `/api`: returns the whoami information as JSON. The optional `wait` query parameter can be provided to tell the server to wait before sending the response.
- `/health`: heath check The duration is expected in Go's [`time.Duration`](https://golang.org/pkg/time/#ParseDuration) format (e.g. `/?wait=100ms` to wait 100 milliseconds).
#### `/api`
Returns the whoami information as JSON.
#### `/bench`
Always return the same response (`1`).
#### `/data?size=n[&unit=u]`
Creates a response with a size `n`.
The unit of measure, if specified, accepts the following values: `KB`, `MB`, `GB`, `TB` (optional, default: bytes).
#### `/echo`
WebSocket echo.
#### `/health`
Heath check.
- `GET`, `HEAD`, ...: returns a response with the status code defined by the `POST` - `GET`, `HEAD`, ...: returns a response with the status code defined by the `POST`
- `POST`: changes the status code of the `GET` (`HEAD`, ...) response. - `POST`: changes the status code of the `GET` (`HEAD`, ...) response.
### Flags ### Flags
- `cert`: give me a certificate. | Flag | Env var | Description |
- `key`: give me a key. |-----------|----------------------|-----------------------------------------|
- `port`: give me a port number. (it can be also defined with `WHOAMI_PORT` environment variable) (default: 80) | `cert` | | Give me a certificate. |
- `name`: give me a name. (it can be also defined with `WHOAMI_NAME` environment variable) | `key` | | Give me a key. |
| `cacert` | | Give me a CA chain, enforces mutual TLS |
| `port` | `WHOAMI_PORT_NUMBER` | Give me a port number. (default: `80`) |
| `name` | `WHOAMI_NAME` | Give me a name. |
| `verbose` | | Enable verbose logging. |
## Examples ## Examples
@ -66,5 +93,17 @@ $ curl -v http://localhost:80/health
``` ```
```console ```console
docker run -d -P -v ./certs:/certs --name iamfoo traefik/whoami --cert /certs/cert.cer --key /certs/key.key docker run -d -P -v ./certs:/certs --name iamfoo traefik/whoami --cert /certs/example.cert --key /certs/example.key
```
```yml
version: '3.9'
services:
whoami:
image: traefik/whoami
command:
# It tells whoami to start listening on 2001 instead of 80
- --port 2001
- --name iamfoo
``` ```

42
app.go
View File

@ -37,13 +37,15 @@ var (
ca string ca string
port string port string
name string name string
verbose bool
) )
func init() { func init() {
flag.BoolVar(&verbose, "verbose", false, "Enable verbose logging")
flag.StringVar(&cert, "cert", "", "give me a certificate") flag.StringVar(&cert, "cert", "", "give me a certificate")
flag.StringVar(&key, "key", "", "give me a key") flag.StringVar(&key, "key", "", "give me a key")
flag.StringVar(&ca, "cacert", "", "give me a CA chain, enforces mutual TLS") flag.StringVar(&ca, "cacert", "", "give me a CA chain, enforces mutual TLS")
flag.StringVar(&port, "port", getEnv("WHOAMI_PORT", "80"), "give me a port number") flag.StringVar(&port, "port", getEnv("WHOAMI_PORT_NUMBER", "80"), "give me a port number")
flag.StringVar(&name, "name", os.Getenv("WHOAMI_NAME"), "give me a name") flag.StringVar(&name, "name", os.Getenv("WHOAMI_NAME"), "give me a name")
} }
@ -55,28 +57,33 @@ var upgrader = websocket.Upgrader{
func main() { func main() {
flag.Parse() flag.Parse()
http.HandleFunc("/data", dataHandler) mux := http.NewServeMux()
http.HandleFunc("/echo", echoHandler) mux.Handle("/data", handle(dataHandler, verbose))
http.HandleFunc("/bench", benchHandler) mux.Handle("/echo", handle(echoHandler, verbose))
http.HandleFunc("/", whoamiHandler) mux.Handle("/bench", handle(benchHandler, verbose))
http.HandleFunc("/api", apiHandler) mux.Handle("/api", handle(apiHandler, verbose))
http.HandleFunc("/health", healthHandler) mux.Handle("/health", handle(healthHandler, verbose))
mux.Handle("/", handle(whoamiHandler, verbose))
fmt.Println("Starting up on port " + port) if cert == "" || key == "" {
log.Printf("Starting up on port %s", port)
log.Fatal(http.ListenAndServe(":"+port, mux))
}
if len(cert) > 0 && len(key) > 0 {
server := &http.Server{ server := &http.Server{
Addr: ":" + port, Addr: ":" + port,
Handler: mux,
} }
if len(ca) > 0 { if len(ca) > 0 {
server.TLSConfig = setupMutualTLS(ca) server.TLSConfig = setupMutualTLS(ca)
} }
log.Printf("Starting up with TLS on port %s", port)
log.Fatal(server.ListenAndServeTLS(cert, key)) log.Fatal(server.ListenAndServeTLS(cert, key))
} }
log.Fatal(http.ListenAndServe(":"+port, nil))
}
func setupMutualTLS(ca string) *tls.Config { func setupMutualTLS(ca string) *tls.Config {
clientCACert, err := ioutil.ReadFile(ca) clientCACert, err := ioutil.ReadFile(ca)
@ -97,6 +104,19 @@ func setupMutualTLS(ca string) *tls.Config {
return tlsConfig return tlsConfig
} }
func handle(next http.HandlerFunc, verbose bool) http.Handler {
if !verbose {
return next
}
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
next(w, r)
// <remote_IP_address> - [<timestamp>] "<request_method> <request_path> <request_protocol>" -
log.Printf("%s - - [%s] \"%s %s %s\" - -", r.RemoteAddr, time.Now().Format("02/Jan/2006:15:04:05 -0700"), r.Method, r.URL.Path, r.Proto)
})
}
func benchHandler(w http.ResponseWriter, _ *http.Request) { func benchHandler(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Connection", "keep-alive") w.Header().Set("Connection", "keep-alive")
w.Header().Set("Content-Type", "text/plain") w.Header().Set("Content-Type", "text/plain")