Configuration file

AdminConfig

Properties

Name	Type	Description	Default	Required
email	string	Administrator email address to use for local accounts and OIDC configuration		Yes
username	string	Administrator username to use for local accounts and OIDC configuration	admin	No

AppCredentials

Properties

Name	Type	Description	Default	Required
username	string	Git username		Yes
password	string	Git password		Yes

AppCredentialsConfig

Properties

Name	Type	Description	Default	Required
endpoint	string	Application endpoint		Yes
credentials	AppCredentials	Applications credentials configuration		Yes

ApplicationsConfig

Properties

Name	Type	Description	Default	Required
disabled	array	List applications to disable		No

BaremetalController

Properties

Name	Type	Description	Default	Required
address	string	Baremetal Controller IP Address		Yes
disableCertificateVerification	boolean	Toggle to disable certificate verification		No

Config

Properties

Name	Type	Description	Default	Required
credentials	Credentials	GCP Specific Configuration		No
git	GitConfig	Git credentials config		Yes
registry	AppCredentialsConfig	Registry credentials config		No
secretStore	SecretStore	Secret store configuration		Yes
baseDir	string	Base directory containing K8SaaS files		No
outputDir	string	Directory to output final cluster kubeconfig		No
debug	boolean	Toggle the debug mode		No
keepEphemeral	boolean	Toggle to keep ephemeral cluster after the cluster creation		No
ephemeralClusterName	string	Set the ephemeral cluster name	epk8saas	No
enableCache	boolean	Enable docker caching		No
clusterName	string	Set the final cluster name	k8saas	Yes
region	string	Set the final cluster region		No
image	Image	Final cluster image configuration		No
applications	ApplicationsConfig	Applications configuration		No
ingress	IngressConfig	Ingress configuration		Yes
admin	AdminConfig	Admin credentials configuration		Yes
overlays	array	Use specific overlays when generating manifests		No
provider	string	Set the provider name (metal3	gcp	docker)
providerVersion	string	Set the provider version (i.e. v1.6.1)		No
logLevel	string	Set log level (trace, debug, info, warn, error, fatal, panic)		No
k8s	K8sConfig	K8S Configuration		Yes
metal3	Metal3Config	Metal3 Specific Configuration		No
gcp	GCPConfig	GCP Specific Configuration		No

Credentials

Properties

Name	Type	Description	Default	Required
accessKey	string	AccessKey		Yes
secretKey	string	SecretKey		Yes

GCPConfig

Properties

Name	Type	Description	Default	Required
keyFile	string	Path to the GCP key file		Yes
project	string	GCP project name		Yes
dnsProject	string	GCP dns project name		Yes
controlPlaneMachineType	string	Machine type for control plane nodes		Yes
nodeMachineType	string	Machine type for worker nodes		Yes
network	string	GCP network name		Yes

GitConfig

Properties

Name	Type	Description	Default	Required
global	GitRemoteConfig	Git Config global configuration, used as base for all other repositories		Yes
bases	GitRemoteConfig	Git Config for the bases repository		Yes
config	GitRemoteConfig	Git Config for the config repository		Yes
frozen	GitRemoteConfig	Git Config for the frozen repository		Yes
custom	GitRemoteConfig	Git Config for the custom repository		No

GitRemoteConfig

Properties

Name	Type	Description	Default	Required
endpoint	string	Repository endpoint		No
branch	string	Repository branch		No
credentials	AppCredentials	Git credentials		No

Image

Properties

Name	Type	Description	Default	Required
name	string	Name of the image file (qcow2 file)		Yes

IngressConfig

Properties

Name	Type	Description	Default	Required
domainName	string	Set the domain name		Yes
defaultClass	string	Ingress class name default value	nginx	Yes
defaultClusterIssuer	string	Cluster Certificate Issuer default value	selfsigned	Yes
letsencryptEmail	string	Let’s Encrypt email	k8saas@k8saas.io	Yes

K8sConfig

Properties

Name	Type	Description	Default	Required
provider	string	Kubernetes version		Yes
ephemeralVersion	string	Kubernetes version of the ephemeral cluster		Yes
controlPlaneMachineCount	integer	Amount of ControlPlane machines		Yes
workerMachineCount	integer	Amount of Worker machines		Yes

Metal3CIDR

Properties

Name	Type	Description	Default	Required
services	string	CIDR services		Yes
pods	string	CIDR pods		Yes

Metal3Config

Properties

Name	Type	Description	Default	Required
hostIP	string	Host IP		No
hosts	array	Hosts list		Yes
cidr	Metal3CIDR	CIDR Configuration		Yes
ipPool	Metal3IPPool	IP Pool Configuration		Yes
controlplaneEndpoint	Metal3ControlplaneEndpoint	ControlPlane Endpoint Configuration		Yes
networkData	N/A	Network Data Configuration		Yes

Metal3ControlplaneEndpoint

Properties

Name	Type	Description	Default	Required
host	string	ControlPlane host		Yes
port	integer	ControlPlane port		Yes

Metal3HostConfig

Properties

Name	Type	Description	Default	Required
type	string	Host type (controlplane or worker)		Yes
idrac	Metal3IdracConfig	Idrac configuration		Yes
nodeIP	string	Node IP Address		Yes
nodeMAC	string	Node MAC Address		Yes
gatewayIP	string	Node Gateway IP Address		Yes
bmc	BaremetalController	Baremetal Controller Configuration		Yes
rootDeviceHints	array	Root devide hints		Yes

Metal3IPPool

Properties

Name	Type	Description	Default	Required
start	string	Start of the IP Pool for Metal3		Yes
end	string	End of the IP Pool for Metal3		Yes
dns	string	DNS Address of this Metal3 IP Pool		Yes
gatewayIP	string	Gateway IP of this Metal3 IP Pool		Yes

Metal3IdracConfig

Properties

Name	Type	Description	Default	Required
username	string	Idrac username		Yes
password	string	Idrac Password		Yes
ip	string	Idrac IP Address		No

RootDeviceHint

Properties

Name	Type	Description	Default	Required
type	string	List of root device hints		Yes
value	string	Type of the root device hint		Yes

SecretStore

Properties

Name	Type	Description	Default	Required
plain	object	Plain text secret store		No
gcpSecretsKeyFile	string	GCP Service Account Key file for GCP Secrets access		No
provider	string	Secret store provider (Available options: plain, gcp)	plain	Yes
valsPrefix	string	Prefix used for constructing secret references	secretref+file:///var/run/secrets/vals-expander/secret-store.yaml#/	Yes
valsSuffix	string	Suffix appended to secret references after resolving	+	Yes

SecretStoreCredentials

Properties

Name	Type	Description	Default	Required
plain	object	Plain text secret store		No