ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
endif::[]

[[configuration-options]]
== Configuration Options

Main point of a _carvel_ is to provide a clear _API_ for consuming and using
its features. From a user point of view this means that there is a set of
options user can set which then drives k8s deployment files templating
and deployment into an environment. This sections documents these options
user as a consumer can use. Essentially this means that you will set
options with either plain properties of combine those into fully set of
yaml document.

*Curated List of Options:*

- <<configuration-options-scdf.registry.secret.ref>>
- <<configuration-options-scdf.server.image.repository>>
- <<configuration-options-scdf.server.image.tag>>
- <<configuration-options-scdf.server.image.digest>>
- <<configuration-options-scdf.server.service.type>>
- <<configuration-options-scdf.server.resources.limits.cpu>>
- <<configuration-options-scdf.server.resources.limits.memory>>
- <<configuration-options-scdf.server.resources.requests.cpu>>
- <<configuration-options-scdf.server.resources.requests.memory>>
- <<configuration-options-scdf.server.database.url>>
- <<configuration-options-scdf.server.database.username>>
- <<configuration-options-scdf.server.database.password>>
- <<configuration-options-scdf.server.database.driverClassName>>
- <<configuration-options-scdf.server.database.testOnBorrow>>
- <<configuration-options-scdf.server.database.validationQuery>>
- <<configuration-options-scdf.server.database.dialect>>
- <<configuration-options-scdf.server.config>>
- <<configuration-options-scdf.server.env>>
- <<configuration-options-scdf.server.metrics.dashboard.url>>
- <<configuration-options-scdf.server.contextPath>>
- <<configuration-options-scdf.ctr.image.repository>>
- <<configuration-options-scdf.ctr.image.tag>>
- <<configuration-options-scdf.ctr.image.digest>>
- <<configuration-options-scdf.skipper.image.repository>>
- <<configuration-options-scdf.skipper.image.tag>>
- <<configuration-options-scdf.skipper.image.digest>>
- <<configuration-options-scdf.skipper.service.type>>
- <<configuration-options-scdf.skipper.resources.limits.cpu>>
- <<configuration-options-scdf.skipper.resources.limits.memory>>
- <<configuration-options-scdf.skipper.resources.requests.cpu>>
- <<configuration-options-scdf.skipper.resources.requests.memory>>
- <<configuration-options-scdf.skipper.database.url>>
- <<configuration-options-scdf.skipper.database.username>>
- <<configuration-options-scdf.skipper.database.password>>
- <<configuration-options-scdf.skipper.database.driverClassName>>
- <<configuration-options-scdf.skipper.database.testOnBorrow>>
- <<configuration-options-scdf.skipper.database.validationQuery>>
- <<configuration-options-scdf.skipper.database.dialect>>
- <<configuration-options-scdf.skipper.config>>
- <<configuration-options-scdf.skipper.env>>
- <<configuration-options-scdf.binder.type>>
- <<configuration-options-scdf.binder.kafka.broker.host>>
- <<configuration-options-scdf.binder.kafka.broker.port>>
- <<configuration-options-scdf.binder.kafka.zk.host>>
- <<configuration-options-scdf.binder.kafka.zk.port>>
- <<configuration-options-scdf.binder.rabbit.host>>
- <<configuration-options-scdf.binder.rabbit.port>>
- <<configuration-options-scdf.binder.rabbit.username>>
- <<configuration-options-scdf.binder.rabbit.password>>
- <<configuration-options-scdf.feature.monitoring.prometheus.enabled>>
- <<configuration-options-scdf.feature.monitoring.grafana.enabled>>
- <<configuration-options-scdf.feature.monitoring.prometheusRsocketProxy.enabled>>
- <<configuration-options-scdf.feature.monitoring.prometheusRsocketProxy.image.repository>>
- <<configuration-options-scdf.feature.monitoring.prometheusRsocketProxy.image.tag>>
- <<configuration-options-scdf.feature.monitoring.prometheusRsocketProxy.image.digest>>

[[options]]
=== Options

[[configuration-options-scdf.registry.secret.ref]]`scdf.registry.secret.ref`::
  Description:::
If defined a reference will be added as imagePullSecret to all services.
On default a carvel secretgen placeholder is added as one Secret resource.
  Required:::
No
  Type:::
String
   Default Value:::
Empty

[[configuration-options-scdf.binder.type]]`scdf.deploy.binder.type`::
  Description:::
Defines a binder type if deployment is enabled.
  Required:::
No
  Type:::
enum(rabbit,kafka)
   Default Value:::
rabbit

