utils

Documentation

Index

• Constants
• Variables
• func AddCommonFlags(command *cobra.Command, flags *CommonFlags)
• func AddNodeFlags(command *cobra.Command)
• func AddNodeFlagsOnly(command *cobra.Command)
• func GetCredentials() (*azidentity.ChainedTokenCredential, error)
• func GetNodeResourceID(ctx context.Context, nodeName string) (string, error)
• func ParseVMSSResourceID(id string, vm *VirtualMachineScaleSetVM) error
• func RunCommand(ctx context.Context, cred azcore.TokenCredential, vm *VirtualMachineScaleSetVM, ...) (string, error)
• func VirtualMachineScaleSetVMsViaKubeconfig() (map[string]*VirtualMachineScaleSetVM, error)
• type CommonFlags
• type VirtualMachineScaleSetVM
  • func VirtualMachineScaleSetVMFromConfig() (*VirtualMachineScaleSetVM, error)

Constants

const (
	NodeKey              = "node"
	SubscriptionIDKey    = "subscription"
	NodeResourceGroupKey = "node-resource-group"
	VMSSKey              = "vmss"
	VMSSInstanceIDKey    = "instance-id"
	ResourceIDKey        = "id"
)

Variables

var KubernetesConfigFlags = genericclioptions.NewConfigFlags(false)

Functions

func AddCommonFlags

func AddCommonFlags(command *cobra.Command, flags *CommonFlags)

func AddNodeFlags

func AddNodeFlags(command *cobra.Command)

Every command that allows user to specify the node name has three options: (1) Provide the kubernetes node name (2) Provide the VMMS instance information (--subscription, --node-resource-group, --vmss and --instance-id) (3) Provide Resource ID (/subscriptions/mySubID/resourceGroups/myRG/providers/myProvider/virtualMachineScaleSets/myVMSS/virtualMachines/myInsID)

func AddNodeFlagsOnly

func AddNodeFlagsOnly(command *cobra.Command)

AddNodeFlagsOnly adds node flags without binding config/environment variables

func GetCredentials

func GetCredentials() (*azidentity.ChainedTokenCredential, error)

Further details about authentication: https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/azidentity

func GetNodeResourceID

func GetNodeResourceID(ctx context.Context, nodeName string) (string, error)

GetNodeResourceID retrieve the Azure resource ID of a given node. In other words, the resource ID of the VM scale set instance. It returns format: /subscriptions/mySubID/resourceGroups/myRG/providers/myProvider/virtualMachineScaleSets/myVMSS/virtualMachines/myInsID

func ParseVMSSResourceID

func ParseVMSSResourceID(id string, vm *VirtualMachineScaleSetVM) error

ParseVMSSResourceID extracts elements from a given VMSS resource ID with format: /subscriptions/mySubID/resourceGroups/myRG/providers/myProvider/virtualMachineScaleSets/myVMSS/virtualMachines/myInsID

func RunCommand

func RunCommand(
	ctx context.Context,
	cred azcore.TokenCredential,
	vm *VirtualMachineScaleSetVM,
	command *string,
	verbose bool,
) (
	string,
	error,
)

func VirtualMachineScaleSetVMsViaKubeconfig

func VirtualMachineScaleSetVMsViaKubeconfig() (map[string]*VirtualMachineScaleSetVM, error)

Types

type CommonFlags

type CommonFlags struct {
	Verbose bool
}

CommonFlags contains CLI flags common for all subcommands

type VirtualMachineScaleSetVM

type VirtualMachineScaleSetVM struct {
	SubscriptionID    string
	NodeResourceGroup string
	VMScaleSet        string
	InstanceID        string
}

func VirtualMachineScaleSetVMFromConfig

func VirtualMachineScaleSetVMFromConfig() (*VirtualMachineScaleSetVM, error)

VirtualMachineScaleSetVMFromConfig returns a VirtualMachineScaleSetVM object it assumes that the config is set and valid