crd-execution-doc.md



API Reference
Packages:

theodolite.com/v1


theodolite.com/v1
Resource Types:

execution


execution
^{^Parent}

    
            Name
            Type
            Description
            Required
        
    
      apiVersion
      string
      theodolite.com/v1
      true
      
      
      kind
      string
      execution
      true
      
      
      metadata
      object
      Refer to the Kubernetes API documentation for the fields of the `metadata` field.
      true
      

        status
        object
        
          
        false
      

        spec
        object
        
          
        true
      

execution.status
^{^Parent}

    
            Name
            Type
            Description
            Required
        
    
        executionDuration
        string
        
          Duration of the execution in seconds

        
        false
      

        executionState
        string
        
          
        false
      

execution.spec
^{^Parent}

    
            Name
            Type
            Description
            Required
        
    
        name
        string
        
          This field exists only for technical reasons and should not be set by the user. The value of the field will be overwritten.

          
            Default: 

        
        false
      

        benchmark
        string
        
          The name of the benchmark this execution is referring to.

        
        true
      

        configOverrides
        []object
        
          List of patchers that are used to override existing configurations.

        
        true
      

        execution
        object
        
          Defines the overall parameter for the execution.

        
        true
      

        load
        object
        
          Specifies the load values that are benchmarked.

        
        true
      

        resources
        object
        
          Specifies the scaling resource that is benchmarked.

        
        true
      

        slos
        []object
        
          List of resource values for the specified resource type.

        
        true
      

execution.spec.configOverrides[index]
^{^Parent}

    
            Name
            Type
            Description
            Required
        
    
        patcher
        object
        
          Patcher used to patch a resource

        
        false
      

        value
        string
        
          
        false
      

execution.spec.configOverrides[index].patcher
^{^Parent}
Patcher used to patch a resource

    
            Name
            Type
            Description
            Required
        
    
        properties
        object
        
          (Optional) Patcher specific additional arguments.

          
            Default: map[]

        
        false
      

        resource
        string
        
          Specifies the Kubernetes resource to be patched.

          
            Default: 

        
        true
      

        type
        string
        
          Type of the Patcher.

          
            Default: 

        
        true
      

execution.spec.execution
^{^Parent}
Defines the overall parameter for the execution.

    
            Name
            Type
            Description
            Required
        
    
        loadGenerationDelay
        integer
        
          Seconds to wait between the start of the SUT and the load generator.

        
        false
      

        duration
        integer
        
          Defines the duration of each experiment in seconds.

        
        true
      

        repetitions
        integer
        
          Numper of repititions for each experiments.

        
        true
      

        restrictions
        []string
        
          List of restriction strategys used to delimit the search space.

        
        true
      

        strategy
        string
        
          Defines the used strategy for the execution, either 'LinearSearch' or 'BinarySearch'

        
        true
      

execution.spec.load
^{^Parent}
Specifies the load values that are benchmarked.

    
            Name
            Type
            Description
            Required
        
    
        loadType
        string
        
          The type of the load. It must match one of the load types specified in the referenced benchmark.

        
        true
      

        loadValues
        []integer
        
          List of load values for the specified load type.

        
        true
      

execution.spec.resources
^{^Parent}
Specifies the scaling resource that is benchmarked.

    
            Name
            Type
            Description
            Required
        
    
        resourceType
        string
        
          The type of the resource. It must match one of the resource types specified in the referenced benchmark.

        
        true
      

        resourceValues
        []integer
        
          
        true
      

execution.spec.slos[index]
^{^Parent}

    
            Name
            Type
            Description
            Required
        
    
        externalSloUrl
        string
        
          Connection string for a external slo analysis.

        
        true
      

        offset
        integer
        
          Hours by which the start and end timestamp will be shifted (for different timezones).

        
        true
      

        prometheusUrl
        string
        
          Connection string for Promehteus.

        
        true
      

        sloType
        string
        
          The type of the SLO. It must match 'lag trend'.

        
        true
      

        threshold
        integer
        
          The threshold the SUT should meet for a sucessful experiment.

        
        true
      

        warmup
        integer
        
          Seconds of time that are ignored in the analysis.

        
        true