Documentation
¶
Index ¶
- Constants
- Variables
- type AutoReloadConfig
- type AutoReloadPathsConfig
- type BandwidthLimits
- 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 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 AutoReloadConfig ¶
type AutoReloadConfig struct {
Disabled *bool `yaml:"disabled,omitempty"`
}
AutoReloadConfig defines the struct for auto reloading deployments and images
type AutoReloadPathsConfig ¶
type AutoReloadPathsConfig struct {
Paths *[]*string `yaml:"paths,omitempty"`
}
AutoReloadPathsConfig defines the struct for auto reloading devspace with additional paths
type BandwidthLimits ¶
type BandwidthLimits struct {
Download *int64 `yaml:"download,omitempty"`
Upload *int64 `yaml:"upload,omitempty"`
}
BandwidthLimits defines the struct for specifying the sync bandwidth limits
type BuildConfig ¶ added in v1.0.0
type BuildConfig struct {
Disabled *bool `yaml:"disabled,omitempty"`
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 ¶ added in v1.0.0
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"`
CloudProviderDeployTarget *string `yaml:"cloudProviderDeployTarget,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 ¶ added in v1.0.0
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 ¶ 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"`
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"`
AutoReload *AutoReloadConfig `yaml:"autoReload,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"`
AutoReload *AutoReloadPathsConfig `yaml:"autoReload,omitempty"`
Services *[]*ServiceConfig `yaml:"services,omitempty"`
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"`
DevOverwrite *string `yaml:"devOverwrite,omitempty"`
}
HelmConfig defines the specific helm options used during deployment
type ImageConfig ¶ added in v1.0.0
type ImageConfig struct {
Name *string `yaml:"name"`
Tag *string `yaml:"tag"`
Registry *string `yaml:"registry"`
CreatePullSecret *bool `yaml:"createPullSecret,omitempty"`
SkipPush *bool `yaml:"skipPush"`
AutoReload *AutoReloadConfig `yaml:"autoReload"`
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 ¶ added in v1.0.0
type PortForwardingConfig struct {
Service *string `yaml:"service,omitempty"`
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 ¶
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 ServiceConfig ¶ added in v1.0.0
type ServiceConfig struct {
Name *string `yaml:"name,omitempty"`
Namespace *string `yaml:"namespace,omitempty"`
ResourceType *string `yaml:"resourceType,omitempty"`
LabelSelector *map[string]*string `yaml:"labelSelector"`
ContainerName *string `yaml:"containerName"`
}
ServiceConfig defines the ports for a port forwarding to a DevSpace
type SyncConfig ¶ added in v1.0.0
type SyncConfig struct {
Service *string `yaml:"service,omitempty"`
Namespace *string `yaml:"namespace,omitempty"`
LabelSelector *map[string]*string `yaml:"labelSelector"`
ContainerName *string `yaml:"containerName,omitempty"`
LocalSubPath *string `yaml:"localSubPath"`
ContainerPath *string `yaml:"containerPath"`
ExcludePaths *[]string `yaml:"excludePaths"`
DownloadExcludePaths *[]string `yaml:"downloadExcludePaths"`
UploadExcludePaths *[]string `yaml:"uploadExcludePaths"`
BandwidthLimits *BandwidthLimits `yaml:"bandwidthLimits,omitempty"`
}
SyncConfig defines the paths for a SyncFolder
type Terminal ¶ added in v1.1.0
type Terminal struct {
Disabled *bool `yaml:"disabled,omitempty"`
Service *string `yaml:"service,omitempty"`
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 ¶ added in v1.0.0
type TillerConfig struct {
Namespace *string `yaml:"namespace,omitempty"`
}
TillerConfig defines the tiller service