name string

deployments DeploymentInfo array

managedDeployments integer

readyDeployments integer

pollingInterval integer

PollingInterval is the interval (in seconds) to check each trigger on. Default is 30 seconds.

cooldownPeriod integer

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).

maxReplicaCount integer

MaxReplicaCount is the maximum number of replicas the scaler will scale the deployment to. Default is 10.

minReplicaCount integer

MinReplicaCount is the minimum number of replicas the scaler will scale the deployment to.

advanced AdvancedConfig

triggers ScaleTriggers array

fallback Fallback

externalHPA boolean

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.

mode AutoScalerMode

Enable the autoscaler feature

replicas SimpleAutoScalerReplicas

ram SimpleAutoScalerMetric

cpu SimpleAutoScalerMetric

apiVersion string

cloud.redhat.com/v1alpha1

kind string

ClowdApp

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ClowdAppSpec

A ClowdApp specification.

apiVersion string

cloud.redhat.com/v1alpha1

kind string

ClowdAppList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items ClowdApp array

A list of ClowdApp Resources.

deployments Deployment array

A list of deployments

jobs Job array

A list of jobs

envName string

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.

kafkaTopics KafkaTopicSpec array

A list of Kafka topics that will be created and made available to all the pods listed in the ClowdApp.

database DatabaseSpec

The database specification defines a single database, the configuration of which will be made available to all the pods in the ClowdApp.

objectStore string array

A list of string names defining storage buckets. In certain modes, defined by the ClowdEnvironment, Clowder will create those buckets.

inMemoryDb boolean

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.

featureFlags boolean

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.

dependencies string array

A list of dependencies in the form of the name of the ClowdApps that are required to be present for this ClowdApp to function.

optionalDependencies string array

A list of optional dependencies in the form of the name of the ClowdApps that will be added to the configuration when present.

testing TestingSpec

Iqe plugin and other specifics

cyndi CyndiSpec

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.

disabled boolean

Disabled turns off reconciliation for this ClowdApp

apiVersion string

cloud.redhat.com/v1alpha1

kind string

ClowdEnvironment

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ClowdEnvironmentSpec

A ClowdEnvironmentSpec object.

apiVersion string

cloud.redhat.com/v1alpha1

kind string

ClowdEnvironmentList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items ClowdEnvironment array

A list of ClowdEnvironment objects.

targetNamespace string

TargetNamespace describes the namespace where any generated environmental resources should end up, this is particularly important in (local) mode.

providers ProvidersConfig

A ProvidersConfig object, detailing the setup and configuration of all the providers used in this ClowdEnvironment.

resourceDefaults ResourceRequirements

Defines the default resource requirements in standard k8s format in the event that they omitted from a PodSpec inside a ClowdApp.

serviceConfig ServiceConfig

disabled boolean

Disabled turns off reconciliation for this ClowdEnv

apiVersion string

cloud.redhat.com/v1alpha1

kind string

ClowdJobInvocation

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ClowdJobInvocationSpec

apiVersion string

cloud.redhat.com/v1alpha1

kind string

ClowdJobInvocationList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items ClowdJobInvocation array

appName string

Name of the ClowdApp who owns the jobs

jobs string array

Jobs is the set of jobs to be run by the invocation

testing JobTestingSpec

Testing is the struct for building out test jobs (iqe, etc) in a CJI

runOnNotReady boolean

RunOnNotReady is a flag that when true, the job will not wait for the deployment to be ready to run

enabled boolean

Enables or Disables the Cyndi pipeline for the Clowdapp

appName string

Application name - if empty will default to Clowdapp’s name

additionalFilters object array

AdditionalFilters

insightsOnly boolean

Desired host syndication type (all or Insights hosts only) - defaults to false (All hosts)

mode DatabaseMode

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.

caBundleURL string

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.

pvc boolean

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.

version integer

Defines the Version of the PostGreSQL database, defaults to 12.

name string

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'

sharedDbAppName string

Defines the Name of the app to share a database from

dbVolumeSize string

T-shirt size, one of small, medium, large

dbResourceSize string

T-shirt size, one of small, medium, large

name string

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.

minReplicas integer

Deprecated: Use Replicas instead If Replicas is not set and MinReplicas is set, then MinReplicas will be used

replicas integer

Defines the desired replica count for the pod

web WebDeprecated

If set to true, creates a service on the webPort defined in the ClowdEnvironment resource, along with the relevant liveness and readiness probes.

webServices WebServices

podSpec PodSpec

PodSpec defines a container running inside a ClowdApp.

k8sAccessLevel K8sAccessLevel

K8sAccessLevel defines the level of access for this deployment

autoScaler AutoScaler

AutoScaler defines the configuration for the Keda auto scaler

autoScalerSimple AutoScalerSimple

deploymentStrategy DeploymentStrategy

