Basics

How to configure Flinkwerk

The Flinkwerk Config folder .flinkwerk holds all configuration files constituting your Flinkwerk project. It must be located in the root of your project folder or repository.

To be able to use Flinkwerk, the Flinkwerk Config folder must contain the Flinkwerk config file .flinkwerk/config.yml, which is a format for describing Flinkwerk projects. It is based on the YAML syntax and declares a project, its applications and resources dependencies, deployment environments, as well as its product metadata. The respective configuration enables you to specify integrated and automatic development, deployment and distribution for your project without expert knowledge.

The Flinkwerk configuration file can use either the three- or four-letter extension .yml or .yaml. It is processed by the Flinkwerk CLI.

Learn more about all declarative parameters available in .flinkwerk/config.yml in the fields reference.