Appendix: cdap-site.xml and cdap-default.xml

Owned by Robin Rielley
Last updated: Oct 18, 2022 by robin
1 min read

Theย cdap-site.xmlย file is the configuration file for a CDAP installation. Its properties and values determine the settings used by CDAP when starting and operating.

Any properties not found in an installation'sย cdap-site.xmlย will use a default parameter value defined in the fileย cdap-default.xml. It is located in the CDAP JARs and should not be altered.

You can find all of the available parameters in CDAP git:

https://github.com/cdapio/cdap/blob/release/<version>/cdap-common/src/main/resources/cdap-default.xml

For example, to see all of the available parameters in CDAP 6.7:

Any of the default values (with the exception of those markedย [Final]) can be overridden by defining a modifying value in theย cdap-site.xmlย file, located (by default) either inย <CDAP-HOME>/conf/cdap-site.xmlย (CDAP Sandbox) orย /etc/cdap/conf/cdap-site.xmlย (Distributed CDAP).

Notes

  • [Final]:ย Properties marked asย [Final]ย indicates that their value cannot be changed, even with a setting in theย cdap-site.xml.

  • Kafka Server:ย All properties that begin withย kafka.server.ย are passed to the CDAP Kafka service when it is started.

  • Security:ย For information on configuring theย cdap-site.xmlย file, itsย security section, and CDAP for security, see the documentationย Securityย section.

Created in 2020 by Google Inc.