Replace Traefik with kamal-proxy #940
Conversation
The proxy can be enabled via the config:
```
proxy:
enabled: true
hosts:
- 10.0.0.1
- 10.0.0.2
```
This will enable the proxy and cause it to be run on the hosts listed
under `hosts`, after running `kamal proxy reboot`.
Enabling the proxy disables `kamal traefik` commands and replaces them
with `kamal proxy` ones. However only the marked hosts will run the
kamal-proxy container, the rest will run Traefik as before.
Avoid docker inspect: 1. Use the container ID as the host 2. Configure the port, default to 3000
We need to drop to be fixed so multiple applications put the config in the same place.
This will allow us to share files with the proxy via the host.
This will make running kamal remove simpler, we can just clean up that directory.
The proxy only supports a single host per app for nowm so make the config match that.
|
This is exciting! I haven't looked through the whole PR but just had a couple of questions come to mind, quotes added for context.
How will this work if you're currently using networks? Or if you're hosting multiple apps on the same server? I'm guessing the custom options just get added along with the default kamal network. By default this should give us more of a docker compose experience which is really nice, being able to connect to SSL is one of the more difficult things to get going with traefik, is Thruster no longer the replacement for traefik? If an app does need to support multiple hosts, how would we go about that? I have multiple apps at the moment that utilize more than one host. Should the |
Right now Kamal will attempt to create the It might make sense to make the name of the network configurable. E.g. if you are running multiple applications on one server and want them in separate networks, or if you have an existing network you'd like to use.
kamal-proxy currently only supports one host per application, but we'll add support for multiple hosts soon - see basecamp/kamal-proxy#14. I've switched the key from Thruster is designed to run in the same container as the app, so its not a Traefik replacement. It can do SSL termination itself, but Kamal gets in the way if you are using it, so kamal-proxy also has support. |
|
@djmb Appreciate the context! I forgot about Thruster actually running within the container, makes sense. |
Kamal now uses our custom proxy kamal-proxy. The proxy responds to a deploy command which tells it which container to send requests to. It then waits for the container to respond on its healthcheck URL and returns once that is successful.
Changes this brings:
optionsconfig which allows you to pass custom options to docker run.To enable proper multi-app support:
.kamal/apps/#{service}[-#{destination}], so they can be easily removed by removing that folder.Upgrading:
kamal proxy upgradeto upgrade the proxy containers. This will remove Traefik and boot the proxy and app containers in the kamal docker network. There will be a similardowngradecommand added to Kamal 1.9 to reverse the process.Config changes:
traefik&healthcheckboth removedproxy: truenottraefik: truefor non primary role roles that use a proxyproxysetting:hosts- a list of hosts that should be forwarded to this app by the proxy. Allows multiple apps to use the same server and proxy, and have the requests routed by the host. Currently the proxy only supports one hostssl- requires hosts to be set if enabled, if enabled it will automatically set up HTTPS via Let's Encrypt. Should only be used with one server!app_port- the port on the application that we will proxy (default 80)deploy_timeout- how long kamal-proxy waits for the container to come up (default 30 seconds)response_timeout- how long kamal-proxy waits for a response (default 30 seconds)healthcheck- configure the healthcheck URL, interval and timeoutbuffering- configure request and response buffering, max request and response size and memory buffer sizelogging- log extra request and response headersforward_headers- whether to forward X-Forwarded-For and X-Forwarded-Proto, defaults to false