kubernetes

Documentation

Index

• Constants
• Variables
• func DecodeAuthTokenFromPullSecret(secret k8sv1.Secret, host string) (string, error)
• func GetRegistryFromImageName(imageName string) (string, error)
• func IsCritical(status *corev1.ContainerStatus) bool
• func IsReady(status *corev1.ContainerStatus) bool
• func IsRunning(status *corev1.ContainerStatus) bool
• func IsStarted(status *corev1.ContainerStatus) bool
• func IsTerminated(status *corev1.ContainerStatus) bool
• func IsWaiting(status *corev1.ContainerStatus) bool
• func NewKubernetesDriver(options *options.Options, log log.Logger) driver.Driver
• func PreparePullSecretData(registryURL, authToken, email string) (string, error)
• func Succeeded(status *corev1.ContainerStatus) bool
• type DevContainerInfo
• type DockerConfig
• type DockerConfigEntry
• type DockerConfigJSON
• type KubernetesDriver
  • func (k *KubernetesDriver) CommandDevContainer(ctx context.Context, workspaceId, user, command string, stdin io.Reader, ...) error
  • func (k *KubernetesDriver) DeleteDevContainer(ctx context.Context, workspaceId string) error
  • func (k *KubernetesDriver) DeletePullSecret(ctx context.Context, pullSecretName string) error
  • func (k *KubernetesDriver) EnsurePullSecret(ctx context.Context, pullSecretName string, dockerImage string) (bool, error)
  • func (k *KubernetesDriver) FindDevContainer(ctx context.Context, workspaceId string) (*config.ContainerDetails, error)
  • func (k *KubernetesDriver) GetDevContainerLogs(ctx context.Context, workspaceID string, stdout io.Writer, stderr io.Writer) error
  • func (k *KubernetesDriver) ReadSecretContents(ctx context.Context, pullSecretName string, host string) (string, error)
  • func (k *KubernetesDriver) RunDevContainer(ctx context.Context, workspaceId string, options *driver.RunOptions) error
  • func (k *KubernetesDriver) StartDevContainer(ctx context.Context, workspaceId string) error
  • func (k *KubernetesDriver) StopDevContainer(ctx context.Context, workspaceId string) error
  • func (k *KubernetesDriver) TargetArchitecture(ctx context.Context, workspaceId string) (string, error)

Constants

const (
	DevPodCreatedLabel      = "devpod.sh/created"
	DevPodWorkspaceLabel    = "devpod.sh/workspace"
	DevPodWorkspaceUIDLabel = "devpod.sh/workspace-uid"

	DevPodInfoAnnotation        = "devpod.sh/info"
	DevPodLastAppliedAnnotation = "devpod.sh/last-applied-configuration"
)

const DevContainerName = "devpod"

const InitContainerName = "devpod-init"

const OfficialDockerRegistry = "https://index.docker.io/v1/"

Variables

var ExtraDevPodLabels = map[string]string{
	DevPodCreatedLabel: "true",
}

Functions

func DecodeAuthTokenFromPullSecret

func DecodeAuthTokenFromPullSecret(secret k8sv1.Secret, host string) (string, error)

func GetRegistryFromImageName

func GetRegistryFromImageName(imageName string) (string, error)

GetRegistryFromImageName retrieves the registry name from an imageName

func IsCritical

func IsCritical(status *corev1.ContainerStatus) bool

func IsReady

func IsReady(status *corev1.ContainerStatus) bool

func IsRunning

func IsRunning(status *corev1.ContainerStatus) bool

func IsStarted

func IsStarted(status *corev1.ContainerStatus) bool

func IsTerminated

func IsTerminated(status *corev1.ContainerStatus) bool

func IsWaiting

func IsWaiting(status *corev1.ContainerStatus) bool

func NewKubernetesDriver

func NewKubernetesDriver(options *options.Options, log log.Logger) driver.Driver

func PreparePullSecretData

func PreparePullSecretData(registryURL, authToken, email string) (string, error)

func Succeeded

func Succeeded(status *corev1.ContainerStatus) bool

Types

type DevContainerInfo

type DevContainerInfo struct {
	WorkspaceID string
	Options     *driver.RunOptions
}

type DockerConfig

type DockerConfig map[string]DockerConfigEntry

DockerConfig represents the config file used by the docker CLI. This config that represents the credentials that should be used when pulling images from specific image repositories.

type DockerConfigEntry

type DockerConfigEntry struct {
	Auth  string `json:"auth"`
	Email string `json:"email"`
}

DockerConfigEntry holds the user information that grant the access to docker registry

type DockerConfigJSON

type DockerConfigJSON struct {
	Auths DockerConfig `json:"auths"`
}

DockerConfigJSON represents a local docker auth config file for pulling images.

type KubernetesDriver

type KubernetesDriver struct {
	Log log.Logger
	// contains filtered or unexported fields
}

func (*KubernetesDriver) CommandDevContainer

func (k *KubernetesDriver) CommandDevContainer(ctx context.Context, workspaceId, user, command string, stdin io.Reader, stdout io.Writer, stderr io.Writer) error

func (*KubernetesDriver) DeleteDevContainer

func (k *KubernetesDriver) DeleteDevContainer(ctx context.Context, workspaceId string) error

func (*KubernetesDriver) DeletePullSecret

func (k *KubernetesDriver) DeletePullSecret(
	ctx context.Context,
	pullSecretName string) error

func (*KubernetesDriver) EnsurePullSecret

func (k *KubernetesDriver) EnsurePullSecret(
	ctx context.Context,
	pullSecretName string,
	dockerImage string,
) (bool, error)

func (*KubernetesDriver) FindDevContainer

func (k *KubernetesDriver) FindDevContainer(ctx context.Context, workspaceId string) (*config.ContainerDetails, error)

func (*KubernetesDriver) GetDevContainerLogs

func (k *KubernetesDriver) GetDevContainerLogs(ctx context.Context, workspaceID string, stdout io.Writer, stderr io.Writer) error

func (*KubernetesDriver) ReadSecretContents

func (k *KubernetesDriver) ReadSecretContents(
	ctx context.Context,
	pullSecretName string,
	host string,
) (string, error)

func (*KubernetesDriver) RunDevContainer

func (k *KubernetesDriver) RunDevContainer(
	ctx context.Context,
	workspaceId string,
	options *driver.RunOptions,
) error

func (*KubernetesDriver) StartDevContainer

func (k *KubernetesDriver) StartDevContainer(ctx context.Context, workspaceId string) error

func (*KubernetesDriver) StopDevContainer

func (k *KubernetesDriver) StopDevContainer(ctx context.Context, workspaceId string) error

func (*KubernetesDriver) TargetArchitecture

func (k *KubernetesDriver) TargetArchitecture(ctx context.Context, workspaceId string) (string, error)