v1alpha1

type APIPath string

type AppInfo struct {
	Name        string           `json:"name"`
	Deployments []DeploymentInfo `json:"deployments"`
}

type AppProtocol string

type AppResourceStatus struct {
	ManagedDeployments int32 `json:"managedDeployments"`
	ReadyDeployments   int32 `json:"readyDeployments"`
}

type AutoScaler struct {
	// PollingInterval is the interval (in seconds) to check each trigger on.
	// Default is 30 seconds.
	// +optional
	PollingInterval *int32 `json:"pollingInterval,omitempty"`
	// CooldownPeriod is the interval (in seconds) to wait after the last trigger reported active before
	// scaling the deployment down. Default is 5 minutes (300 seconds).
	// +optional
	CooldownPeriod *int32 `json:"cooldownPeriod,omitempty"`
	// MaxReplicaCount is the maximum number of replicas the scaler will scale the deployment to.
	// Default is 10.
	// +optional
	MaxReplicaCount *int32 `json:"maxReplicaCount,omitempty"`
	// MinReplicaCount is the minimum number of replicas the scaler will scale the deployment to.
	MinReplicaCount *int32 `json:"minReplicaCount,omitempty"`
	// +optional
	Advanced *keda.AdvancedConfig `json:"advanced,omitempty"`
	// +optional
	Triggers []keda.ScaleTriggers `json:"triggers,omitempty"`
	// +optional
	Fallback *keda.Fallback `json:"fallback,omitempty"`
	// ExternalHPA allows replicas on deployments to be controlled by another resource, but will
	// not be allowed to fall under the minReplicas as set in the ClowdApp.
	ExternalHPA bool `json:"externalHPA,omitempty"`
}

type AutoScalerConfig struct {
	// Enable the autoscaler feature
	Mode AutoScalerMode `json:"mode,omitempty"`
}

type AutoScalerMode string

type AutoScalerSimple struct {
	Replicas SimpleAutoScalerReplicas `json:"replicas"`
	RAM      SimpleAutoScalerMetric   `json:"ram,omitempty"`
	CPU      SimpleAutoScalerMetric   `json:"cpu,omitempty"`
}

type ClowdApp struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// A ClowdApp specification.
	Spec   ClowdAppSpec   `json:"spec,omitempty"`
	Status ClowdAppStatus `json:"status,omitempty"`
}

type ClowdAppList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// A list of ClowdApp Resources.
	Items []ClowdApp `json:"items"`
}

type ClowdAppSpec struct {
	// A list of deployments
	Deployments []Deployment `json:"deployments,omitempty"`

	// A list of jobs
	Jobs []Job `json:"jobs,omitempty"`

	// The name of the ClowdEnvironment resource that this ClowdApp will use as
	// its base. This does not mean that the ClowdApp needs to be placed in the
	// same directory as the targetNamespace of the ClowdEnvironment.
	EnvName string `json:"envName"`

	// A list of Kafka topics that will be created and made available to all
	// the pods listed in the ClowdApp.
	KafkaTopics []KafkaTopicSpec `json:"kafkaTopics,omitempty"`

	// The database specification defines a single database, the configuration
	// of which will be made available to all the pods in the ClowdApp.
	Database DatabaseSpec `json:"database,omitempty"`

	// A list of string names defining storage buckets. In certain modes,
	// defined by the ClowdEnvironment, Clowder will create those buckets.
	ObjectStore []string `json:"objectStore,omitempty"`

	// If inMemoryDb is set to true, Clowder will pass configuration
	// of an In Memory Database to the pods in the ClowdApp. This single
	// instance will be shared between all apps.
	InMemoryDB bool `json:"inMemoryDb,omitempty"`

	// If featureFlags is set to true, Clowder will pass configuration of a
	// FeatureFlags instance to the pods in the ClowdApp. This single
	// instance will be shared between all apps.
	FeatureFlags bool `json:"featureFlags,omitempty"`

	// A list of dependencies in the form of the name of the ClowdApps that are
	// required to be present for this ClowdApp to function.
	Dependencies []string `json:"dependencies,omitempty"`

	// A list of optional dependencies in the form of the name of the ClowdApps that
	// will be added to the configuration when present.
	OptionalDependencies []string `json:"optionalDependencies,omitempty"`

	// Iqe plugin and other specifics
	Testing TestingSpec `json:"testing,omitempty"`

	// Configures 'cyndi' database syndication for this app. When the app's ClowdEnvironment has
	// the kafka provider set to (*_operator_*) mode, Clowder will configure a CyndiPipeline
	// for this app in the environment's kafka-connect namespace. When the kafka provider is in
	// (*_app-interface_*) mode, Clowder will check to ensure that a CyndiPipeline resource exists
	// for the application in the environment's kafka-connect namespace. For all other kafka
	// provider modes, this configuration option has no effect.
	Cyndi CyndiSpec `json:"cyndi,omitempty"`

	// Disabled turns off reconciliation for this ClowdApp
	Disabled bool `json:"disabled,omitempty"`
}

type ClowdAppStatus struct {
	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
	// Important: Run "make" to regenerate code after modifying this file
	// ClowdEnvironmentStatus defines the observed state of ClowdEnvironment
	Deployments AppResourceStatus     `json:"deployments,omitempty"`
	Ready       bool                  `json:"ready"`
	Conditions  []clusterv1.Condition `json:"conditions,omitempty"`
}

