Documentation
¶
Overview ¶
Package config provides TOML-based configuration for warp (.warprc.toml). Used to set up paths to tools, amongst other things.
Index ¶
Constants ¶
View Source
const ( Kustomize = Tool("Kustomize") Helm = Tool("Helm") KubeScore = Tool("KubeScore") Kubectl = Tool("Kubectl") Ksync = Tool("Ksync") BrowserSync = Tool("BrowserSync") Docker = Tool("Docker") )
Names of the tools used by warp.
Variables ¶
View Source
var ToolNames = []Tool{Kustomize, Helm, KubeScore, Kubectl, Ksync, BrowserSync, Docker}
ToolNames gives all the required tools.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// NameManagerURL is the URL for the name_manager backend.
// name_manager is used to acquire/release stacks with no
// race condition.
//
// See https://github.com/hchauvin/name_manager.
NameManagerURL string
// OutputRoot is the path to a folder, given relative to
// the parent folder of the Config file, where all the
// intermediary artifacts are put. This folder is
// within the workspace to allow for easy inspection
// during debugging.
OutputRoot string
// Tools configures tools. By default, the tools are looked up
// in the PATH folders.
Tools map[Tool]ToolInfo
// Kubernetes holds the (default) configuration for the Kubernetes
// cluster used for deployment.
Kubernetes *Kubernetes
// Telemetry configures telemetry.
Telemetry Telemetry
// WorkspaceDir is the workspace directory.
WorkspaceDir string `toml:"-"`
// RunID is a random ID specific to this run of "warp".
RunID string `toml:"-"`
// contains filtered or unexported fields
}
Config is the project-wide configuration for warp.
type Kubernetes ¶
type Kubernetes struct {
// DefaultContext is the default kubeconfig context to use. If omitted,
// the current kubeconfig context is used.
DefaultContext string
// Kubeconfig is a list of configuration files that are merged
// to give the final kubeconfig configuration. The files
// are "~" (home) expanded.
//
// For background info on configuration merging, see
// https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#the-kubeconfig-environment-variable
Kubeconfig []string
// Resources is a list of custom resources to be managed by warp,
// especially during garbage collection.
Resources []Resource
// PreservePVCByDefault should be set to true to enable preserving
// persistent volume claims by default during garbage collection.
PreservePVCByDefault bool
// KubeconfigEnvVar is the value of the KUBECONFIG environment
// variable that is created from Kubeconfig.
KubeconfigEnvVar string `toml:"-"`
}
Kubernetes holds the configuration for a Kubernetes cluster used for deployment.
type Resource ¶ added in v0.1.0
type Resource struct {
Group string
Version string
Resource string
// Namespaced indicates whether the resource is namespaced or
// cluster-wide.
Namespaced bool
}
Resource identifies custom resources by group, version, and kind.
type Telemetry ¶ added in v0.1.0
type Telemetry struct {
// Connection string for the telemetry module
ConnectionString string
}
Telemetry configures telemetry. Telemetry is used to gather usage info.
Click to show internal directories.
Click to hide internal directories.