[[configuration-options-scdf.server.image.repository]]`scdf.server.image.repository`::
  Description:::
Server image repository
  Required:::
No
  Type:::
String
   Default Value:::
springcloud/spring-cloud-dataflow-server

[[configuration-options-scdf.server.image.tag]]`scdf.server.image.tag`::
  Description:::
Server image tag
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.server.image.digest]]`scdf.server.image.digest`::
  Description:::
Server image digest
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.server.service.type]]`scdf.server.service.type`::
  Description:::
Server service type.
  Required:::
No
  Type:::
Enum(NodePort, LoadBalancer, ClusterIP, ExternalName)
   Default Value:::
ClusterIP

[[configuration-options-scdf.server.resources.limits.cpu]]`scdf.server.resources.limits.cpu`::
  Description:::
Limits cpu setting.
  Required:::
No
  Type:::
String
   Default Value:::
500m

[[configuration-options-scdf.server.resources.limits.memory]]`scdf.server.resources.limits.memory`::
  Description:::
Limits memory setting.
  Required:::
No
  Type:::
String
   Default Value:::
1024Mi

[[configuration-options-scdf.server.resources.requests.cpu]]`scdf.server.resources.requests.cpu`::
  Description:::
Requests cpu setting.
  Required:::
No
  Type:::
String
   Default Value:::
500m

[[configuration-options-scdf.server.resources.requests.memory]]`scdf.server.resources.requests.memory`::
  Description:::
Requests memory setting.
  Required:::
No
  Type:::
String
   Default Value:::
1024Mi

[[configuration-options-scdf.server.database.url]]`scdf.server.database.url`::
  Description:::
Datasource url setting
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.server.database.username]]`scdf.server.database.username`::
  Description:::
Datasource username setting.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.server.database.password]]`scdf.server.database.password`::
  Description:::
Datasource password setting.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.server.database.driverClassName]]`scdf.server.database.driverClassName`::
  Description:::
Datasource driverClassName setting.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.server.database.validationQuery]]`scdf.server.database.validationQuery`::
  Description:::
Datasource validationQuery setting.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.server.database.dialect]]`scdf.server.database.dialect`::
Description:::
Hibernate Dialect if required.
Required:::
No
Type:::
String
Default Value:::
None

[[configuration-options-scdf.server.database.testOnBorrow]]`scdf.server.database.testOnBorrow`::
  Description:::
Datasource testOnBorrow setting.
  Required:::
No
  Type:::
Boolean
   Default Value:::
True

[[configuration-options-scdf.server.config]]`scdf.server.config`::
  Description:::
Raw server config as yml.
  Required:::
No
  Type:::
String(yml)
   Default Value:::
None

[[configuration-options-scdf.server.env]]`scdf.server.env`::
  Description:::
Extra environment variables for dataflow container.
  Required:::
No
  Type:::
List({name,value})
   Default Value:::
None

[[configuration-options-scdf.server.metrics.dashboard.url]]`scdf.server.metrics.dashboard.url`::
  Description:::
Metrics dashboard url for UI.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.server.contextPath]]`scdf.server.contextPath`::
  Description:::
Server context path, aka server.servlet.context-path
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.ctr.image.repository]]`scdf.ctr.image.repository`::
  Description:::
Composed Task Runner image repository
  Required:::
No
  Type:::
String
   Default Value:::
springcloud/spring-cloud-dataflow-composed-task-runner

[[configuration-options-scdf.ctr.image.tag]]`scdf.ctr.image.tag`::
  Description:::
Composed Task Runner image tag
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.ctr.image.digest]]`scdf.ctr.image.digest`::
  Description:::
Composed Task Runner image digest
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.skipper.image.repository]]`scdf.skipper.image.repository`::
  Description:::
Skipper image repository
  Required:::
No
  Type:::
String
   Default Value:::
springcloud/spring-cloud-skipper-server

[[configuration-options-scdf.skipper.image.tag]]`scdf.skipper.image.tag`::
  Description:::
Skipper image tag
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.skipper.image.digest]]`scdf.skipper.image.digest`::
  Description:::
Skipper image digest
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.skipper.service.type]]`scdf.server.skipper.type`::
  Description:::
Skipper service type.
  Required:::
No
  Type:::
Enum(NodePort, LoadBalancer, ClusterIP, ExternalName)
   Default Value:::
ClusterIP

[[configuration-options-scdf.skipper.resources.limits.cpu]]`scdf.skipper.resources.limits.cpu`::
  Description:::
Limits cpu setting.
  Required:::
No
  Type:::
String
   Default Value:::
