coderutil

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 DialWorkspaceWsep(ctx context.Context, client coder.Client, workspace *coder.Workspace) (*websocket.Conn, error)
• func MakeImageMap(ctx context.Context, client coder.Client, workspaces []coder.Workspace) (map[string]*coder.Image, error)
• func MakeUserMap(ctx context.Context, client coder.Client, workspaces []coder.Workspace) (map[string]*coder.User, error)
• func ProviderByName(ctx context.Context, client coder.Client, name string) (*coder.KubernetesProvider, error)
• type WorkspaceTable
  • func WorkspacesHumanTable(ctx context.Context, client coder.Client, workspaces []coder.Workspace) ([]WorkspaceTable, error)
• type WorkspaceWithWorkspaceProvider
  • func WorkspacesWithProvider(ctx context.Context, client coder.Client, workspaces []coder.Workspace) ([]WorkspaceWithWorkspaceProvider, error)

Functions

func DefaultWorkspaceProvider

func DefaultWorkspaceProvider(ctx context.Context, c coder.Client) (*coder.KubernetesProvider, error)

DefaultWorkspaceProvider returns the default provider with which to create workspaces.

func DialWorkspaceWsep

func DialWorkspaceWsep(ctx context.Context, client coder.Client, workspace *coder.Workspace) (*websocket.Conn, error)

DialWorkspaceWsep dials the executor endpoint using the https://github.com/cdr/wsep message protocol. The proper workspace provider envproxy access URL is used.

func MakeImageMap

func MakeImageMap(ctx context.Context, client coder.Client, workspaces []coder.Workspace) (map[string]*coder.Image, error)

MakeImageMap fetches all image entities specified in the slice of workspaces, then places them into an ID map.

func MakeUserMap

func MakeUserMap(ctx context.Context, client coder.Client, workspaces []coder.Workspace) (map[string]*coder.User, error)

func ProviderByName

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 WorkspaceTable

type WorkspaceTable struct {
	Name     string  `table:"Name" json:"name"`
	Image    string  `table:"Image" json:"image"`
	CPU      float32 `table:"vCPU" json:"cpu"`
	MemoryGB float32 `table:"MemoryGB" json:"memory_gb"`
	DiskGB   int     `table:"DiskGB" json:"disk_gb"`
	Status   string  `table:"Status" json:"status"`
	Provider string  `table:"Provider" json:"provider"`
	CVM      bool    `table:"CVM" json:"cvm"`
	Username string  `table:"Username" json:"username"`
}

WorkspaceTable defines an Workspace-like structure with associated entities composed in a human readable form.

func WorkspacesHumanTable

func WorkspacesHumanTable(ctx context.Context, client coder.Client, workspaces []coder.Workspace) ([]WorkspaceTable, error)

WorkspacesHumanTable performs the composition of each Workspace with its associated ProviderName and ImageRepo.

type WorkspaceWithWorkspaceProvider

type WorkspaceWithWorkspaceProvider struct {
	Workspace         coder.Workspace
	WorkspaceProvider coder.KubernetesProvider
}

WorkspaceWithWorkspaceProvider composes an Workspace entity with its associated WorkspaceProvider.

func WorkspacesWithProvider

func WorkspacesWithProvider(ctx context.Context, client coder.Client, workspaces []coder.Workspace) ([]WorkspaceWithWorkspaceProvider, error)

WorkspacesWithProvider performs the composition of each Workspace with its associated WorkspaceProvider.