cmd

Documentation

Index

• Variables

Variables

var AddAccount = &subcommands.Command{
	UsageLine: "add-account [-rate RATE...] [-charge-time CHARGE_TIME] [-fanout FANOUT] POOL_ID ACCOUNT_ID",
	ShortDesc: "Add a quota account",
	LongDesc:  "Add a quota account",
	CommandRun: func() subcommands.CommandRun {
		c := &addAccountRun{}
		c.authFlags.Register(&c.Flags, site.DefaultAuthOptions)
		c.envFlags.Register(&c.Flags)
		c.Flags.Var(flag.StringSlice(&c.chargeRates), "rate", `Quota recharge rate for a given priority level. May be specified multiple times,
to specify charge rate at P0, P1, P2, etc. If specified, overwrites the full charge-rate vector.`)
		c.Flags.Float64Var(&c.chargeTime, "charge-time", 0,
			"Maximum amount of time (seconds) for which the account can accumulate quota.")
		c.Flags.IntVar(&c.fanout, "fanout", 0, "Maximum number of concurrent tasks that account will pay for.")
		c.Flags.Var(int32KeyVals(&c.labelLimits), "per-label-task-limits", `Optional limits on the number of tasks with matching label values
for any given label, in format label1:limit1,label2:limit2,...`)
		c.Flags.BoolVar(&c.disableFreeTasks, "disable-free-tasks", false, "Disallow the account from running free tasks.")
		return c
	},
}

AddAccount subcommand: add an account.

var Create = &subcommands.Command{
	UsageLine: "create [-label KEY:VALUE...] POOL_ID",
	ShortDesc: "Create a qscheduler pool",
	LongDesc:  "Create a qscheduler pool.",
	CommandRun: func() subcommands.CommandRun {
		c := &createRun{}
		c.authFlags.Register(&c.Flags, site.DefaultAuthOptions)
		c.envFlags.Register(&c.Flags)
		c.Flags.BoolVar(&c.allowPreemption, "allow-preemption", true, "Allow preemption.")
		c.Flags.Var(nullableInt32Value(&c.botExpiry), "bot-expiry-seconds", "Number of seconds after which idle bots expire.")

		return c
	},
}

Create subcommand: Create a qscheduler pool.

var Inspect = &subcommands.Command{
	UsageLine: "inspect POOL_ID",
	ShortDesc: "Inspect a qscheduler pool",
	LongDesc:  "Inspect a qscheduler pool.",
	CommandRun: func() subcommands.CommandRun {
		c := &inspectRun{}
		c.authFlags.Register(&c.Flags, site.DefaultAuthOptions)
		c.envFlags.Register(&c.Flags)
		c.Flags.BoolVar(&c.accounts, "accounts", false, "Show the account balances and policies.")
		c.Flags.BoolVar(&c.bots, "bots", false, "Show the bot summaries.")
		c.Flags.BoolVar(&c.tasks, "tasks", false, "Show the task summaries.")
		return c
	},
}

Inspect subcommand: Inspect a qscheduler pool.

var Mod = &subcommands.Command{
	UsageLine: "mod [-allow-preemption ALLOW] POOL_ID",
	ShortDesc: "modify a qscheduler pool",
	LongDesc:  "Modify a qscheduler pool's global configuration.",
	CommandRun: func() subcommands.CommandRun {
		c := &modRun{}
		c.authFlags.Register(&c.Flags, site.DefaultAuthOptions)
		c.envFlags.Register(&c.Flags)
		c.Flags.Var(nullableBoolValue(&c.allowPreemption), "allow-preemption", "Allow preemption.")
		c.Flags.Var(nullableInt32Value(&c.botExpiry), "bot-expiry-seconds", "Number of seconds after which idle bots expire.")

		return c
	},
}

Mod subcommand: Modify a qscheduler pool.

var ModAccount = &subcommands.Command{
	UsageLine: "mod-account [-rate RATE...] [-charge-time CHARGE_TIME] [-fanout FANOUT] [-description ACCOUNT_DESCRIPTION] POOL_ID ACCOUNT_ID",
	ShortDesc: "Modify a quota account",
	LongDesc:  "Modify a quota account. Values that are unspecified will not be modified.",
	CommandRun: func() subcommands.CommandRun {
		c := &modAccountRun{}
		c.authFlags.Register(&c.Flags, site.DefaultAuthOptions)
		c.envFlags.Register(&c.Flags)
		c.Flags.Var(flag.StringSlice(&c.chargeRates), "rate", `Quota recharge rate for a given priority level. May be specified multiple times,
to specify charge rate at P0, P1, P2, etc. If specified, overwrites the full charge-rate vector.`)
		c.Flags.Var(nullableFloat32Value(&c.chargeTime), "charge-time",
			"Maximum amount of time (seconds) for which the account can accumulate quota.")
		c.Flags.Var(nullableInt32Value(&c.fanout), "fanout", "Maximum number of concurrent tasks that account will pay for.")
		c.Flags.Var(int32KeyVals(&c.labelLimits), "per-label-task-limits", `Optional limits on the number of tasks with matching label values
for any given label, in format label1:limit1,label2:limit2,...`)
		c.Flags.Var(nullableBoolValue(&c.disableFreeTasks), "disable-free-tasks", "Disallow the account from running free tasks.")
		c.Flags.BoolVar(&c.resetBalance, "reset-balance", false, "Reset the account's balance to 0.")
		c.Flags.StringVar(&c.description, "description", "", "Attach a description for an account.")
		return c
	},
}

ModAccount subcommand: add an account.

var Wipe = &subcommands.Command{
	UsageLine: "wipe -X POOL_ID",
	ShortDesc: "Wipe a qscheduler pool",
	LongDesc:  "Wipe a qscheduler pool.",
	CommandRun: func() subcommands.CommandRun {
		c := &wipeRun{}
		c.authFlags.Register(&c.Flags, site.DefaultAuthOptions)
		c.envFlags.Register(&c.Flags)
		c.Flags.BoolVar(&c.confirmed, "X", false, "I know what I'm doing, and I want to wipe out scheduler state.")
		return c
	},
}

Wipe subcommand: Wipe a qscheduler pool.