type ClowdEnvironment struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// A ClowdEnvironmentSpec object.
	Spec   ClowdEnvironmentSpec   `json:"spec,omitempty"`
	Status ClowdEnvironmentStatus `json:"status,omitempty"`
}

type ClowdEnvironmentList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// A list of ClowdEnvironment objects.
	Items []ClowdEnvironment `json:"items"`
}

type ClowdEnvironmentSpec struct {
	// TargetNamespace describes the namespace where any generated environmental
	// resources should end up, this is particularly important in (*_local_*) mode.
	TargetNamespace string `json:"targetNamespace,omitempty"`

	// A ProvidersConfig object, detailing the setup and configuration of all the
	// providers used in this ClowdEnvironment.
	Providers ProvidersConfig `json:"providers"`

	// Defines the default resource requirements in standard k8s format in the
	// event that they omitted from a PodSpec inside a ClowdApp.
	ResourceDefaults core.ResourceRequirements `json:"resourceDefaults"`

	ServiceConfig ServiceConfig `json:"serviceConfig,omitempty"`

	// Disabled turns off reconciliation for this ClowdEnv
	Disabled bool `json:"disabled,omitempty"`
}

type ClowdEnvironmentStatus struct {
	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
	// Important: Run "make" to regenerate code after modifying this file
	Conditions      []clusterv1.Condition `json:"conditions,omitempty"`
	TargetNamespace string                `json:"targetNamespace,omitempty"`
	Ready           bool                  `json:"ready,omitempty"`
	Deployments     EnvResourceStatus     `json:"deployments,omitempty"`
	Apps            []AppInfo             `json:"apps,omitempty"`
	Generation      int64                 `json:"generation,omitempty"`
	Hostname        string                `json:"hostname,omitempty"`
	Prometheus      PrometheusStatus      `json:"prometheus,omitempty"`
}

type ClowdJobInvocation struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ClowdJobInvocationSpec   `json:"spec,omitempty"`
	Status ClowdJobInvocationStatus `json:"status,omitempty"`
}

type ClowdJobInvocationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ClowdJobInvocation `json:"items"`
}

type ClowdJobInvocationSpec struct {
	// Name of the ClowdApp who owns the jobs
	AppName string `json:"appName"`

	// Jobs is the set of jobs to be run by the invocation
	Jobs []string `json:"jobs,omitempty"`

	// Testing is the struct for building out test jobs (iqe, etc) in a CJI
	Testing JobTestingSpec `json:"testing,omitempty"`

	// RunOnNotReady is a flag that when true, the job will not wait for the deployment to be ready to run
	RunOnNotReady bool `json:"runOnNotReady,omitempty"`
}

type ClowdJobInvocationStatus struct {
	// Completed is false and updated when all jobs have either finished
	// successfully or failed past their backoff and retry values
	Completed bool `json:"completed"`
	// DEPRECATED : Jobs is an array of jobs name run by a CJI.
	Jobs []string `json:"jobs,omitempty"`
	// JobMap is a map of the job names run by Job invocation and their outcomes
	JobMap     map[string]JobConditionState `json:"jobMap"`
	Conditions []clusterv1.Condition        `json:"conditions,omitempty"`
}

type ConfigAccessMode string

type CyndiSpec struct {
	// Enables or Disables the Cyndi pipeline for the Clowdapp
	Enabled bool `json:"enabled,omitempty"`

	// Application name - if empty will default to Clowdapp's name
	// +kubebuilder:validation:MinLength:=1
	// +kubebuilder:validation:MaxLength:=64
	// +kubebuilder:validation:Pattern:="[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*"
	AppName string `json:"appName,omitempty"`

	// AdditionalFilters
	AdditionalFilters []map[string]string `json:"additionalFilters,omitempty"`

	// Desired host syndication type (all or Insights hosts only) - defaults to false (All hosts)
	InsightsOnly bool `json:"insightsOnly,omitempty"`
}

type DatabaseConfig struct {
	// The mode of operation of the Clowder Database Provider. Valid options are:
	// (*_app-interface_*) where the provider will pass through database credentials
	// found in the secret defined by the database name in the ClowdApp, and (*_local_*)
	// where the provider will spin up a local instance of the database.
	Mode DatabaseMode `json:"mode"`

	// Indicates where Clowder will fetch the database CA certificate bundle from. Currently only used in
	// (*_app-interface_*) mode. If none is specified, the AWS RDS combined CA bundle is used.
	// +kubebuilder:validation:Pattern=`^https?:\/\/.+$`
	CaBundleURL string `json:"caBundleURL,omitempty"`

	// If using the (*_local_*) mode and PVC is set to true, this instructs the local
	// Database instance to use a PVC instead of emptyDir for its volumes.
	PVC bool `json:"pvc,omitempty"`
}

type DatabaseMode string

