v1

type AWSAction struct {
	// Context is an AWS API context (EC2 or IAM)
	Context string `json:"context,omitempty"`
	// Name is the resource name
	Name string `json:"name,omitempty"`
}

type AWSActions []AWSAction

type AWSStatement struct {
	// PolicyVersion is the version of the document used to
	// describe the policy
	PolicyVersion string `json:"policy_version,omitempty"`
	// Actions defines a list of actions this terraform script will execute
	// Action is defined by a context (EC2 or IAM) and a name of the action
	// that is performed against a certain AWS resource:
	//  ec2:DescribeImages
	// defines an action to query EC2 image metadata
	Actions AWSActions `json:"items,omitempty"`
}

type AWSTerraformProvisioner struct {
	// Spec groups configuration parameters
	Spec AWSTerraformSpec `json:"variables,omitempty"`
}

type AWSTerraformSpec struct {
	// Image defines the AWS machine image to use to boot instances
	Image string `json:"ami,omitempty"`
	// Region defines an AWS region
	Region string `json:"region,omitempty"`
	// Regions is a list of AWS regions this application supports
	Regions []string `json:"regions,omitempty"`
	// AvailabilityZone defines an AWS availability zone to create instances in
	AvailabilityZone string `json:"az1,omitempty"`
	// AccessKey defines a access key part of the API key
	AccessKey string `json:"access_key,omitempty"`
	// SecretKey defines a secret key part of the API key
	SecretKey string `json:"secret_key,omitempty"`
	// VPCID is an ID of a pre-existing VPC to put instances into
	VPCID string `json:"vpc_id,omitempty"`
	// VPCCIDR defines a CIDR block for the VPC
	VPCCIDR string `json:"vpc_cidr,omitempty"`
	// SubnetID is an ID of a VPC's subnet to put instances into
	SubnetID string `json:"subnet_id,omitempty"`
	// SubnetCIDR defines a CIDR block for the subnet
	SubnetCIDR string `json:"subnet_cidr,omitempty"`
	// InternetGatewayID is an ID of internet gateway attached to a VPC
	InternetGatewayID string `json:"internet_gateway_id,omitempty"`
	// Statement defines an extent of actions on AWS resources this script will execute
	Statement AWSStatement `json:"required_actions,omitempty"`
	// KeyPair defines an optional key pair to use for provisioning
	KeyPair string `json:"key_pair,omitempty"`
	// TerraformSpec is terraform script describing infrastructure to provision, excluding
	// instances, such as VPC, security groups, etc.
	TerraformSpec string `json:"terraform_spec,omitempty"`
	// InstanceSpec is terraform script describing a single instance
	InstanceSpec string `json:"instance_spec,omitempty"`
	// Docker defines docker-specific configuration
	Docker Docker `json:"docker"`
}

type AppDependencies []AppDependency

type AppDependency struct {
	// Package defines the package name of the dependency
	Package loc.Locator
}

type CPU struct {
	MinCount int `json:"min_count"`
}

type Dependencies struct {
	// Packages defines the package dependencies
	Packages PackageDependencies `json:"packages,omitempty"`
	// Apps defines the application dependencies
	Apps AppDependencies `json:"apps,omitempty"`
}

type Device struct {
	// Name is device's name, e.g. "vdb"
	Name string `json:"device,omitempty"`
	// MB is device's capacity in megabytes, e.g. 2048
	MB int `json:"mb,omitempty"`
}

type Directories []Directory

type Directory struct {
	// Name directory name to check
	Name string `json:"name,omitempty"`
	// MinTotalMB is a minimum total MB available for this directory
	MinTotalMB int `json:"min_total_mb,omitempty"`
	// FSTypes is a list of allowed fs types mounted for this
	// directory
	FSTypes []string `json:"fs_types,omitempty"`
}

type Disk struct {
	// MinMBPerSecond is the minimum speed in megabytes per second
	MinMBPerSecond int `json:"min_mbps"`
}

