updating documentation

we also add a demo app to help understanding where exactly this project
is useful

Author: rmoraes92

README.md

@@ -1,6 +1,6 @@
 # HTTP Status Code Checker
 
-dead simple binary to check http status code returned from health-check
+dead simple binary to check http status code(s) returned from health-check
 endpoint.
 
 ## Why not just use cURL?
@@ -14,10 +14,22 @@ status codes and let you dealing only with the program exit code itself:
 - 0 - if the status code is inside the list of expected ones
 - 1 - if the status code is outside the list of expected ones
 
+Also. In a scenario where one of the containers get compromised a tool like curl
+can become a liability helping the intruder having an easier time fetching more
+external data/tools.
+
 ## Install
 
 `cargo install http_status_code_check`
 
+or
+
+```
+curl -L https://github.com/rmoraes92/http_status_code_check/releases/download/0.1.2/http_status_code_check \
+  > /bin/http_status_code_check && \
+  chmod 755 /bin/http_status_code_check
+```
+
 ## Usage
 
 - Checking for single code:
@@ -28,6 +40,12 @@ status codes and let you dealing only with the program exit code itself:
 
 `http_status_code_check -u http://google.com -s 201,200`
 
+## Example Mocking AWS ECS
+
+An example using docker compose is located at `demo/` folder.
+
+It uses to barebones container images with the healthcheck capability of docker
+compose.
 
 ## License
 

demo/Dockerfile.go

@@ -0,0 +1,31 @@
+FROM golang:1.23
+WORKDIR /src
+RUN curl -L https://github.com/rmoraes92/http_status_code_check/releases/download/0.1.1/http_status_code_check > /bin/http_status_code_check && \
+    chmod 755 /bin/http_status_code_check
+RUN go mod init example/http_server
+COPY <<EOF ./main.go
+package main
+
+import (
+	"github.com/gin-gonic/gin"
+	"net/http"
+)
+
+func main() {
+	r := gin.Default()
+
+	r.GET("/", func(c *gin.Context) {
+		c.String(http.StatusOK, "hello world")
+	})
+
+	r.Run()
+}
+EOF
+RUN go get .
+RUN go build -o /bin/http_server ./main.go
+
+FROM debian
+COPY --from=0 /bin/http_server /bin/http_server
+COPY --from=0 /bin/http_status_code_check /bin/http_status_code_check
+RUN apt-get update && apt-get install -y libssl-dev
+CMD ["http_server"]

demo/Dockerfile.python

@@ -0,0 +1,8 @@
+FROM debian
+RUN apt-get update -y && apt-get install -y curl
+RUN curl -L https://github.com/rmoraes92/http_status_code_check/releases/download/0.1.1/http_status_code_check > /bin/http_status_code_check && \
+    chmod 755 /bin/http_status_code_check
+
+FROM python:3-slim
+COPY --from=0 /bin/http_status_code_check /bin/http_status_code_check
+CMD ["python", "-m", "http.server"]

demo/README.md

@@ -0,0 +1,24 @@
+# Demo
+
+We have two small http echo servers using Python and Go:
+
+- Dockerfile.python
+- Dockerfile.go
+
+The focus here is on the compose file. Specifically in the healthcheck section:
+
+```
+    healthcheck:
+      test: ["CMD", "http_status_code_check", "-u", "http://localhost:8080/", "-s", "200"]
+      interval: 2s
+      timeout: 5s
+      retries: 3
+```
+
+This more or less replicates the scenario where AWS ECS Task definition will
+ask you to have an internal call/script/routine that can confirm the server is
+up.
+
+Using `http_status_code_check` will handle the task of checking for the HTTP
+status code without providing any extra function reducing the amount of vectors
+we could had if the container get compromised.

demo/docker-compose.yaml

@@ -0,0 +1,21 @@
+services:
+  python:
+    image: simple-python-http
+    build:
+      dockerfile: Dockerfile.python
+      context: .
+    healthcheck:
+      test: [ "CMD", "http_status_code_check", "-u", "http://localhost:8000/", "-s", "200" ]
+      interval: 2s
+      timeout: 5s
+      retries: 3
+  go:
+    image: simple-go-http
+    build:
+      dockerfile: Dockerfile.go
+      context: .
+    healthcheck:
+      test: ["CMD", "http_status_code_check", "-u", "http://localhost:8080/", "-s", "200"]
+      interval: 2s
+      timeout: 5s
+      retries: 3