type DatabaseSpec struct {
	// Defines the Version of the PostGreSQL database, defaults to 12.
	// +kubebuilder:validation:Enum:=10;12;13;14;15;16
	Version *int32 `json:"version,omitempty"`

	// Defines the Name of the database used by this app. This will be used as the
	// name of the logical database created by Clowder when the DB provider is in (*_local_*) mode.
	// In (*_app-interface_*) mode, the name here is used to locate the DB secret as a fallback mechanism
	// in cases where there is no 'clowder/database: <app-name>' annotation set on any secrets by looking
	// for a secret with 'db.host' starting with '<name>-<env>' where env is usually 'stage' or 'prod'
	Name string `json:"name,omitempty"`

	// Defines the Name of the app to share a database from
	SharedDBAppName string `json:"sharedDbAppName,omitempty"`

	// T-shirt size, one of small, medium, large
	// +kubebuilder:validation:Enum={"small", "medium", "large"}
	DBVolumeSize string `json:"dbVolumeSize,omitempty"`

	// T-shirt size, one of small, medium, large
	// +kubebuilder:validation:Enum={"small", "medium", "large"}
	DBResourceSize string `json:"dbResourceSize,omitempty"`
}

type Deployment struct {
	// Name defines the identifier of a Pod inside the ClowdApp. This name will
	// be used along side the name of the ClowdApp itself to form a <app>-<pod>
	// pattern which will be used for all other created resources and also for
	// some labels. It must be unique within a ClowdApp.
	Name string `json:"name"`

	// Deprecated: Use Replicas instead
	// If Replicas is not set and MinReplicas is set, then MinReplicas will be used
	MinReplicas *int32 `json:"minReplicas,omitempty"`

	// Defines the desired replica count for the pod
	Replicas *int32 `json:"replicas,omitempty"`

	// If set to true, creates a service on the webPort defined in
	// the ClowdEnvironment resource, along with the relevant liveness and
	// readiness probes.
	Web WebDeprecated `json:"web,omitempty"`

	WebServices WebServices `json:"webServices,omitempty"`

	// PodSpec defines a container running inside a ClowdApp.
	PodSpec PodSpec `json:"podSpec"`

	// K8sAccessLevel defines the level of access for this deployment
	K8sAccessLevel K8sAccessLevel `json:"k8sAccessLevel,omitempty"`

	// AutoScaler defines the configuration for the Keda auto scaler
	AutoScaler *AutoScaler `json:"autoScaler,omitempty"`

	AutoScalerSimple *AutoScalerSimple `json:"autoScalerSimple,omitempty"`

	// DeploymentStrategy allows the deployment strategy to be set only if the
	// deployment has no public service enabled
	DeploymentStrategy *DeploymentStrategy `json:"deploymentStrategy,omitempty"`

	Metadata DeploymentMetadata `json:"metadata,omitempty"`
}

type DeploymentConfig struct {
	OmitPullPolicy bool `json:"omitPullPolicy,omitempty"`
}

type DeploymentInfo struct {
	Name     string `json:"name"`
	Hostname string `json:"hostname,omitempty"`
	Port     int32  `json:"port,omitempty"`
}

type DeploymentMetadata struct {
	Annotations map[string]string `json:"annotations,omitempty"`
}

type DeploymentStrategy struct {
	// PrivateStrategy allows a deployment that only uses a private port to set
	// the deployment strategy one of Recreate or Rolling, default for a
	// private service is Recreate. This is to enable a quicker roll out for
	// services that do not have public facing endpoints.
	PrivateStrategy apps.DeploymentStrategyType `json:"privateStrategy,omitempty"`
}

type EnvResourceStatus struct {
	ManagedDeployments int32 `json:"managedDeployments"`
	ReadyDeployments   int32 `json:"readyDeployments"`
	ManagedTopics      int32 `json:"managedTopics"`
	ReadyTopics        int32 `json:"readyTopics"`
}

type FeatureFlagsConfig struct {
	// The mode of operation of the Clowder FeatureFlag Provider. Valid options are:
	// (*_app-interface_*) where the provider will pass through credentials
	// to the app configuration, and (*_local_*) where a local Unleash instance will
	// be created.
	Mode FeatureFlagsMode `json:"mode,omitempty"`

	// If using the (*_local_*) mode and PVC is set to true, this instructs the local
	// Database instance to use a PVC instead of emptyDir for its volumes.
	PVC bool `json:"pvc,omitempty"`

	// Defines the secret containing the client access token, only used for (*_app-interface_*)
	// mode.
	CredentialRef NamespacedName `json:"credentialRef,omitempty"`

	// Defines the hostname for (*_app-interface_*) mode
	Hostname string `json:"hostname,omitempty"`

	// Defineds the port for (*_app-interface_*) mode
	Port int32 `json:"port,omitempty"`
}

type FeatureFlagsMode string

type GatewayCert struct {
	// Determines whether to enable the gateway cert, default is disabled
	Enabled bool `json:"enabled,omitempty"`

	// Determines the mode of certificate generation, either self-signed or acme
	CertMode GatewayCertMode `json:"certMode,omitempty"`

	// Determines a ConfigMap in the target namespace of the env which has ca.pem detailing the cert to use for mTLS verification
	LocalCAConfigMap string `json:"localCAConfigMap,omitempty"`

	// The email address used to register with Let's Encrypt for acme mode certs
	EmailAddress string `json:"emailAddress,omitempty"`
}

type GatewayCertMode string

type InMemoryDBConfig struct {
	// The mode of operation of the Clowder InMemory Provider. Valid options are:
	// (*_redis_*) where a local Minio instance will be created, and (*_elasticache_*)
	// which will search the namespace of the ClowdApp for a secret called 'elasticache'
	Mode InMemoryMode `json:"mode"`

	// If using the (*_local_*) mode and PVC is set to true, this instructs the local
	// Database instance to use a PVC instead of emptyDir for its volumes.
	PVC bool `json:"pvc,omitempty"`
}

