schema

type AWS struct {
	// Networking describes networking configuration
	Networking Networking `json:"network,omitempty"`
	// Regions is a list of supported regions
	Regions []string `json:"regions,omitempty"`
	// IAMPolicy is a list of permissions
	IAMPolicy IAMPolicy `json:"iamPolicy,omitempty"`
	// Disabled is whether this provider should be disabled
	Disabled bool `json:"disabled,omitempty"`
}

type Azure struct {
	// Disabled is whether this provider should be disabled
	Disabled bool `json:"disabled,omitempty"`
}

type BaseImage struct {
	// Locator is the base image locator.
	Locator loc.Locator
}

type CPU struct {
	// Min is minimum required amount of CPUs
	Min int `json:"min,omitempty"`
	// Max is maximum supported amount of CPUs
	Max int `json:"max,omitempty"`
}

type CatalogExtension struct {
	// Disabled disables application catalog and tiller
	Disabled bool `json:"disabled,omitempty"`
}

type ConfigurationExtension struct {
	// Disabled allows to disable Configuration tab
	Disabled bool `json:"disabled,omitempty"`
}

type CustomCheck struct {
	// Description provides a readable description for the check
	Description string `json:"description,omitempty"`
	// Script defines the contents of the check script.
	// It is provided to the shell verbatim in a temporary file
	Script string `json:"script,omitempty"`
}

type Dependencies struct {
	// Packages is a list of dependencies-packages
	Packages []Dependency `json:"packages,omitempty"`
	// Apps is a list of dependencies-apps
	Apps []Dependency `json:"apps,omitempty"`
}

type Dependency struct {
	// Locator is dependency package locator
	Locator loc.Locator
}

type Device struct {
	// Path is the device path, treated as a glob, e.g. /dev/nvidia*
	Path string `json:"path"`
	// Permissions is the device permissions, a composition
	// of 'r' (read), 'w' (write) and 'm' (mknod)
	Permissions string `json:"permissions,omitempty"`
	// FileMode is the permission bits for the device
	FileMode string `json:"fileMode,omitempty"`
	// UID is the device user ID
	UID *int `json:"uid,omitempty"`
	// GID is the device group ID
	GID *int `json:"gid,omitempty"`
}

type Docker struct {
	// ExternalService defines additional configuration for the docker service
	ExternalService
	// StorageDriver is the docker storage driver to use
	StorageDriver string `json:"storageDriver,omitempty"`
	// Capacity is required docker device capacity
	Capacity utils.Capacity `json:"capacity,omitempty"`
}

type EULA struct {
	// Source is the license text URL (file:// or http://) or literal text
	Source string `json:"source,omitempty"`
}

type EncryptionExtension struct {
	// EncryptionKey is the passphrase for installer encryption
	EncryptionKey string `json:"encryptionKey,omitempty"`
	// CACert is the certificate authority certificate
	CACert string `json:"caCert,omitempty"`
}

type Endpoint struct {
	// Name is the endpoint short name
	Name string `json:"name,omitempty"`
	// Description is the endpoint verbose description
	Description string `json:"description,omitempty"`
	// Selector is the endpoint's k8s service selector
	Selector map[string]string `json:"selector,omitempty"`
	// ServiceName is the endpoint's k8s service name
	ServiceName string `json:"serviceName,omitempty"`
	// Namespace is the endpoint's k8s namespace
	Namespace string `json:"namespace,omitempty"`
	// Protocol is the endpoint protocol
	Protocol string `json:"protocol,omitempty"`
	// Port is the endpoint port
	Port int `json:"port,omitempty"`
	// Hidden is whether to hide the endpoint from the UI
	Hidden bool `json:"hidden,omitempty"`
}

type Etcd struct {
	// ExternalService defines additional configuration for the etcd service
	ExternalService
}

type Extensions struct {
	// Encryption allows to encrypt installer packages
	Encryption *EncryptionExtension `json:"encryption,omitempty"`
	// Logs allows to customize logs feature
	Logs *LogsExtension `json:"logs,omitempty"`
	// Monitoring allows to customize monitoring feature
	Monitoring *MonitoringExtension `json:"monitoring,omitempty"`
	// Kubernetes allows to customize kubernetes feature
	Kubernetes *KubernetesExtension `json:"kubernetes,omitempty"`
	// Configuration allows to customize configuration feature
	Configuration *ConfigurationExtension `json:"configuration,omitempty"`
	// Catalog allows to customize application catalog feature
	Catalog *CatalogExtension `json:"catalog,omitempty"`
	// OpsCenter enables the management web UI
	OpsCenter *OpsCenterExtension `json:"opsCenter,omitempty"`
}

