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.
This commit is contained in:
Erin Call 2019-12-24 15:25:44 -08:00
parent ff8e988122
commit d4506608d7
No known key found for this signature in database
GPG key ID: 4071FF6C15B8DAD1

View file

@ -56,14 +56,10 @@ steps:
## Upgrading from drone-helm ## 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:
* 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:
* `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 * `purge` -- this is the default behavior in Helm 3
* `recreate_pods` * `recreate_pods`
* `tiller_ns` * `tiller_ns`
@ -71,3 +67,5 @@ There are some recommended changes, though:
* `canary_image` * `canary_image`
* `client_only` * `client_only`
* `stable_repo_url` * `stable_repo_url`
Since helm 3 does not require Tiller, we also recommend switching to a service account with less-expansive permissions.