type Docker struct {
	// Backend defines the type of storage backend to setup Docker with
	Backend string `json:"backend,omitempty"`
	// MinTotalGB defines Docker's minimum device size requirement
	MinTotalGB int `json:"min_total_gb,omitempty"`
	// Args lists arbitrary docker options
	Args []string `json:"args,omitempty"`
}

type EULA struct {
	// Enabled is whether it is enabled for the installer
	Enabled bool `json:"enabled"`
	// Source is the source of the license agreement
	Source unversioned.MultiSourceValue `json:"source"`
}

type EncryptionExtension struct {
	// EncryptionKey is the passphrase for installer encryption
	EncryptionKey unversioned.MultiSourceValue `json:"encryption_key"`
	// CACert is the certificate authority certificate
	CACert unversioned.MultiSourceValue `json:"ca_cert"`
}

type Endpoint struct {
	// Name is the name of endpoint used for display purposes
	Name string `json:"name"`
	// Description is the verbose description of the endpoint used for display purposes
	Description string `json:"description"`
	// Selector is the label selector of a k8s service for this endpoint
	Selector map[string]string `json:"selector"`
	// Protocol is the communication protocol the service behind this endpoint is configured with (tcp, http, etc)
	Protocol string `json:"protocol"`
	// Port is the specific port for this service, can be left blank to default to all service ports
	Port int `json:"port"`
}

type Extensions struct {
	// Encryption configures application installer encryption
	Encryption *EncryptionExtension `json:"encryption,omitempty"`
	// User specifies a special user to create during install
	User *UserExtension `json:"user,omitempty"`
	// Monitoring configures monitoring extension
	Monitoring *MonitoringExtension `json:"monitoring,omitempty"`
}

type FinalInstallStep struct {
	// ServiceName is the name of a service running inside installed k8s cluster
	// that the installer should be redirected to
	ServiceName string `json:"service_name,omitempty"`
}

type Flavor struct {
	// Name defines the flavor name
	Name string `json:"name,omitempty"`
	// Description provides free text description of the flavor
	Description string `json:"description,omitempty"`
	// Threshold defines the boundary between two scaling steps (flavors)
	Threshold Threshold `json:"threshold,omitempty"`
	// Profiles defines the allocation of server profiles in this scaling step
	Profiles map[string]int `json:"profiles,omitempty"`
}

type Flavors struct {
	// Title sets a descriptive title for this scaling matrix
	Title string `json:"title"`
	// DefaultFlavor specifies the name of the default flavor for the application
	DefaultFlavor string `json:"default_flavor,omitempty"`
	// Items define a list of scaling steps (flavors)
	Items []Flavor `json:"items"`
}

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

type HookType string

type Hooks struct {
	// Install hook executes an installation script
	Install *HooksBase `json:"install,omitempty"`
	// Installed hook executes script after install
	Installed *HooksBase `json:"post_install,omitempty"`
	// Uninstall hook executes an uninstallation script
	Uninstall *HooksBase `json:"uninstall,omitempty"`
	// Uninstalling hook runs just before the uninstall operation commences
	Uninstalling *HooksBase `json:"pre_uninstall,omitempty"`
	// NodeAdding hook runs before the expand operation starts
	NodeAdding *HooksBase `json:"pre_node_add,omitempty"`
	// NodeAdded hook runs after the expand operation has completed
	NodeAdded *HooksBase `json:"post_node_add,omitempty"`
	// NodeRemoving hook runs before the shrink operation starts
	NodeRemoving *HooksBase `json:"pre_node_remove,omitempty"`
	// NodeRemoved hook runs after the shrink operation has completed
	NodeRemoved *HooksBase `json:"post_node_remove,omitempty"`
	// Updating hook runs before the update operation starts
	Updating *HooksBase `json:"update,omitempty"`
	// Updated hook runs after the update operation has completed
	Updated *HooksBase `json:"post_update,omitempty"`
	// Rollback hook runs when update operation fails
	Rollback *HooksBase `json:"rollback,omitempty"`
	// RolledBack hook runs after rollback has been finished
	RolledBack *HooksBase `json:"post_rollback,omitempty"`
	// Status hook reports the status of the application
	Status *HooksBase `json:"status,omitempty"`
	// Info hook serves as an information endpoint for an installed application.
	// It is used to obtain the details of the application service(s)
	Info *HooksBase `json:"info,omitempty"`
	// LicenseUpdated hook is triggered when a site license has been updated.
	LicenseUpdated *HooksBase `json:"license_updated,omitempty"`
	// Start hook provides a way to start a stopped application.
	Start *HooksBase `json:"start,omitempty"`
	// Stop hook provides a way to stop a running application.
	Stop *HooksBase `json:"stop,omitempty"`
	// Dump hook is used for retrieving application-specific dumps for debug reports
	Dump *HooksBase `json:"dump,omitempty"`
	// HookBackup defines a hook to trigger backup of application data
	Backup *HooksBase `json:"backup,omitempty"`
	// HookRestore defines a hook to restore application state from a previously
	// created backup
	Restore *HooksBase `json:"restore,omitempty"`
}