type ExternalService struct {
	// Args is a list of extra arguments to provide to the service
	Args []string `json:"args,omitempty"`
}

type Flavor struct {
	// Name is the flavor name
	Name string `json:"name,omitempty"`
	// Description is verbose flavor description
	Description string `json:"description,omitempty"`
	// Nodes defines a list of node profiles composing the flavor
	Nodes []FlavorNode `json:"nodes,omitempty"`
}

type FlavorNode struct {
	// Profile is a node profile name
	Profile string `json:"profile,omitempty"`
	// Count is number of nodes of this profile
	Count int `json:"count,omitempty"`
}

type Flavors struct {
	// Default is the name of the default application flavor
	Default string `json:"default,omitempty"`
	// Prompt is a phrase or a question describing the criteria that
	// should be considered when picking a flavor (e.g. "How many
	// requests per second do you want to process?")
	Prompt string `json:"prompt,omitempty"`
	// Description is a general description for the application flavors
	Description string `json:"description,omitempty"`
	// Items is a list of flavors
	Items []Flavor `json:"items,omitempty"`
}

type Generic struct {
	// Networking describes networking configuration
	Networking Networking `json:"network,omitempty"`
	// Disabled is whether this provider should be disabled
	Disabled bool `json:"disabled,omitempty"`
}

type Header struct {
	metav1.TypeMeta
	// Metadata is the application metadata
	Metadata Metadata `json:"metadata,omitempty"`
}

type Hook struct {
	// Type is a hook type
	Type HookType `json:"type,omitempty"`
	// Job is a URL of (file:// or http://) or a literal value of a k8s job
	Job string `json:"job,omitempty"`
}

type HookType string

type Hooks struct {
	// ClusterProvision provisions new cluster
	ClusterProvision *Hook `json:"clusterProvision,omitempty"`
	// ClusterDeprovision deprovisions cluster
	ClusterDeprovision *Hook `json:"clusterDeprovision,omitempty"`
	// NodesProvision provisions new nodes to the existing cluster
	NodesProvision *Hook `json:"nodesProvision,omitempty"`
	// NodesDeprovision deprovisions nodes
	NodesDeprovision *Hook `json:"nodesDeprovision,omitempty"`
	// Install installs the application
	Install *Hook `json:"install,omitempty"`
	// Installed is called after the application has been installed
	Installed *Hook `json:"postInstall,omitempty"`
	// Uninstall uninstalls the application
	Uninstall *Hook `json:"uninstall,omitempty"`
	// Uninstalling is called before uninstall
	Uninstalling *Hook `json:"preUninstall,omitempty"`
	// NodeAdding is called before expansion
	NodeAdding *Hook `json:"preNodeAdd,omitempty"`
	// NodeAdded is called after expansion
	NodeAdded *Hook `json:"postNodeAdd,omitempty"`
	// NodeRemoving is called before shrink
	NodeRemoving *Hook `json:"preNodeRemove,omitempty"`
	// NodeRemoved is called after shrink
	NodeRemoved *Hook `json:"postNodeRemove,omitempty"`
	// BeforeUpdate is executed before the application is updated
	BeforeUpdate *Hook `json:"preUpdate,omitempty"`
	// Updating performs application update
	Updating *Hook `json:"update,omitempty"`
	// Updated is called after successful update
	Updated *Hook `json:"postUpdate,omitempty"`
	// Rollback performs application rollback after an unsuccessful update
	Rollback *Hook `json:"rollback,omitempty"`
	// RolledBack is called after successful rollback
	RolledBack *Hook `json:"postRollback,omitempty"`
	// Status is called every minute to check application status
	Status *Hook `json:"status,omitempty"`
	// Info is used to obtain application information
	Info *Hook `json:"info,omitempty"`
	// LicenseUpdated is called after license update
	LicenseUpdated *Hook `json:"licenseUpdated,omitempty"`
	// Start starts the application
	Start *Hook `json:"start,omitempty"`
	// Stop stops the application
	Stop *Hook `json:"stop,omitempty"`
	// Dump is used to retrieve application-specific dumps for debug reports
	Dump *Hook `json:"dump,omitempty"`
	// Backup triggers application data backup
	Backup *Hook `json:"backup,omitempty"`
	// Restore restores application state from a backup
	Restore *Hook `json:"restore,omitempty"`
	// NetworkInstall is a hook for installing a custom overlay network
	NetworkInstall *Hook `json:"networkInstall,omitempty"`
	// NetworkUpdate is a hook for updating a custom overlay network
	NetworkUpdate *Hook `json:"networkUpdate,omitempty"`
	// NetworkRollback is a hook for rolling back a custom overlay network
	NetworkRollback *Hook `json:"networkRollback,omitempty"`
}

