Skip to content

Commit

Permalink
Add update and upgrade docs (#700)
Browse files Browse the repository at this point in the history
Co-Authored-By: Aleksey Dukhovniy <alex.dukhovniy@googlemail.com>
  • Loading branch information
alenkacz and zen-dog committed Aug 8, 2019
1 parent de4f770 commit 82bf2ee
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ Or you can use compile and install the plugin from your `$GOPATH/src/github.com/
| `kubectl kudo plan status [flags]` | View all available plans. |
| `kubectl kudo plan history <name> [flags]` | View all available plans. |
| `kubectl kudo version` | Print the current KUDO package version. |
| `kubectl kudo update` | Update installed operator parameters.
| `kubectl kudo upgrade` | Upgrade installed operator from one version to another.

## Flags

Expand Down Expand Up @@ -368,3 +370,21 @@ $ kubectl kudo plan history --instance=up
```
This includes the previous history but also all OperatorVersions that have been applied to the selected instance.
### Update parameters on running operator
Every operator can define overridable parameters in `params.yaml`. When installing an operator, you can use the defined defaults or override them with `-p` parameters for `kudo install`.
`kudo update` command allows you to change these parameters even on an already installed operator. If you have an operator instance in your cluster named `dev-flink` (you can figure out what you have installed with `kubectl get instances`) and that instance exposes a parameter with the name `param` you can change its value with the following command:
`kubectl kudo update dev-flink -p param=value`
### Upgrade running operator from one version to another
Following the same example from the previous section, having a `dev-flink` instance installed, we can upgrade it to a newer version with the following command:
`kubectl kudo upgrade flink --instance dev-flink -p param=xxx`
A new version of that operator is installed to the cluster and `upgrade` (or `deploy`) plan is started to roll out new flink pods.
At the same time, we're overriding value of parameter `param`. That is optional and you can always do it in separate step via `kudo update`.

0 comments on commit 82bf2ee

Please sign in to comment.