metadata

Documentation

Index

• Constants
• func ProvisionWorkspaceMetadata(podAdditions *v1alpha1.PodAdditions, ...) error
• type NotReadyError
  • func (e *NotReadyError) Error() string
• type ProvisioningError
  • func (e *ProvisioningError) Error() string

Constants

const (
	// MetadataMountPathEnvVar is the name of an env var added to all containers to specify where workspace yamls are mounted.
	MetadataMountPathEnvVar = "DEVWORKSPACE_METADATA"

	// FlattenedDevfileMountPathEnvVar is an environment variable holding the path to the flattened devworkspace template spec
	FlattenedDevfileMountPathEnvVar = "DEVWORKSPACE_FLATTENED_DEVFILE"

	// OriginalDevfileMountPathEnvVar is an environment variable holding the path to the original devworkspace template spec
	OriginalDevfileMountPathEnvVar = "DEVWORKSPACE_ORIGINAL_DEVFILE"
)

Functions

func ProvisionWorkspaceMetadata

func ProvisionWorkspaceMetadata(podAdditions *v1alpha1.PodAdditions, original, flattened *common.DevWorkspaceWithConfig, api sync.ClusterAPI) error

ProvisionWorkspaceMetadata creates a configmap on the cluster that stores metadata about the workspace and configures all workspace containers to mount that configmap at /devworkspace-metadata. Each container has the environment variable DEVWORKSPACE_METADATA set to the mount path for the configmap

Types

type NotReadyError

type NotReadyError struct {
	// Message is a user-friendly string explaining why the error occurred
	Message string
	// RequeueAfter represents how long we should wait before checking if storage is ready
	RequeueAfter time.Duration
}

NotReadyError represents the state where no unexpected issues occurred but the provisioning required for the DevWorkspace is not ready

func (*NotReadyError) Error

func (e *NotReadyError) Error() string

type ProvisioningError

type ProvisioningError struct {
	// Err is the underlying error causing the problem. If nil, it is not included in the output of Error()
	Err error
	// Message is a user-friendly string explaining why the error occurred
	Message string
}

ProvisioningError represents an unrecoverable issue in provisioning a DevWorkspace.

func (*ProvisioningError) Error

func (e *ProvisioningError) Error() string