Struct PipelineTemplateConfig 

pub struct PipelineTemplateConfig {
    pub key: String,
    pub name: String,
}

Configuration for supplying a custom pipeline StatefulSet template via a Kubernetes ConfigMap.

Operators can provide a custom StatefulSet YAML that the Kubernetes runner will use when creating pipeline StatefulSets for a pipeline. The custom template must be stored as the value of a key in a ConfigMap in the same namespace as the pipeline; set name to the ConfigMap name and key to the entry that contains the template.

Recommendations and requirements:

• Start from the default template and modify it as needed. The default template is present in ConfigMap named as <release-name>-pipeline-template, with key pipelineTemplate in the release namespace and should be used as a reference.
• The template must contain a valid Kubernetes StatefulSet manifest in YAML form. The runner substitutes variables in the template before parsing; therefore the final YAML must be syntactically valid.
• The runner performs simple string substitution for the following placeholders. Please ensure these placeholders are placed at appropriate location for their semantics:
• {id}: pipeline Kubernetes name (used for object names and labels)
• {namespace}: Kubernetes namespace where the pipeline runs
• {pipeline_executor_image}: container image used to run the pipeline executor
• {binary_ref}: program binary reference passed as an argument
• {program_info_ref}: program info reference passed as an argument
• {pipeline_storage_path}: mount path for persistent pipeline storage
• {storage_class_name}: storage class name to use for PVCs (if applicable)
• {deployment_id}: UUID identifying the deployment instance
• {deployment_initial}: initial desired runtime status (e.g., provisioning)
• {bootstrap_policy}: bootstrap policy value when applicable

JSON schema

{
 "description": "Configuration for supplying a custom pipeline StatefulSet template via a Kubernetes ConfigMap.\n\nOperators can provide a custom StatefulSet YAML that the Kubernetes runner will use when\ncreating pipeline StatefulSets for a pipeline. The custom template must be stored as the\nvalue of a key in a ConfigMap in the same namespace as the pipeline; set `name` to the\nConfigMap name and `key` to the entry that contains the template.\n\nRecommendations and requirements:\n- **Start from the default template and modify it as needed.** The default template is present\nin ConfigMap named as `<release-name>-pipeline-template`, with key `pipelineTemplate` in the release\nnamespace and should be used as a reference.\n- The template must contain a valid Kubernetes `StatefulSet` manifest in YAML form. The\nrunner substitutes variables in the template before parsing; therefore the final YAML\nmust be syntactically valid.\n- The runner performs simple string substitution for the following placeholders. Please ensure these\nplaceholders are placed at appropriate location for their semantics:\n- `{id}`: pipeline Kubernetes name (used for object names and labels)\n- `{namespace}`: Kubernetes namespace where the pipeline runs\n- `{pipeline_executor_image}`: container image used to run the pipeline executor\n- `{binary_ref}`: program binary reference passed as an argument\n- `{program_info_ref}`: program info reference passed as an argument\n- `{pipeline_storage_path}`: mount path for persistent pipeline storage\n- `{storage_class_name}`: storage class name to use for PVCs (if applicable)\n- `{deployment_id}`: UUID identifying the deployment instance\n- `{deployment_initial}`: initial desired runtime status (e.g., `provisioning`)\n- `{bootstrap_policy}`: bootstrap policy value when applicable",
 "type": "object",
 "required": [
   "name"
 ],
 "properties": {
   "key": {
     "description": "Key in the ConfigMap containing the pipeline template.\n\nIf not set, defaults to `pipelineTemplate`.",
     "default": "pipelineTemplate",
     "type": "string"
   },
   "name": {
     "description": "Name of the ConfigMap containing the pipeline template.",
     "type": "string"
   }
 }
}

Fields

key: String

Key in the ConfigMap containing the pipeline template.

If not set, defaults to pipelineTemplate.

name: String

Name of the ConfigMap containing the pipeline template.

Implementations

impl PipelineTemplateConfig

pub fn builder() -> PipelineTemplateConfig

Trait Implementations

impl Clone for PipelineTemplateConfig

fn clone(&self) -> PipelineTemplateConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PipelineTemplateConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PipelineTemplateConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PipelineTemplateConfig> for PipelineTemplateConfig

fn from(value: &PipelineTemplateConfig) -> Self

Converts to this type from the input type.

impl From<PipelineTemplateConfig> for PipelineTemplateConfig

fn from(value: PipelineTemplateConfig) -> Self

Converts to this type from the input type.

impl Serialize for PipelineTemplateConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PipelineTemplateConfig> for PipelineTemplateConfig

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: PipelineTemplateConfig) -> Result<Self, ConversionError>

Performs the conversion.