500m

[[configuration-options-scdf.skipper.resources.limits.memory]]`scdf.skipper.resources.limits.memory`::
  Description:::
Limits memory setting.
  Required:::
No
  Type:::
String
   Default Value:::
1024Mi

[[configuration-options-scdf.skipper.resources.requests.cpu]]`scdf.skipper.resources.requests.cpu`::
  Description:::
Requests cpu setting.
  Required:::
No
  Type:::
String
   Default Value:::
500m

[[configuration-options-scdf.skipper.resources.requests.memory]]`scdf.skipper.resources.requests.memory`::
  Description:::
Requests memory setting.
  Required:::
No
  Type:::
String
   Default Value:::
1024Mi

[[configuration-options-scdf.skipper.database.url]]`scdf.skipper.database.url`::
  Description:::
Datasource url setting.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.skipper.database.username]]`scdf.skipper.database.username`::
  Description:::
Datasource username setting.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.skipper.database.password]]`scdf.skipper.database.password`::
  Description:::
Datasource password setting.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.skipper.database.driverClassName]]`scdf.skipper.database.driverClassName`::
  Description:::
Datasource driverClassName setting.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.skipper.database.validationQuery]]`scdf.skipper.database.validationQuery`::
  Description:::
Datasource validationQuery setting.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.skipper.database.dialect]]`scdf.skipper.database.dialect`::
Description:::
Hibernate Dialect if required.
Required:::
No
Type:::
String
Default Value:::
None

[[configuration-options-scdf.skipper.database.testOnBorrow]]`scdf.skipper.database.testOnBorrow`::
  Description:::
Datasource testOnBorrow setting.
  Required:::
No
  Type:::
Boolean
   Default Value:::
True

[[configuration-options-scdf.skipper.config]]`scdf.skipper.config`::
  Description:::
Raw skipper config as yml.
  Required:::
No
  Type:::
String(yml)
   Default Value:::
None

[[configuration-options-scdf.skipper.env]]`scdf.skipper.env`::
  Description:::
Extra environment variables for skipper container.
  Required:::
No
  Type:::
List({name,value})
   Default Value:::
None

[[configuration-options-scdf.binder.kafka.broker.host]]`scdf.binder.kafka.broker.host`::
  Description:::
External kafka broker host.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.binder.kafka.broker.port]]`scdf.binder.kafka.broker.port`::
  Description:::
External kafka broker port.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.binder.kafka.zk.host]]`scdf.binder.kafka.zk.host`::
  Description:::
External kafka zk host.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.binder.kafka.zk.port]]`scdf.binder.kafka.zk.port`::
  Description:::
External kafka zk port.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.binder.rabbit.host]]`scdf.binder.rabbit.host`::
  Description:::
External rabbit host.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.binder.rabbit.port]]`scdf.binder.rabbit.port`::
  Description:::
External rabbit port.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.binder.rabbit.username]]`scdf.binder.rabbit.username`::
  Description:::
External rabbit username.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.binder.rabbit.password]]`scdf.binder.rabbit.password`::
  Description:::
External rabbit password.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.feature.monitoring.prometheusRsocketProxy.enabled]]`scdf.feature.monitoring.prometheusRsocketProxy.enabled`::
  Description:::
Enables prometheus rsocket proxy feature.
  Required:::
No
  Type:::
Boolean
   Default Value:::
False

[[configuration-options-scdf.feature.monitoring.prometheusRsocketProxy.image.repository]]`scdf.feature.monitoring.prometheusRsocketProxy.image.repository`::
  Description:::
Prometheus rsocket proxy image repository.
  Required:::
No
  Type:::
String
   Default Value:::
micrometermetrics/prometheus-rsocket-proxy

[[configuration-options-scdf.feature.monitoring.prometheusRsocketProxy.image.tag]]`scdf.feature.monitoring.prometheusRsocketProxy.image.tag`::
  Description:::
Prometheus rsocket proxy image tag.
  Required:::
No
  Type:::
String
   Default Value:::
1.0.0

[[configuration-options-scdf.feature.monitoring.prometheusRsocketProxy.image.digest]]`scdf.feature.monitoring.prometheusRsocketProxy.image.digest`::
  Description:::
Prometheus rsocket proxy image digest.
  Required:::
No
  Type:::
String
   Default Value:::
None

[[configuration-options-scdf.feature.monitoring.grafana.enabled]]`scdf.feature.monitoring.grafana.enabled`::
  Description:::
Enables grafana feature.
  Required:::
No
  Type:::
Boolean
   Default Value:::
False

