jayjay
/
k9s
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md plugin format (#2788) 

* Update README.md plugin for Shortcut and OverwriteOutput

See a07243dbb0/change_logs/release_0.8.0.md (L51) for supported

* Update README.md with plugin dangerous field

Relates to https://github.com/derailed/k9s/issues/2604 introduced in https://github.com/derailed/k9s/pull/2637
mine
Guillaume Berche 2024-08-16 01:52:36 +02:00 committed by GitHub
parent a6e7b655bf
commit 0cdf0f537c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -647,7 +647,7 @@ K9s allows you to extend your command line and tooling by defining your very own
A plugin is defined as follows: A plugin is defined as follows:
* Shortcut option represents the key combination a user would type to activate the plugin * Shortcut option represents the key combination a user would type to activate the plugin. Valid values are [a-z], Shift-[A-Z], Ctrl-[A-Z].
* Override option make that the default action related to the shortcut will be overrided by the plugin * Override option make that the default action related to the shortcut will be overrided by the plugin
* Confirm option (when enabled) lets you see the command that is going to be executed and gives you an option to confirm or prevent execution * Confirm option (when enabled) lets you see the command that is going to be executed and gives you an option to confirm or prevent execution
* Description will be printed next to the shortcut in the k9s menu * Description will be printed next to the shortcut in the k9s menu
@ -655,7 +655,8 @@ A plugin is defined as follows:
* Command represents ad-hoc commands the plugin runs upon activation * Command represents ad-hoc commands the plugin runs upon activation
* Background specifies whether or not the command runs in the background * Background specifies whether or not the command runs in the background
* Args specifies the various arguments that should apply to the command above * Args specifies the various arguments that should apply to the command above
* OverwriteOutput options allows plugin developers to provide custom messages on plugin execution * OverwriteOutput boolean option allows plugin developers to provide custom messages on plugin stdout execution. See example in [#2644](https://github.com/derailed/k9s/pull/2644)
* Dangerous boolean option enables disabling the plugin when read-only mode is set. See [#2604](https://github.com/derailed/k9s/issues/2604)
K9s does provide additional environment variables for you to customize your plugins arguments. Currently, the available environment variables are as follows: K9s does provide additional environment variables for you to customize your plugins arguments. Currently, the available environment variables are as follows:
@ -687,7 +688,9 @@ plugins:
fred: fred:
shortCut: Ctrl-L shortCut: Ctrl-L
override: false override: false
overwriteOutput: false
confirm: false confirm: false
dangerous: false
description: Pod logs description: Pod logs
scopes: scopes:
- pods - pods