Documentation
¶
Overview ¶
Package coderutil providers utilities for high-level operations on coder-sdk entities.
Index ¶
- func DefaultWorkspaceProvider(ctx context.Context, c coder.Client) (*coder.KubernetesProvider, error)
- func DialEnvWsep(ctx context.Context, client coder.Client, env *coder.Environment) (*websocket.Conn, error)
- func MakeImageMap(ctx context.Context, client coder.Client, envs []coder.Environment) (map[string]*coder.Image, error)
- func ProviderByName(ctx context.Context, client coder.Client, name string) (*coder.KubernetesProvider, error)
- type EnvTable
- type EnvWithWorkspaceProvider
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultWorkspaceProvider ¶ added in v1.17.0
func DefaultWorkspaceProvider(ctx context.Context, c coder.Client) (*coder.KubernetesProvider, error)
DefaultWorkspaceProvider returns the default provider with which to create environments.
func DialEnvWsep ¶
func DialEnvWsep(ctx context.Context, client coder.Client, env *coder.Environment) (*websocket.Conn, error)
DialEnvWsep dials the executor endpoint using the https://github.com/cdr/wsep message protocol. The proper workspace provider envproxy access URL is used.
func MakeImageMap ¶ added in v1.17.2
func MakeImageMap(ctx context.Context, client coder.Client, envs []coder.Environment) (map[string]*coder.Image, error)
MakeImageMap fetches all image entities specified in the slice of environments, then places them into an ID map.
func ProviderByName ¶ added in v1.17.0
func ProviderByName(ctx context.Context, client coder.Client, name string) (*coder.KubernetesProvider, error)
ProviderByName searches linearly for a workspace provider by its name.
Types ¶
type EnvTable ¶ added in v1.17.0
type EnvTable struct {
Name string `table:"Name"`
Image string `table:"Image"`
CPU float32 `table:"vCPU"`
MemoryGB float32 `table:"MemoryGB"`
DiskGB int `table:"DiskGB"`
Status string `table:"Status"`
Provider string `table:"Provider"`
CVM bool `table:"CVM"`
}
EnvTable defines an Environment-like structure with associated entities composed in a human readable form.
func EnvsHumanTable ¶ added in v1.17.0
func EnvsHumanTable(ctx context.Context, client coder.Client, envs []coder.Environment) ([]EnvTable, error)
EnvsHumanTable performs the composition of each Environment with its associated ProviderName and ImageRepo.
type EnvWithWorkspaceProvider ¶
type EnvWithWorkspaceProvider struct {
Env coder.Environment
WorkspaceProvider coder.KubernetesProvider
}
EnvWithWorkspaceProvider composes an Environment entity with its associated WorkspaceProvider.
func EnvsWithProvider ¶
func EnvsWithProvider(ctx context.Context, client coder.Client, envs []coder.Environment) ([]EnvWithWorkspaceProvider, error)
EnvsWithProvider performs the composition of each Environment with its associated WorkspaceProvider.
Source Files