Package com.scivicslab.pojoactor.workflow.kustomize

Class OverlayConf

java.lang.Object
com.scivicslab.pojoactor.workflow.kustomize.OverlayConf
public class OverlayConf extends Object
Represents an overlay-conf.yaml configuration file.

This class is designed to be populated from YAML using SnakeYAML or Jackson. It defines which base workflows to use and which patches to apply.

Example overlay-conf.yaml:

 apiVersion: pojoactor.scivicslab.com/v1
 kind: OverlayConf

 bases:
   - ../../base

 # Simple format (applies to all matching workflows)
 patches:
   - patch-prod.yaml

 # OR Targeted format (applies patch to specific workflow file)
 patches:
   - target: setup.yaml
     patch: patch-setup.yaml
   - target: build.yaml
     patch: patch-build.yaml

 vars:
   environment: production
   nodeGroup: webservers

 namePrefix: prod-
Since:
2.9.0
Author:
devteam@scivics-lab.com

  • Constructor Details

    • OverlayConf

      public OverlayConf()

  • Method Details

    • getApiVersion

      public String getApiVersion()
      Gets the API version.
      Returns:
      the API version string

    • setApiVersion

      public void setApiVersion(String apiVersion)
      Sets the API version.
      Parameters:
      apiVersion - the API version string

    • getKind

      public String getKind()
      Gets the kind.
      Returns:
      the kind string (typically "OverlayConf")

    • setKind

      public void setKind(String kind)
      Sets the kind.
      Parameters:
      kind - the kind string

    • getBases

      public List<String> getBases()
      Gets the list of base directories.
      Returns:
      list of relative paths to base kustomization directories

    • setBases

      public void setBases(List<String> bases)
      Sets the list of base directories.
      Parameters:
      bases - list of relative paths to base directories

    • getPatches

      public List<PatchEntry> getPatches()
      Gets the list of patch entries.
      Returns:
      list of patch entries (each may have target and patch fields)

    • setPatches

      public void setPatches(List<PatchEntry> patches)
      Sets the list of patch entries.
      Parameters:
      patches - list of patch entries

    • getVars

      public Map<String,String> getVars()
      Gets the variable substitution map.
      Returns:
      map of variable names to values

    • setVars

      public void setVars(Map<String,String> vars)
      Sets the variable substitution map.
      Parameters:
      vars - map of variable names to values

    • getNamePrefix

      public String getNamePrefix()
      Gets the name prefix.
      Returns:
      the prefix to add to workflow names

    • setNamePrefix

      public void setNamePrefix(String namePrefix)
      Sets the name prefix.
      Parameters:
      namePrefix - the prefix to add to workflow names

    • getNameSuffix

      public String getNameSuffix()
      Gets the name suffix.
      Returns:
      the suffix to add to workflow names

    • setNameSuffix

      public void setNameSuffix(String nameSuffix)
      Sets the name suffix.
      Parameters:
      nameSuffix - the suffix to add to workflow names

    • getCommonLabels

      public Map<String,String> getCommonLabels()
      Gets the common labels map.
      Returns:
      map of label names to values

    • setCommonLabels

      public void setCommonLabels(Map<String,String> commonLabels)
      Sets the common labels map.
      Parameters:
      commonLabels - map of label names to values