type IAMPolicy struct {
	// Version is the policy version
	Version string `json:"version,omitempty"`
	// Actions is a list of IAM permissions (e.g. "ec2:CreateVolume")
	Actions []string `json:"actions,omitempty"`
}

type Ingress struct {
	// Nginx allows to customize the nginx based Ingress resource
	Nginx *Nginx `json:"nginx,omitempty"`
}

type Installer struct {
	// EULA describes the application end user license agreement
	EULA EULA `json:"eula,omitempty"`
	// SetupEndpoints is a list of names of endpoints to use in
	// post installation; only one is actually supported for now
	SetupEndpoints []string `json:"setupEndpoints,omitempty"`
	// Flavors defines application flavors
	Flavors Flavors `json:"flavors,omitempty"`
}

type Kubelet struct {
	// ExternalService defines additional configuration for kubelet
	ExternalService
	// HairpinMode is deprecated and no longer used
	HairpinMode string `json:"hairpinMode,omitempty"`
}

type KubernetesExtension struct {
	// Disabled allows to disable Kubernetes tab
	Disabled bool `json:"disabled,omitempty"`
}

type License struct {
	// Enabled is whether licensing is enabled/disabled
	Enabled bool `json:"enabled,omitempty"`
	// Type is the license type
	Type string `json:"type,omitempty"`
}

type LogsExtension struct {
	// Disabled allows to disable Logs tab
	Disabled bool `json:"disabled,omitempty"`
}

type Manifest struct {
	// Header provides basic information about application
	Header
	// BaseImage specifies the cluster image that's used as a base image
	BaseImage *BaseImage `json:"baseImage,omitempty"`
	// Logo is the application logo; can be either a filename (file://) or
	// an HTTP address (http://) or base64 encoded image data in the format
	// that can be used in a web page
	Logo string `json:"logo,omitempty"`
	// ReleaseNotes is the application's release notes; can be either a filename
	// (file://) or an HTTP address (http://) or plain text
	ReleaseNotes string `json:"releaseNotes,omitempty"`
	// Endpoints is a list of application endpoints
	Endpoints []Endpoint `json:"endpoints,omitempty"`
	// Dependencies is other apps/packages the application depends on
	Dependencies Dependencies `json:"dependencies,omitempty"`
	// Installer customizes the installer behavior
	Installer *Installer `json:"installer,omitempty"`
	// NodeProfiles describes types of nodes the application supports
	NodeProfiles NodeProfiles `json:"nodeProfiles,omitempty"`
	// Providers contains settings specific to different providers (e.g. cloud)
	Providers *Providers `json:"providers,omitempty"`
	// Ingress configures Ingress controllers.
	Ingress *Ingress `json:"ingress,omitempty"`
	// Storage configures persistent storage providers.
	Storage *Storage `json:"storage,omitempty"`
	// License allows to turn on/off license mode for the application
	License *License `json:"license,omitempty"`
	// Hooks contains application-defined hooks
	Hooks *Hooks `json:"hooks,omitempty"`
	// SystemOptions contains various global settings
	SystemOptions *SystemOptions `json:"systemOptions,omitempty"`
	// Extensions allows to enable/disable various custom features
	Extensions *Extensions `json:"extensions,omitempty"`
	// WebConfig allows to specify config.js used by UI to customize installer
	WebConfig string `json:"webConfig,omitempty"`
}

