kubectl-kruise

kubectl plugin for OpenKruise

kubectl supports a plug-in mechanism, but the rollout and other related operations provided by this tool itself only support the native workload resources of Kubernetes. Therefore, we need to create a kubectl plugin for OpenKruise, through which community users can use kubectl to operate Kruise’s workload resources.

So, kubectl-kruise was created.

How to use

The development of kubectl-kruise is in progress, if you wanna to experience it, you can clone it and make it:

make build && cp kubectl-kruise /usr/local/bin

Then you can operate Openkruise resource by kubectl-kruise. By now the rollout undo, rollout status, rollout history has been developed.

TODO

kubectl kruise rollout for CloneSet workload

• undo
• history
• status
• pause
• resume
• restart

kubectl kruise rollout for Advanced StatefulSet

• undo
• history
• status
• pause
• resume
• restart

kubectl kruise set SUBCOMMAND [options] for CloneSet

• kubectl kruise set image cloneset/abc
• kubectl kruise set env cloneset/abc
• kubectl kruise set serviceaccount cloneset/abc
• kubectl kruise set resources cloneset/abc

kubectl kruise set SUBCOMMAND [options] for Advanced StatefulSet

• kubectl kruise set image asts/abc
• kubectl kruise set env asts/abc
• kubectl kruise set serviceaccount asts/abc
• kubectl kruise set resources asts/abc

kubectl kruise top cloneset [cloneset name]

• kubectl kruise top cloneset abc

kubectl kruise autoscale SUBCOMMAND [options]

• kubectl kruise autoscale

Contributing

We encourage you to help out by reporting issues, improving documentation, fixing bugs, or adding new features.