config

package
v0.8.0-rc.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 5, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DefaultConfig = Config{
	InstanceID: "local",
	K8s: K8sConfig{
		Context:   "",
		Namespace: "",
	},
	Worker: WorkerConfig{
		Steps: StepsConfig{
			Docker: DockerStepConfig{
				Image:    "gcr.io/kaniko-project/executor",
				ImageTag: "v1.7.0",
			},
			Kubectl: KubectlStepConfig{
				Image:    "docker.io/wharfse/kubectl",
				ImageTag: "v1.23.5",
			},
			Helm: HelmStepConfig{
				Image: "docker.io/wharfse/helm",
			},
		},
	},
	Provisioner: ProvisionerConfig{
		HTTP: HTTPConfig{
			CORS: CORSConfig{
				AllowAllOrigins: false,
				AllowOrigins:    []string{},
			},
			BindAddress: "0.0.0.0:5009",
		},
		K8s: ProvisionerK8sConfig{
			Worker: ProvisionerK8sWorkerConfig{
				ServiceAccountName: "wharf-cmd",
				InitContainer: K8sContainerConfig{
					Image:           "bitnami/git",
					ImageTag:        "2-debian-10",
					ImagePullPolicy: v1.PullIfNotPresent,
				},
				Container: K8sContainerConfig{
					Image:           "quay.io/iver-wharf/wharf-cmd",
					ImageTag:        "latest",
					ImagePullPolicy: v1.PullAlways,
				},
			},
		},
	},
	Aggregator: AggregatorConfig{
		WharfAPIURL:           "http://localhost:5001",
		WorkerAPIExternalPort: 5010,
	},
	Watchdog: WatchdogConfig{
		WharfAPIURL:    "http://localhost:5001",
		ProvisionerURL: "http://localhost:5009",
	},
}

DefaultConfig is the hard-coded default values for wharf-cmd's configs.

Functions

This section is empty.

Types

type AggregatorConfig 

type AggregatorConfig struct {
	// WharfAPIURL is the URL used to connect to Wharf API.
	//
	// Added in v0.8.0.
	WharfAPIURL string
	// WorkerAPIExternalPort is the port used to connect to a Wharf worker.
	//
	// Added in v0.8.0.
	WorkerAPIExternalPort int16
}

AggregatorConfig holds settings for the aggregator.

type CORSConfig 

type CORSConfig struct {
	// AllowAllOrigins enables CORS and allows all hostnames and URLs in the
	// HTTP request origins when set to true. Practically speaking, this
	// results in the HTTP header "Access-Control-Allow-Origin" set to "*".
	//
	// Added in v0.8.0.
	AllowAllOrigins bool
	// AllowOrigins enables CORS and allows the list of origins in the
	// HTTP request origins when set. Practically speaking, this
	// results in the HTTP header "Access-Control-Allow-Origin".
	//
	// Added in v0.8.0.
	AllowOrigins []string
}

CORSConfig holds settings for the HTTP server's CORS settings.

type Config 

type Config struct {
	K8s         K8sConfig
	Worker      WorkerConfig
	Provisioner ProvisionerConfig
	Aggregator  AggregatorConfig
	Watchdog    WatchdogConfig

	// InstanceID may be an arbitrary string that is used to identify different
	// Wharf installations from each other. Needed when you use multiple Wharf
	// installations in the same environment, such as the same Kubernetes
	// namespace, to let Wharf know which builds belong to which Wharf
	// installation.
	//
	// Added in v0.8.0.
	InstanceID string
}

Config holds all configurable settings for wharf-api.

The config is read in the following order:

1. File: /etc/iver-wharf/wharf-cmd/wharf-cmd-config.yml

2. File: (config home)/iver-wharf/wharf-cmd/wharf-cmd-config.yml, depending on OS:

  • Linux: ~/.config/iver-wharf/wharf-cmd/wharf-cmd-config.yml
  • Darwin/OS X: ~/Library/Application Support/iver-wharf/wharf-cmd/wharf-cmd-config.yml
  • Windows: %APPDATA%\iver-wharf\wharf-cmd\wharf-cmd-config.yml

2. File: ./wharf-cmd-config.yml

3. File from environment variable: WHARF_CONFIG

4. Environment variables, prefixed with WHARF_

Each inner struct is represented as a deeper field in the different configurations. For YAML they represent deeper nested maps. For environment variables they are joined together by underscores.

All environment variables must be uppercased, while YAML files are case-insensitive. Keeping camelCasing in YAML config files is recommended for consistency.

