README.md in krane-2.0.0 vs README.md in krane-2.1.0
- old
+ new
@@ -157,9 +157,14 @@
- `krane.shopify.io/predeployed`: Causes a Custom Resource to be deployed in the pre-deploy phase.
- _Compatibility_: Custom Resource Definition
- _Default_: `true`
- `true`: The custom resource will be deployed in the pre-deploy phase.
- All other values: The custom resource will be deployed in the main deployment phase.
+- `krane.shopify.io/deploy-method-override`: Cause a resource to be deployed by the specified `kubectl` command, instead of the default `apply`.
+ - _Compatibility_: Cannot be used for `PodDisruptionBudget`, since it always uses `create/replace-force`
+ - _Accepted values_: `create`, `replace`, and `replace-force`
+ - _Warning_: Resources whose deploy method is overridden are no longer subject to pruning on deploy.
+ - This feature is _experimental_ and may be removed at any time.
### Running tasks at the beginning of a deploy
To run a task in your cluster at the beginning of every deploy, simply include a `Pod` template in your deploy directory. `krane` will first deploy any `ConfigMap` and `PersistentVolumeClaim` resources present in the provided templates, followed by any such pods. If the command run by one of these pods fails (i.e. exits with a non-zero status), the overall deploy will fail at this step (no other resources will be deployed).