From eb36dc17bedbdafbb18280fa09e0697c6febd093 Mon Sep 17 00:00:00 2001 From: Igor Alexandrov Date: Fri, 20 Sep 2024 12:35:56 +0400 Subject: [PATCH 1/5] Replaced Traefik with kamal-proxy and removed Traefik from the navigation --- _data/docs.yml | 2 -- docs/commands/deploy.md | 2 +- docs/commands/redeploy.md | 2 +- docs/commands/remove.md | 2 +- 4 files changed, 3 insertions(+), 5 deletions(-) diff --git a/_data/docs.yml b/_data/docs.yml index 777aab6..58f8d7c 100644 --- a/_data/docs.yml +++ b/_data/docs.yml @@ -82,8 +82,6 @@ url: /docs/commands/server/ - title: "kamal setup" url: /docs/commands/setup/ - - title: "kamal traefik" - url: /docs/commands/traefik/ - title: "kamal upgrade" url: /docs/commands/upgrade/ - title: "kamal version" diff --git a/docs/commands/deploy.md b/docs/commands/deploy.md index 236b489..b9c6390 100644 --- a/docs/commands/deploy.md +++ b/docs/commands/deploy.md @@ -6,7 +6,7 @@ title: Deploy Build and deploy your app to all servers. By default it will build the currently checked out version of the app. -Kamal will use the Traefik proxy to seamlessly move requests from the old version of the app to new without downtime. +Kamal will use the kamal-proxy to seamlessly move requests from the old version of the app to new without downtime. The deployment process is: 1. Login into the docker registry locally and on all servers diff --git a/docs/commands/redeploy.md b/docs/commands/redeploy.md index 8f28c64..59d8365 100644 --- a/docs/commands/redeploy.md +++ b/docs/commands/redeploy.md @@ -4,6 +4,6 @@ title: Redeploy # kamal redeploy -Deploy your app, but skip bootstrapping servers, starting Traefik, pruning, and registry login. +Deploy your app, but skip bootstrapping servers, starting kamal-proxy, pruning, and registry login. You must run [`kamal deploy`](../deploy) at least once first. diff --git a/docs/commands/remove.md b/docs/commands/remove.md index 7f98d3b..a153458 100644 --- a/docs/commands/remove.md +++ b/docs/commands/remove.md @@ -4,6 +4,6 @@ title: Remove # kamal remove -This will remove app, Traefik and accessory containers and log out of the docker registry. +This will remove app, kamal-proxy and accessory containers and log out of the docker registry. It will prompt for confirmation unless you add the `-y` option. From 91c999c9cc0885def47ad6f9a9ba4c049df0d8fe Mon Sep 17 00:00:00 2001 From: Antonio Pagano Date: Thu, 26 Sep 2024 18:20:14 -0500 Subject: [PATCH 2/5] fix: fixing broken link --- docs/configuration/environment-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/environment-variables.md b/docs/configuration/environment-variables.md index a3bde24..8f60760 100644 --- a/docs/configuration/environment-variables.md +++ b/docs/configuration/environment-variables.md @@ -33,7 +33,7 @@ KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD RAILS_MASTER_KEY=$(cat config/master.key) ``` -You can also use [secret helpers](../commands/secrets) for some common password managers. +You can also use [secret helpers](../../commands/secrets) for some common password managers. ``` SECRETS=$(kamal secrets fetch ...) From 094a69b8b79d9b74b68c245660d0a8caf64f862b Mon Sep 17 00:00:00 2001 From: Camillo Visini Date: Fri, 27 Sep 2024 09:15:56 +0200 Subject: [PATCH 3/5] Update secrets file paths for destinations Destination-specific secret files are prefixed with a dot instead of a hyphen, according to https://github.com/basecamp/kamal/blob/8c32e6af07356031ffbad2e8eb60169904bc5e52/lib/kamal/secrets.rb#L10 --- docs/configuration/environment-variables.md | 2 +- docs/upgrading/secrets-changes.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/environment-variables.md b/docs/configuration/environment-variables.md index a3bde24..951bfd1 100644 --- a/docs/configuration/environment-variables.md +++ b/docs/configuration/environment-variables.md @@ -22,7 +22,7 @@ env: Kamal uses dotenv to automatically load environment variables set in the `.kamal/secrets` file. -If you are using destinations, secrets will instead be read from `.kamal/secrets-` if it exists. +If you are using destinations, secrets will instead be read from `.kamal/secrets.` if it exists. Common secrets across all destinations can be set in `.kamal/secrets-common`. diff --git a/docs/upgrading/secrets-changes.md b/docs/upgrading/secrets-changes.md index 781cb4a..c874e1a 100644 --- a/docs/upgrading/secrets-changes.md +++ b/docs/upgrading/secrets-changes.md @@ -6,7 +6,7 @@ title: Secrets changes Secrets have moved from `.env`/`.env.rb` to `.kamal/secrets.` -If you are using destinations, secrets will be read from `.kamal/secrets-` first or `.kamal/secrets` if it is not found. +If you are using destinations, secrets will be read from `.kamal/secrets.` first or `.kamal/secrets` if it is not found. ## [Interpolating secrets](#interpolating-secrets) From f94babc2ffac80d5c8431a4c54040b9acf9fa082 Mon Sep 17 00:00:00 2001 From: Adam Haris Date: Fri, 27 Sep 2024 09:47:17 +0200 Subject: [PATCH 4/5] Better readability & avoid copy-paste diffs --- docs/upgrading/secrets-changes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/upgrading/secrets-changes.md b/docs/upgrading/secrets-changes.md index 781cb4a..9db25dd 100644 --- a/docs/upgrading/secrets-changes.md +++ b/docs/upgrading/secrets-changes.md @@ -4,7 +4,7 @@ title: Secrets changes # Kamal 2: Secrets changes -Secrets have moved from `.env`/`.env.rb` to `.kamal/secrets.` +Secrets have moved from `.env`/`.env.rb` to `.kamal/secrets`. If you are using destinations, secrets will be read from `.kamal/secrets-` first or `.kamal/secrets` if it is not found. From 6a644c7e5b894ba038dfd07218439c7b0a9be33f Mon Sep 17 00:00:00 2001 From: Deepak Mahakale Date: Fri, 27 Sep 2024 17:05:26 +0530 Subject: [PATCH 5/5] Fix broken link --- docs/upgrading/secrets-changes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/upgrading/secrets-changes.md b/docs/upgrading/secrets-changes.md index 781cb4a..a08ae16 100644 --- a/docs/upgrading/secrets-changes.md +++ b/docs/upgrading/secrets-changes.md @@ -23,7 +23,7 @@ SECRET_FROM_ENV=$SECRET_FROM_ENV SECRET_FROM_COMMAND=$(op read ...) ``` -See [here](../configuration/environment-variables#using-kamal-secrets) for more details +See [here](../configuration/environment-variables#secrets) for more details ## [Environment variables in deploy.yml](#environment-variables-in-deployyml)