type InMemoryMode string

type InitContainer struct {
	// Name gives an identifier in the situation where multiple init containers exist
	Name string `json:"name,omitempty"`

	// Image refers to the container image used to create the init container
	// (if different from the primary pod image).
	Image string `json:"image,omitempty"`

	// A list of commands to run inside the parent Pod.
	Command []string `json:"command,omitempty"`

	// A list of args to be passed to the init container.
	Args []string `json:"args,omitempty"`

	// If true, inheirts the environment variables from the parent pod.
	// specification
	InheritEnv bool `json:"inheritEnv,omitempty"`

	// A list of environment variables used only by the initContainer.
	Env []v1.EnvVar `json:"env,omitempty"`
}

type IqeConfig struct {
	ImageBase string `json:"imageBase"`

	// A pass-through of a resource requirements in k8s ResourceRequirements
	// format. If omitted, the default resource requirements from the
	// ClowdEnvironment will be used.
	Resources core.ResourceRequirements `json:"resources,omitempty"`

	// Defines the secret reference for loading vault credentials into the IQE job
	VaultSecretRef NamespacedName `json:"vaultSecretRef,omitempty"`

	// Defines configurations related to UI testing containers
	UI IqeUIConfig `json:"ui,omitempty"`
}

type IqeJobSpec struct {
	// Image tag to use for IQE container. By default, Clowder will set the image tag to be
	// baseImage:name-of-iqe-plugin, where baseImage is defined in the ClowdEnvironment. Only the tag can be overridden here.
	ImageTag string `json:"imageTag,omitempty"`

	// A comma,separated,list indicating IQE plugin(s) to run tests for. By default, Clowder will use the plugin name given on the ClowdApp's
	// spec.testing.iqePlugin field. Use this field if you wish you override the plugin list.
	IqePlugins string `json:"plugins,omitempty"`

	// Defines configuration for a selenium container (optional)
	UI IqeUISpec `json:"ui,omitempty"`

	// Specifies environment variables to set on the IQE container
	Env *[]core.EnvVar `json:"env,omitempty"`

	// Changes entrypoint to invoke 'iqe container-debug' so that container starts but does not run tests, allowing 'rsh' to be invoked
	Debug bool `json:"debug,omitempty"`

	// (DEPRECATED, using 'env' now preferred) sets IQE_MARKER_EXPRESSION env var on the IQE container
	Marker string `json:"marker,omitempty"`

	// (DEPRECATED, using 'env' now preferred) sets ENV_FOR_DYNACONF env var on the IQE container
	DynaconfEnvName string `json:"dynaconfEnvName,omitempty"`

	// (DEPRECATED, using 'env' now preferred) sets IQE_FILTER_EXPRESSION env var on the IQE container
	Filter string `json:"filter,omitempty"`

	// (DEPRECATED, using 'env' now preferred) sets IQE_REQUIREMENTS env var on the IQE container
	Requirements *[]string `json:"requirements,omitempty"`

	// (DEPRECATED, using 'env' now preferred) sets IQE_REQUIREMENTS_PRIORITY env var on the IQE container
	RequirementsPriority *[]string `json:"requirementsPriority,omitempty"`

	// (DEPRECATED, using 'env' now preferred) sets IQE_TEST_IMPORTANCE env var on the IQE container
	TestImportance *[]string `json:"testImportance,omitempty"`

	// (DEPRECATED, using 'env' now preferred) sets IQE_LOG_LEVEL env var on the IQE container
	//+kubebuilder:validation:Enum={"", "critical", "error", "warning", "info", "debug", "notset"}
	LogLevel string `json:"logLevel,omitempty"`

	// (DEPRECATED, using 'env' now preferred) sets IQE_PARALLEL_ENABLED env var on the IQE container
	ParallelEnabled string `json:"parallelEnabled,omitempty"`

	// (DEPRECATED, using 'env' now preferred) sets IQE_PARALLEL_WORKER_COUNT env var on the IQE container
	ParallelWorkerCount string `json:"parallelWorkerCount,omitempty"`

	// (DEPRECATED, using 'env' now preferred) sets IQE_RP_ARGS env var on the IQE container
	RpArgs string `json:"rpArgs,omitempty"`

	// (DEPRECATED, using 'env' now preferred) sets IQE_IBUTSU_SOURCE env var on the IQE container
	IbutsuSource string `json:"ibutsuSource,omitempty"`
}

type IqeSeleniumSpec struct {
	// Whether or not a selenium container should be deployed in the IQE pod
	Deploy bool `json:"deploy,omitempty"`

	// Name of selenium image tag to use if not using the environment's default
	ImageTag string `json:"imageTag,omitempty"`
}

type IqeUIConfig struct {
	// Defines configurations for selenium containers in this environment
	Selenium IqeUISeleniumConfig `json:"selenium,omitempty"`
}

type IqeUISeleniumConfig struct {
	// Defines the image used for selenium containers in this environment
	ImageBase string `json:"imageBase,omitempty"`

	// Defines the default image tag used for selenium containers in this environment
	DefaultImageTag string `json:"defaultImageTag,omitempty"`

	// Defines the resource requests/limits set on selenium containers
	Resources core.ResourceRequirements `json:"resources,omitempty"`
}