type HooksBase struct {
	// Type denotes the type of this hook
	Type HookType `json:"type,omitempty"`
	// JobSpec defines the raw kubernetes job resource template executed
	// verbatim
	JobSpec v1.Job `json:"spec,omitempty"`
}

type Installer struct {
	// Provisioners defines provisioner configuration
	Provisioners Provisioners `json:"provisioners,omitempty"`
	// Servers lists server profiles that specify generic hardware requirements
	// for a set of nodes
	Servers map[string]ServerProfile `json:"servers,omitempty"`
	// Flavors defines a scaling matrix for the configured server profiles
	Flavors Flavors `json:"flavors"`
	// License defines whether an application requires a license to operate
	License License `json:"license"`
	// EULA defines the End User License Agreement
	EULA EULA `json:"eula"`
	// FinalInstallStep defines the last vendor-customizable installation step
	FinalInstallStep *FinalInstallStep `json:"final_install_step,omitempty"`
}

type KubeConfig struct {
	// CloudProvider defines the cloud provider to use
	CloudProvider string `json:"cloud_provider,omitempty"`
}

type License struct {
	// Enabled flag controls whether an application requires a license
	Enabled bool `json:"enabled"` // does not have "omitempty" so it's always explicit
	// Type is the type of license accepted by application (see ops.license.LicenseType* for details)
	Type string `json:"type"`
	// TrialFlavors is a list of flavor names that do not require a license
	TrialFlavors []string `json:"trial_flavors,omitempty"`
}

type Manifest struct {
	Header
	*Installer     `json:"installer,omitempty"`
	*Orchestration `json:"orchestration,omitempty"`
	Dependencies   `json:"dependencies,omitempty"`
	*Hooks         `json:"hooks,omitempty"`
	Base           *ManifestRef `json:"base,omitempty"`
	Endpoints      []Endpoint   `json:"endpoints,omitempty"`
	WebConfig      *WebConfig   `json:"webConfig,omitempty"`
	// OpsCenterConfig defines the block to configure remote access to an OpsCenter
	OpsCenterConfig *OpsCenterConfig `json:"opscenter,omitempty"`
	// Extensions section defines various application extension features, such as
	// encryption
	Extensions *Extensions `json:"extensions,omitempty"`
}

type ManifestRef struct {
	// Package names the referred to application
	Package loc.Locator
}

type Metadata struct {
	metav1.ObjectMeta
	// Repository is the name of the repository the application belongs to
	Repository string `json:"repository,omitempty" yaml:"repository,omitempty"`
	// ReleaseNotes are the release notes for the current application version
	ReleaseNotes string `json:"releaseNotes,omitempty" yaml:"releaseNotes,omitempty"`
	// Resources are the resource notes for the current application
	Resources string `json:"resources,omitempty" yaml:"resources,omitempty"`
	// Logo defines user-specific brand markup
	Logo map[string]string `json:"logo,omitempty" yaml:"logo,omitempty"`
}

type MonitoringExtension struct {
	// Enabled flag controls monitoring extension status
	Enabled bool `json:"enabled"`
}

