Updated README.md
This commit is contained in:
parent
c8b7dd7be9
commit
ce58685691
13
README.md
13
README.md
@ -3,14 +3,17 @@
|
|||||||
**DISCLAIMER**: this is still a *huge* work in progress.
|
**DISCLAIMER**: this is still a *huge* work in progress.
|
||||||
|
|
||||||
### Goal
|
### Goal
|
||||||
This repository aims to have a *small stack* of self hosted programs that are accessible through a single endpoint, the reverse proxy (Nginx) in the `rp` folder, that exposes whatever pieces of the stack you decide to have accessible from the outside, with or without using a domain.
|
This repository aims to have a *small stack* of self hosted programs that are accessible through a single endpoint, the reverse proxy (Caddy) in the `caddy-docker-proxy` folder, that exposes whatever pieces of the stack you decide to have accessible from the outside, with or without using a domain.
|
||||||
|
|
||||||
### Why not Docker Swarm? Or k8s?
|
### Why not Docker Swarm? Or k8s?
|
||||||
That's something else in the plans, but this was more an attempt to answer the question: "what if I have a single machine but I want some modularity, without having to think too much when I want to add something?". I could still use Swarm or k8s on a single machine, but I find this solution a bit more suitable. This is also the reason I choose the Jwilder Nginx docker image over Traefik, as I didn't need service discovery on other nodes.
|
As clearly explained on the [Docker Swarm Rocks](https://dockerswarm.rocks/swarm-or-kubernetes/) website, Docker Swarm Mode feels a bit left behind. I tried myself to build my stack on top of it, but it didn't feel as refined as the plain Docker itself. I'm still keeping an eye on the [Awesome Swarm](https://github.com/BretFisher/awesome-swarm) repository in case some new interesting tools come up.
|
||||||
|
|
||||||
|
Kubernetes has simply too much overhead for a small home lab like mine. I'm using a couple of air-gapped ARM64 boards, some mini PCs and a small Cloud VPS to achieve my needs, and at the time of writing k8s would add too much complexity to the stack.
|
||||||
|
The only thing that would make me change idea would be a need for autoscaling, but I'm still far from that situation.
|
||||||
|
|
||||||
### How do I use this?
|
### How do I use this?
|
||||||
~~Nice question.~~
|
The `caddy-docker-proxy` is the first container that should be started, after running `$ docker network create caddy` to ensure the external network exists on the system. The `Caddyfile` included and mounted in `/etc/caddy/caddyfile` is used in this case to give access to the air-gapped comtainers running on different machines on the same network.
|
||||||
The `rp` folder is the first piece of the puzzle. It creates the proxy, the letsencrypt companion and the `rp_reverse-proxy` network that containers exposed to the internet will have to access. Every service in the Compose files tries to have the least amount of networks necessary to operate.
|
As you can see, this is a borderline situation where some people may prefer having service discovery with either Swarm or Kubernetes, but in my experience this is still not enough to call for that.
|
||||||
|
|
||||||
### Conclusion (for now):
|
### Conclusion (for now):
|
||||||
Although I still don't know if this approach has some major flaw(s), it has been reliable for many projects that I will add to this repository. Maybe someone else can find it useful for their projects, and if so I'm happy for you. I'll make sure to link as many references I followed as I can inside the individual Compose files.
|
This approach worked without any major issue in the last years, and it has been reliable for many projects that I will add to this repository. Maybe someone else can find it useful for their projects, and if so I'm happy for you. I'll make sure to link as many references I followed as I can inside the individual Compose files.
|
||||||
|
|||||||
@ -4,7 +4,7 @@ x-logging:
|
|||||||
driver: syslog
|
driver: syslog
|
||||||
options:
|
options:
|
||||||
tag: "container_name/{{.Name}}"
|
tag: "container_name/{{.Name}}"
|
||||||
labels: "q920"
|
labels: "LABEL"
|
||||||
syslog-facility: local7
|
syslog-facility: local7
|
||||||
|
|
||||||
x-opt-values:
|
x-opt-values:
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user