type IqeUISpec struct {
	// No longer used
	Enabled bool `json:"enabled,omitempty"`

	// Configuration options for running IQE with a selenium container
	Selenium IqeSeleniumSpec `json:"selenium,omitempty"`
}

type Job struct {
	// Name defines identifier of the Job. This name will be used to name the
	// CronJob resource, the container will be name identically.
	Name string `json:"name"`

	// Disabled allows a job to be disabled, as such, the resource is not
	// created on the system and cannot be invoked with a CJI
	Disabled bool `json:"disabled,omitempty"`

	// Defines the schedule for the job to run
	Schedule string `json:"schedule,omitempty"`

	// Defines the parallelism of the job
	Parallelism *int32 `json:"parallelism,omitempty"`

	// Defines the completions of the job
	Completions *int32 `json:"completions,omitempty"`

	// PodSpec defines a container running inside the CronJob.
	PodSpec PodSpec `json:"podSpec"`

	// Defines the restart policy for the CronJob, defaults to never
	RestartPolicy v1.RestartPolicy `json:"restartPolicy,omitempty"`

	// Defines the concurrency policy for the CronJob, defaults to Allow
	// Only applies to Cronjobs
	ConcurrencyPolicy batch.ConcurrencyPolicy `json:"concurrencyPolicy,omitempty"`

	// This flag tells the controller to suspend subsequent executions, it does
	// not apply to already started executions.  Defaults to false.
	// Only applies to Cronjobs
	Suspend *bool `json:"suspend,omitempty"`

	// The number of successful finished jobs to retain. Value must be non-negative integer.
	// Defaults to 3.
	// Only applies to Cronjobs
	SuccessfulJobsHistoryLimit *int32 `json:"successfulJobsHistoryLimit,omitempty"`

	// The number of failed finished jobs to retain. Value must be non-negative integer.
	// Defaults to 1.
	// Only applies to Cronjobs
	FailedJobsHistoryLimit *int32 `json:"failedJobsHistoryLimit,omitempty"`

	// Defines the StartingDeadlineSeconds for the CronJob
	StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty"`

	// The activeDeadlineSeconds for the Job or CronJob.
	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/job/
	ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty"`
}

type JobConditionState string

type JobTestingSpec struct {
	// Iqe is the job spec to override defaults from the ClowdApp's
	// definition of the job
	Iqe IqeJobSpec `json:"iqe,omitempty"`
}

type K8sAccessLevel string

type KafkaClusterConfig struct {
	// Defines the kafka cluster name (default: <ClowdEnvironment Name>-<UID>)
	Name string `json:"name,omitempty"`

	// The namespace the kafka cluster is expected to reside in (default: the environment's targetNamespace)
	Namespace string `json:"namespace,omitempty"`

	// Force TLS
	ForceTLS bool `json:"forceTLS,omitempty"`

	// The requested number of replicas for kafka/zookeeper. If unset, default is '1'
	// +kubebuilder:validation:Minimum:=1
	Replicas int32 `json:"replicas,omitempty"`

	// Persistent volume storage size. If unset, default is '1Gi'
	// Only applies when KafkaConfig.PVC is set to 'true'
	StorageSize string `json:"storageSize,omitempty"`

	// Delete persistent volume claim if the Kafka cluster is deleted
	// Only applies when KafkaConfig.PVC is set to 'true'
	DeleteClaim bool `json:"deleteClaim,omitempty"`

	// Version. If unset, default is '2.5.0'
	Version string `json:"version,omitempty"`

	// Config full options
	Config *map[string]string `json:"config,omitempty"`

	// JVM Options
	JVMOptions strimzi.KafkaSpecKafkaJvmOptions `json:"jvmOptions,omitempty"`

	// Resource Limits
	Resources strimzi.KafkaSpecKafkaResources `json:"resources,omitempty"`
}