type Metadata struct {
	// Name is the application name
	Name string `json:"name,omitempty"`
	// ResourceVersion is the application version in semver format
	ResourceVersion string `json:"resourceVersion,omitempty"`
	// Namespace is the application namespace
	Namespace string `json:"namespace,omitempty"`
	// Repository is the repository where application package resides;
	// it is normally not used and always equals to "gravitational.io"
	Repository string `json:"repository,omitempty"`
	// Description is the application description
	Description string `json:"description,omitempty"`
	// Author is the application author
	Author string `json:"author,omitempty"`
	// CreatedTimestamp is a timestamp the application package was built at
	CreatedTimestamp time.Time `json:"createdTimestamp,omitempty"`
	// Hidden allows to hide the app from a list of apps visible in Ops Center
	Hidden bool `json:"hidden,omitempty"`
	// Labels is labels attached to the manifest
	Labels map[string]string `json:"labels,omitempty"`
}

type MonitoringExtension struct {
	// Disabled allows to disable Monitoring tab
	Disabled bool `json:"disabled,omitempty"`
}

type Network struct {
	// MinTransferRate is minimum required transfer rate
	MinTransferRate utils.TransferRate `json:"minTransferRate,omitempty"`
	// Ports specifies port ranges that should be available on the server
	Ports []Port `json:"ports,omitempty"`
}

type Networking struct {
	// Type is networking type
	Type string `json:"type,omitempty"`
}

type Nginx struct {
	// Enabled indicates whether nginx is enabled.
	Enabled bool `json:"enabled,omitempty"`
}

type NodeProfile struct {
	// Name is the profile name (role), e.g. "db"
	Name string `json:"name,omitempty"`
	// Description is a verbose profile description
	Description string `json:"description,omitempty"`
	// Requirements is a list of requirements the servers of this profile
	// should satisty
	Requirements Requirements `json:"requirements,omitempty"`
	// Labels is a list of labels nodes of this profile will be marked with
	Labels map[string]string `json:"labels,omitempty"`
	// Tains is a list of taints to apply to this profile
	Taints []corev1.Taint `json:"taints,omitempty"`
	// Providers contains some cloud provider specific settings
	Providers NodeProviders `json:"providers,omitempty"`
	// ExpandPolicy specifies whether nodes of this profile can
	// be resized
	ExpandPolicy string `json:"expandPolicy,omitempty"`
	// ServiceRole is the node's system role ("master" or "node")
	ServiceRole ServiceRole `json:"serviceRole,omitempty"`
	// SystemOptions defines optional system configuration for the node
	SystemOptions *SystemOptions `json:"systemOptions,omitempty"`
}

type NodeProfiles []NodeProfile

type NodeProviderAWS struct {
	// InstanceTypes is a list of supported instance types
	InstanceTypes []string `json:"instanceTypes,omitempty"`
}

type NodeProviders struct {
	// AWS contains AWS-specific settings
	AWS NodeProviderAWS `json:"aws,omitempty"`
}

type OS struct {
	// Name is the required OS name (e.g. "centos", "redhat")
	Name string `json:"name,omitempty"`
	// Versions is supported OS versions
	Versions []string `json:"versions,omitempty"`
}

type OpenEBS struct {
	// Enabled indicates whether OpenEBS is enabled.
	Enabled bool `json:"enabled,omitempty"`
}

type OpsCenterExtension struct {
	// Disabled disables the OpsCenter UI
	Disabled bool `json:"disabled,omitempty"`
}

type Port struct {
	// Protocol is port protocol ("tcp", "udp")
	Protocol string `json:"protocol,omitempty"`
	// Ranges is a list of port ranges to check
	Ranges []string `json:"ranges,omitempty"`
}

type PortRange struct {
	// Protocol specifies the port's protocol
	Protocol string
	// From and To specify the port range
	From, To uint64
	// Description specifies the optional port description
	Description string
}

type PortRanges struct {
	// Kubernetes lists kubernetes-specific ports
	Kubernetes []PortRange
	// Installer lists installer-specific ports
	Installer []PortRange
	// Generic lists other ports
	Generic []PortRange
	// Reserved lists ports that are reserved by default
	Reserved []PortRange
	// Vxlan defines the xvlan port
	Vxlan PortRange
}

type Providers struct {
	// Default specifies the default provider.
	Default string `json:"default,omitempty"`
	// AWS defines AWS-specific settings
	AWS AWS `json:"aws,omitempty"`
	// Azure defines Azure-specific settings
	Azure Azure `json:"azure,omitempty"`
	// Generic defines settings for a generic provider (e.g. onprem)
	Generic Generic `json:"generic,omitempty"`
}

type RAM struct {
	// Min is minimum required amount of RAM
	Min utils.Capacity `json:"min,omitempty"`
	// Max is maximum supported amount of RAM
	Max utils.Capacity `json:"max,omitempty"`
}

