diff --git a/docs/api_ref.md b/docs/api_ref.md index 89c53f447..b22799e12 100644 --- a/docs/api_ref.md +++ b/docs/api_ref.md @@ -1188,4 +1188,4 @@ Must be one of: **Description:** The external hostname of the deployment, where applicable ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-07-29 at 11:17:42 +0100 +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-08-28 at 14:57:43 +0200 diff --git a/docs/api_reference.md b/docs/api_reference.md index 5a599c931..38f6b5b02 100644 --- a/docs/api_reference.md +++ b/docs/api_reference.md @@ -24,9 +24,6 @@ _Underlying type:_ _string_ A string representing an API path that should route to this app for Clowder-managed Ingresses (in format "/api/somepath/") -_Validation:_ -- Pattern: `^\/api\/[a-zA-Z0-9-]+\/$` - _Appears in:_ - [PublicWebService](#publicwebservice) @@ -38,15 +35,13 @@ _Appears in:_ AppInfo details information about a specific app. - - _Appears in:_ - [ClowdEnvironmentStatus](#clowdenvironmentstatus) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `name` _string_ | | | | -| `deployments` _[DeploymentInfo](#deploymentinfo) array_ | | | | +| Field | Description | +| --- | --- | +| `name` _string_ | | +| `deployments` _[DeploymentInfo](#deploymentinfo) array_ | | #### AppProtocol @@ -55,9 +50,6 @@ _Underlying type:_ _string_ AppProtocol is used to define an appProtocol for Istio -_Validation:_ -- Enum: [http http2 https tcp tls grpc grpc-web mongo mysql redis] - _Appears in:_ - [PrivateWebService](#privatewebservice) @@ -69,15 +61,13 @@ _Appears in:_ - - _Appears in:_ - [ClowdAppStatus](#clowdappstatus) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `managedDeployments` _integer_ | | | | -| `readyDeployments` _integer_ | | | | +| Field | Description | +| --- | --- | +| `managedDeployments` _integer_ | | +| `readyDeployments` _integer_ | | #### AutoScaler @@ -86,38 +76,33 @@ _Appears in:_ AutoScaler defines the autoscaling parameters of a KEDA ScaledObject targeting the given deployment. - - _Appears in:_ - [Deployment](#deployment) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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](#advancedconfig)_ | | | | -| `triggers` _ScaleTriggers array_ | | | | -| `fallback` _[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. | | | +| Field | Description | +| --- | --- | +| `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](#advancedconfig)_ | | +| `triggers` _ScaleTriggers array_ | | +| `fallback` _[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. | #### AutoScalerConfig -AutoScalerConfig configures the Clowder provider controlling the creation of -AutoScaler configuration. - - +AutoScalerConfig configures the Clowder provider controlling the creation of AutoScaler configuration. _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `mode` _[AutoScalerMode](#autoscalermode)_ | Enable the autoscaler feature | | Enum: [none enabled keda]
| +| Field | Description | +| --- | --- | +| `mode` _[AutoScalerMode](#autoscalermode)_ | Enable the autoscaler feature | #### AutoScalerMode @@ -126,9 +111,6 @@ _Underlying type:_ _string_ AutoScaler mode enabled or disabled the autoscaler. The key "keda" is deprecated but preserved for backwards compatibility -_Validation:_ -- Enum: [none enabled keda] - _Appears in:_ - [AutoScalerConfig](#autoscalerconfig) @@ -138,19 +120,16 @@ _Appears in:_ -SimpleAutoScaler defines a simple HPA with scaling for RAM and CPU by -value and utilization thresholds, along with replica count limits - - +SimpleAutoScaler defines a simple HPA with scaling for RAM and CPU by value and utilization thresholds, along with replica count limits _Appears in:_ - [Deployment](#deployment) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `replicas` _[SimpleAutoScalerReplicas](#simpleautoscalerreplicas)_ | | | | -| `ram` _[SimpleAutoScalerMetric](#simpleautoscalermetric)_ | | | | -| `cpu` _[SimpleAutoScalerMetric](#simpleautoscalermetric)_ | | | | +| Field | Description | +| --- | --- | +| `replicas` _[SimpleAutoScalerReplicas](#simpleautoscalerreplicas)_ | | +| `ram` _[SimpleAutoScalerMetric](#simpleautoscalermetric)_ | | +| `cpu` _[SimpleAutoScalerMetric](#simpleautoscalermetric)_ | | #### ClowdApp @@ -159,17 +138,15 @@ _Appears in:_ ClowdApp is the Schema for the clowdapps API - - _Appears in:_ - [ClowdAppList](#clowdapplist) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `cloud.redhat.com/v1alpha1` | | | -| `kind` _string_ | `ClowdApp` | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[ClowdAppSpec](#clowdappspec)_ | A ClowdApp specification. | | | +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `cloud.redhat.com/v1alpha1` +| `kind` _string_ | `ClowdApp` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[ClowdAppSpec](#clowdappspec)_ | A ClowdApp specification. | #### ClowdAppList @@ -180,43 +157,38 @@ ClowdAppList contains a list of ClowdApp - - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `cloud.redhat.com/v1alpha1` | | | -| `kind` _string_ | `ClowdAppList` | | | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `items` _[ClowdApp](#clowdapp) array_ | A list of ClowdApp Resources. | | | +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `cloud.redhat.com/v1alpha1` +| `kind` _string_ | `ClowdAppList` +| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `items` _[ClowdApp](#clowdapp) array_ | A list of ClowdApp Resources. | #### ClowdAppSpec -ClowdAppSpec is the main specification for a single Clowder Application -it defines n pods along with dependencies that are shared between them. - - +ClowdAppSpec is the main specification for a single Clowder Application it defines n pods along with dependencies that are shared between them. _Appears in:_ - [ClowdApp](#clowdapp) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `deployments` _[Deployment](#deployment) array_ | A list of deployments | | | -| `jobs` _[Job](#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](#kafkatopicspec) array_ | A list of Kafka topics that will be created and made available to all
the pods listed in the ClowdApp. | | | -| `database` _[DatabaseSpec](#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](#testingspec)_ | Iqe plugin and other specifics | | | -| `cyndi` _[CyndiSpec](#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 | | | +| Field | Description | +| --- | --- | +| `deployments` _[Deployment](#deployment) array_ | A list of deployments | +| `jobs` _[Job](#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](#kafkatopicspec) array_ | A list of Kafka topics that will be created and made available to all the pods listed in the ClowdApp. | +| `database` _[DatabaseSpec](#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](#testingspec)_ | Iqe plugin and other specifics | +| `cyndi` _[CyndiSpec](#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 | @@ -227,17 +199,15 @@ _Appears in:_ ClowdEnvironment is the Schema for the clowdenvironments API - - _Appears in:_ - [ClowdEnvironmentList](#clowdenvironmentlist) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `cloud.redhat.com/v1alpha1` | | | -| `kind` _string_ | `ClowdEnvironment` | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[ClowdEnvironmentSpec](#clowdenvironmentspec)_ | A ClowdEnvironmentSpec object. | | | +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `cloud.redhat.com/v1alpha1` +| `kind` _string_ | `ClowdEnvironment` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[ClowdEnvironmentSpec](#clowdenvironmentspec)_ | A ClowdEnvironmentSpec object. | #### ClowdEnvironmentList @@ -248,14 +218,12 @@ ClowdEnvironmentList contains a list of ClowdEnvironment - - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `cloud.redhat.com/v1alpha1` | | | -| `kind` _string_ | `ClowdEnvironmentList` | | | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `items` _[ClowdEnvironment](#clowdenvironment) array_ | A list of ClowdEnvironment objects. | | | +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `cloud.redhat.com/v1alpha1` +| `kind` _string_ | `ClowdEnvironmentList` +| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `items` _[ClowdEnvironment](#clowdenvironment) array_ | A list of ClowdEnvironment objects. | #### ClowdEnvironmentSpec @@ -264,18 +232,16 @@ ClowdEnvironmentList contains a list of ClowdEnvironment ClowdEnvironmentSpec defines the desired state of ClowdEnvironment. - - _Appears in:_ - [ClowdEnvironment](#clowdenvironment) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `targetNamespace` _string_ | TargetNamespace describes the namespace where any generated environmental
resources should end up, this is particularly important in (*_local_*) mode. | | | -| `providers` _[ProvidersConfig](#providersconfig)_ | A ProvidersConfig object, detailing the setup and configuration of all the
providers used in this ClowdEnvironment. | | | -| `resourceDefaults` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)_ | Defines the default resource requirements in standard k8s format in the
event that they omitted from a PodSpec inside a ClowdApp. | | | -| `serviceConfig` _[ServiceConfig](#serviceconfig)_ | | | | -| `disabled` _boolean_ | Disabled turns off reconciliation for this ClowdEnv | | | +| Field | Description | +| --- | --- | +| `targetNamespace` _string_ | TargetNamespace describes the namespace where any generated environmental resources should end up, this is particularly important in (*_local_*) mode. | +| `providers` _[ProvidersConfig](#providersconfig)_ | A ProvidersConfig object, detailing the setup and configuration of all the providers used in this ClowdEnvironment. | +| `resourceDefaults` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)_ | Defines the default resource requirements in standard k8s format in the event that they omitted from a PodSpec inside a ClowdApp. | +| `serviceConfig` _[ServiceConfig](#serviceconfig)_ | | +| `disabled` _boolean_ | Disabled turns off reconciliation for this ClowdEnv | @@ -286,17 +252,15 @@ _Appears in:_ ClowdJobInvocation is the Schema for the jobinvocations API - - _Appears in:_ - [ClowdJobInvocationList](#clowdjobinvocationlist) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `cloud.redhat.com/v1alpha1` | | | -| `kind` _string_ | `ClowdJobInvocation` | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[ClowdJobInvocationSpec](#clowdjobinvocationspec)_ | | | | +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `cloud.redhat.com/v1alpha1` +| `kind` _string_ | `ClowdJobInvocation` +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `spec` _[ClowdJobInvocationSpec](#clowdjobinvocationspec)_ | | #### ClowdJobInvocationList @@ -307,14 +271,12 @@ ClowdJobInvocationList contains a list of ClowdJobInvocation - - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `cloud.redhat.com/v1alpha1` | | | -| `kind` _string_ | `ClowdJobInvocationList` | | | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `items` _[ClowdJobInvocation](#clowdjobinvocation) array_ | | | | +| Field | Description | +| --- | --- | +| `apiVersion` _string_ | `cloud.redhat.com/v1alpha1` +| `kind` _string_ | `ClowdJobInvocationList` +| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `items` _[ClowdJobInvocation](#clowdjobinvocation) array_ | | #### ClowdJobInvocationSpec @@ -323,17 +285,15 @@ ClowdJobInvocationList contains a list of ClowdJobInvocation ClowdJobInvocationSpec defines the desired state of ClowdJobInvocation - - _Appears in:_ - [ClowdJobInvocation](#clowdjobinvocation) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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](#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 | | | +| Field | Description | +| --- | --- | +| `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](#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 | @@ -344,9 +304,6 @@ _Underlying type:_ _string_ Describes what amount of app config is mounted to the pod -_Validation:_ -- Enum: [none app environment] - _Appears in:_ - [TestingConfig](#testingconfig) @@ -356,39 +313,33 @@ _Appears in:_ -CyndiSpec is used to indicate whether a ClowdApp needs database syndication configured by the -cyndi operator and exposes a limited set of cyndi configuration options - - +CyndiSpec is used to indicate whether a ClowdApp needs database syndication configured by the cyndi operator and exposes a limited set of cyndi configuration options _Appears in:_ - [ClowdAppSpec](#clowdappspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `enabled` _boolean_ | Enables or Disables the Cyndi pipeline for the Clowdapp | | | -| `appName` _string_ | Application name - if empty will default to Clowdapp's name | | MaxLength: 64
MinLength: 1
Pattern: `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`
| -| `additionalFilters` _object array_ | AdditionalFilters | | | -| `insightsOnly` _boolean_ | Desired host syndication type (all or Insights hosts only) - defaults to false (All hosts) | | | +| Field | Description | +| --- | --- | +| `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) | #### DatabaseConfig -DatabaseConfig configures the Clowder provider controlling the creation of -Database instances. - - +DatabaseConfig configures the Clowder provider controlling the creation of Database instances. _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `mode` _[DatabaseMode](#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. | | Enum: [shared app-interface local none]
| -| `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. | | Pattern: `^https?:\/\/.+$`
| -| `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. | | | +| Field | Description | +| --- | --- | +| `mode` _[DatabaseMode](#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. | #### DatabaseMode @@ -397,9 +348,6 @@ _Underlying type:_ _string_ DatabaseMode details the mode of operation of the Clowder Database Provider -_Validation:_ -- Enum: [shared app-interface local none] - _Appears in:_ - [DatabaseConfig](#databaseconfig) @@ -411,45 +359,40 @@ _Appears in:_ DatabaseSpec is a struct defining a database to be exposed to a ClowdApp. - - _Appears in:_ - [ClowdAppSpec](#clowdappspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `version` _integer_ | Defines the Version of the PostGreSQL database, defaults to 12. | | Enum: [10 12 13 14 15 16]
| -| `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: ' annotation set on any secrets by looking
for a secret with 'db.host' starting with '-' 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 | | Enum: [small medium large]
| -| `dbResourceSize` _string_ | T-shirt size, one of small, medium, large | | Enum: [small medium large]
| +| Field | Description | +| --- | --- | +| `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: ' annotation set on any secrets by looking for a secret with 'db.host' starting with '-' 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 | #### Deployment -Deployment defines a service running inside a ClowdApp and will output a deployment resource. -Only one container per pod is allowed and this is defined in the PodSpec attribute. - - +Deployment defines a service running inside a ClowdApp and will output a deployment resource. Only one container per pod is allowed and this is defined in the PodSpec attribute. _Appears in:_ - [ClowdAppSpec](#clowdappspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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 -
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](#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](#webservices)_ | | | | -| `podSpec` _[PodSpec](#podspec)_ | PodSpec defines a container running inside a ClowdApp. | | | -| `k8sAccessLevel` _[K8sAccessLevel](#k8saccesslevel)_ | K8sAccessLevel defines the level of access for this deployment | | Enum: [default view edit]
| -| `autoScaler` _[AutoScaler](#autoscaler)_ | AutoScaler defines the configuration for the Keda auto scaler | | | -| `autoScalerSimple` _[AutoScalerSimple](#autoscalersimple)_ | | | | -| `deploymentStrategy` _[DeploymentStrategy](#deploymentstrategy)_ | DeploymentStrategy allows the deployment strategy to be set only if the
deployment has no public service enabled | | | -| `metadata` _[DeploymentMetadata](#deploymentmetadata)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | +| Field | Description | +| --- | --- | +| `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 - 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](#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](#webservices)_ | | +| `podSpec` _[PodSpec](#podspec)_ | PodSpec defines a container running inside a ClowdApp. | +| `k8sAccessLevel` _[K8sAccessLevel](#k8saccesslevel)_ | K8sAccessLevel defines the level of access for this deployment | +| `autoScaler` _[AutoScaler](#autoscaler)_ | AutoScaler defines the configuration for the Keda auto scaler | +| `autoScalerSimple` _[AutoScalerSimple](#autoscalersimple)_ | | +| `deploymentStrategy` _[DeploymentStrategy](#deploymentstrategy)_ | DeploymentStrategy allows the deployment strategy to be set only if the deployment has no public service enabled | +| `metadata` _[DeploymentMetadata](#deploymentmetadata)_ | Refer to Kubernetes API documentation for fields of `metadata`. | #### DeploymentConfig @@ -458,14 +401,12 @@ _Appears in:_ - - _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `omitPullPolicy` _boolean_ | | | | +| Field | Description | +| --- | --- | +| `omitPullPolicy` _boolean_ | | #### DeploymentInfo @@ -474,16 +415,14 @@ _Appears in:_ DeploymentInfo defailts information about a specific deployment. - - _Appears in:_ - [AppInfo](#appinfo) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `name` _string_ | | | | -| `hostname` _string_ | | | | -| `port` _integer_ | | | | +| Field | Description | +| --- | --- | +| `name` _string_ | | +| `hostname` _string_ | | +| `port` _integer_ | | #### DeploymentMetadata @@ -492,14 +431,12 @@ _Appears in:_ - - _Appears in:_ - [Deployment](#deployment) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `annotations` _object (keys:string, values:string)_ | | | | +| Field | Description | +| --- | --- | +| `annotations` _object (keys:string, values:string)_ | | #### DeploymentStrategy @@ -508,14 +445,12 @@ _Appears in:_ - - _Appears in:_ - [Deployment](#deployment) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `privateStrategy` _[DeploymentStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#deploymentstrategytype-v1-apps)_ | 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. | | | +| Field | Description | +| --- | --- | +| `privateStrategy` _[DeploymentStrategyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#deploymentstrategytype-v1-apps)_ | 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. | #### EnvResourceStatus @@ -524,39 +459,34 @@ _Appears in:_ - - _Appears in:_ - [ClowdEnvironmentStatus](#clowdenvironmentstatus) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `managedDeployments` _integer_ | | | | -| `readyDeployments` _integer_ | | | | -| `managedTopics` _integer_ | | | | -| `readyTopics` _integer_ | | | | +| Field | Description | +| --- | --- | +| `managedDeployments` _integer_ | | +| `readyDeployments` _integer_ | | +| `managedTopics` _integer_ | | +| `readyTopics` _integer_ | | #### FeatureFlagsConfig -FeatureFlagsConfig configures the Clowder provider controlling the creation of -FeatureFlag instances. - - +FeatureFlagsConfig configures the Clowder provider controlling the creation of FeatureFlag instances. _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `mode` _[FeatureFlagsMode](#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. | | Enum: [local app-interface none]
| -| `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](#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](#featureflagsimages)_ | Defines images used for the feature flags provider | | | +| Field | Description | +| --- | --- | +| `mode` _[FeatureFlagsMode](#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](#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](#featureflagsimages)_ | Defines images used for the feature flags provider | #### FeatureFlagsImages @@ -565,25 +495,19 @@ _Appears in:_ - - _Appears in:_ - [FeatureFlagsConfig](#featureflagsconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `unleash` _string_ | | | | +| Field | Description | +| --- | --- | +| `unleash` _string_ | | #### FeatureFlagsMode _Underlying type:_ _string_ -FeatureFlagsMode details the mode of operation of the Clowder FeatureFlags -Provider - -_Validation:_ -- Enum: [local app-interface none] +FeatureFlagsMode details the mode of operation of the Clowder FeatureFlags Provider _Appears in:_ - [FeatureFlagsConfig](#featureflagsconfig) @@ -596,17 +520,15 @@ _Appears in:_ - - _Appears in:_ - [WebConfig](#webconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `enabled` _boolean_ | Determines whether to enable the gateway cert, default is disabled | | | -| `certMode` _[GatewayCertMode](#gatewaycertmode)_ | Determines the mode of certificate generation, either self-signed or acme | | Enum: [self-signed acme none]
| -| `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 | | | +| Field | Description | +| --- | --- | +| `enabled` _boolean_ | Determines whether to enable the gateway cert, default is disabled | +| `certMode` _[GatewayCertMode](#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 | #### GatewayCertMode @@ -615,9 +537,6 @@ _Underlying type:_ _string_ GatewayCertMode details the mode of operation of the Gateway Cert -_Validation:_ -- Enum: [self-signed acme none] - _Appears in:_ - [GatewayCert](#gatewaycert) @@ -627,29 +546,22 @@ _Appears in:_ -InMemoryDBConfig configures the Clowder provider controlling the creation of -InMemoryDB instances. - - +InMemoryDBConfig configures the Clowder provider controlling the creation of InMemoryDB instances. _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `mode` _[InMemoryMode](#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' | | Enum: [redis app-interface elasticache none]
| -| `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. | | | +| Field | Description | +| --- | --- | +| `mode` _[InMemoryMode](#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. | #### InMemoryMode _Underlying type:_ _string_ -InMemoryMode details the mode of operation of the Clowder InMemoryDB -Provider - -_Validation:_ -- Enum: [redis app-interface elasticache none] +InMemoryMode details the mode of operation of the Clowder InMemoryDB Provider _Appears in:_ - [InMemoryDBConfig](#inmemorydbconfig) @@ -660,23 +572,19 @@ _Appears in:_ -InitContainer is a struct defining a k8s init container. This will be -deployed along with the parent pod and is used to carry out one time -initialization procedures. - - +InitContainer is a struct defining a k8s init container. This will be deployed along with the parent pod and is used to carry out one time initialization procedures. _Appears in:_ - [PodSpec](#podspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core) array_ | A list of environment variables used only by the initContainer. | | | +| Field | Description | +| --- | --- | +| `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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core) array_ | A list of environment variables used only by the initContainer. | #### IqeConfig @@ -685,17 +593,15 @@ _Appears in:_ - - _Appears in:_ - [TestingConfig](#testingconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `imageBase` _string_ | | | | -| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)_ | 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](#namespacedname)_ | Defines the secret reference for loading vault credentials into the IQE job | | | -| `ui` _[IqeUIConfig](#iqeuiconfig)_ | Defines configurations related to UI testing containers | | | +| Field | Description | +| --- | --- | +| `imageBase` _string_ | | +| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)_ | 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](#namespacedname)_ | Defines the secret reference for loading vault credentials into the IQE job | +| `ui` _[IqeUIConfig](#iqeuiconfig)_ | Defines configurations related to UI testing containers | #### IqeJobSpec @@ -704,29 +610,27 @@ _Appears in:_ - - _Appears in:_ - [JobTestingSpec](#jobtestingspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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](#iqeuispec)_ | Defines configuration for a selenium container (optional) | | | -| `env` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)_ | 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 | | Enum: [ critical error warning info debug notset]
| -| `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 | | | +| Field | Description | +| --- | --- | +| `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](#iqeuispec)_ | Defines configuration for a selenium container (optional) | +| `env` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core)_ | 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 | #### IqeSeleniumSpec @@ -735,15 +639,13 @@ _Appears in:_ - - _Appears in:_ - [IqeUISpec](#iqeuispec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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 | | | +| Field | Description | +| --- | --- | +| `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 | #### IqeUIConfig @@ -752,14 +654,12 @@ _Appears in:_ - - _Appears in:_ - [IqeConfig](#iqeconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `selenium` _[IqeUISeleniumConfig](#iqeuiseleniumconfig)_ | Defines configurations for selenium containers in this environment | | | +| Field | Description | +| --- | --- | +| `selenium` _[IqeUISeleniumConfig](#iqeuiseleniumconfig)_ | Defines configurations for selenium containers in this environment | #### IqeUISeleniumConfig @@ -768,16 +668,14 @@ _Appears in:_ - - _Appears in:_ - [IqeUIConfig](#iqeuiconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)_ | Defines the resource requests/limits set on selenium containers | | | +| Field | Description | +| --- | --- | +| `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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)_ | Defines the resource requests/limits set on selenium containers | #### IqeUISpec @@ -786,46 +684,39 @@ _Appears in:_ - - _Appears in:_ - [IqeJobSpec](#iqejobspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `enabled` _boolean_ | No longer used | | | -| `selenium` _[IqeSeleniumSpec](#iqeseleniumspec)_ | Configuration options for running IQE with a selenium container | | | +| Field | Description | +| --- | --- | +| `enabled` _boolean_ | No longer used | +| `selenium` _[IqeSeleniumSpec](#iqeseleniumspec)_ | Configuration options for running IQE with a selenium container | #### Job -Job defines a ClowdJob -A Job struct will deploy as a CronJob if `schedule` is set -and will deploy as a Job if it is not set. Unsupported fields -will be dropped from Jobs - - +Job defines a ClowdJob A Job struct will deploy as a CronJob if `schedule` is set and will deploy as a Job if it is not set. Unsupported fields will be dropped from Jobs _Appears in:_ - [ClowdAppSpec](#clowdappspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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)_ | PodSpec defines a container running inside the CronJob. | | | -| `restartPolicy` _[RestartPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#restartpolicy-v1-core)_ | Defines the restart policy for the CronJob, defaults to never | | | -| `concurrencyPolicy` _[ConcurrencyPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#concurrencypolicy-v1-batch)_ | 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/ | | | +| Field | Description | +| --- | --- | +| `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)_ | PodSpec defines a container running inside the CronJob. | +| `restartPolicy` _[RestartPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#restartpolicy-v1-core)_ | Defines the restart policy for the CronJob, defaults to never | +| `concurrencyPolicy` _[ConcurrencyPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#concurrencypolicy-v1-batch)_ | 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/ | #### JobConditionState @@ -834,16 +725,9 @@ _Underlying type:_ _string_ - - _Appears in:_ - [ClowdJobInvocationStatus](#clowdjobinvocationstatus) -| Field | Description | -| --- | --- | -| `Invoked` | | -| `Complete` | | -| `Failed` | | #### JobTestingSpec @@ -852,14 +736,12 @@ _Appears in:_ - - _Appears in:_ - [ClowdJobInvocationSpec](#clowdjobinvocationspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `iqe` _[IqeJobSpec](#iqejobspec)_ | Iqe is the job spec to override defaults from the ClowdApp's
definition of the job | | | +| Field | Description | +| --- | --- | +| `iqe` _[IqeJobSpec](#iqejobspec)_ | Iqe is the job spec to override defaults from the ClowdApp's definition of the job | #### K8sAccessLevel @@ -868,9 +750,6 @@ _Underlying type:_ _string_ K8sAccessLevel defines the access level for the deployment, one of 'default', 'view' or 'edit' -_Validation:_ -- Enum: [default view edit] - _Appears in:_ - [Deployment](#deployment) - [TestingConfig](#testingconfig) @@ -883,54 +762,49 @@ _Appears in:_ KafkaClusterConfig defines options related to the Kafka cluster managed/monitored by Clowder - - _Appears in:_ - [KafkaConfig](#kafkaconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `name` _string_ | Defines the kafka cluster name (default: -) | | | -| `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' | | Minimum: 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](#kafkaspeckafkajvmoptions)_ | JVM Options | | | -| `resources` _[KafkaSpecKafkaResources](#kafkaspeckafkaresources)_ | Resource Limits | | | +| Field | Description | +| --- | --- | +| `name` _string_ | Defines the kafka cluster name (default: -) | +| `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](#kafkaspeckafkajvmoptions)_ | JVM Options | +| `resources` _[KafkaSpecKafkaResources](#kafkaspeckafkaresources)_ | Resource Limits | #### KafkaConfig -KafkaConfig configures the Clowder provider controlling the creation of -Kafka instances. - - +KafkaConfig configures the Clowder provider controlling the creation of Kafka instances. _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `mode` _[KafkaMode](#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. | | Enum: [ephem-msk managed operator app-interface local none]
| -| `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](#kafkaclusterconfig)_ | Defines options related to the Kafka cluster for this environment. Ignored for (*_local_*) mode. | | | -| `connect` _[KafkaConnectClusterConfig](#kafkaconnectclusterconfig)_ | Defines options related to the Kafka Connect cluster for this environment. Ignored for (*_local_*) mode. | | | -| `managedSecretRef` _[NamespacedName](#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 | | | +| Field | Description | +| --- | --- | +| `mode` _[KafkaMode](#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](#kafkaclusterconfig)_ | Defines options related to the Kafka cluster for this environment. Ignored for (*_local_*) mode. | +| `connect` _[KafkaConnectClusterConfig](#kafkaconnectclusterconfig)_ | Defines options related to the Kafka Connect cluster for this environment. Ignored for (*_local_*) mode. | +| `managedSecretRef` _[NamespacedName](#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 | #### KafkaConnectClusterConfig @@ -939,19 +813,17 @@ _Appears in:_ KafkaConnectClusterConfig defines options related to the Kafka Connect cluster managed/monitored by Clowder - - _Appears in:_ - [KafkaConfig](#kafkaconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `name` _string_ | Defines the kafka connect cluster name (default: ) | | | -| `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' | | Minimum: 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](#kafkaconnectspecresources)_ | Resource Limits | | | +| Field | Description | +| --- | --- | +| `name` _string_ | Defines the kafka connect cluster name (default: ) | +| `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](#kafkaconnectspecresources)_ | Resource Limits | #### KafkaMode @@ -960,9 +832,6 @@ _Underlying type:_ _string_ KafkaMode details the mode of operation of the Clowder Kafka Provider -_Validation:_ -- Enum: [ephem-msk managed operator app-interface local none] - _Appears in:_ - [KafkaConfig](#kafkaconfig) @@ -974,34 +843,29 @@ _Appears in:_ KafkaTopicSpec defines the desired state of KafkaTopic - - _Appears in:_ - [ClowdAppSpec](#clowdappspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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' | | Maximum: 200000
Minimum: 1
| -| `replicas` _integer_ | The requested number of replicas for this topic. If unset, default is '3' | | Maximum: 32767
Minimum: 1
| -| `topicName` _string_ | The requested name for this topic. | | MaxLength: 249
MinLength: 1
Pattern: `[a-zA-Z0-9\._\-]`
| +| Field | Description | +| --- | --- | +| `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. | #### LoggingConfig -LoggingConfig configures the Clowder provider controlling the creation of -Logging instances. - - +LoggingConfig configures the Clowder provider controlling the creation of Logging instances. _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `mode` _[LoggingMode](#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. | | Enum: [app-interface null none]
| +| Field | Description | +| --- | --- | +| `mode` _[LoggingMode](#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. | #### LoggingMode @@ -1010,9 +874,6 @@ _Underlying type:_ _string_ LoggingMode details the mode of operation of the Clowder Logging Provider -_Validation:_ -- Enum: [app-interface null none] - _Appears in:_ - [LoggingConfig](#loggingconfig) @@ -1022,20 +883,17 @@ _Appears in:_ -MetricsConfig configures the Clowder provider controlling the creation of -metrics services and their probes. - - +MetricsConfig configures the Clowder provider controlling the creation of metrics services and their probes. _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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](#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. | | Enum: [none operator app-interface]
| -| `prometheus` _[PrometheusConfig](#prometheusconfig)_ | Prometheus specific configuration | | | +| Field | Description | +| --- | --- | +| `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](#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](#prometheusconfig)_ | Prometheus specific configuration | #### MetricsMode @@ -1044,9 +902,6 @@ _Underlying type:_ _string_ MetricsMode details the mode of operation of the Clowder Metrics Provider -_Validation:_ -- Enum: [none operator app-interface] - _Appears in:_ - [MetricsConfig](#metricsconfig) @@ -1056,11 +911,7 @@ _Appears in:_ -MetricsWebService is the definition of the metrics web service. This is automatically -enabled and the configuration here at the moment is included for completeness, as there -are no configurable options. - - +MetricsWebService is the definition of the metrics web service. This is automatically enabled and the configuration here at the moment is included for completeness, as there are no configurable options. _Appears in:_ - [WebServices](#webservices) @@ -1075,38 +926,33 @@ _Appears in:_ NamespacedName type to represent a real Namespaced Name - - _Appears in:_ - [FeatureFlagsConfig](#featureflagsconfig) - [IqeConfig](#iqeconfig) - [KafkaConfig](#kafkaconfig) - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `name` _string_ | Name defines the Name of a resource. | | | -| `namespace` _string_ | Namespace defines the Namespace of a resource. | | | +| Field | Description | +| --- | --- | +| `name` _string_ | Name defines the Name of a resource. | +| `namespace` _string_ | Namespace defines the Namespace of a resource. | #### ObjectStoreConfig -ObjectStoreConfig configures the Clowder provider controlling the creation of -ObjectStore instances. - - +ObjectStoreConfig configures the Clowder provider controlling the creation of ObjectStore instances. _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `mode` _[ObjectStoreMode](#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. | | Enum: [minio app-interface none]
| -| `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](#objectstoreimages)_ | Override the object store images | | | +| Field | Description | +| --- | --- | +| `mode` _[ObjectStoreMode](#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](#objectstoreimages)_ | Override the object store images | #### ObjectStoreImages @@ -1115,25 +961,19 @@ _Appears in:_ - - _Appears in:_ - [ObjectStoreConfig](#objectstoreconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `minio` _string_ | | | | +| Field | Description | +| --- | --- | +| `minio` _string_ | | #### ObjectStoreMode _Underlying type:_ _string_ -ObjectStoreMode details the mode of operation of the Clowder ObjectStore -Provider - -_Validation:_ -- Enum: [minio app-interface none] +ObjectStoreMode details the mode of operation of the Clowder ObjectStore Provider _Appears in:_ - [ObjectStoreConfig](#objectstoreconfig) @@ -1146,29 +986,27 @@ _Appears in:_ PodSpec defines a container running inside a ClowdApp. - - _Appears in:_ - [Deployment](#deployment) - [Job](#job) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `image` _string_ | Image refers to the container image used to create the pod. | | | -| `initContainers` _[InitContainer](#initcontainer) array_ | A list of init containers used to perform at-startup operations. | | | -| `metadata` _[PodspecMetadata](#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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core) array_ | A list of environment variables in k8s defined format. | | | -| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)_ | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#probe-v1-core)_ | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#probe-v1-core)_ | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volume-v1-core) array_ | A pass-through of a list of Volumes in standa k8s format. | | | -| `volumeMounts` _[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core) array_ | A pass-through of a list of VolumesMounts in standa k8s format. | | | -| `lifecycle` _[Lifecycle](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#lifecycle-v1-core)_ | 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](#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. | | | +| Field | Description | +| --- | --- | +| `image` _string_ | Image refers to the container image used to create the pod. | +| `initContainers` _[InitContainer](#initcontainer) array_ | A list of init containers used to perform at-startup operations. | +| `metadata` _[PodspecMetadata](#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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvar-v1-core) array_ | A list of environment variables in k8s defined format. | +| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)_ | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#probe-v1-core)_ | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#probe-v1-core)_ | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volume-v1-core) array_ | A pass-through of a list of Volumes in standa k8s format. | +| `volumeMounts` _[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core) array_ | A pass-through of a list of VolumesMounts in standa k8s format. | +| `lifecycle` _[Lifecycle](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#lifecycle-v1-core)_ | 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](#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. | #### PodspecMetadata @@ -1177,32 +1015,27 @@ _Appears in:_ Metadata for applying annotations etc to PodSpec - - _Appears in:_ - [PodSpec](#podspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `annotations` _object (keys:string, values:string)_ | | | | +| Field | Description | +| --- | --- | +| `annotations` _object (keys:string, values:string)_ | | #### PrivateWebService -PrivateWebService is the definition of the private web service. There can be only -one private service managed by Clowder. - - +PrivateWebService is the definition of the private web service. There can be only one private service managed by Clowder. _Appears in:_ - [WebServices](#webservices) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `enabled` _boolean_ | Enabled describes if Clowder should enable the private service and provide the
configuration in the cdappconfig. | | | -| `appProtocol` _[AppProtocol](#appprotocol)_ | AppProtocol determines the protocol to be used for the private port, (defaults to http) | | Enum: [http http2 https tcp tls grpc grpc-web mongo mysql redis]
| +| Field | Description | +| --- | --- | +| `enabled` _boolean_ | Enabled describes if Clowder should enable the private service and provide the configuration in the cdappconfig. | +| `appProtocol` _[AppProtocol](#appprotocol)_ | AppProtocol determines the protocol to be used for the private port, (defaults to http) | #### PrometheusConfig @@ -1211,15 +1044,13 @@ _Appears in:_ - - _Appears in:_ - [MetricsConfig](#metricsconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `deploy` _boolean_ | Determines whether to deploy prometheus in operator mode | | | -| `appInterfaceHostname` _string_ | Specify prometheus hostname when in app-interface mode | | | +| Field | Description | +| --- | --- | +| `deploy` _boolean_ | Determines whether to deploy prometheus in operator mode | +| `appInterfaceHostname` _string_ | Specify prometheus hostname when in app-interface mode | #### PrometheusStatus @@ -1228,14 +1059,12 @@ _Appears in:_ PrometheusStatus provides info on how to connect to Prometheus - - _Appears in:_ - [ClowdEnvironmentStatus](#clowdenvironmentstatus) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `hostname` _string_ | | | | +| Field | Description | +| --- | --- | +| `hostname` _string_ | | #### ProvidersConfig @@ -1244,48 +1073,43 @@ _Appears in:_ ProvidersConfig defines a group of providers configuration for a ClowdEnvironment. - - _Appears in:_ - [ClowdEnvironmentSpec](#clowdenvironmentspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `db` _[DatabaseConfig](#databaseconfig)_ | Defines the Configuration for the Clowder Database Provider. | | | -| `inMemoryDb` _[InMemoryDBConfig](#inmemorydbconfig)_ | Defines the Configuration for the Clowder InMemoryDB Provider. | | | -| `kafka` _[KafkaConfig](#kafkaconfig)_ | Defines the Configuration for the Clowder Kafka Provider. | | | -| `logging` _[LoggingConfig](#loggingconfig)_ | Defines the Configuration for the Clowder Logging Provider. | | | -| `metrics` _[MetricsConfig](#metricsconfig)_ | Defines the Configuration for the Clowder Metrics Provider. | | | -| `objectStore` _[ObjectStoreConfig](#objectstoreconfig)_ | Defines the Configuration for the Clowder ObjectStore Provider. | | | -| `web` _[WebConfig](#webconfig)_ | Defines the Configuration for the Clowder Web Provider. | | | -| `featureFlags` _[FeatureFlagsConfig](#featureflagsconfig)_ | Defines the Configuration for the Clowder FeatureFlags Provider. | | | -| `serviceMesh` _[ServiceMeshConfig](#servicemeshconfig)_ | Defines the Configuration for the Clowder ServiceMesh Provider. | | | -| `pullSecrets` _[NamespacedName](#namespacedname) array_ | Defines the pull secret to use for the service accounts. | | | -| `testing` _[TestingConfig](#testingconfig)_ | Defines the environment for iqe/smoke testing | | | -| `sidecars` _[Sidecars](#sidecars)_ | Defines the sidecar configuration | | | -| `autoScaler` _[AutoScalerConfig](#autoscalerconfig)_ | Defines the autoscaler configuration | | | -| `deployment` _[DeploymentConfig](#deploymentconfig)_ | Defines the Deployment provider options | | | +| Field | Description | +| --- | --- | +| `db` _[DatabaseConfig](#databaseconfig)_ | Defines the Configuration for the Clowder Database Provider. | +| `inMemoryDb` _[InMemoryDBConfig](#inmemorydbconfig)_ | Defines the Configuration for the Clowder InMemoryDB Provider. | +| `kafka` _[KafkaConfig](#kafkaconfig)_ | Defines the Configuration for the Clowder Kafka Provider. | +| `logging` _[LoggingConfig](#loggingconfig)_ | Defines the Configuration for the Clowder Logging Provider. | +| `metrics` _[MetricsConfig](#metricsconfig)_ | Defines the Configuration for the Clowder Metrics Provider. | +| `objectStore` _[ObjectStoreConfig](#objectstoreconfig)_ | Defines the Configuration for the Clowder ObjectStore Provider. | +| `web` _[WebConfig](#webconfig)_ | Defines the Configuration for the Clowder Web Provider. | +| `featureFlags` _[FeatureFlagsConfig](#featureflagsconfig)_ | Defines the Configuration for the Clowder FeatureFlags Provider. | +| `serviceMesh` _[ServiceMeshConfig](#servicemeshconfig)_ | Defines the Configuration for the Clowder ServiceMesh Provider. | +| `pullSecrets` _[NamespacedName](#namespacedname) array_ | Defines the pull secret to use for the service accounts. | +| `testing` _[TestingConfig](#testingconfig)_ | Defines the environment for iqe/smoke testing | +| `sidecars` _[Sidecars](#sidecars)_ | Defines the sidecar configuration | +| `autoScaler` _[AutoScalerConfig](#autoscalerconfig)_ | Defines the autoscaler configuration | +| `deployment` _[DeploymentConfig](#deploymentconfig)_ | Defines the Deployment provider options | #### PublicWebService -PublicWebService is the definition of the public web service. There can be only -one public service managed by Clowder. - - +PublicWebService is the definition of the public web service. There can be only one public service managed by Clowder. _Appears in:_ - [WebServices](#webservices) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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//' that this app will serve requests from. | | | -| `apiPaths` _[APIPath](#apipath) array_ | Defines a list of API paths (each matching format: "/api/some-path/") that this app will serve requests from. | | Pattern: `^\/api\/[a-zA-Z0-9-]+\/$`
| -| `whitelistPaths` _string array_ | WhitelistPaths define the paths that do not require authentication | | | -| `sessionAffinity` _boolean_ | Set SessionAffinity to true to enable sticky sessions | | | +| Field | Description | +| --- | --- | +| `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//' that this app will serve requests from. | +| `apiPaths` _[APIPath](#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 | #### ServiceConfig @@ -1294,31 +1118,26 @@ _Appears in:_ ServiceConfig provides options for k8s Service resources - - _Appears in:_ - [ClowdEnvironmentSpec](#clowdenvironmentspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `type` _string_ | | | Enum: [ClusterIP NodePort ]
| +| Field | Description | +| --- | --- | +| `type` _string_ | | #### ServiceMeshConfig -ServiceMeshConfig determines if this env should be part of a service mesh -and, if enabled, configures the service mesh - - +ServiceMeshConfig determines if this env should be part of a service mesh and, if enabled, configures the service mesh _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `mode` _[ServiceMeshMode](#servicemeshmode)_ | | | Enum: [enabled disabled]
| +| Field | Description | +| --- | --- | +| `mode` _[ServiceMeshMode](#servicemeshmode)_ | | #### ServiceMeshMode @@ -1327,9 +1146,6 @@ _Underlying type:_ _string_ ServiceMeshMode just determines if we enable or disable the service mesh -_Validation:_ -- Enum: [enabled disabled] - _Appears in:_ - [ServiceMeshConfig](#servicemeshconfig) @@ -1341,15 +1157,13 @@ _Appears in:_ - - _Appears in:_ - [PodSpec](#podspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `name` _string_ | The name of the sidecar, only supported names allowed, (token-refresher) | | | -| `enabled` _boolean_ | Defines if the sidecar is enabled, defaults to False | | | +| Field | Description | +| --- | --- | +| `name` _string_ | The name of the sidecar, only supported names allowed, (token-refresher) | +| `enabled` _boolean_ | Defines if the sidecar is enabled, defaults to False | #### Sidecars @@ -1358,14 +1172,12 @@ _Appears in:_ - - _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `tokenRefresher` _[TokenRefresherConfig](#tokenrefresherconfig)_ | Sets up Token Refresher configuration | | | +| Field | Description | +| --- | --- | +| `tokenRefresher` _[TokenRefresherConfig](#tokenrefresherconfig)_ | Sets up Token Refresher configuration | #### SimpleAutoScalerMetric @@ -1374,15 +1186,13 @@ _Appears in:_ SimpleAutoScalerMetric defines a metric of either a value or utilization - - _Appears in:_ - [AutoScalerSimple](#autoscalersimple) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `scaleAtValue` _string_ | | | | -| `scaleAtUtilization` _integer_ | | | | +| Field | Description | +| --- | --- | +| `scaleAtValue` _string_ | | +| `scaleAtUtilization` _integer_ | | #### SimpleAutoScalerReplicas @@ -1391,15 +1201,13 @@ _Appears in:_ SimpleAutoScalerReplicas defines the minimum and maximum replica counts for the auto scaler - - _Appears in:_ - [AutoScalerSimple](#autoscalersimple) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `min` _integer_ | | | | -| `max` _integer_ | | | | +| Field | Description | +| --- | --- | +| `min` _integer_ | | +| `max` _integer_ | | #### TLS @@ -1408,16 +1216,14 @@ _Appears in:_ - - _Appears in:_ - [WebConfig](#webconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `enabled` _boolean_ | | | | -| `port` _integer_ | | | | -| `privatePort` _integer_ | | | | +| Field | Description | +| --- | --- | +| `enabled` _boolean_ | | +| `port` _integer_ | | +| `privatePort` _integer_ | | #### TestingConfig @@ -1426,16 +1232,14 @@ _Appears in:_ - - _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `iqe` _[IqeConfig](#iqeconfig)_ | Defines the environment for iqe/smoke testing | | | -| `k8sAccessLevel` _[K8sAccessLevel](#k8saccesslevel)_ | The mode of operation of the testing Pod. Valid options are:
'default', 'view' or 'edit' | | Enum: [default view edit]
| -| `configAccess` _[ConfigAccessMode](#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 | | Enum: [none app environment]
| +| Field | Description | +| --- | --- | +| `iqe` _[IqeConfig](#iqeconfig)_ | Defines the environment for iqe/smoke testing | +| `k8sAccessLevel` _[K8sAccessLevel](#k8saccesslevel)_ | The mode of operation of the testing Pod. Valid options are: 'default', 'view' or 'edit' | +| `configAccess` _[ConfigAccessMode](#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 | #### TestingSpec @@ -1444,14 +1248,12 @@ _Appears in:_ - - _Appears in:_ - [ClowdAppSpec](#clowdappspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `iqePlugin` _string_ | | | | +| Field | Description | +| --- | --- | +| `iqePlugin` _string_ | | #### TokenRefresherConfig @@ -1460,42 +1262,37 @@ _Appears in:_ - - _Appears in:_ - [Sidecars](#sidecars) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `enabled` _boolean_ | Enables or disables token refresher sidecars | | | +| Field | Description | +| --- | --- | +| `enabled` _boolean_ | Enables or disables token refresher sidecars | #### WebConfig -WebConfig configures the Clowder provider controlling the creation of web -services and their probes. - - +WebConfig configures the Clowder provider controlling the creation of web services and their probes. _Appears in:_ - [ProvidersConfig](#providersconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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](#webmode)_ | The mode of operation of the Web provider. The allowed modes are
(*_none_*/*_operator_*), and (*_local_*) which deploys keycloak and BOP. | | Enum: [none operator local]
| -| `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](#webimages)_ | Optional images to use for web provider components -- only applies when running in (*_local_*) mode. | | | -| `tls` _[TLS](#tls)_ | TLS sidecar enablement | | | -| `gatewayCert` _[GatewayCert](#gatewaycert)_ | Gateway cert | | | +| Field | Description | +| --- | --- | +| `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](#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](#webimages)_ | Optional images to use for web provider components -- only applies when running in (*_local_*) mode. | +| `tls` _[TLS](#tls)_ | TLS sidecar enablement | +| `gatewayCert` _[GatewayCert](#gatewaycert)_ | Gateway cert | #### WebDeprecated @@ -1504,8 +1301,6 @@ _Underlying type:_ _boolean_ WebDeprecated defines a boolean flag to help distinguish from the newer WebServices - - _Appears in:_ - [Deployment](#deployment) @@ -1517,18 +1312,16 @@ _Appears in:_ WebImages defines optional container image overrides for the web provider components - - _Appears in:_ - [WebConfig](#webconfig) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `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. | | | +| Field | Description | +| --- | --- | +| `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. | #### WebMode @@ -1537,9 +1330,6 @@ _Underlying type:_ _string_ WebMode details the mode of operation of the Clowder Web Provider -_Validation:_ -- Enum: [none operator local] - _Appears in:_ - [WebConfig](#webconfig) @@ -1549,18 +1339,15 @@ _Appears in:_ -WebServices defines the structs for the three exposed web services: public, -private and metrics. - - +WebServices defines the structs for the three exposed web services: public, private and metrics. _Appears in:_ - [Deployment](#deployment) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `public` _[PublicWebService](#publicwebservice)_ | | | | -| `private` _[PrivateWebService](#privatewebservice)_ | | | | -| `metrics` _[MetricsWebService](#metricswebservice)_ | | | | +| Field | Description | +| --- | --- | +| `public` _[PublicWebService](#publicwebservice)_ | | +| `private` _[PrivateWebService](#privatewebservice)_ | | +| `metrics` _[MetricsWebService](#metricswebservice)_ | | diff --git a/docs/developer-guide.md b/docs/developer-guide.md index b6164a64f..fd3489bf5 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -417,17 +417,17 @@ defined in the below. Clowder currently support several feature flags which are intended to enable or disable certain behaviour. They are detailed as follows: -| Flag Name | Description | Permanent -|--|--|-- -| ``features.createServiceMonitor`` | Enables the creation of prometheus ``ServiceMonitor`` resources. | No -| ``features.disableWebhooks`` | While testing locally and for the ``suite_test``, the webhooks need to be disabled. this option facilitates that. | Yes -| ``features.watchStrimziResources`` | When enabled, Clowder will assume ownership of the ``Kafka`` and ``KafkaConnect`` resources it creates. It will then respond to changes to these resources. | No -| ``features.useComplexStrimziTopicNames`` | This flag switches Clowder to use non-colliding names for strimzi resources. This is important if using a singular strimzi server for multiple ``ClowdEnvironment`` resources. | Yes -| ``features.enableAuthSidecarHook`` | Turns the sidecar functionality on or off globally. | Yes -| ``features.enablekedaResources`` | Turns on the addition of Keda resources into the protectedGVK list. | No -| ``features.perProviderMetrics`` | Turns on metrics that calculate reconciliation time per provider. | Yes -| ``features.reconciliationMetrics`` | Enables extra detailed metrics on reconciliations per application. | Yes -| ``features.enableDependencyMetrics`` | Turns on metrics that report availability of a ClowdApps dependencies. | Yes -| ``disableCloudWatchLogging`` | Disables logging to CloudWatch. | Yes -| ``enableExternalStrimzi`` | Enables talking to Strimzi via a local nodeport (only useful on minikube) | Yes -| ``disableRandomRoutes`` | Gives the ability to disable the extra portion of randomness added to routes. | Yes +| Flag Name | Description | Permanent | +|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| `features.createServiceMonitor` | Enables the creation of prometheus `ServiceMonitor` resources. | No | +| `features.disableWebhooks` | While testing locally and for the `suite_test`, the webhooks need to be disabled. this option facilitates that. | Yes | +| `features.watchStrimziResources` | When enabled, Clowder will assume ownership of the `Kafka` and `KafkaConnect` resources it creates. It will then respond to changes to these resources. | No | +| `features.useComplexStrimziTopicNames` | This flag switches Clowder to use non-colliding names for strimzi resources. This is important if using a singular strimzi server for multiple `ClowdEnvironment` resources. | Yes | +| `features.enableAuthSidecarHook` | Turns the sidecar functionality on or off globally. | Yes | +| `features.enablekedaResources` | Turns on the addition of Keda resources into the protectedGVK list. | No | +| `features.perProviderMetrics` | Turns on metrics that calculate reconciliation time per provider. | Yes | +| `features.reconciliationMetrics` | Enables extra detailed metrics on reconciliations per application. | Yes | +| `features.enableDependencyMetrics` | Turns on metrics that report availability of a ClowdApps dependencies. | Yes | +| `disableCloudWatchLogging` | Disables logging to CloudWatch. | Yes | +| `enableExternalStrimzi` | Enables talking to Strimzi via a local nodeport (only useful on minikube) | Yes | +| `disableRandomRoutes` | Gives the ability to disable the extra portion of randomness added to routes. | Yes | diff --git a/docs/providers/database.md b/docs/providers/database.md index c3b5a5017..626db4b0f 100644 --- a/docs/providers/database.md +++ b/docs/providers/database.md @@ -116,12 +116,13 @@ A client helper is available for the RDS CA, used in app-interface mode. For supported languages, the database configuration is access via the following attribute names. -Language | Attribute ------------- | ------------- -Python | `LoadedConfig.database` -Go | `LoadedConfig.Database` -Javascript | `LoadedConfig.database` -Ruby | `LoadedConfig.database` +| Language | Attribute | +|-------------|---------------------------| +| Python | `LoadedConfig.database` | +| Go | `LoadedConfig.Database` | +| JavaScript | `LoadedConfig.database` | +| Ruby | `LoadedConfig.database` | + ### Client helpers @@ -131,12 +132,12 @@ Ruby | `LoadedConfig.database` Returns a filename which points to a temporary file containing the contents of the CA cert. -Language | Attribute ------------- | ------------- -Python |`LoadedConfig.rds_ca()` -Go |`LoadedConfig.RdsCa()` -Javascript | Not yet implemented -Ruby | Not yet implemented +| Language | Attribute | +|-------------|----------------------------| +| Python | `LoadedConfig.rds_ca()` | +| Go | `LoadedConfig.RdsCa()` | +| JavaScript | Not yet implemented | +| Ruby | Not yet implemented | ### ClowdEnv Configuration diff --git a/docs/providers/dependencies.md b/docs/providers/dependencies.md index 89f44461d..2ce4f70b9 100644 --- a/docs/providers/dependencies.md +++ b/docs/providers/dependencies.md @@ -78,20 +78,22 @@ LoadedConfig.dependencyEndpoints["app_name1"]["deployment1"] For supported languages, the dependency configuration is access via the following attribute names. -Language | Attribute Name ---|-- -Python | ``LoadedConfig.dependencyEndpoints`` -Go | ``LoadedConfig.DependencyEndpoints`` -Javascript | ``LoadedConfig.dependencyEndpoints`` -Ruby | ``LoadedConfig.dependencyEndpoints`` +| Language | Attribute Name | +|------------|-------------------------------------| +| Python | `LoadedConfig.dependencyEndpoints` | +| Go | `LoadedConfig.DependencyEndpoints` | +| JavaScript | `LoadedConfig.dependencyEndpoints` | +| Ruby | `LoadedConfig.dependencyEndpoints` | + Private endpoints are accessible via these attribute names. -Language | Attribute Name ---|-- -Python | ``LoadedConfig.privateDependencyEndpoints`` -Go | ``LoadedConfig.PrivateDependencyEndpoints`` -Javascript | ``LoadedConfig.privateDependencyEndpoints`` -Ruby | ``LoadedConfig.privateDependencyEndpoints`` +| Language | Attribute Name | +|------------|--------------------------------------------| +| Python | `LoadedConfig.privateDependencyEndpoints` | +| Go | `LoadedConfig.PrivateDependencyEndpoints` | +| JavaScript | `LoadedConfig.privateDependencyEndpoints` | +| Ruby | `LoadedConfig.privateDependencyEndpoints` | + diff --git a/docs/providers/featureflags.md b/docs/providers/featureflags.md index 5de9e9fc8..ad293ceb9 100644 --- a/docs/providers/featureflags.md +++ b/docs/providers/featureflags.md @@ -51,12 +51,13 @@ following structure. For supported languages, the feature flags configuration is access via the following attribute names. -Language | Attribute Name ---|-- -Python | ``LoadedConfig.featureFlags`` -Go | ``LoadedConfig.FeatureFlags`` -Javscript | ``LoadedConfig.featureFlags`` -Ruby | ``LoadedConfig.featureFlags`` +| Language | Attribute Name | +|------------|------------------------------| +| Python | `LoadedConfig.featureFlags` | +| Go | `LoadedConfig.FeatureFlags` | +| JavaScript | `LoadedConfig.featureFlags` | +| Ruby | `LoadedConfig.featureFlags` | + ### ClowdEnv Configuration diff --git a/docs/providers/inmemorydb.md b/docs/providers/inmemorydb.md index dc502b563..a27edc1fb 100644 --- a/docs/providers/inmemorydb.md +++ b/docs/providers/inmemorydb.md @@ -63,12 +63,13 @@ following structure. For supported languages, the In-Memory DB configuration is accessed via the following attribute names. -Language | Attribute Name ---|-- -Python | ``LoadedConfig.inMemoryDb`` -Go | ``LoadedConfig.InMemoryDb`` -Javscript | ``LoadedConfig.inMemoryDb`` -Ruby | ``LoadedConfig.inMemoryDb`` +| Language | Attribute Name | +|------------|----------------------------| +| Python | `LoadedConfig.inMemoryDb` | +| Go | `LoadedConfig.InMemoryDb` | +| JavaScript | `LoadedConfig.inMemoryDb` | +| Ruby | `LoadedConfig.inMemoryDb` | + ### ClowdEnv Configuration diff --git a/docs/providers/kafka.md b/docs/providers/kafka.md index 3cd681592..72077fd6e 100644 --- a/docs/providers/kafka.md +++ b/docs/providers/kafka.md @@ -144,12 +144,13 @@ A User auth enabled Kafka will look like this For supported languages, the kafka configuration is accessed via the following attribute names. -Language | Attribute Name ---|-- -Python | `LoadedConfig.kafka` -Go | `LoadedConfig.Kafka` -Javscript | `LoadedConfig.kafka` -Ruby | `LoadedConfig.kafka` +| Language | Attribute Name | +|------------|-----------------------| +| Python | `LoadedConfig.kafka` | +| Go | `LoadedConfig.Kafka` | +| JavaScript | `LoadedConfig.kafka` | +| Ruby | `LoadedConfig.kafka` | + ### Client helpers @@ -157,13 +158,14 @@ Ruby | `LoadedConfig.kafka` as the key and the topic object the value. `KafkaServers` Returns a list of Kafka broker strings comprising of hostname and port. -Name | Kafka Topics | Kafka Servers ---|--|-- -Description | Returns a map of topic objects, using the original requested name as the key and the topic object the value. | Returns a list of Kafka broker strings comprising of hostname and port. -Python | `KafkaTopics` | `KafkaServers` -Go | `KafkaTopics` | `KafkaServers` -Javscript | `KafkaTopics` | `KafkaServers` -Ruby | `KafkaTopics` | `KafkaServers` +| Name | Kafka Topics | Kafka Servers | +|-------------|------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| Description | Returns a map of topic objects, using the original requested name as the key and the topic object as the value. | Returns a list of Kafka broker strings comprising of hostname and port. | +| Python | `KafkaTopics` | `KafkaServers` | +| Go | `KafkaTopics` | `KafkaServers` | +| JavaScript | `KafkaTopics` | `KafkaServers` | +| Ruby | `KafkaTopics` | `KafkaServers` | + ### ClowdEnv Configuration diff --git a/docs/providers/logging.md b/docs/providers/logging.md index 110817940..dd2d748c6 100644 --- a/docs/providers/logging.md +++ b/docs/providers/logging.md @@ -46,12 +46,12 @@ structure. The example below is given for `app-interface` mode. For supported languages, the logging configuration is access via the following attribute names. -| Language | Attribute Name ---|-- -| Python | `LoadedConfig.logging` -| Go | `LoadedConfig.Logging` -| Javscript | `LoadedConfig.logging` -| Ruby | `LoadedConfig.logging` +| Language | Attribute Name | +|------------|-------------------------| +| Python | `LoadedConfig.logging` | +| Go | `LoadedConfig.Logging` | +| Javascript | `LoadedConfig.logging` | +| Ruby | `LoadedConfig.logging` | ### ClowdEnv Configuration diff --git a/docs/providers/metrics.md b/docs/providers/metrics.md index dadf459cb..6058d9800 100644 --- a/docs/providers/metrics.md +++ b/docs/providers/metrics.md @@ -43,12 +43,12 @@ structure. For supported languages, the metrics configuration is access via the following attribute names. -Language | Attribute Name ---|-- -Python | `LoadedConfig.metricsPort` -Go | `LoadedConfig.MetricsPort` -Javscript | `LoadedConfig.metricsPort` -Ruby | `LoadedConfig.metricsPort` +| Language | Attribute Name | +|------------|-----------------------------| +| Python | `LoadedConfig.metricsPort` | +| Go | `LoadedConfig.MetricsPort` | +| Javascript | `LoadedConfig.metricsPort` | +| Ruby | `LoadedConfig.metricsPort` | ### ClowdEnv Configuration diff --git a/docs/providers/objectstore.md b/docs/providers/objectstore.md index d6a7903bc..f13f22ff7 100644 --- a/docs/providers/objectstore.md +++ b/docs/providers/objectstore.md @@ -86,12 +86,12 @@ A helper is available below to facilitate quick access via a map. For supported languages, the object store configuration is access via the following attribute names. -Language | Attribute Name ---|-- -Python | `LoadedConfig.objectStore` -Go | `LoadedConfig.ObjectStore` -Javscript | `LoadedConfig.objectStore` -Ruby | `LoadedConfig.objectStore` +| Language | Attribute Name | +|-------------|-----------------------------| +| Python | `LoadedConfig.objectStore` | +| Go | `LoadedConfig.ObjectStore` | +| Javascript | `LoadedConfig.objectStore` | +| Ruby | `LoadedConfig.objectStore` | ### Client helpers @@ -99,12 +99,12 @@ Ruby | `LoadedConfig.objectStore` `ObjectBuckets` returns a map of bucket objects, using the original requested name as the key and the bucket object as the value. -Name | Object Store Buckets ---|-- -Python | `ObjectBuckets` -Go | `ObjectBuckets` -Javscript | `ObjectBuckets` -Ruby | `ObjectBuckets` +| Name | Object Store Buckets | +|-------------|-----------------------| +| Python | `ObjectBuckets` | +| Go | `ObjectBuckets` | +| Javascript | `ObjectBuckets` | +| Ruby | `ObjectBuckets` | ### ClowdEnv Configuration diff --git a/docs/providers/web.md b/docs/providers/web.md index 8ce48b6ee..b373f381d 100644 --- a/docs/providers/web.md +++ b/docs/providers/web.md @@ -154,12 +154,12 @@ structure. For supported languages, the web configuration is access via the following attribute names. -Language | Attribute Name ---|-- -Python | `LoadedConfig.publicPort` -Go | `LoadedConfig.PublicPort` -Javscript | `LoadedConfig.publicPort` -Ruby | `LoadedConfig.publicPort` +| Language | Attribute Name | +|------------|----------------------------| +| Python | `LoadedConfig.publicPort` | +| Go | `LoadedConfig.PublicPort` | +| Javascript | `LoadedConfig.publicPort` | +| Ruby | `LoadedConfig.publicPort` | ### ClowdEnv Configuration