func LoadConfig 

func LoadConfig() (Config, error)

LoadConfig looks for, parses and validates the config and returns it as a Config object.

type DockerStepConfig 

type DockerStepConfig struct {
	// Image is the image for the kaniko executor to use.
	//
	// Added in v0.8.0.
	Image string
	// ImageTag is the image tag to use for the image.
	//
	// Added in v0.8.0.
	ImageTag string
}

DockerStepConfig holds settings for the docker step type.

type HTTPConfig 

type HTTPConfig struct {
	CORS CORSConfig
	// BindAddress is the IP-address and port, separated by a colon, to bind
	// the HTTP server to. An IP-address of 0.0.0.0 will bind to all
	// IP-addresses.
	//
	// Added in v0.8.0.
	BindAddress string
}

HTTPConfig holds settings for the HTTP server.

type HelmStepConfig 

type HelmStepConfig struct {
	// Image is the image to use in the helm step.
	//
	// There's no config value for the Docker image tag to use, as that comes
	// from the helmVersion field in the helm step type from the .wharf-ci.yml
	// file.
	//
	// Added in v0.8.0.
	Image string
}

HelmStepConfig holds settings for the helm step type.

type K8sConfig 

type K8sConfig struct {
	// Context is the context used when talking to kubernetes.
	//
	// Added in v0.8.0.
	Context string
	// Namespace is the kubernetes namespace to talk to.
	//
	// Added in v0.8.0.
	Namespace string
}

K8sConfig holds settings for using kubernetes.

type K8sContainerConfig 

type K8sContainerConfig struct {
	// Image is the base path for the image to use for a container.
	//
	// Added in v0.8.0.
	Image string
	// ImageTag is the version tag to use for a container.
	//
	// Added in v0.8.0.
	ImageTag string
	// ImagePullPolicy is the image pull policy to use for a container.
	//
	// "Always"
	//   Attempts to pull the latest image.
	//   Container will fail if the pull fails.
	//
	// "Never"
	//   Never pulls an image, i.e. only uses a local image.
	//   Container will fail if the image isn't present
	//
	// "IfNotPresent"
	//   Pulls if the image isn't present on disk.
	//   Container will fail if the image isn't present and the pull fails.
	//
	// Added in v0.8.0.
	ImagePullPolicy v1.PullPolicy
}

K8sContainerConfig holds settings for a kubernetes container.

type KubectlStepConfig 

type KubectlStepConfig struct {
	// Image is the image to use in the kubectl step.
	//
	// Added in v0.8.0.
	Image string
	// ImageTag is the image tag to use for the image.
	//
	// Added in v0.8.0.
	ImageTag string
}

KubectlStepConfig holds settings for the kubectl step type.

type ProvisionerConfig 

type ProvisionerConfig struct {
	HTTP HTTPConfig
	K8s  ProvisionerK8sConfig
}

ProvisionerConfig holds settings for the provisioner.

type ProvisionerK8sConfig 

type ProvisionerK8sConfig struct {
	Worker ProvisionerK8sWorkerConfig
}

ProvisionerK8sConfig holds kubernetes specific settings for the provisioner.

type ProvisionerK8sWorkerConfig 

type ProvisionerK8sWorkerConfig struct {
	// ServiceAccountName is the service account name to use for the pod.
	//
	// Added in v0.8.0.
	ServiceAccountName string
	// InitContainer holds settings for the init container.
	//
	// Added in v0.8.0.
	InitContainer K8sContainerConfig
	// Container holds settings for the container.
	//
	// Added in v0.8.0.
	Container K8sContainerConfig
}

ProvisionerK8sWorkerConfig holds settings for worker pods that are created by the provisioner.

type StepsConfig 

type StepsConfig struct {
	Docker  DockerStepConfig
	Kubectl KubectlStepConfig
	Helm    HelmStepConfig
}

StepsConfig holds settings for the different types of steps.

type WatchdogConfig 

type WatchdogConfig struct {
	// WharfAPIURL is the URL used to connect to Wharf API.
	//
	// Added in v0.8.0.
	WharfAPIURL string
	// ProvisionerURL is the URL used to connect to the Wharf Cmd
	// provisioner.
	//
	// Added in v0.8.0.
	ProvisionerURL string
}

WatchdogConfig holds settings for the watchdog.

type WorkerConfig 

type WorkerConfig struct {
	Steps StepsConfig
}

WorkerConfig holds settings for the worker.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.