type KafkaConfig struct {
	// The mode of operation of the Clowder Kafka Provider. Valid options are:
	// (*_operator_*) which provisions Strimzi resources and will configure
	// KafkaTopic CRs and place them in the Kafka cluster's namespace described in the configuration,
	// (*_app-interface_*) which simply passes the topic names through to the App's
	// cdappconfig.json and expects app-interface to have created the relevant
	// topics, and (*_local_*) where a small instance of Kafka is created in the desired cluster namespace
	// and configured to auto-create topics.
	Mode KafkaMode `json:"mode"`

	// EnableLegacyStrimzi disables TLS + user auth
	EnableLegacyStrimzi bool `json:"enableLegacyStrimzi,omitempty"`

	// If using the (*_local_*) or (*_operator_*) mode and PVC is set to true, this sets the provisioned
	// Kafka instance to use a PVC instead of emptyDir for its volumes.
	PVC bool `json:"pvc,omitempty"`

	// Defines options related to the Kafka cluster for this environment. Ignored for (*_local_*) mode.
	Cluster KafkaClusterConfig `json:"cluster,omitempty"`

	// Defines options related to the Kafka Connect cluster for this environment. Ignored for (*_local_*) mode.
	Connect KafkaConnectClusterConfig `json:"connect,omitempty"`

	// Defines the secret reference for the Managed Kafka mode. Only used in (*_managed_*) mode.
	ManagedSecretRef NamespacedName `json:"managedSecretRef,omitempty"`

	// Managed topic prefix for the managed cluster. Only used in (*_managed_*) mode.
	ManagedPrefix string `json:"managedPrefix,omitempty"`

	// Namespace that kafkaTopics should be written to for (*_msk_*) mode.
	TopicNamespace string `json:"topicNamespace,omitempty"`

	// Cluster annotation identifier for (*_msk_*) mode.
	ClusterAnnotation string `json:"clusterAnnotation,omitempty"`

	// (Deprecated) Defines the cluster name to be used by the Kafka Provider this will
	// be used in some modes to locate the Kafka instance.
	ClusterName string `json:"clusterName,omitempty"`

	// (Deprecated) The Namespace the cluster is expected to reside in. This is only used
	// in (*_app-interface_*) and (*_operator_*) modes.
	Namespace string `json:"namespace,omitempty"`

	// (Deprecated) The namespace that the Kafka Connect cluster is expected to reside in. This is only used
	// in (*_app-interface_*) and (*_operator_*) modes.
	ConnectNamespace string `json:"connectNamespace,omitempty"`

	// (Deprecated) Defines the kafka connect cluster name that is used in this environment.
	ConnectClusterName string `json:"connectClusterName,omitempty"`

	// (Deprecated) (Unused)
	Suffix string `json:"suffix,omitempty"`

	// Sets the replica count for ephem-msk mode for kafka connect
	KafkaConnectReplicaCount int `json:"kafkaConnectReplicaCount,omitempty"`
}

type KafkaConnectClusterConfig struct {
	// Defines the kafka connect cluster name (default: <kafka cluster's name>)
	Name string `json:"name,omitempty"`

	// The namespace the kafka connect cluster is expected to reside in (default: the kafka cluster's namespace)
	Namespace string `json:"namespace,omitempty"`

	// The requested number of replicas for kafka connect. If unset, default is '1'
	// +kubebuilder:validation:Minimum:=1
	Replicas int32 `json:"replicas,omitempty"`

	// Version. If unset, default is '2.5.0'
	Version string `json:"version,omitempty"`

	// Image. If unset, default is 'quay.io/cloudservices/xjoin-kafka-connect-strimzi:latest'
	Image string `json:"image,omitempty"`

	// Resource Limits
	Resources strimzi.KafkaConnectSpecResources `json:"resources,omitempty"`
}

type KafkaMode string

type KafkaTopicSpec struct {

	// A key/value pair describing the configuration of a particular topic.
	// +optional
	Config map[string]string `json:"config,omitempty"`

	// The requested number of partitions for this topic. If unset, default is '3'
	// +optional
	// +kubebuilder:validation:Minimum:=1
	// +kubebuilder:validation:Maximum:=200000
	Partitions int32 `json:"partitions,omitempty"`

	// The requested number of replicas for this topic. If unset, default is '3'
	// +optional
	// +kubebuilder:validation:Minimum:=1
	// +kubebuilder:validation:Maximum:=32767
	Replicas int32 `json:"replicas,omitempty"`

	// The requested name for this topic.
	// +kubebuilder:validation:MinLength:=1
	// +kubebuilder:validation:MaxLength:=249
	// +kubebuilder:validation:Pattern:="[a-zA-Z0-9\\._\\-]"
	TopicName string `json:"topicName"`
}

type LoggingConfig struct {
	// The mode of operation of the Clowder Logging Provider. Valid options are:
	// (*_app-interface_*) where the provider will pass through cloudwatch credentials
	// to the app configuration, and (*_none_*) where no logging will be configured.
	Mode LoggingMode `json:"mode"`
}

type LoggingMode string

type MetricsConfig struct {
	// The port that metrics services inside ClowdApp pods should be served on.
	Port int32 `json:"port"`

	// A prefix path that pods will be instructed to use when setting up their
	// metrics server.
	Path string `json:"path,omitempty"`

	// The mode of operation of the Metrics provider. The allowed modes are
	//  (*_none_*), which disables metrics service generation, or
	// (*_operator_*) where services and probes are generated.
	// (*_app-interface_*) where services and probes are generated for app-interface.
	Mode MetricsMode `json:"mode"`

	// Prometheus specific configuration
	Prometheus PrometheusConfig `json:"prometheus,omitempty"`
}

type MetricsMode string

type MetricsWebService struct {
}

type MinioStatus struct {
	// A reference to standard k8s secret.
	Credentials core.SecretReference `json:"credentials"`

	// The hostname of a Minio instance.
	Hostname string `json:"hostname"`

	// The port number the Minio instance is to be served on.
	Port int32 `json:"port"`
}

type NamespacedName struct {
	// Name defines the Name of a resource.
	Name string `json:"name"`

	// Namespace defines the Namespace of a resource.
	Namespace string `json:"namespace"`
}

type ObjectStoreConfig struct {
	// The mode of operation of the Clowder ObjectStore Provider. Valid options are:
	// (*_app-interface_*) where the provider will pass through Amazon S3 credentials
	// to the app configuration, and (*_minio_*) where a local Minio instance will
	// be created.
	Mode ObjectStoreMode `json:"mode"`

	// Currently unused.
	Suffix string `json:"suffix,omitempty"`

	// If using the (*_local_*) mode and PVC is set to true, this instructs the local
	// Database instance to use a PVC instead of emptyDir for its volumes.
	PVC bool `json:"pvc,omitempty"`
}

