Skip to content

Introduction

Note: make sure to read up on inventory before moving on.

Phases of the compile command

Now that we have a basic understanding of Kapitan inventory, we can talk about the kapitan compile command.

The command has five distinct phases:

graph LR
  classDef pink fill:#f9f,stroke:#333,stroke-width:4px,color:#000,font-weight: bold;
  classDef blue fill:#00FFFF,stroke:#333,stroke-width:4px,color:#000,font-weight: bold;
  INVENTORY["Inventory"]:::pink

  COMPILE["Compile"]:::pink
  FINISH["Finish"]:::pink
  COPY["Copy"]:::pink


  subgraph "fetch"
    F{"fetch?"}
    FETCH["fetch dependencies"]
  end 

  subgraph "validate"
    V{"validate?"}
    VALIDATE["Validate"]
  end

  subgraph "reveal"
    REVEAL["Reveal"]
    R{"reveal?"}
  end

  INVENTORY --> F
  F --> |yes| FETCH
  FETCH --> COMPILE
  F ==> |no| COMPILE
  COMPILE ==> R
  R ==> |no| COPY
  R --> |yes| REVEAL
  REVEAL --> COPY
  COPY --> V
  V --> |yes| VALIDATE
  V ==> |no| FINISH
  VALIDATE --> FINISH
Step Flag Description Configuration
Inventory Kapitan uses reclass to render a final version of the inventory.
Fetch --fetch Kapitan fetches external dependencies parameters.kapitan.dependencies
Compile Kapitan compiles the input types for each target parameters.kapitan.compile
Reveal --reveal Kapitan reveals the secrets directly in the compiled output parameters.kapitan.secrets
Copy Kapitan moves the output files from the tmp directory to /compiled
Validate --validate Kapitan validates the schema of compiled output. parameters.kapitan.validate
Finish Kapitan has completed all tasks

Supported input types

Input types can be specified in the inventory under kapitan.compile in the following format:

parameters:
  kapitan:
    compile:
    - output_path: <output_path_in_target_dir>
      input_type: jinja2 
      input_params: # (1)! 
      input_paths:
        - directory/
        - file
        - globbed/path/*
  1. a dict passed to the template

Please see Jinja

parameters:
  kapitan:
    compile:
    - output_path: <output_path_in_target_dir>
      input_type: jsonnet 
      prune: false # (1)! 
      input_paths:
        - directory/
        - file
        - globbed/path/*
      output_type: [`yaml` | `json`]
  1. (Default: global --prune)
parameters:
  kapitan:
    compile:
    - output_path: <output_path_in_target_dir>
      input_type: kadet 
      prune: false # (1)! 
      input_paths:
        - directory/
        - file
        - globbed/path/*
      output_type: [`yaml` | `json`]
  1. (Default: global --prune)

Please see Kadet

parameters:
  kapitan:
    compile:
    - output_path: <output_path_in_target_dir>
      input_type: helm 
      prune: false # (1)! 
      input_paths:
        - directory/
        - file
        - globbed/path/*
      output_type: <output_type_specific_to_input_type>
  1. (Default: global --prune)
parameters:
  kapitan:
    compile:
    - output_path: <output_path_in_target_dir>
      input_type: copy 
      prune: false # (1)! 
      input_paths:
        - directory/
        - file
        - globbed/path/*
      output_type: <output_type_specific_to_input_type>
  1. (Default: global --prune)