Documentation
¶
Index ¶
- Constants
- Variables
- type BuildConfig
- type BuildEngine
- type BuildOptions
- type Cluster
- type ClusterUser
- type Config
- type DevSpaceConfig
- type DockerBuildEngine
- type ImageConfig
- type InternalRegistry
- type KanikoBuildEngine
- type PortForwardingConfig
- type PortMapping
- type RegistryAuth
- type RegistryConfig
- type Release
- type ServiceConfig
- 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
Functions ¶
This section is empty.
Types ¶
type BuildConfig ¶ added in v1.0.0
type BuildConfig struct {
ContextPath *string `yaml:"contextPath"`
DockerfilePath *string `yaml:"dockerfilePath"`
Engine *BuildEngine `yaml:"engine"`
LatestTimestamp *string `yaml:"latestTimestamp"`
Options *BuildOptions `yaml:"options"`
}
BuildConfig defines the build process for an image
type BuildEngine ¶ added in v1.0.0
type BuildEngine struct {
Kaniko *KanikoBuildEngine `yaml:"kaniko"`
Docker *DockerBuildEngine `yaml:"docker"`
}
BuildEngine defines which build engine to use
type BuildOptions ¶ added in v1.0.0
type BuildOptions struct {
BuildArgs *map[string]*string `yaml:"buildArgs"`
Target *string `yaml:"target"`
Network *string `yaml:"network"`
}
BuildOptions defines options for building Docker images
type Cluster ¶
type Cluster struct {
UseKubeConfig *bool `yaml:"useKubeConfig,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 ¶ added in v1.0.0
type ClusterUser struct {
Username *string `yaml:"username,omitempty"`
ClientCert *string `yaml:"clientCert,omitempty"`
ClientKey *string `yaml:"clientKey,omitempty"`
}
ClusterUser is a user with its username and its client certificate
type Config ¶ added in v1.0.0
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"`
Services *ServiceConfig `yaml:"services,omitempty"`
}
Config defines the configuration
type DevSpaceConfig ¶
type DevSpaceConfig struct {
Terminal *Terminal `yaml:"terminal"`
Release *Release `yaml:"release"`
ChartHash *string `yaml:"chartHash"`
PortForwarding *[]*PortForwardingConfig `yaml:"portForwarding"`
Sync *[]*SyncConfig `yaml:"sync"`
}
DevSpaceConfig defines the devspace deployment
type DockerBuildEngine ¶ added in v1.0.0
type DockerBuildEngine struct {
Enabled *bool `yaml:"enabled"`
PreferMinikube *bool `yaml:"preferMinikube"`
}
DockerBuildEngine tells the DevSpace CLI to build with Docker on Minikube or on localhost
type ImageConfig ¶ added in v1.0.0
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 InternalRegistry ¶ added in v1.0.0
type InternalRegistry struct {
Release *Release `yaml:"release,omitempty"`
}
InternalRegistry defines the deployment of an internal registry
type KanikoBuildEngine ¶ added in v1.0.0
type KanikoBuildEngine struct {
Enabled *bool `yaml:"enabled"`
Namespace *string `yaml:"namespace"`
}
KanikoBuildEngine tells the DevSpace CLI to build with Docker on Minikube or on localhost
type PortForwardingConfig ¶ added in v1.0.0
type PortForwardingConfig struct {
Namespace *string `yaml:"namespace"`
ResourceType *string `yaml:"resourceType"`
LabelSelector *map[string]*string `yaml:"labelSelector"`
PortMappings *[]*PortMapping `yaml:"portMappings"`
}
PortForwardingConfig defines the ports for a port forwarding to a DevSpace
type PortMapping ¶
PortMapping defines the ports for a PortMapping
type RegistryAuth ¶ added in v1.0.0
RegistryAuth is a user for the registry
type RegistryConfig ¶ added in v1.0.0
type RegistryConfig struct {
URL *string `yaml:"url,omitempty"`
Auth *RegistryAuth `yaml:"auth,omitempty"`
Insecure *bool `yaml:"insecure,omitempty"`
}
RegistryConfig defines the registry service
type Release ¶
type Release struct {
Name *string `yaml:"name"`
Namespace *string `yaml:"namespace"`
Values *map[interface{}]interface{} `yaml:"values,omitempty"`
}
Release defines running version of a project
type ServiceConfig ¶ added in v1.0.0
type ServiceConfig struct {
Tiller *TillerConfig `yaml:"tiller,omitempty"`
InternalRegistry *InternalRegistry `yaml:"internalRegistry,omitempty"`
}
ServiceConfig defines additional services
type SyncConfig ¶ added in v1.0.0
type SyncConfig struct {
Namespace *string `yaml:"namespace"`
ResourceType *string `yaml:"resourceType"`
LabelSelector *map[string]*string `yaml:"labelSelector"`
LocalSubPath *string `yaml:"localSubPath"`
ContainerPath *string `yaml:"containerPath"`
ContainerName *string `yaml:"containerName"`
ExcludePaths *[]string `yaml:"excludePaths"`
DownloadExcludePaths *[]string `yaml:"downloadExcludePaths"`
UploadExcludePaths *[]string `yaml:"uploadExcludePaths"`
}
SyncConfig defines the paths for a SyncFolder
type Terminal ¶ added in v1.1.0
type Terminal struct {
ContainerName *string `yaml:"containerName"`
Command *[]*string `yaml:"command"`
}
Terminal describes the terminal options
type TillerConfig ¶ added in v1.0.0
type TillerConfig struct {
Release *Release `yaml:"release"`
AppNamespaces *[]*string `yaml:"appNamespaces"`
}
TillerConfig defines the tiller service
Source Files