run

Documentation

Index

• Variables
• func New(f cmdutil.Factory) *cobra.Command
• type Options
  • func (r *Options) DefineFlags(fs *pflag.FlagSet)
  • func (r *Options) Run(f cmdutil.Factory) error
  • func (r *Options) Validate() error

Variables

var RunCommandDescription = command.NewDescription(
	"run",
	"Run an arbitrary executable (e.g. shell code) in the context of the local machine",
	`ydbops restart run:
		Run an arbitrary executable (e.g. shell code) in the context of the local machine
		(where rolling-restart is launched). For example, if you want to execute ssh commands
		on the ydb cluster node, you must write ssh commands yourself. See the examples.

		For every node released by CMS, ydbops will execute this payload independently.

		Restart will be treated as successful if your executable finished with a zero
		return code.

		Certain environment variable will be passed to your executable on each run:
			$HOSTNAME: the fqdn of the node currently released by CMS.`,
)

Functions

func New

func New(
	f cmdutil.Factory,
) *cobra.Command

Types

type Options

type Options struct {
	*rolling.RestartOptions
	PayloadFilePath string
}

func (*Options) DefineFlags

func (r *Options) DefineFlags(fs *pflag.FlagSet)

func (*Options) Run

func (r *Options) Run(f cmdutil.Factory) error

func (*Options) Validate

func (r *Options) Validate() error