v1

Documentation

Index

• Constants
• Variables
• type AppConfig
• type AppContainer
• type AppExternal
• type Cluster
• type DevSpaceConfig
• type PortForwarding
• type PortMapping
• type PrivateConfig
• type RegistryAccess
• type RegistryUser
• type Release
• type SyncPath
• type User

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 AppConfig

type AppConfig struct {
	Name      string
	Container *AppContainer
	External  *AppExternal
}

AppConfig is the config for a single app

type AppContainer

type AppContainer struct {
	Image string
	Ports []int
}

AppContainer is the container in which an app is running

type AppExternal

type AppExternal struct {
	Domain string
	Port   int
}

AppExternal defines the external acces to an app

type Cluster

type Cluster struct {
	TillerNamespace string `yaml:"tillerNamespace"`
	UseKubeConfig   bool   `yaml:"useKubeConfig,omitempty"`
	ApiServer       string `yaml:"apiServer,omitempty"`
	CaCert          string `yaml:"caCert,omitempty"`
	User            *User  `yaml:"user,omitempty"`
}

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

type DevSpaceConfig

type DevSpaceConfig struct {
	Version        string                      `yaml:"version"`
	PortForwarding []*PortForwarding           `yaml:"portForwarding"`
	SyncPaths      []*SyncPath                 `yaml:"syncPath"`
	Registry       map[interface{}]interface{} `yaml:"registry,omitempty"`
}

DevSpaceConfig defines the config for a DevSpace

type PortForwarding

type PortForwarding struct {
	ResourceType  string            `yaml:"resourceType"`
	LabelSelector map[string]string `yaml:"labelSelector"`
	PortMappings  []*PortMapping    `yaml:"portMappings"`
}

PortForwarding 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 PrivateConfig

type PrivateConfig struct {
	Version  string          `yaml:"version"`
	Release  *Release        `yaml:"release"`
	Registry *RegistryAccess `yaml:"registry"`
	Cluster  *Cluster        `yaml:"cluster"`
}

PrivateConfig defines the private config of the users' computer

type RegistryAccess

type RegistryAccess struct {
	Release *Release      `yaml:"release"`
	User    *RegistryUser `yaml:"user"`
}

RegistryAccess sets the access from a user to a release

type RegistryUser

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

RegistryUser is a user for the registry

type Release

type Release struct {
	Name        string `yaml:"name"`
	Namespace   string `yaml:"namespace"`
	LatestBuild string `yaml:"latestBuild"`
	LatestImage string `yaml:"latestImage"`
}

Release defines running version of a project

type SyncPath

type SyncPath struct {
	ResourceType  string            `yaml:"resourceType"`
	LabelSelector map[string]string `yaml:"labelSelector"`
	LocalSubPath  string            `yaml:"localSubPath"`
	ContainerPath string            `yaml:"containerPath"`
	ExcludeRegex  []string          `yaml:"excludeRegex"`
}

SyncPath defines the paths for a SyncFolder

type User

type User struct {
	Username   string `yaml:"username,omitempty"`
	ClientCert string `yaml:"clientCert,omitempty"`
	ClientKey  string `yaml:"clientKey,omitempty"`
}

User is a user with its username and its client certificate