blob: 3ea4a227141a34c65d1fc8e314854606a8c06cda [file] [log] [blame]
// Copyright 2020 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
package vm
import (
"context"
"fmt"
"github.com/maruel/subcommands"
"go.chromium.org/luci/auth/client/authcli"
"go.chromium.org/luci/common/cli"
"go.chromium.org/luci/common/errors"
"go.chromium.org/luci/grpc/prpc"
"infra/cmd/shivas/cmdhelp"
"infra/cmd/shivas/site"
"infra/cmd/shivas/utils"
"infra/cmdsupport/cmdlib"
ufspb "infra/unifiedfleet/api/v1/models"
ufsAPI "infra/unifiedfleet/api/v1/rpc"
ufsUtil "infra/unifiedfleet/app/util"
)
// AddVMCmd add a vm on a host.
var AddVMCmd = &subcommands.Command{
UsageLine: "vm [Options..]",
ShortDesc: "Add a VM on a host",
LongDesc: `Add a VM on a host
Examples:
shivas add vm -f vm.json
Add a VM on a host by reading a JSON file input.
[WARNING]: machineLseId is a required field in json, all other output only fields will be ignored.
Specify additional settings, e.g. vlan, ip via command line parameters along with JSON input
shivas add vm -name vm1 -host host1 -mac 12:34:56 -os chrome-version-1
Add a VM by parameters.`,
CommandRun: func() subcommands.CommandRun {
c := &addVM{}
c.authFlags.Register(&c.Flags, site.DefaultAuthOptions)
c.envFlags.Register(&c.Flags)
c.commonFlags.Register(&c.Flags)
c.Flags.StringVar(&c.newSpecsFile, "f", "", cmdhelp.VMFileText)
c.Flags.StringVar(&c.hostName, "host", "", "hostname of the host to add the VM")
c.Flags.StringVar(&c.vmName, "name", "", "hostname/name of the VM")
c.Flags.StringVar(&c.macAddress, "mac", "", "mac address of the VM")
c.Flags.StringVar(&c.osVersion, "os", "", "os version of the VM")
c.Flags.StringVar(&c.tags, "tags", "", "comma separated tags. You can only append/add new tags here.")
c.Flags.StringVar(&c.deploymentTicket, "ticket", "", "the deployment ticket for this vm")
c.Flags.StringVar(&c.vlanName, "vlan", "", "name of the vlan to assign this vm to")
c.Flags.StringVar(&c.ip, "ip", "", "the ip to assign the vm to")
return c
},
}
type addVM struct {
subcommands.CommandRunBase
authFlags authcli.Flags
envFlags site.EnvFlags
commonFlags site.CommonFlags
newSpecsFile string
hostName string
vmName string
macAddress string
osVersion string
tags string
vlanName string
ip string
deploymentTicket string
}
func (c *addVM) Run(a subcommands.Application, args []string, env subcommands.Env) int {
if err := c.innerRun(a, args, env); err != nil {
cmdlib.PrintError(a, err)
return 1
}
return 0
}
func (c *addVM) innerRun(a subcommands.Application, args []string, env subcommands.Env) error {
if err := c.validateArgs(); err != nil {
return err
}
ctx := cli.GetContext(a, c, env)
ns, err := c.envFlags.Namespace()
if err != nil {
return err
}
ctx = utils.SetupContext(ctx, ns)
hc, err := cmdlib.NewHTTPClient(ctx, &c.authFlags)
if err != nil {
return err
}
e := c.envFlags.Env()
if c.commonFlags.Verbose() {
fmt.Printf("Using UFS service %s\n", e.UnifiedFleetService)
}
ic := ufsAPI.NewFleetPRPCClient(&prpc.Client{
C: hc,
Host: e.UnifiedFleetService,
Options: site.DefaultPRPCOptions,
})
// Parse input json
var vm ufspb.VM
if c.newSpecsFile != "" {
if err = utils.ParseJSONFile(c.newSpecsFile, &vm); err != nil {
return err
}
if vm.GetMachineLseId() == "" {
return errors.New(fmt.Sprintf("machineLseId field is empty in json. It is a required parameter for json input."))
}
} else {
c.parseArgs(&vm)
}
if !ufsUtil.ValidateTags(vm.Tags) {
return fmt.Errorf(ufsAPI.InvalidTags)
}
res, err := ic.CreateVM(ctx, &ufsAPI.CreateVMRequest{
Vm: &vm,
NetworkOption: c.parseNetworkOpt(),
})
if err != nil {
return errors.Annotate(err, "Unable to add the VM to the host").Err()
}
res.Name = ufsUtil.RemovePrefix(res.Name)
c.printRes(ctx, ic, res)
return nil
}
func (c *addVM) printRes(ctx context.Context, ic ufsAPI.FleetClient, res *ufspb.VM) {
fmt.Println("The newly added vm:")
utils.PrintProtoJSON(res, !utils.NoEmitMode(false))
fmt.Printf("Successfully added the vm %s to host %s\n", res.Name, res.GetMachineLseId())
if c.vlanName != "" || c.ip != "" {
// Log the assigned IP
if dhcp, err := ic.GetDHCPConfig(ctx, &ufsAPI.GetDHCPConfigRequest{
Hostname: res.Name,
}); err == nil {
fmt.Println("Newly added DHCP config:")
utils.PrintProtoJSON(dhcp, false)
fmt.Printf("Successfully added dhcp config %s to vm %s\nPlease run `shivas get vm -full %s` to further check\n", dhcp.GetIp(), res.Name, res.Name)
}
}
}
func (c *addVM) parseArgs(vm *ufspb.VM) {
vm.Name = c.vmName
vm.Hostname = c.vmName
vm.MacAddress = c.macAddress
vm.MachineLseId = c.hostName
vm.OsVersion = &ufspb.OSVersion{
Value: c.osVersion,
}
vm.Tags = utils.GetStringSlice(c.tags)
vm.DeploymentTicket = c.deploymentTicket
}
func (c *addVM) parseNetworkOpt() *ufsAPI.NetworkOption {
if c.ip != "" || c.vlanName != "" {
fmt.Println("Setting network option parameters")
if c.ip != "" {
return &ufsAPI.NetworkOption{
Ip: c.ip,
}
}
if c.vlanName != "" {
return &ufsAPI.NetworkOption{
Vlan: c.vlanName,
}
}
}
return nil
}
func (c *addVM) validateArgs() error {
if c.newSpecsFile != "" {
if c.vmName != "" {
return cmdlib.NewQuietUsageError(c.Flags, "Wrong usage!!\nThe interactive/JSON mode is specified. '-name' cannot be specified at the same time.")
}
if c.hostName != "" {
return cmdlib.NewQuietUsageError(c.Flags, "Wrong usage!!\nThe interactive/JSON mode is specified. '-host' cannot be specified at the same time.")
}
if c.macAddress != "" {
return cmdlib.NewQuietUsageError(c.Flags, "Wrong usage!!\nThe interactive/JSON mode is specified. '-mac' cannot be specified at the same time.")
}
if c.tags != "" {
return cmdlib.NewQuietUsageError(c.Flags, "Wrong usage!!\nThe interactive/JSON mode is specified. '-tags' cannot be specified at the same time.")
}
if c.osVersion != "" {
return cmdlib.NewQuietUsageError(c.Flags, "Wrong usage!!\nThe interactive/JSON mode is specified. '-os' cannot be specified at the same time.")
}
if c.hostName != "" {
return cmdlib.NewQuietUsageError(c.Flags, "Wrong usage!!\nThe interactive/JSON mode is specified. '-host' cannot be specified at the same time.")
}
if c.deploymentTicket != "" {
return cmdlib.NewQuietUsageError(c.Flags, "Wrong usage!!\nThe interactive/JSON mode is specified. '-ticket' cannot be specified at the same time.")
}
} else {
if c.hostName == "" {
return cmdlib.NewQuietUsageError(c.Flags, "Wrong usage!!\n'-host' is required.")
}
if c.vmName == "" {
return cmdlib.NewQuietUsageError(c.Flags, "Wrong usage!!\n'-name' is required, no mode ('-f') is specified.")
}
if c.macAddress == "" {
return cmdlib.NewQuietUsageError(c.Flags, "Wrong usage!!\n'-mac' is required, no mode ('-f') is specified.")
}
}
return nil
}