workspace

Documentation

Index

• Variables
• func AddProvider(devPodConfig *config.Config, providerName, providerSourceRaw string, ...) (*provider2.ProviderConfig, error)
• func AddProviderRaw(devPodConfig *config.Config, providerName string, ...) (*provider2.ProviderConfig, error)
• func Delete(ctx context.Context, devPodConfig *config.Config, args []string, ...) (string, error)
• func DownloadProviderGithub(originalPath string, log log.Logger) ([]byte, *provider2.ProviderSource, error)
• func Exists(ctx context.Context, devPodConfig *config.Config, args []string, ...) string
• func FindProviderProInstance(proInstances []*provider2.ProInstance, providerName string) (*provider2.ProInstance, bool)
• func Get(ctx context.Context, devPodConfig *config.Config, args []string, ...) (client.BaseWorkspaceClient, error)
• func GetMachine(devPodConfig *config.Config, args []string, log log.Logger) (client.MachineClient, error)
• func List(ctx context.Context, devPodConfig *config.Config, skipPro bool, log log.Logger) ([]*providerpkg.Workspace, error)
• func ListLocalWorkspaces(contextName string, skipPro bool, log log.Logger) ([]*providerpkg.Workspace, error)
• func ListProInstances(devPodConfig *config.Config, log log.Logger) ([]*provider2.ProInstance, error)
• func LoadAllProviders(devPodConfig *config.Config, log log.Logger) (map[string]*ProviderWithOptions, error)
• func MachineExists(devPodConfig *config.Config, args []string) string
• func Resolve(ctx context.Context, devPodConfig *config.Config, ide string, ...) (client.BaseWorkspaceClient, error)
• func ResolveMachine(devPodConfig *config.Config, args []string, userOptions []string, ...) (client.Client, error)
• func ResolveProvider(providerSource string, log log.Logger) ([]byte, *provider2.ProviderSource, error)
• func ResolveProviderSource(devPodConfig *config.Config, providerName string, log log.Logger) (string, error)
• func SingleMachineName(devPodConfig *config.Config, provider string, log log.Logger) string
• func ToID(str string) string
• func UpdateProvider(devPodConfig *config.Config, providerName, providerSourceRaw string, ...) (*provider2.ProviderConfig, error)
• type ProviderWithOptions
  • func CloneProvider(devPodConfig *config.Config, providerName, providerSourceRaw string, ...) (*ProviderWithOptions, error)
  • func FindProvider(devPodConfig *config.Config, name string, log log.Logger) (*ProviderWithOptions, error)
  • func LoadProviders(devPodConfig *config.Config, log log.Logger) (*ProviderWithOptions, map[string]*ProviderWithOptions, error)

Variables

var (
	ErrNoWorkspaceFound = errors.New("no workspace found")
)

Functions

func AddProvider

func AddProvider(devPodConfig *config.Config, providerName, providerSourceRaw string, log log.Logger) (*provider2.ProviderConfig, error)

func AddProviderRaw

func AddProviderRaw(devPodConfig *config.Config, providerName string, providerSource *provider2.ProviderSource, providerRaw []byte, log log.Logger) (*provider2.ProviderConfig, error)

func Delete

func Delete(ctx context.Context, devPodConfig *config.Config, args []string, ignoreNotFound, force bool, deleteOptions client2.DeleteOptions, log log.Logger) (string, error)

func DownloadProviderGithub

func DownloadProviderGithub(originalPath string, log log.Logger) ([]byte, *provider2.ProviderSource, error)

func Exists

func Exists(ctx context.Context, devPodConfig *config.Config, args []string, workspaceID string, log log.Logger) string

Exists checks if the given workspace already exists

func FindProviderProInstance

func FindProviderProInstance(proInstances []*provider2.ProInstance, providerName string) (*provider2.ProInstance, bool)

func Get

func Get(ctx context.Context, devPodConfig *config.Config, args []string, changeLastUsed bool, log log.Logger) (client.BaseWorkspaceClient, error)

Get tries to retrieve an already existing workspace

func GetMachine

func GetMachine(devPodConfig *config.Config, args []string, log log.Logger) (client.MachineClient, error)

GetMachine creates a machine client

func List

func List(ctx context.Context, devPodConfig *config.Config, skipPro bool, log log.Logger) ([]*providerpkg.Workspace, error)

func ListLocalWorkspaces

func ListLocalWorkspaces(contextName string, skipPro bool, log log.Logger) ([]*providerpkg.Workspace, error)

func ListProInstances

func ListProInstances(devPodConfig *config.Config, log log.Logger) ([]*provider2.ProInstance, error)

func LoadAllProviders

func LoadAllProviders(devPodConfig *config.Config, log log.Logger) (map[string]*ProviderWithOptions, error)

func MachineExists

func MachineExists(devPodConfig *config.Config, args []string) string

MachineExists checks if the given workspace already exists

func Resolve

func Resolve(
	ctx context.Context,
	devPodConfig *config.Config,
	ide string,
	ideOptions []string,
	args []string,
	desiredID,
	desiredMachine string,
	providerUserOptions []string,
	reconfigureProvider bool,
	devContainerImage string,
	devContainerPath string,
	sshConfigPath string,
	source *providerpkg.WorkspaceSource,
	uid string,
	changeLastUsed bool,
	log log.Logger,
) (client.BaseWorkspaceClient, error)

Resolve takes the `devpod up|build` CLI input and either finds an existing workspace or creates a new one

func ResolveMachine

func ResolveMachine(devPodConfig *config.Config, args []string, userOptions []string, log log.Logger) (client.Client, error)

func ResolveProvider

func ResolveProvider(providerSource string, log log.Logger) ([]byte, *provider2.ProviderSource, error)

func ResolveProviderSource

func ResolveProviderSource(devPodConfig *config.Config, providerName string, log log.Logger) (string, error)

func SingleMachineName

func SingleMachineName(devPodConfig *config.Config, provider string, log log.Logger) string

func ToID

func ToID(str string) string

func UpdateProvider

func UpdateProvider(devPodConfig *config.Config, providerName, providerSourceRaw string, log log.Logger) (*provider2.ProviderConfig, error)

Types

type ProviderWithOptions

type ProviderWithOptions struct {
	Config *provider2.ProviderConfig `json:"config,omitempty"`
	State  *config.ProviderConfig    `json:"state,omitempty"`
}

func CloneProvider

func CloneProvider(devPodConfig *config.Config, providerName, providerSourceRaw string, log log.Logger) (*ProviderWithOptions, error)

func FindProvider

func FindProvider(devPodConfig *config.Config, name string, log log.Logger) (*ProviderWithOptions, error)

func LoadProviders

func LoadProviders(devPodConfig *config.Config, log log.Logger) (*ProviderWithOptions, map[string]*ProviderWithOptions, error)

LoadProviders loads all known providers for the given context and