type ObjectStoreMode string

type PodSpec struct {
	// Image refers to the container image used to create the pod.
	Image string `json:"image,omitempty"`

	// A list of init containers used to perform at-startup operations.
	InitContainers []InitContainer `json:"initContainers,omitempty"`

	// Allows for defining custom PodSpec metadata, such as annotations
	Metadata PodspecMetadata `json:"metadata,omitempty"`

	// The command that will be invoked inside the pod at startup.
	Command []string `json:"command,omitempty"`

	// A list of args to be passed to the pod container.
	Args []string `json:"args,omitempty"`

	// A list of environment variables in k8s defined format.
	Env []v1.EnvVar `json:"env,omitempty"`

	// A pass-through of a resource requirements in k8s ResourceRequirements
	// format. If omitted, the default resource requirements from the
	// ClowdEnvironment will be used.
	Resources v1.ResourceRequirements `json:"resources,omitempty"`

	// A pass-through of a Liveness Probe specification in standard k8s format.
	// If omitted, a standard probe will be setup point to the webPort defined
	// in the ClowdEnvironment and a path of /healthz. Ignored if Web is set to
	// false.
	LivenessProbe *v1.Probe `json:"livenessProbe,omitempty"`

	// A pass-through of a Readiness Probe specification in standard k8s format.
	// If omitted, a standard probe will be setup point to the webPort defined
	// in the ClowdEnvironment and a path of /healthz. Ignored if Web is set to
	// false.
	ReadinessProbe *v1.Probe `json:"readinessProbe,omitempty"`

	// A pass-through of a list of Volumes in standa k8s format.
	Volumes []v1.Volume `json:"volumes,omitempty"`

	// A pass-through of a list of VolumesMounts in standa k8s format.
	VolumeMounts []v1.VolumeMount `json:"volumeMounts,omitempty"`

	// A pass-through of Lifecycle specification in standard k8s format
	Lifecycle *v1.Lifecycle `json:"lifecycle,omitempty"`

	// A pass-through of TerminationGracePeriodSeconds specification in standard k8s format
	// default is 30 seconds
	TerminationGracePeriodSeconds *int64 `json:"terminationGracePeriodSeconds,omitempty"`

	// Lists the expected side cars, will be validated in the validating webhook
	Sidecars []Sidecar `json:"sidecars,omitempty"`

	// MachinePool allows the pod to be scheduled to a particular machine pool.
	MachinePool string `json:"machinePool,omitempty"`
}

type PodspecMetadata struct {
	Annotations map[string]string `json:"annotations,omitempty"`
}

type PrivateWebService struct {
	// Enabled describes if Clowder should enable the private service and provide the
	// configuration in the cdappconfig.
	Enabled bool `json:"enabled,omitempty"`

	// AppProtocol determines the protocol to be used for the private port, (defaults to http)
	AppProtocol AppProtocol `json:"appProtocol,omitempty"`
}

type PrometheusConfig struct {
	// Determines whether to deploy prometheus in operator mode
	Deploy bool `json:"deploy,omitempty"`

	// Specify prometheus hostname when in app-interface mode
	AppInterfaceHostname string `json:"appInterfaceHostname,omitempty"`
}

type PrometheusStatus struct {
	Hostname string `json:"hostname"`
}

type ProvidersConfig struct {
	// Defines the Configuration for the Clowder Database Provider.
	Database DatabaseConfig `json:"db,omitempty"`

	// Defines the Configuration for the Clowder InMemoryDB Provider.
	InMemoryDB InMemoryDBConfig `json:"inMemoryDb"`

	// Defines the Configuration for the Clowder Kafka Provider.
	Kafka KafkaConfig `json:"kafka"`

	// Defines the Configuration for the Clowder Logging Provider.
	Logging LoggingConfig `json:"logging"`

	// Defines the Configuration for the Clowder Metrics Provider.
	Metrics MetricsConfig `json:"metrics,omitempty"`

	// Defines the Configuration for the Clowder ObjectStore Provider.
	ObjectStore ObjectStoreConfig `json:"objectStore"`

	// Defines the Configuration for the Clowder Web Provider.
	Web WebConfig `json:"web,omitempty"`

	// Defines the Configuration for the Clowder FeatureFlags Provider.
	FeatureFlags FeatureFlagsConfig `json:"featureFlags,omitempty"`

	// Defines the Configuration for the Clowder ServiceMesh Provider.
	ServiceMesh ServiceMeshConfig `json:"serviceMesh,omitempty"`

	// Defines the pull secret to use for the service accounts.
	PullSecrets []NamespacedName `json:"pullSecrets,omitempty"`

	// Defines the environment for iqe/smoke testing
	Testing TestingConfig `json:"testing,omitempty"`

	// Defines the sidecar configuration
	Sidecars Sidecars `json:"sidecars,omitempty"`

	// Defines the autoscaler configuration
	AutoScaler AutoScalerConfig `json:"autoScaler,omitempty"`

	// Defines the Deployment provider options
	Deployment DeploymentConfig `json:"deployment,omitempty"`
}

