opts.go

package installation

import "time"

// Options holds the configuration options for the installation.
type Options struct {
	// Source specifies the installation source. To use the specific release, pass the release version (e.g. 1.6.0).
	// To use the master branch, pass "master". To use the local sources, pass "local". To use the remote image, pass the installer image (e.g. user/my-kyma-installer:v1.6.0).
	Source string `json:"source"`

	// releaseVersion is set to the version of the release being installed.
	releaseVersion string
	// configVersion is set to the version of the configuration files being used.
	configVersion string
	// bucket is set to the name of the bucket where installation artifacts being stored.
	bucket string
	// remoteImage holds the image URL if the installation source is an image.
	remoteImage string
	// fromLocalSources is set if the installation source is local.
	fromLocalSources bool

	// LocalSrcPath specifies the absolute path to local sources.
	// +optional
	LocalSrcPath string `json:"localSrcPath,omitempty"`
	// OverrideConfigs specifies the path to a yaml file with parameters to override.
	// +optional
	OverrideConfigs []string `json:"overrideConfigs,omitempty"`
	// ComponentsConfig specifies the path to a yaml file with components to override.
	// +optional
	ComponentsConfig string `json:"componentsConfig,omitempty"`
	// Password specifies the predefined cluster password.
	// +optional
	Password string `json:"password,omitempty"`
	// Domain specifies the domain used for installation.
	// +optional
	Domain string `json:"domain,omitempty"`
	// TLSCert specifies the TLS certificate for the domain used for installation
	// +optional
	TLSCert string `json:"tlsCert,omitempty"`
	// TLSKey specifies the TLS key for the domain used for installation.
	// +optional
	TLSKey string `json:"tlsKey,omitempty"`
	// IsLocal indicates if the installation is on a local cluster.
	// +optional
	IsLocal bool `json:"isLocal,omitempty"`
	// LocalCluster includes the configuration options of a local cluster.
	// +optional
	LocalCluster *LocalCluster `json:"localCluster,omitempty"`

	// Timeout specifies the time-out after which watching the installation progress stops.
	// +optional
	Timeout time.Duration `json:"timeout,omitempty"`
	// CI enables skipping some steps not needed on CI/CD systems.
	// +optional
	CI bool `json:"ci,omitempty"`
	// NonInteractive enables non-interactive mode.
	// +optional
	NonInteractive bool `json:"nonInteractive,omitempty"`
	// NoWait determines if the Kyma installation should be waited to complete.
	// +optional
	NoWait bool `json:"noWait,omitempty"`
	// Verbose enables displaying details of actions triggered.
	// +optional
	Verbose bool `json:"verbose,omitempty"`
	// CustomImage determines the name for a custom Kyma installer image built for installation from local sources.
	// +optional
	CustomImage string `json:"customImage,omitempty"`
	// If source=master, defines how many commits from master branch are taken into account if artifacts for newer commits does not exist yet
	// +optional
	FallbackLevel int `json:"fallback_level,omitempty"`
	// Profile specifies the Kyma installation profile (evaluation|production).
	// +optional
	Profile string `json:"profile,omitempty"`
}

// LocalCluster includes the configuration options of a local cluster.
type LocalCluster struct {
	// Provider specifies the provider of the local cluster.
	Provider string `json:"localProvider"`
	// Profile specifies the profile of the local cluster.
	Profile string `json:"localProfile"`
	// IP holds the IP of the local cluster.
	IP string `json:"localIP"`
	// VMDriver indicates the VM driver of the local cluster.
	VMDriver string `json:"localVMDriver"`
}

//NewOptions creates options with default values.
func NewOptions() *Options {
	return &Options{
		Timeout: 1 * time.Hour,
		Domain:  defaultDomain,
		Source:  "master",
		IsLocal: true,
	}
}