type Mount struct {
	// Name defines a name for this mount
	Name string `json:"name,omitempty"`
	// Source defines the path on host mapped inside the cluster
	// environment container.
	// The source can be left empty at manifest definition state to
	// allow user input
	Source string `json:"source,omitempty"`
	// Destination is the mount point where the host path is mapped inside
	// the cluster container
	Destination string `json:"destination,omitempty"`
	// CreateIfMissing forces a non-existing source directory to be created
	CreateIfMissing *bool `json:"create_if_missing,omitempty"`
	// MinTotalMB is a minimum size requirement in MB for the source directory
	MinTotalMB int `json:"min_total_mb,omitempty"`
	// FSTypes is a list of allowed fs types for the source directory
	FSTypes []string `json:"fs_types,omitempty"`
}

type Mounts map[string]Mount

type Network struct {
	// MinMBPerSecond is the minimum bandwidth in megabytes per second
	MinMBPerSecond int `json:"min_mbps"`
}

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

type OnPremProvisioner struct {
	// Variables defines all configuration parameters for a bare metal provisioner
	Spec OnPremSpec `json:"variables"`
}

type OnPremSpec struct {
	// Docker defines docker configuration
	Docker Docker `json:"docker"`
}

type OpsCenterConfig struct {
	// Address specifies the address of the remote OpsCenter
	Address unversioned.MultiSourceValue `json:"address"`
	// Token defines the agent token used to connect to the remote OpsCenter
	Token unversioned.MultiSourceValue `json:"token"`
}

type Orchestration struct {
	// KubeConfig defines kubernetes-specific orchestration configuration
	KubeConfig KubeConfig `json:"k8s,omitempty"`
}

type PackageDependencies []PackageDependency

type PackageDependency struct {
	// Package defines the package name of the dependency
	Package loc.Locator
	// Selector defines the list of selectors assigned to this package
	Selector map[string]string `json:"selector,omitempty"`
}

type Provisioners struct {
	// Virsh defines a virsh provisioner
	Virsh *VirshProvisioner `json:"virsh,omitempty"`
	// OnPrem defines a bare metal provisioner
	OnPrem *OnPremProvisioner `json:"onprem,omitempty"`
	// AWSTerraform defines an AWS terraform provisioner
	AWSTerraform *AWSTerraformProvisioner `json:"aws_terraform,omitempty"`
}

type RAM struct {
	// MinTotalMB is a minimum amount of RAM provided by the system
	MinTotalMB int `json:"min_total_mb"`
}

type ServerPorts struct {
	// Protocol is port protocol, tcp or udp
	Protocol string `json:"protocol"`
	// Ranges is the port ranges
	Ranges []string `json:"ranges"`
}

type ServerProfile struct {
	// Description is a human-readable description of this porfile
	Description string `json:"description,omitempty"`
	// CPU specifies CPU requirements
	CPU CPU `json:"cpu,omitempty"`
	// RAM specifies RAM requirements
	RAM RAM `json:"ram,omitempty"`
	// OS specifies Operation System requirements
	OS []OS `json:"os,omitempty"`
	// Ports specifies port requirements
	Ports []ServerPorts `json:"ports,omitempty"`
	// Disk specifies I/O requirements
	Disk Disk `json:"disk,omitempty"`
	// Network specifies networking requirements
	Network Network `json:"network,omitempty"`
	// Directories specifies the directory requirements
	Directories Directories `json:"directories,omitempty"`
	// Mounts lists required mount points
	Mounts Mounts `json:"mounts,omitempty"`
	// Labels specifies a set of application-specific labels to assign
	// to this profile
	Labels map[string]string `json:"labels,omitempty"`
	// ServiceRole specifies the server role
	ServiceRole ServiceRole `json:"service_role,omitempty"`
	// InstanceTypes defines a list of supported instance types for every
	// supported cloud provider
	InstanceTypes map[string][]string `json:"instance_types,omitempty"`
	// FixedInstanceType indicates whether it is allowed to add servers (during expand)
	// of the same role with an instance type different than the one other servers of
	// this profile have been provisioned with
	FixedInstanceType bool `json:"fixed_instance_type"`
	// NonExpandable defines whether this profile is not available for expansion.
	// Default is false (i.e. expandable)
	NonExpandable bool `json:"non_expandable"`
	// Request augments the static server profile with information about how many servers
	// of a certain instance type were actually requested for an install/expand operation.
	//
	// This is sort of "runtime" information used only during installation/expansion so it
	// is not a part of manifest schema.
	Request ServerProfileRequest `json:"request,omitempty"`
}