DeploymentStrategy allows the deployment strategy to be set only if the deployment has no public service enabled

metadata DeploymentMetadata

Refer to Kubernetes API documentation for fields of metadata.

omitPullPolicy boolean

name string

hostname string

port integer

annotations object (keys:string, values:string)

privateStrategy DeploymentStrategyType

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.

managedDeployments integer

readyDeployments integer

managedTopics integer

readyTopics integer

mode FeatureFlagsMode

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.

pvc boolean

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.

credentialRef NamespacedName

Defines the secret containing the client access token, only used for (app-interface) mode.

hostname string

Defines the hostname for (app-interface) mode

port integer

Defineds the port for (app-interface) mode

images FeatureFlagsImages

Defines images used for the feature flags provider

unleash string

enabled boolean

Determines whether to enable the gateway cert, default is disabled

certMode GatewayCertMode

Determines the mode of certificate generation, either self-signed or acme

localCAConfigMap string

Determines a ConfigMap in the target namespace of the env which has ca.pem detailing the cert to use for mTLS verification

emailAddress string

The email address used to register with Let’s Encrypt for acme mode certs

mode InMemoryMode

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'

pvc boolean

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.

name string

Name gives an identifier in the situation where multiple init containers exist

image string

Image refers to the container image used to create the init container (if different from the primary pod image).

command string array

A list of commands to run inside the parent Pod.

args string array

A list of args to be passed to the init container.

inheritEnv boolean

If true, inheirts the environment variables from the parent pod. specification

env EnvVar array

A list of environment variables used only by the initContainer.

imageBase string

resources ResourceRequirements

A pass-through of a resource requirements in k8s ResourceRequirements format. If omitted, the default resource requirements from the ClowdEnvironment will be used.

vaultSecretRef NamespacedName

Defines the secret reference for loading vault credentials into the IQE job

ui IqeUIConfig

Defines configurations related to UI testing containers

imageTag string

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.

plugins string

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.

ui IqeUISpec

Defines configuration for a selenium container (optional)

env EnvVar

Specifies environment variables to set on the IQE container

debug boolean

Changes entrypoint to invoke 'iqe container-debug' so that container starts but does not run tests, allowing 'rsh' to be invoked

marker string

(DEPRECATED, using 'env' now preferred) sets IQE_MARKER_EXPRESSION env var on the IQE container

dynaconfEnvName string

(DEPRECATED, using 'env' now preferred) sets ENV_FOR_DYNACONF env var on the IQE container

filter string

(DEPRECATED, using 'env' now preferred) sets IQE_FILTER_EXPRESSION env var on the IQE container

requirements string

(DEPRECATED, using 'env' now preferred) sets IQE_REQUIREMENTS env var on the IQE container

requirementsPriority string

(DEPRECATED, using 'env' now preferred) sets IQE_REQUIREMENTS_PRIORITY env var on the IQE container

testImportance string

(DEPRECATED, using 'env' now preferred) sets IQE_TEST_IMPORTANCE env var on the IQE container

logLevel string

(DEPRECATED, using 'env' now preferred) sets IQE_LOG_LEVEL env var on the IQE container

parallelEnabled string

(DEPRECATED, using 'env' now preferred) sets IQE_PARALLEL_ENABLED env var on the IQE container

parallelWorkerCount string

(DEPRECATED, using 'env' now preferred) sets IQE_PARALLEL_WORKER_COUNT env var on the IQE container

rpArgs string

(DEPRECATED, using 'env' now preferred) sets IQE_RP_ARGS env var on the IQE container

ibutsuSource string

(DEPRECATED, using 'env' now preferred) sets IQE_IBUTSU_SOURCE env var on the IQE container

deploy boolean

Whether or not a selenium container should be deployed in the IQE pod

imageTag string

Name of selenium image tag to use if not using the environment’s default

selenium IqeUISeleniumConfig

Defines configurations for selenium containers in this environment

imageBase string

Defines the image used for selenium containers in this environment

defaultImageTag string

Defines the default image tag used for selenium containers in this environment

resources ResourceRequirements

Defines the resource requests/limits set on selenium containers

enabled boolean

No longer used

selenium IqeSeleniumSpec

Configuration options for running IQE with a selenium container

name string

Name defines identifier of the Job. This name will be used to name the CronJob resource, the container will be name identically.

disabled boolean

Disabled allows a job to be disabled, as such, the resource is not created on the system and cannot be invoked with a CJI

schedule string

Defines the schedule for the job to run

parallelism integer

Defines the parallelism of the job

completions integer

Defines the completions of the job

podSpec PodSpec

PodSpec defines a container running inside the CronJob.

restartPolicy RestartPolicy

Defines the restart policy for the CronJob, defaults to never

concurrencyPolicy ConcurrencyPolicy