type PublicWebService struct {

	// Enabled describes if Clowder should enable the public service and provide the
	// configuration in the cdappconfig.
	Enabled bool `json:"enabled,omitempty"`

	// (DEPRECATED, use apiPaths instead) Configures a path named '/api/<apiPath>/' that this app will serve requests from.
	APIPath string `json:"apiPath,omitempty"`

	// Defines a list of API paths (each matching format: "/api/some-path/") that this app will serve requests from.
	APIPaths []APIPath `json:"apiPaths,omitempty"`

	// WhitelistPaths define the paths that do not require authentication
	WhitelistPaths []string `json:"whitelistPaths,omitempty"`

	// Set SessionAffinity to true to enable sticky sessions
	SessionAffinity bool `json:"sessionAffinity,omitempty"`
}

type ServiceConfig struct {
	// +kubebuilder:validation:Enum=ClusterIP;NodePort;""
	Type string `json:"type"`
}

type ServiceMeshConfig struct {
	Mode ServiceMeshMode `json:"mode,omitempty"`
}

type ServiceMeshMode string

type Sidecar struct {
	// The name of the sidecar, only supported names allowed, (token-refresher)
	Name string `json:"name"`

	// Defines if the sidecar is enabled, defaults to False
	Enabled bool `json:"enabled"`
}

type Sidecars struct {
	// Sets up Token Refresher configuration
	TokenRefresher TokenRefresherConfig `json:"tokenRefresher,omitempty"`
}

type SimpleAutoScalerMetric struct {
	ScaleAtValue       string `json:"scaleAtValue,omitempty"`
	ScaleAtUtilization int32  `json:"scaleAtUtilization,omitempty"`
}

type SimpleAutoScalerReplicas struct {
	Min int32 `json:"min"`
	Max int32 `json:"max"`
}

type TLS struct {
	Enabled     bool  `json:"enabled,omitempty"`
	Port        int32 `json:"port,omitempty"`
	PrivatePort int32 `json:"privatePort,omitempty"`
}

type TestingConfig struct {
	// Defines the environment for iqe/smoke testing
	Iqe IqeConfig `json:"iqe,omitempty"`

	// The mode of operation of the testing Pod. Valid options are:
	// 'default', 'view' or 'edit'
	K8SAccessLevel K8sAccessLevel `json:"k8sAccessLevel"`

	// The mode of operation for access to outside app configs. Valid
	// options are:
	// (*_none_*) -- no app config is mounted to the pod
	// (*_app_*) -- only the ClowdApp's config is mounted to the pod
	// (*_environment_*) -- the config for all apps in the env are mounted
	ConfigAccess ConfigAccessMode `json:"configAccess"`
}

type TestingSpec struct {
	IqePlugin string `json:"iqePlugin"`
}

type TokenRefresherConfig struct {
	// Enables or disables token refresher sidecars
	Enabled bool `json:"enabled"`
}

type WebConfig struct {
	// The port that web services inside ClowdApp pods should be served on.
	Port int32 `json:"port"`

	// The private port that web services inside a ClowdApp should be served on.
	PrivatePort int32 `json:"privatePort,omitempty"`

	// The auth port that the web local mode will use with the AuthSidecar
	AuthPort int32 `json:"aiuthPort,omitempty"`

	// An api prefix path that pods will be instructed to use when setting up
	// their web server.
	APIPrefix string `json:"apiPrefix,omitempty"`

	// The mode of operation of the Web provider. The allowed modes are
	// (*_none_*/*_operator_*), and (*_local_*) which deploys keycloak and BOP.
	Mode WebMode `json:"mode"`

	// The URL of BOP - only used in (*_none_*/*_operator_*) mode.
	BOPURL string `json:"bopURL,omitempty"`

	// Ingress Class Name used only in (*_local_*) mode.
	IngressClass string `json:"ingressClass,omitempty"`

	// Optional keycloak version override -- used only in (*_local_*) mode -- if not set, a hard-coded default is used.
	KeycloakVersion string `json:"keycloakVersion,omitempty"`

	// Optionally use PVC storage for keycloak db
	KeycloakPVC bool `json:"keycloakPVC,omitempty"`

	// Optional images to use for web provider components -- only applies when running in (*_local_*) mode.
	Images WebImages `json:"images,omitempty"`

	// TLS sidecar enablement
	TLS TLS `json:"tls,omitempty"`

	// Gateway cert
	GatewayCert GatewayCert `json:"gatewayCert,omitempty"`
}

type WebDeprecated bool

type WebImages struct {
	// Mock entitlements image -- if not defined, value from operator config is used if set, otherwise a hard-coded default is used.
	Mocktitlements string `json:"mocktitlements,omitempty"`

	// Keycloak image -- default is 'quay.io/keycloak/keycloak:{KeycloakVersion}' unless overridden here
	Keycloak string `json:"keycloak,omitempty"`

	// Caddy image -- if not defined, value from operator config is used if set, otherwise a hard-coded default is used.
	Caddy string `json:"caddy,omitempty"`

	// Caddy Gateway image -- if not defined, value from operator config is used if set, otherwise a hard-coded default is used.
	CaddyGateway string `json:"caddyGateway,omitempty"`

	// Mock BOP image -- if not defined, value from operator config is used if set, otherwise a hard-coded default is used.
	MockBOP string `json:"mockBop,omitempty"`
}

type WebMode string

type WebServices struct {
	Public  PublicWebService  `json:"public,omitempty"`
	Private PrivateWebService `json:"private,omitempty"`
	Metrics MetricsWebService `json:"metrics,omitempty"`
}