Repository Organisation
A KubeRig repository follows a well defined directory structure.
The root directory is referred to as the project directory.
- It contains the Gradle wrapper files.
- It contains the
environments
directory. - It contains the
src\main\kotlin
directory. - It contains the
.gitignore
file. You can initialize it by executing theinitGitIgnore
task. - It contains the
settings.gradle.kts
andbuild.gradle.kts
Gradle build files.
Each environment
directory contains the following files:
- {environment-name}.keyset.json the encryption key of the environment. You should NEVER EVER commit the {environment-name}.keyset.json file. If you have used the
initGitIgnore
task this file will already get ignored. - .encrypted.{environment-name}.access-token the encrypted version of the JWT access token of a service account that can be used to do deployments.
- {environment-name}-configs.properties a properties file with environment specific configuration parameters. Can contain encrypted values use the
encryptConfig{Environment-name}Environment
task to encrypt values. - other files that are environment specific, remember to prefix files that contains sensitive information with
.plain.
.
The src\main\kotlin
directory is where you place your Kotlin resource generation code.