Skip to content

Commit

Permalink
added proper documentation about new flag
Browse files Browse the repository at this point in the history
 added readme note about new flag
  • Loading branch information
atighineanu committed Jun 25, 2022
1 parent 1d1a1df commit bd1d84f
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ Flags:
--lock-annotation string annotation in which to record locking node (default "weave.works/kured-node-lock")
--lock-release-delay duration hold lock after reboot by this duration (default: 0, disabled)
--lock-ttl duration expire lock annotation after this duration (default: 0, disabled)
--message-template-uncordon string message template used to notify about a node being successfully uncordoned (default "Node %s rebooted & uncordoned successfully!")
--message-template-drain string message template used to notify about a node being drained (default "Draining node %s")
--message-template-reboot string message template used to notify about a node being rebooted (default "Rebooting node %s")
--notify-url url for reboot notifications (cannot use with --slack-hook-url flags)
Expand Down Expand Up @@ -275,7 +276,7 @@ about draining and rebooting nodes across a list of technologies.

![Notification](img/slack-notification.png)

Alternatively you can use the `--message-template-drain` and `--message-template-reboot` to customize the text of the message, e.g.
Alternatively you can use the `--message-template-drain`, `--message-template-reboot` and `--message-template-uncordon` to customize the text of the message, e.g.

```cli
--message-template-drain="Draining node %s part of *my-cluster* in region *xyz*"
Expand Down
4 changes: 2 additions & 2 deletions charts/kured/values.minikube.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ configuration:
# annotateNodes: false # enable 'weave.works/kured-reboot-in-progress' and 'weave.works/kured-most-recent-reboot-needed' node annotations to signify kured reboot operations
# lockReleaseDelay: "5m" # hold lock after reboot by this amount of time (default 0, disabled)
# logFormat: "text" # log format specified as text or json, defaults to text
# preRebootNodeLabels: [] # labels to add to nodes before cordoning (default [])
# postRebootNodeLabels: [] # labels to add to nodes after uncordoning (default [])
# preRebootNodeLabels: [] # labels to add to nodes before cordoning (default [])
# postRebootNodeLabels: [] # labels to add to nodes after uncordoning (default [])
2 changes: 1 addition & 1 deletion charts/kured/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ configuration:
preRebootNodeLabels: [] # labels to add to nodes before cordoning (default [])
postRebootNodeLabels: [] # labels to add to nodes after uncordoning (default [])


rbac:
create: true

Expand Down

0 comments on commit bd1d84f

Please sign in to comment.