machinescommon

Documentation

Index

• Constants
• Variables
• func DoWebForTargets(target *machines.DeploymentTarget, dependencies *cmd.Dependencies, ...)
• func DoWebForWorkerPools(workerPool workerpools.IWorkerPool, dependencies *cmd.Dependencies, ...)
• func DoWebForWorkers(worker *machines.Worker, dependencies *cmd.Dependencies, flags *WebFlags, ...)
• func FindMachinePolicy(getAllMachinePoliciesCallback GetAllMachinePoliciesCallback, nameOrId string) (*machines.MachinePolicy, error)
• func FindProxy(opts *CreateTargetProxyOptions, flags *CreateTargetProxyFlags) (*proxies.Proxy, error)
• func GetSshAccount(opts *SshCommonOptions, flags *SshCommonFlags) (accounts.IAccount, error)
• func PromptForDotNetConfig(opts *SshCommonOptions, flags *SshCommonFlags, entityType string) error
• func PromptForMachinePolicy(opts *CreateTargetMachinePolicyOptions, flags *CreateTargetMachinePolicyFlags) error
• func PromptForProxy(opts *CreateTargetProxyOptions, flags *CreateTargetProxyFlags, ...) error
• func PromptForSshAccount(opts *SshCommonOptions, flags *SshCommonFlags) error
• func PromptForSshEndpoint(opts *SshCommonOptions, flags *SshCommonFlags, entityType string) error
• func RegisterCreateTargetMachinePolicyFlags(cmd *cobra.Command, machinePolicyFlags *CreateTargetMachinePolicyFlags)
• func RegisterCreateTargetProxyFlags(cmd *cobra.Command, proxyFlags *CreateTargetProxyFlags, description string)
• func RegisterSshCommonFlags(cmd *cobra.Command, flags *SshCommonFlags, entityType string)
• func RegisterWebFlag(cmd *cobra.Command, flags *WebFlags)
• type CreateTargetMachinePolicyFlags
  • func NewCreateTargetMachinePolicyFlags() *CreateTargetMachinePolicyFlags
• type CreateTargetMachinePolicyOptions
  • func NewCreateTargetMachinePolicyOptions(dependencies *cmd.Dependencies) *CreateTargetMachinePolicyOptions
• type CreateTargetProxyFlags
  • func NewCreateTargetProxyFlags() *CreateTargetProxyFlags
• type CreateTargetProxyOptions
  • func NewCreateTargetProxyOptions(dependencies *cmd.Dependencies) *CreateTargetProxyOptions
• type GetAllAccountsForSshMachine
• type GetAllMachinePoliciesCallback
• type GetAllProxiesCallback
• type SshCommonFlags
  • func NewSshCommonFlags() *SshCommonFlags
• type SshCommonOptions
  • func NewSshCommonOpts(dependencies *cmd.Dependencies) *SshCommonOptions
• type WebFlags
  • func NewWebFlags() *WebFlags

Constants

const (
	FlagFingerprint = "fingerprint"
	FlagHost        = "host"
	FlagPort        = "port"
	FlagAccount     = "account"
	FlagRuntime     = "runtime"
	FlagPlatform    = "platform"

	SelfContainedCalamari = "self-contained"
	MonoCalamari          = "mono"

	LinuxX64   = "linux-x64"
	LinuxArm64 = "linux-arm64"
	LinuxArm   = "linux-arm"
	OsxX64     = "osx-x64"

	DefaultPort = 22
)

const (
	FlagMachinePolicy = "machine-policy"
)

const FlagProxy = "proxy"

const (
	FlagWeb = "web"
)

Variables

var CommunicationStyleToDeploymentTargetTypeMap = map[string]string{
	"TentaclePassive":           "TentaclePassive",
	"TentacleActive":            "TentacleActive",
	"Ssh":                       "Ssh",
	"OfflineDrop":               "OfflineDrop",
	"AzureWebApp":               "AzureWebApp",
	"AzureCloudService":         "AzureCloudService",
	"AzureServiceFabricCluster": "AzureServiceFabricCluster",
	"Kubernetes":                "Kubernetes",
	"None":                      "CloudRegion",
}

var CommunicationStyleToDescriptionMap = map[string]string{
	"TentaclePassive":           "Listening Tentacle",
	"TentacleActive":            "Polling Tentacle",
	"Ssh":                       "SSH Connection",
	"OfflineDrop":               "Offline Package Drop",
	"AzureWebApp":               "Azure Web App",
	"AzureCloudService":         "Azure Cloud Service",
	"AzureServiceFabricCluster": "Service Fabric Cluster",
	"Kubernetes":                "Kubernetes Cluster",
	"None":                      "Cloud Region",
	"StepPackage":               "Step Package",
}

