From d4506608d79d78ed4164c6953e167df23ca8395c Mon Sep 17 00:00:00 2001 From: Erin Call Date: Tue, 24 Dec 2019 15:25:44 -0800 Subject: [PATCH] Note a backwards-incompatibility in the README [#8] This probably isn't going to bite anyone, but it's technically possible, and it doesn't hurt to mention it. --- README.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 023232a..592baee 100644 --- a/README.md +++ b/README.md @@ -56,18 +56,16 @@ steps: ## Upgrading from drone-helm -The setting names for drone-helm3 are backwards-compatible with those for drone-helm, so the only mandatory step is to update the `image` clause so that drone uses the new plugin. +drone-helm3 is largely backwards-compatible with drone-helm. There are some known differences: -There are some recommended changes, though: +* `prefix` must be supplied via the `settings` block, not `environment`. +* Several settings no longer have any effect: + * `purge` -- this is the default behavior in Helm 3 + * `recreate_pods` + * `tiller_ns` + * `upgrade` + * `canary_image` + * `client_only` + * `stable_repo_url` -* If your `service_account` is currently `tiller`, change it to a service account with more restricted permissions. - * If possible, remove the tiller account entirely, since its superuser status presents a security risk. -* Remove outdated settings that have no effect in drone-helm3: - -* `purge` -- this is the default behavior in Helm 3 -* `recreate_pods` -* `tiller_ns` -* `upgrade` -* `canary_image` -* `client_only` -* `stable_repo_url` +Since helm 3 does not require Tiller, we also recommend switching to a service account with less-expansive permissions.