v1

Documentation

Index

• Constants
• Variables
• type BuildConfig
• type BuildOptions
• type Cluster
• type ClusterUser
• type Config
• type DeploymentConfig
• type DevSpaceConfig
• type DockerConfig
• type HelmConfig
• type ImageConfig
• type InternalRegistryConfig
• type KanikoConfig
• type KubectlConfig
• type PortForwardingConfig
• type PortMapping
• type RegistryAuth
• type RegistryConfig
• type SyncConfig
• type Terminal
• type TillerConfig

Constants

const Version string = "v1"

Version is the current api version

Variables

var Kubernetes = &kubernetesInfo{
	RegexPatterns: &kubernetesRegexPatterns{
		Name: "^[a-z][a-z0-9-]{0,50}[a-z0-9]$",
	},
}

Kubernetes is a var that contains all regexes for names given to kubernetes objects

Types

type BuildConfig

type BuildConfig struct {
	ContextPath    *string       `yaml:"contextPath"`
	DockerfilePath *string       `yaml:"dockerfilePath"`
	Kaniko         *KanikoConfig `yaml:"kaniko,omitempty"`
	Docker         *DockerConfig `yaml:"docker,omitempty"`
	Options        *BuildOptions `yaml:"options,omitempty"`
}

BuildConfig defines the build process for an image

type BuildOptions

type BuildOptions struct {
	BuildArgs *map[string]*string `yaml:"buildArgs,omitempty"`
	Target    *string             `yaml:"target,omitempty"`
	Network   *string             `yaml:"network,omitempty"`
}

BuildOptions defines options for building Docker images

type Cluster

type Cluster struct {
	CloudProvider *string      `yaml:"cloudProvider,omitempty"`
	KubeContext   *string      `yaml:"kubeContext,omitempty"`
	Namespace     *string      `yaml:"namespace,omitempty"`
	APIServer     *string      `yaml:"apiServer,omitempty"`
	CaCert        *string      `yaml:"caCert,omitempty"`
	User          *ClusterUser `yaml:"user,omitempty"`
}

Cluster is a struct that contains data for a Kubernetes-Cluster

type ClusterUser

type ClusterUser struct {
	ClientCert *string `yaml:"clientCert,omitempty"`
	ClientKey  *string `yaml:"clientKey,omitempty"`
	Token      *string `yaml:"token,omitempty"`
}

ClusterUser is a user with its username and its client certificate

type Config

type Config struct {
	Version          *string                     `yaml:"version"`
	DevSpace         *DevSpaceConfig             `yaml:"devSpace,omitempty"`
	Images           *map[string]*ImageConfig    `yaml:"images,omitempty"`
	Registries       *map[string]*RegistryConfig `yaml:"registries,omitempty"`
	Cluster          *Cluster                    `yaml:"cluster,omitempty"`
	Tiller           *TillerConfig               `yaml:"tiller,omitempty"`
	InternalRegistry *InternalRegistryConfig     `yaml:"internalRegistry,omitempty"`
}

Config defines the configuration

type DeploymentConfig

type DeploymentConfig struct {
	Name      *string        `yaml:"name"`
	Namespace *string        `yaml:"namespace,omitempty"`
	Helm      *HelmConfig    `yaml:"helm,omitempty"`
	Kubectl   *KubectlConfig `yaml:"kubectl,omitempty"`
}

DeploymentConfig defines the configuration how the devspace should be deployed

type DevSpaceConfig

type DevSpaceConfig struct {
	Terminal    *Terminal                `yaml:"terminal"`
	Deployments *[]*DeploymentConfig     `yaml:"deployments,omitempty"`
	Ports       *[]*PortForwardingConfig `yaml:"ports"`
	Sync        *[]*SyncConfig           `yaml:"sync"`
}

DevSpaceConfig defines the devspace deployment

type DockerConfig

type DockerConfig struct {
	PreferMinikube *bool `yaml:"preferMinikube,omitempty"`
}

DockerConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost

type HelmConfig

type HelmConfig struct {
	ChartPath *string `yaml:"chartPath,omitempty"`
}

HelmConfig defines the specific helm options used during deployment

type ImageConfig

type ImageConfig struct {
	Name     *string      `yaml:"name"`
	Tag      *string      `yaml:"tag"`
	Registry *string      `yaml:"registry"`
	Build    *BuildConfig `yaml:"build"`
}

ImageConfig defines the image specification

type InternalRegistryConfig

type InternalRegistryConfig struct {
	Deploy    *bool   `yaml:"deploy,omitempty"`
	Namespace *string `yaml:"namespace,omitempty"`
}

InternalRegistryConfig defines the internal registry config options

type KanikoConfig

type KanikoConfig struct {
	Cache      *bool   `yaml:"cache"`
	Namespace  *string `yaml:"namespace,omitempty"`
	PullSecret *string `yaml:"pullSecret,omitempty"`
}

KanikoConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost

type KubectlConfig

type KubectlConfig struct {
	CmdPath   *string    `yaml:"cmdPath,omitempty"`
	Manifests *[]*string `yaml:"manifests,omitempty"`
}

KubectlConfig defines the specific kubectl options used during deployment

type PortForwardingConfig

type PortForwardingConfig struct {
	Namespace     *string             `yaml:"namespace,omitempty"`
	ResourceType  *string             `yaml:"resourceType,omitempty"`
	LabelSelector *map[string]*string `yaml:"labelSelector"`
	PortMappings  *[]*PortMapping     `yaml:"portMappings"`
}

PortForwardingConfig defines the ports for a port forwarding to a DevSpace

type PortMapping

type PortMapping struct {
	LocalPort  *int `yaml:"localPort"`
	RemotePort *int `yaml:"remotePort"`
}

PortMapping defines the ports for a PortMapping

type RegistryAuth

type RegistryAuth struct {
	Username *string `yaml:"username"`
	Password *string `yaml:"password"`
}

RegistryAuth is a user for the registry

type RegistryConfig

type RegistryConfig struct {
	URL      *string       `yaml:"url,omitempty"`
	Auth     *RegistryAuth `yaml:"auth,omitempty"`
	Insecure *bool         `yaml:"insecure,omitempty"`
}

RegistryConfig defines the registry service

type SyncConfig

type SyncConfig struct {
	Namespace            *string             `yaml:"namespace,omitempty"`
	ResourceType         *string             `yaml:"resourceType,omitempty"`
	LabelSelector        *map[string]*string `yaml:"labelSelector"`
	LocalSubPath         *string             `yaml:"localSubPath"`
	ContainerPath        *string             `yaml:"containerPath"`
	ContainerName        *string             `yaml:"containerName,omitempty"`
	ExcludePaths         *[]string           `yaml:"excludePaths"`
	DownloadExcludePaths *[]string           `yaml:"downloadExcludePaths"`
	UploadExcludePaths   *[]string           `yaml:"uploadExcludePaths"`
}

SyncConfig defines the paths for a SyncFolder

type Terminal

type Terminal struct {
	ResourceType  *string             `yaml:"resourceType"`
	LabelSelector *map[string]*string `yaml:"labelSelector"`
	Namespace     *string             `yaml:"namespace"`
	ContainerName *string             `yaml:"containerName"`
	Command       *[]*string          `yaml:"command"`
}

Terminal describes the terminal options

type TillerConfig

type TillerConfig struct {
	Namespace *string `yaml:"namespace,omitempty"`
}

TillerConfig defines the tiller service