Functions

func DoWebForTargets

func DoWebForTargets(target *machines.DeploymentTarget, dependencies *cmd.Dependencies, flags *WebFlags, description string)

func DoWebForWorkerPools

func DoWebForWorkerPools(workerPool workerpools.IWorkerPool, dependencies *cmd.Dependencies, flags *WebFlags)

func DoWebForWorkers

func DoWebForWorkers(worker *machines.Worker, dependencies *cmd.Dependencies, flags *WebFlags, description string)

func FindMachinePolicy

func FindMachinePolicy(getAllMachinePoliciesCallback GetAllMachinePoliciesCallback, nameOrId string) (*machines.MachinePolicy, error)

func FindProxy

func FindProxy(opts *CreateTargetProxyOptions, flags *CreateTargetProxyFlags) (*proxies.Proxy, error)

func GetSshAccount

func GetSshAccount(opts *SshCommonOptions, flags *SshCommonFlags) (accounts.IAccount, error)

func PromptForDotNetConfig

func PromptForDotNetConfig(opts *SshCommonOptions, flags *SshCommonFlags, entityType string) error

func PromptForMachinePolicy

func PromptForMachinePolicy(opts *CreateTargetMachinePolicyOptions, flags *CreateTargetMachinePolicyFlags) error

func PromptForProxy

func PromptForProxy(opts *CreateTargetProxyOptions, flags *CreateTargetProxyFlags, description string) error

func PromptForSshAccount

func PromptForSshAccount(opts *SshCommonOptions, flags *SshCommonFlags) error

func PromptForSshEndpoint

func PromptForSshEndpoint(opts *SshCommonOptions, flags *SshCommonFlags, entityType string) error

func RegisterCreateTargetMachinePolicyFlags

func RegisterCreateTargetMachinePolicyFlags(cmd *cobra.Command, machinePolicyFlags *CreateTargetMachinePolicyFlags)

func RegisterCreateTargetProxyFlags

func RegisterCreateTargetProxyFlags(cmd *cobra.Command, proxyFlags *CreateTargetProxyFlags, description string)

func RegisterSshCommonFlags

func RegisterSshCommonFlags(cmd *cobra.Command, flags *SshCommonFlags, entityType string)

func RegisterWebFlag

func RegisterWebFlag(cmd *cobra.Command, flags *WebFlags)

Types

type CreateTargetMachinePolicyFlags

type CreateTargetMachinePolicyFlags struct {
	MachinePolicy *flag.Flag[string]
}

func NewCreateTargetMachinePolicyFlags

func NewCreateTargetMachinePolicyFlags() *CreateTargetMachinePolicyFlags

type CreateTargetMachinePolicyOptions

type CreateTargetMachinePolicyOptions struct {
	*cmd.Dependencies
	GetAllMachinePoliciesCallback
}

func NewCreateTargetMachinePolicyOptions

func NewCreateTargetMachinePolicyOptions(dependencies *cmd.Dependencies) *CreateTargetMachinePolicyOptions

type CreateTargetProxyFlags

type CreateTargetProxyFlags struct {
	Proxy *flag.Flag[string]
}

func NewCreateTargetProxyFlags

func NewCreateTargetProxyFlags() *CreateTargetProxyFlags

type CreateTargetProxyOptions

type CreateTargetProxyOptions struct {
	*cmd.Dependencies
	GetAllProxiesCallback
}

func NewCreateTargetProxyOptions

func NewCreateTargetProxyOptions(dependencies *cmd.Dependencies) *CreateTargetProxyOptions

type GetAllAccountsForSshMachine

type GetAllAccountsForSshMachine func() ([]accounts.IAccount, error)

type GetAllMachinePoliciesCallback

type GetAllMachinePoliciesCallback func() ([]*machines.MachinePolicy, error)

type GetAllProxiesCallback

type GetAllProxiesCallback func() ([]*proxies.Proxy, error)

type SshCommonFlags

type SshCommonFlags struct {
	Fingerprint *flag.Flag[string]
	HostName    *flag.Flag[string]
	Port        *flag.Flag[int]
	Account     *flag.Flag[string]
	Runtime     *flag.Flag[string]
	Platform    *flag.Flag[string]
}

func NewSshCommonFlags

func NewSshCommonFlags() *SshCommonFlags

type SshCommonOptions

type SshCommonOptions struct {
	*cmd.Dependencies
	GetAllAccountsForSshMachine
}

func NewSshCommonOpts

func NewSshCommonOpts(dependencies *cmd.Dependencies) *SshCommonOptions

type WebFlags

type WebFlags struct {
	Web *flag.Flag[bool]
}

func NewWebFlags

func NewWebFlags() *WebFlags