Defines the concurrency policy for the CronJob, defaults to Allow Only applies to Cronjobs

suspend boolean

This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. Only applies to Cronjobs

successfulJobsHistoryLimit integer

The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3. Only applies to Cronjobs

failedJobsHistoryLimit integer

The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1. Only applies to Cronjobs

startingDeadlineSeconds integer

Defines the StartingDeadlineSeconds for the CronJob

activeDeadlineSeconds integer

The activeDeadlineSeconds for the Job or CronJob. More info: https://kubernetes.io/docs/concepts/workloads/controllers/job/

iqe IqeJobSpec

Iqe is the job spec to override defaults from the ClowdApp’s definition of the job

name string

Defines the kafka cluster name (default: <ClowdEnvironment Name>-<UID>)

namespace string

The namespace the kafka cluster is expected to reside in (default: the environment’s targetNamespace)

forceTLS boolean

Force TLS

replicas integer

The requested number of replicas for kafka/zookeeper. If unset, default is '1'

storageSize string

Persistent volume storage size. If unset, default is '1Gi' Only applies when KafkaConfig.PVC is set to 'true'

deleteClaim boolean

Delete persistent volume claim if the Kafka cluster is deleted Only applies when KafkaConfig.PVC is set to 'true'

version string

Version. If unset, default is '2.5.0'

config map[string]string

Config full options

jvmOptions KafkaSpecKafkaJvmOptions

JVM Options

resources KafkaSpecKafkaResources

Resource Limits

mode KafkaMode

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.

enableLegacyStrimzi boolean

EnableLegacyStrimzi disables TLS + user auth

pvc boolean

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.

cluster KafkaClusterConfig

Defines options related to the Kafka cluster for this environment. Ignored for (local) mode.

connect KafkaConnectClusterConfig

Defines options related to the Kafka Connect cluster for this environment. Ignored for (local) mode.

managedSecretRef NamespacedName

Defines the secret reference for the Managed Kafka mode. Only used in (managed) mode.

managedPrefix string

Managed topic prefix for the managed cluster. Only used in (managed) mode.

topicNamespace string

Namespace that kafkaTopics should be written to for (msk) mode.

clusterAnnotation string

Cluster annotation identifier for (msk) mode.

clusterName string

(Deprecated) Defines the cluster name to be used by the Kafka Provider this will be used in some modes to locate the Kafka instance.

namespace string

(Deprecated) The Namespace the cluster is expected to reside in. This is only used in (app-interface) and (operator) modes.

connectNamespace string

(Deprecated) The namespace that the Kafka Connect cluster is expected to reside in. This is only used in (app-interface) and (operator) modes.

connectClusterName string

(Deprecated) Defines the kafka connect cluster name that is used in this environment.

suffix string

(Deprecated) (Unused)

kafkaConnectReplicaCount integer

Sets the replica count for ephem-msk mode for kafka connect

name string

Defines the kafka connect cluster name (default: <kafka cluster’s name>)

namespace string

The namespace the kafka connect cluster is expected to reside in (default: the kafka cluster’s namespace)

replicas integer

The requested number of replicas for kafka connect. If unset, default is '1'

version string

Version. If unset, default is '2.5.0'

image string

Image. If unset, default is 'quay.io/cloudservices/xjoin-kafka-connect-strimzi:latest'

resources KafkaConnectSpecResources

Resource Limits

config object (keys:string, values:string)

A key/value pair describing the configuration of a particular topic.

partitions integer

The requested number of partitions for this topic. If unset, default is '3'

replicas integer

The requested number of replicas for this topic. If unset, default is '3'

topicName string

The requested name for this topic.

mode LoggingMode

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.

port integer

The port that metrics services inside ClowdApp pods should be served on.

path string

A prefix path that pods will be instructed to use when setting up their metrics server.

mode MetricsMode

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.

prometheus PrometheusConfig

Prometheus specific configuration

name string

Name defines the Name of a resource.

namespace string

Namespace defines the Namespace of a resource.

mode ObjectStoreMode

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.

suffix string

Currently unused.

pvc boolean

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.

images ObjectStoreImages

Override the object store images

minio string

image string

Image refers to the container image used to create the pod.

initContainers InitContainer array

A list of init containers used to perform at-startup operations.

metadata PodspecMetadata

Refer to Kubernetes API documentation for fields of metadata.

command string array

The command that will be invoked inside the pod at startup.

args string array

A list of args to be passed to the pod container.

env EnvVar array

A list of environment variables in k8s defined format.

resources ResourceRequirements

A pass-through of a resource requirements in k8s ResourceRequirements format. If omitted, the default resource requirements from the ClowdEnvironment will be used.

livenessProbe Probe

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.

readinessProbe Probe

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.

volumes Volume array

A pass-through of a list of Volumes in standa k8s format.

