tasks

Documentation

Index

• Variables

Variables

var LocalRecovery = &subcommands.Command{
	UsageLine: "local-recovery UNIT_NAME",
	ShortDesc: "run recovery from local env.",
	LongDesc: `Run recovery against a DUT from local environment.

For now only running in testing mode.`,
	CommandRun: func() subcommands.CommandRun {
		c := &localRecoveryRun{
			devHostProxyAddresses: make(map[string]string),
		}
		c.authFlags.Register(&c.Flags, site.DefaultAuthOptions)
		c.CommonFlags.Register(&c.Flags)
		c.envFlags.Register(&c.Flags)

		c.Flags.StringVar(&c.configFile, "config", "", "Path to the custom json config file.")
		c.Flags.StringVar(&c.karteServer, "karte-server", "dev", "Use karte metric to record the action (dev by default).")
		c.Flags.BoolVar(&c.csaServer, "csa-server", true, "Use CSA Service or not.")

		c.Flags.StringVar(&c.devJumpHost, "dev-jump-host", "", "Jump host for SSH (Dev-only feature).")
		c.Flags.Var(lflag.JSONMap(&c.devHostProxyAddresses), "host-proxies",
			"JSON map of resource names to proxy addresses to use for ssh access (Dev-only feature). "+
				"For example, if you have an ssh tunnel to host chromeos15-row9-rack2-host1 at localhost:2200, you would set this to '{\"chromeos15-row9-rack2-host1\":\"localhost:2200\"}'. "+
				"The recovery process will then ssh into localhost:2200 when it otherwise would have tried to ssh into chromeos15-row9-rack2-host1. "+
				"The tunnel should point to port 22 on the target host so that requests are sent to the host's ssh server. "+
				"For easy tunneling, use labtunnel to create and maintain your tunnels and check the logs it emits for this JSON map (see go/labtunnel for docs).")
		c.Flags.StringVar(&c.logRoot, "log-root", "", "Path to the custom json config file.")
		c.Flags.BoolVar(&c.generateLogFiles, "generate-log-files", false, "Generate log files. Default is no.")

		c.Flags.BoolVar(&c.onlyVerify, "only-verify", true, "Enable recovery actions. Default is only run verify.")
		c.Flags.BoolVar(&c.devPrintProto, "log-proto", false, "Print proto data of dut. Default is no.")
		c.Flags.BoolVar(&c.updateInventory, "update-inv", false, "Update UFS at the end execution. Default is no.")
		c.Flags.BoolVar(&c.showSteps, "steps", false, "Show generated steps. Default is no.")
		c.Flags.BoolVar(&c.noCft, "no-cft", false, "Disable CFT. Default is no.")
		c.Flags.StringVar(&c.taskName, "task-name", "recovery", `What type of task name to use. The default is "recovery".`)
		c.Flags.BoolVar(&c.devOptionActive, "dev-active", true, `Set DevOption Active. Default true.`)
		c.Flags.StringVar(&c.namespace, "namespace", "os", `Specify which namespace to use. The default is "os".`)
		c.Flags.StringVar(&c.adbPort, "adb-port", "", `Specify value for ADB_CONNECTION_PORT.`)
		c.Flags.StringVar(&c.adbPath, "adb-path", "", `Specify value for ADB_PATH.`)
		return c
	},
}

LocalRecovery subcommand: Running verify/recovery against the DUT from local environment.

var RecoveryConfig = &subcommands.Command{
	UsageLine: "config [-task-name TASK] [-device DEV] [-plan PLAN] [-tree]",
	ShortDesc: "print the JSON plan configuration file",
	LongDesc:  "print the JSON plan configuration file.",
	CommandRun: func() subcommands.CommandRun {
		c := &printConfigRun{}
		c.authFlags.Register(&c.Flags, site.DefaultAuthOptions)
		c.Flags.StringVar(&c.taskName, "task-name", "recovery", "Task name of the configuration we print.")
		c.Flags.StringVar(&c.deviceType, "device", "cros", "Device type supported 'cros', 'labstation'.")
		c.Flags.StringVar(&c.planName, "plan", "", "Print only plan instead of config.")
		c.Flags.BoolVar(&c.asTree, "tree", false, "Print data as tree.")
		c.Flags.BoolVar(&c.asShortTree, "short", false, "Print a short version of tree.")
		return c
	},
}

RecoveryConfig subcommand: For now, print the config file content to terminal/file.