type ServerProfileRequest struct {
	// InstanceType is the instance type to provision
	InstanceType string `json:"instance_type,omitempty"`
	// Count is the number of servers to provision
	Count int `json:"count,omitempty"`
}

type ServiceRole string

type Threshold struct {
	// Value sets the value for this threshold in arbitrary units
	Value int64 `json:"value,omitempty"`
	// Label defines the human-readable representation of the value.
	// It can potentially be used to specify the units used in Value
	Label string `json:"label,omitempty"`
}

type UserExtension struct {
	// Name is the name of the user
	Name string `json:"name"`
	// Type is the user type, only "container" is supported currently
	Type string `json:"type"`
	// Selector is the selector for the "container" user
	Selector map[string]string `json:"selector"`
	// Namespace is the k8s namespace to look for the pod in
	Namespace string `json:"namespace"`
	// Shell is the shell to use inside container
	Shell string `json:"shell"`
}

type VirshProvisioner struct {
	// Spec defines the configuration parameters for the virsh provisioner
	Spec VirshSpec `json:"variables,omitempty"`
	// Commands lists all the commands the provisioner runs during provisioning
	Commands []string `json:"commands,omitempty"`
}

type VirshSpec struct {
	// Image defines the VM image to use to boot instances from
	Image string `json:"image,omitempty"`
	// Devices specifies the details of each configured device
	Devices []Device `json:"devices,omitempty"`
	// RAM specifies the memory allocated to the VM, in megabytes
	RAM int `json:"ram_mb,omitempty"`
	// Docker defines docker-specific configuration
	Docker Docker `json:"docker"`
}

type WebConfig struct {
	// Modules specifies various parts of web installer / site that can be customized
	Modules *WebModules `json:"modules,omitempty"`
}

type WebFeature struct {
	// Enabled turns the feature on/off
	Enabled bool `json:"enabled"`
}

type WebFeatures struct {
	// Kubernetes is a tab with Kubernetes resources - pods, services, etc.
	Kubernetes *WebFeature `json:"k8s,omitempty"`
	// Configuration is a tab with Kubernetes config maps
	Configuration *WebFeature `json:"configMaps,omitempty"`
}

type WebInstaller struct {
	// Providers is a list of providers the app installer supports
	Providers []string `json:"providers,omitempty"`
	// EnableTags controls whether the installer allows to change site labels before installation
	EnableTags bool `json:"enableTags,omitempty"`
	// LicenseHeaderText is the title that prompts user to choose licensed versus non-licensed deployment
	LicenseHeaderText string `json:"licenseHeaderText,omitempty"`
	// LicenseOptionTrialText is the text for non-licensed deployment type
	LicenseOptionTrialText string `json:"licenseOptionTrialText,omitempty"`
	// LicenseOptionText is the text for licensed deployment type
	LicenseOptionText string `json:"licenseOptionText,omitempty"`
	// LicenseUserHintText is the help message that appears on the deployment type screen
	LicenseUserHintText string `json:"licenseUserHintText,omitempty"`
	// EULAHeaderText is the title for the EULA screen
	EULAHeaderText string `json:"eulaHeaderText,omitempty"`
	// EULAAgreeText is the agree text for the EULA screen
	EULAAgreeText string `json:"eulaAgreeText,omitempty"`
}

type WebModules struct {
	// Installer contains customizations for web installer
	Installer *WebInstaller `json:"installer,omitempty"`
	// Site contains UI customizations for a deployed site
	Site *WebSite `json:"site,omitempty"`
}

type WebSite struct {
	// Features is a set of UI features that can be enabled/disabled
	Features *WebFeatures `json:"features,omitempty"`
}