volumeMounts VolumeMount array

A pass-through of a list of VolumesMounts in standa k8s format.

lifecycle Lifecycle

A pass-through of Lifecycle specification in standard k8s format

terminationGracePeriodSeconds integer

A pass-through of TerminationGracePeriodSeconds specification in standard k8s format default is 30 seconds

sidecars Sidecar array

Lists the expected side cars, will be validated in the validating webhook

machinePool string

MachinePool allows the pod to be scheduled to a particular machine pool.

annotations object (keys:string, values:string)

enabled boolean

Enabled describes if Clowder should enable the private service and provide the configuration in the cdappconfig.

appProtocol AppProtocol

AppProtocol determines the protocol to be used for the private port, (defaults to http)

deploy boolean

Determines whether to deploy prometheus in operator mode

appInterfaceHostname string

Specify prometheus hostname when in app-interface mode

hostname string

db DatabaseConfig

Defines the Configuration for the Clowder Database Provider.

inMemoryDb InMemoryDBConfig

Defines the Configuration for the Clowder InMemoryDB Provider.

kafka KafkaConfig

Defines the Configuration for the Clowder Kafka Provider.

logging LoggingConfig

Defines the Configuration for the Clowder Logging Provider.

metrics MetricsConfig

Defines the Configuration for the Clowder Metrics Provider.

objectStore ObjectStoreConfig

Defines the Configuration for the Clowder ObjectStore Provider.

web WebConfig

Defines the Configuration for the Clowder Web Provider.

featureFlags FeatureFlagsConfig

Defines the Configuration for the Clowder FeatureFlags Provider.

serviceMesh ServiceMeshConfig

Defines the Configuration for the Clowder ServiceMesh Provider.

pullSecrets NamespacedName array

Defines the pull secret to use for the service accounts.

testing TestingConfig

Defines the environment for iqe/smoke testing

sidecars Sidecars

Defines the sidecar configuration

autoScaler AutoScalerConfig

Defines the autoscaler configuration

deployment DeploymentConfig

Defines the Deployment provider options

enabled boolean

Enabled describes if Clowder should enable the public service and provide the configuration in the cdappconfig.

apiPath string

(DEPRECATED, use apiPaths instead) Configures a path named '/api/<apiPath>/' that this app will serve requests from.

apiPaths APIPath array

Defines a list of API paths (each matching format: "/api/some-path/") that this app will serve requests from.

whitelistPaths string array

WhitelistPaths define the paths that do not require authentication

sessionAffinity boolean

Set SessionAffinity to true to enable sticky sessions

type string

mode ServiceMeshMode

name string

The name of the sidecar, only supported names allowed, (token-refresher)

enabled boolean

Defines if the sidecar is enabled, defaults to False

tokenRefresher TokenRefresherConfig

Sets up Token Refresher configuration

scaleAtValue string

scaleAtUtilization integer

min integer

max integer

enabled boolean

port integer

privatePort integer

iqe IqeConfig

Defines the environment for iqe/smoke testing

k8sAccessLevel K8sAccessLevel

The mode of operation of the testing Pod. Valid options are: 'default', 'view' or 'edit'

configAccess ConfigAccessMode

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

iqePlugin string

enabled boolean

Enables or disables token refresher sidecars

port integer

The port that web services inside ClowdApp pods should be served on.

privatePort integer

The private port that web services inside a ClowdApp should be served on.

aiuthPort integer

The auth port that the web local mode will use with the AuthSidecar

apiPrefix string

An api prefix path that pods will be instructed to use when setting up their web server.

mode WebMode

The mode of operation of the Web provider. The allowed modes are (none/operator), and (local) which deploys keycloak and BOP.

bopURL string

The URL of BOP - only used in (none/operator) mode.

ingressClass string

Ingress Class Name used only in (local) mode.

keycloakVersion string

Optional keycloak version override — used only in (local) mode — if not set, a hard-coded default is used.

keycloakPVC boolean

Optionally use PVC storage for keycloak db

images WebImages

Optional images to use for web provider components — only applies when running in (local) mode.

tls TLS

TLS sidecar enablement

gatewayCert GatewayCert

Gateway cert

mocktitlements string

Mock entitlements image — if not defined, value from operator config is used if set, otherwise a hard-coded default is used.

keycloak string

Keycloak image — default is 'quay.io/keycloak/keycloak:{KeycloakVersion}' unless overridden here

caddy string

Caddy image — if not defined, value from operator config is used if set, otherwise a hard-coded default is used.

caddyGateway string

Caddy Gateway image — if not defined, value from operator config is used if set, otherwise a hard-coded default is used.

mockBop string

Mock BOP image — if not defined, value from operator config is used if set, otherwise a hard-coded default is used.

public PublicWebService

private PrivateWebService

metrics MetricsWebService