type Requirements struct {
	// CPU describes CPU requirements
	CPU CPU `json:"cpu,omitempty"`
	// RAM describes RAM requirements
	RAM RAM `json:"ram,omitempty"`
	// OS describes OS requirements
	OS []OS `json:"os,omitempty"`
	// Network describes network requirements
	Network Network `json:"network,omitempty"`
	// Volumes describes volumes requirements
	Volumes []Volume `json:"volumes,omitempty"`
	// Devices describes devices that should be created inside container
	Devices []Device `json:"devices,omitempty"`
	// CustomChecks lists additional preflight checks as inline scripts
	CustomChecks []CustomCheck `json:"customChecks,omitempty"`
}

type Runtime struct {
	// Locator is the runtime package locator
	Locator loc.Locator
}

type ServiceRole string

type Storage struct {
	// OpenEBS is the OpenEBS storage provider configuration.
	OpenEBS *OpenEBS `json:"openebs,omitempty"`
}

type SystemDependencies struct {
	// Runtime describes the runtime package
	Runtime *Dependency `json:"runtimePackage,omitempty"`
}

type SystemOptions struct {
	// ExternalService specifies additional configuration for the runtime package
	ExternalService
	// Runtime describes the runtime the application is based on
	Runtime *Runtime `json:"runtime,omitempty"`
	// Docker describes docker options
	Docker *Docker `json:"docker,omitempty"`
	// Etcd describes etcd options
	Etcd *Etcd `json:"etcd,omitempty"`
	// Kubelet describes kubelet options
	Kubelet *Kubelet `json:"kubelet,omitempty"`
	// BaseImage optionally overrides the planet image.
	// If specified, the image is vendored locally and translated into a runtime package.
	// If this is specified for a specific node profile, only nodes with the profile
	// will have that runtime package installed.
	BaseImage string `json:"baseImage,omitempty"`
	// Dependencies defines additional package dependencies
	Dependencies SystemDependencies `json:"dependencies"`
	// AllowPrivileged controls whether privileged containers will be allowed
	// in the cluster.
	AllowPrivileged bool `json:"allowPrivileged,omitempty"`
}

type Volume struct {
	// Name is a volume short name for referencing
	Name string `json:"name,omitempty"`
	// Path is a volume path on host
	Path string `json:"path,omitempty"`
	// TargetPath is a volume mount path inside planet
	TargetPath string `json:"targetPath,omitempty"`
	// Capacity is required capacity
	Capacity utils.Capacity `json:"capacity,omitempty"`
	// Filesystems is a list of supported filesystems
	Filesystems []string `json:"filesystems,omitempty"`
	// CreateIfMissing is whether to create directory on host if it's missing
	CreateIfMissing *bool `json:"createIfMissing,omitempty"`
	// SkipIfMissing avoids mounting a directory inside a container if it's missing on host.
	// This flag implies CreateIfMissing == false.
	// The rationale for this flag is to be able to define mounts optimistically
	// for multiple disparate locations (subject to specific OS distributions)
	// and only actually create mounts for existing directories.
	//
	// For a configuration with two mounts: /path/to/dir1 (as found on OS1)
	// and /path/to/dir2 (as found on OS2) to some location inside the container,
	// installing on OS1 will use /path/to/dir1 as a mount source,
	// while installing on OS2 will use /path/to/dir2.
	SkipIfMissing *bool `json:"skipIfMissing,omitempty"`
	// MinTransferRate is required disk speed
	MinTransferRate utils.TransferRate `json:"minTransferRate,omitempty"`
	// Hidden applies to mounts and means that the mount is not shown to a user in installer UI
	Hidden bool `json:"hidden,omitempty"`
	// UID sets UID for a volume path on the host
	UID *int `json:"uid,omitempty"`
	// GID sets GID for a volume path on the host
	GID *int `json:"gid,omitempty"`
	// Mode sets file mode for a volume path on the host
	// accepts octal format
	Mode string `json:"mode,omitempty"`
	// Recursive means that all mount points inside this mount should also be mounted
	Recursive bool `json:"recursive,omitempty"`
	// SELinuxLabel specifies the SELinux label.
	// If left unspecified, the default.ContainerFileLabel will be used to label the directory.
	// If a special value SELinuxLabelNone is specified - no labeling is performed
	SELinuxLabel string `json:"seLinuxLabel,omitempty"`
}