Skip to content

CRD API Docs

Packages:

perf.kubestone.xridge.io/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

    BasicAuth

    (Appears on: EsRallySecurity)

    BasicAuth contains basic HTTP authentication credentials.

    Field Description
    username
    string
    password
    string

    BenchmarkStatus

    (Appears on: Drill, Fio, Ioping, Iperf3, KafkaBench, OcpLogtest, Pgbench, Qperf, S3Bench, Sysbench, YcsbBench)

    BenchmarkStatus describes the current state of the benchmark

    Field Description
    running
    bool

    Running shows the state of execution

    completed
    bool

    Completed shows the state of completion

    Drill

    Drill is the Schema for the drills API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DrillSpec


    image
    ImageSpec

    Image defines the drill docker image used for the benchmark

    benchmarksVolume
    map[string]string

    BenchmarksVolume holds the content of benchmark files. The key of the map specifies the filename and the value is the content of the file. ConfigMap is created from the map which is mounted as benchmarks directory to the benchmark pod.

    benchmarkFile
    string

    BenchmarkFile is the entry point file (passed to –benchmark) specified to drill.

    options
    string
    (Optional)

    Options are appended to the options parameter set of drill

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    status
    BenchmarkStatus

    DrillSpec

    (Appears on: Drill)

    DrillSpec defines benchmark run for drill load tester The benchmarkFile, and options is passed to drill as follows: drill [OPTIONS] –benchmark

    Field Description
    image
    ImageSpec

    Image defines the drill docker image used for the benchmark

    benchmarksVolume
    map[string]string

    BenchmarksVolume holds the content of benchmark files. The key of the map specifies the filename and the value is the content of the file. ConfigMap is created from the map which is mounted as benchmarks directory to the benchmark pod.

    benchmarkFile
    string

    BenchmarkFile is the entry point file (passed to –benchmark) specified to drill.

    options
    string
    (Optional)

    Options are appended to the options parameter set of drill

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    EsRally

    EsRally is the Schema for the esrallies API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    EsRallySpec


    image
    ImageSpec
    (Optional)

    Image defines the docker image used for the benchmark

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    track
    string

    Track defines the track that Rally should run.

    trackRepository
    string
    (Optional)

    TrackRepository defines the track repository that Rally should use to resolve tracks. Default: default https://esrally.readthedocs.io/en/stable/command_line_reference.html#track-repository

    trackParams
    map[string]string
    (Optional)

    TrackParams defines variables to inject into tracks. The supported variables depend on the track and you should check the track JSON file to see which variables can be provided. https://esrally.readthedocs.io/en/stable/command_line_reference.html#track-params

    hosts
    string
    challenge
    string
    (Optional)

    Pipeline string json:"pipeline"

    nodes
    int32
    (Optional)

    Nodes defines the number of esrally clients to use. Default is 1

    persistence
    EsRallyVolConfig
    security
    EsRallySecurity
    (Optional)
    status
    EsRallyStatus

    EsRallySecurity

    (Appears on: EsRallySpec)

    Field Description
    useSsl
    bool
    (Optional)
    verifyCerts
    bool
    (Optional)
    basicAuth
    BasicAuth
    (Optional)

    EsRallySpec

    (Appears on: EsRally)

    EsRallySpec defines the desired state of EsRally

    Field Description
    image
    ImageSpec
    (Optional)

    Image defines the docker image used for the benchmark

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    track
    string

    Track defines the track that Rally should run.

    trackRepository
    string
    (Optional)

    TrackRepository defines the track repository that Rally should use to resolve tracks. Default: default https://esrally.readthedocs.io/en/stable/command_line_reference.html#track-repository

    trackParams
    map[string]string
    (Optional)

    TrackParams defines variables to inject into tracks. The supported variables depend on the track and you should check the track JSON file to see which variables can be provided. https://esrally.readthedocs.io/en/stable/command_line_reference.html#track-params

    hosts
    string
    challenge
    string
    (Optional)

    Pipeline string json:"pipeline"

    nodes
    int32
    (Optional)

    Nodes defines the number of esrally clients to use. Default is 1

    persistence
    EsRallyVolConfig
    security
    EsRallySecurity
    (Optional)

    EsRallyStatus

    (Appears on: EsRally)

    Field Description
    running
    bool

    Running shows the state of execution

    completed
    bool

    Completed shows the state of completion

    deployed
    bool

    Deployed shows the state of the StatefulSet needed for testing

    EsRallyVolConfig

    (Appears on: EsRallySpec)

    Field Description
    size
    string
    storageClass
    string

    Fio

    Fio is the Schema for the fios API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    FioSpec


    image
    ImageSpec

    Image defines the fio docker image used for the benchmark

    builtinJobFiles
    []string
    (Optional)

    BuiltinJobFiles contains a list of fio job files that are already present in the docker image

    customJobFiles
    []string
    (Optional)

    CustomJobFiles contains a list of custom fio job files The exact format of fio job files is documented here: https://fio.readthedocs.io/en/latest/fio_doc.html#job-file-format The job files defined here will be mounted to the fio benchmark container

    cmdLineArgs
    string
    (Optional)

    CmdLineArgs are appended to the predefined fio parameters

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    volume
    VolumeSpec

    Volume contains the configuration for the volume that the fio job should run on.

    status
    BenchmarkStatus

    FioSpec

    (Appears on: Fio)

    FioSpec defines the desired state of Fio

    Field Description
    image
    ImageSpec

    Image defines the fio docker image used for the benchmark

    builtinJobFiles
    []string
    (Optional)

    BuiltinJobFiles contains a list of fio job files that are already present in the docker image

    customJobFiles
    []string
    (Optional)

    CustomJobFiles contains a list of custom fio job files The exact format of fio job files is documented here: https://fio.readthedocs.io/en/latest/fio_doc.html#job-file-format The job files defined here will be mounted to the fio benchmark container

    cmdLineArgs
    string
    (Optional)

    CmdLineArgs are appended to the predefined fio parameters

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    volume
    VolumeSpec

    Volume contains the configuration for the volume that the fio job should run on.

    ImageSpec

    (Appears on: DrillSpec, EsRallySpec, FioSpec, IopingSpec, Iperf3Spec, KafkaBenchSpec, OcpLogtestSpec, PgbenchSpec, QperfSpec, S3BenchSpec, SysbenchSpec, YcsbBenchSpec)

    ImageSpec defines parameters for docker image executed on Kubernetes

    Field Description
    name
    string

    Name is the Docker Image location including the tag

    pullPolicy
    PullPolicy
    (Optional)
    pullSecret
    string
    (Optional)

    PullSecret is an optional list of references to secrets in the same namespace to use for pulling any of the images

    Ioping

    Ioping is the Schema for the iopings API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    IopingSpec


    image
    ImageSpec

    Image defines the ioping docker image used for the benchmark

    args
    string
    (Optional)

    Args are appended to the predefined ioping parameters

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    volume
    VolumeSpec

    Volume contains the configuration for the volume that the ioping job should run on.

    status
    BenchmarkStatus

    IopingSpec

    (Appears on: Ioping)

    IopingSpec defines the ioping benchmark run

    Field Description
    image
    ImageSpec

    Image defines the ioping docker image used for the benchmark

    args
    string
    (Optional)

    Args are appended to the predefined ioping parameters

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    volume
    VolumeSpec

    Volume contains the configuration for the volume that the ioping job should run on.

    Iperf3

    Iperf3 is the Schema for the iperf3s API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Iperf3Spec


    image
    ImageSpec

    Image defines the iperf3 docker image used for the benchmark

    serverConfiguration
    Iperf3ConfigurationSpec
    (Optional)

    ServerConfiguration contains the configuration of the iperf3 server

    clientConfiguration
    Iperf3ConfigurationSpec
    (Optional)

    ClientConfiguration contains the configuration of the iperf3 client

    udp
    bool
    (Optional)

    UDP to use rather than TCP. If enabled the ‘–udp’ parameter is added to iperf command line args

    status
    BenchmarkStatus

    Iperf3ConfigurationSpec

    (Appears on: Iperf3Spec)

    Iperf3ConfigurationSpec contains configuration parameters with scheduling options for the both the iperf3 client and server instances.

    Field Description
    PodConfigurationSpec
    PodConfigurationSpec

    (Members of PodConfigurationSpec are embedded into this type.)

    cmdLineArgs
    string
    (Optional)

    CmdLineArgs are appended to the predefined iperf3 parameters

    hostNetwork
    bool
    (Optional)

    HostNetwork requested for the iperf3 pod, if enabled the hosts network namespace is used. Default to false.

    Iperf3Spec

    (Appears on: Iperf3)

    Iperf3Spec defines the Iperf3 Benchmark Stone which consist of server deployment with service definition and client pod.

    Field Description
    image
    ImageSpec

    Image defines the iperf3 docker image used for the benchmark

    serverConfiguration
    Iperf3ConfigurationSpec
    (Optional)

    ServerConfiguration contains the configuration of the iperf3 server

    clientConfiguration
    Iperf3ConfigurationSpec
    (Optional)

    ClientConfiguration contains the configuration of the iperf3 client

    udp
    bool
    (Optional)

    UDP to use rather than TCP. If enabled the ‘–udp’ parameter is added to iperf command line args

    KafkaBench

    KafkaBench is the Schema for the kafkabenches API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    KafkaBenchSpec


    image
    ImageSpec

    Image defines the kafka docker image used for the benchmark

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    KafkaClusterInfo
    KafkaClusterInfo

    (Members of KafkaClusterInfo are embedded into this type.)

    tests
    []KafkaTestSpec

    Tests defines the tests with which to create

    status
    BenchmarkStatus

    KafkaBenchSpec

    (Appears on: KafkaBench)

    KafkaBenchSpec defines the desired state of KafkaBench

    Field Description
    image
    ImageSpec

    Image defines the kafka docker image used for the benchmark

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    KafkaClusterInfo
    KafkaClusterInfo

    (Members of KafkaClusterInfo are embedded into this type.)

    tests
    []KafkaTestSpec

    Tests defines the tests with which to create

    KafkaClusterInfo

    (Appears on: KafkaBenchSpec)

    ClusterInfo to be used by the benchmark for ZooKeeper and Kafka Brokers

    Field Description
    zookeepers
    []string

    List of ZooKeeper instances we to connect to

    brokers
    []string

    List of Kafka Broker instances we to connect to

    KafkaTestSpec

    (Appears on: KafkaBenchSpec)

    TestSpec defines the specifications for the kafka tests

    Field Description
    name
    string
    threads
    int32
    replication
    int
    partitions
    int
    recordSize
    int
    records
    int
    consumerSleep
    int32
    (Optional)

    ConsumerSleep defines the time in seconds the consumer will sleep before attempting to consume messages. Only change if you are having issues with consuming messages. Default: 40

    timeout
    int
    (Optional)

    Timeout defines the consumer maximum allowed time in milliseconds between returned records. (default: 10000)

    extraProducerOpts
    []string
    (Optional)

    These can be any official producer Kafka options: https://kafka.apache.org/documentation/#producerconfigs

    consumersOnly
    bool
    producersOnly
    bool

    MixedDistributionOptions

    (Appears on: S3BenchSpec)

    MixedDistributionOptions defines the distribution of operation types if using the mixed mode

    Field Description
    get
    int32
    (Optional)

    GetDist The amount of GET operations. (default: 45)

    stat
    int32
    (Optional)

    StatDist The amount of STAT operations. (default: 30)

    put
    int32
    (Optional)

    PutDist The amount of PUT operations. (default: 15)

    delete
    int32
    (Optional)

    DeleteDist The amount of DELETE operations. Must be at least the same as PUT. (default: 10)

    OcpLogtest

    OcpLogtest is the Schema for the ocplogtests API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    OcpLogtestSpec


    image
    ImageSpec

    Image defines the docker image used for the benchmark

    lineLength
    int

    length of each line

    numLines
    int

    number of lines to generate

    rate
    int

    lines per minute

    fixedLine
    bool

    repeat the same line of text over and over or use new text for each line

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    status
    BenchmarkStatus

    OcpLogtestSpec

    (Appears on: OcpLogtest)

    OcpLogtestSpec defines the desired state of OcpLogtest

    Field Description
    image
    ImageSpec

    Image defines the docker image used for the benchmark

    lineLength
    int

    length of each line

    numLines
    int

    number of lines to generate

    rate
    int

    lines per minute

    fixedLine
    bool

    repeat the same line of text over and over or use new text for each line

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    Pgbench

    Pgbench is the Schema for the pgbenches API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    PgbenchSpec


    image
    ImageSpec

    Image defines the docker image used for the benchmark

    postgres
    PostgresSpec

    Postgres contains the configuration parameters for the PostgreSQL database that will run the benchmark

    initArgs
    string
    (Optional)

    InitArgs contains the command line arguments passed to the init container

    args
    string
    (Optional)

    Args contains the command line arguments passed to the main pgbench container

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    status
    BenchmarkStatus

    PgbenchSpec

    (Appears on: Pgbench)

    PgbenchSpec describes a pgbench benchmark job

    Field Description
    image
    ImageSpec

    Image defines the docker image used for the benchmark

    postgres
    PostgresSpec

    Postgres contains the configuration parameters for the PostgreSQL database that will run the benchmark

    initArgs
    string
    (Optional)

    InitArgs contains the command line arguments passed to the init container

    args
    string
    (Optional)

    Args contains the command line arguments passed to the main pgbench container

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    PodConfigurationSpec

    (Appears on: DrillSpec, EsRallySpec, FioSpec, IopingSpec, Iperf3ConfigurationSpec, KafkaBenchSpec, OcpLogtestSpec, PgbenchSpec, QperfConfigurationSpec, S3BenchSpec, SysbenchSpec, YcsbBenchSpec)

    PodConfigurationSpec contains the configuration for the benchmark pods

    Field Description
    annotations
    map[string]string
    (Optional)

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

    podLabels
    map[string]string
    (Optional)

    PodLabels are added to the pod as labels.

    podScheduling
    PodSchedulingSpec
    (Optional)

    PodScheduling contains options to determine which node the pod should be scheduled on

    resources
    Kubernetes core/v1.ResourceRequirements
    (Optional)

    Resources required by the benchmark pod container More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

    PodSchedulingSpec

    (Appears on: PodConfigurationSpec)

    PodSchedulingSpec encapsulates the scheduling related fields of a Kubernetes Pod

    Field Description
    affinity
    Kubernetes core/v1.Affinity
    (Optional)

    Affinity is a group of affinity scheduling rules.

    tolerations
    []Kubernetes core/v1.Toleration
    (Optional)

    If specified, the pod’s tolerations.

    nodeSelector
    map[string]string
    (Optional)

    A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

    nodeName
    string
    (Optional)

    NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

    PostgresSpec

    (Appears on: PgbenchSpec)

    PostgresSpec contains the configuration parameters for the PostreSQL database

    Field Description
    host
    string

    Host is the name of host to connect to

    port
    int

    Port number to connect to at the server host

    user
    string

    User is the PostgreSQL user name to connect as

    password
    string

    Password is to be used if the server demands password authentication

    database
    string

    Database is name of the database

    PullPolicy (string alias)

    (Appears on: ImageSpec)

    PullPolicy controls how the docker images are downloaded Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.

    Qperf

    Qperf is the Schema for the qperves API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    QperfSpec


    image
    ImageSpec

    Image defines the qperf docker image used for the benchmark

    options
    string
    (Optional)

    Options are options for the qperf binary

    tests
    []string

    Tests are the tests that we would like to run

    serverConfiguration
    QperfConfigurationSpec
    (Optional)

    ServerConfiguration contains the configuration of the qperf server

    clientConfiguration
    QperfConfigurationSpec
    (Optional)

    ClientConfiguration contains the configuration of the qperf client

    status
    BenchmarkStatus

    QperfConfigurationSpec

    (Appears on: QperfSpec)

    QperfConfigurationSpec contains configuration parameters with scheduling options for the both the qperf client and server instances.

    Field Description
    PodConfigurationSpec
    PodConfigurationSpec

    (Members of PodConfigurationSpec are embedded into this type.)

    hostNetwork
    bool
    (Optional)

    HostNetwork requested for the qperf pod, if enabled the hosts network namespace is used. Default to false.

    QperfSpec

    (Appears on: Qperf)

    QperfSpec defines the Qperf Benchmark Stone which consist of server deployment with service definition and client pod.

    Field Description
    image
    ImageSpec

    Image defines the qperf docker image used for the benchmark

    options
    string
    (Optional)

    Options are options for the qperf binary

    tests
    []string

    Tests are the tests that we would like to run

    serverConfiguration
    QperfConfigurationSpec
    (Optional)

    ServerConfiguration contains the configuration of the qperf server

    clientConfiguration
    QperfConfigurationSpec
    (Optional)

    ClientConfiguration contains the configuration of the qperf client

    S3AnalysisOptions

    (Appears on: S3BenchSpec)

    S3AnalysisOptions defines options for the analysis features of warp

    Field Description
    duration
    string
    (Optional)

    Duration defines the time length to split analysis into durations of this length (default: “1s”)

    output
    string
    (Optional)

    Output aggregated data as to file

    operationFilter
    string
    (Optional)

    OperationFilter Only output for this op. Can be GET/PUT/DELETE, etc.

    printErrors
    bool
    (Optional)

    PrintErrors Print out errors (default: false)

    hostFilter
    string
    (Optional)

    HostFilter Only output for this host.

    skip
    string
    (Optional)

    Skip Additional duration to skip when analyzing data. (default: 0s)

    hostDetails
    bool
    (Optional)

    HostDetails Do detailed time segmentation per host (default: false)

    S3AutoTermOptions

    (Appears on: S3BenchSpec)

    S3AutoTermOptions defines options for the auto terminate feature of warp.

    Field Description
    enabled
    bool
    (Optional)

    Enabled defines if to auto terminate when benchmark is considered stable. (default: false)

    duration
    string
    (Optional)

    Duration defines the minimum duration where output must have been stable to allow automatic termination. (default: 10s)

    percent
    string
    (Optional)

    Percent defines the percentage the last 625 time blocks must be within current speed to auto terminate. (default: 7.5)

    S3Bench

    S3Bench is the Schema for the s3benches API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    S3BenchSpec


    image
    ImageSpec
    (Optional)

    Image defines the warp docker image used for the benchmark

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    mode
    string

    Mode defines the operating mode of the benchmark test. See https://github.com/minio/warp#mixed for option definition. Currently accepted values are: get, put, delete, mixed

    host
    string

    Host defines the host to benchmark against. Multiple hosts can be specified as a comma separated list. (default: “127.0.0.1:9000”)

    S3BenchOptions
    S3BenchOptions

    (Members of S3BenchOptions are embedded into this type.)

    S3BenchOptions defines the runtime arguments for the benchmark test

    objects
    S3ObjectOptions
    (Optional)

    S3ObjectOptions defines options for the objects generated by the benchmark

    autoTerm
    S3AutoTermOptions
    (Optional)

    S3AutoTermOptions defines options for the auto terminate feature of warp.

    analysis
    S3AnalysisOptions
    (Optional)

    S3AnalysisOptions defines options for the analysis features of warp

    mixedDist
    MixedDistributionOptions
    (Optional)

    MixedDistributionOptions defines the distribution of operation types if using the mixed mode Will only be used in “mixed” mode.

    status
    BenchmarkStatus

    S3BenchOptions

    (Appears on: S3BenchSpec)

    S3BenchOptions defines the runtime arguments for the Warp cli

    Field Description
    noColor
    bool
    (Optional)

    NoColor will disable color theme (default: false)

    debug
    bool
    (Optional)

    Debug will enable debug output (default: false)

    insecure
    bool
    (Optional)

    Insecure defines if to disable SSL certificate verification (default: false)

    accessKey
    string
    (Optional)
    secretKey
    string
    (Optional)
    tls
    bool
    (Optional)

    Tls defines if to use TLS (HTTPS) for transport (default: false)

    region
    string
    (Optional)

    Region defines a custom region

    encrypt
    bool
    (Optional)

    Encrypt defines if to encrypt/decrypt objects (using server-side encryption with random keys) (default: false)

    bucket
    string
    (Optional)

    Bucket defines which bucket to use for benchmark data. ALL DATA WILL BE DELETED IN BUCKET! (default: “warp-benchmark-bucket”)

    hostSelect
    string
    (Optional)

    HostSelect defines the host selection algorithm. Can be “weighed” or “roundrobin” (default: “weighed”)

    concurrent
    int32
    (Optional)

    Concurrent defines how many concurrent operations to run (default: 6)

    noPrefix
    bool
    (Optional)

    NoPrefix defines if to NOT use separate prefix for each thread (default: false)

    benchOutput
    string
    (Optional)

    Output benchmark+profile data to this file. By default unique filename is generated.

    duration
    string
    (Optional)

    Duration defines the time length to run the benchmark. Use ’s’ and ’m’ to specify seconds and minutes. (default: 5m0s)

    noClear
    bool
    (Optional)

    NoClear Do not clear bucket before or after running benchmarks. Use when running multiple clients. (default: false)

    syncStart
    string
    (Optional)

    Specify a benchmark start time. Time format is ‘hh:mm’ where hours are specified in 24h format, server TZ.

    requests
    bool
    (Optional)

    Requests Display individual request stats.

    S3BenchSpec

    (Appears on: S3Bench)

    S3BenchSpec defines the desired state of S3Bench

    Field Description
    image
    ImageSpec
    (Optional)

    Image defines the warp docker image used for the benchmark

    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    mode
    string

    Mode defines the operating mode of the benchmark test. See https://github.com/minio/warp#mixed for option definition. Currently accepted values are: get, put, delete, mixed

    host
    string

    Host defines the host to benchmark against. Multiple hosts can be specified as a comma separated list. (default: “127.0.0.1:9000”)

    S3BenchOptions
    S3BenchOptions

    (Members of S3BenchOptions are embedded into this type.)

    S3BenchOptions defines the runtime arguments for the benchmark test

    objects
    S3ObjectOptions
    (Optional)

    S3ObjectOptions defines options for the objects generated by the benchmark

    autoTerm
    S3AutoTermOptions
    (Optional)

    S3AutoTermOptions defines options for the auto terminate feature of warp.

    analysis
    S3AnalysisOptions
    (Optional)

    S3AnalysisOptions defines options for the analysis features of warp

    mixedDist
    MixedDistributionOptions
    (Optional)

    MixedDistributionOptions defines the distribution of operation types if using the mixed mode Will only be used in “mixed” mode.

    S3ObjectOptions

    (Appears on: S3BenchSpec)

    S3ObjectOptions defines options for the objects generated by the benchmark

    Field Description
    count
    int32
    (Optional)

    Count defines the number of objects to upload. (default: 2500)

    size
    string
    (Optional)

    Size defines the size of each generated object. Can be a number or 10KiB/MiB/GiB. All sizes are base 2 binary. (default: “10MiB”)

    generator
    string
    (Optional)

    Generator defines if to use a specific data generator (default: “random”)

    randomSize
    bool
    (Optional)

    RandomSize defines if to randomize size of objects so they will be up to the specified size (default: false)

    Sysbench

    Sysbench is the Schema for the sysbenches API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    SysbenchSpec


    image
    ImageSpec

    Image defines the sysbench docker image used for the benchmark

    podConfig
    PodConfigurationSpec

    (Members of podConfig are embedded into this type.)

    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    options
    string
    (Optional)

    Options is a list of zero or more command line options starting with ‘–’.

    testName
    string

    TestName is the name of a built-in test (e.g. fileio, memory, cpu, etc.), or a name of one of the bundled Lua scripts (e.g. oltp_read_only), or a path to a custom Lua script.

    command
    string
    (Optional)

    Command is an optional argument that will be passed by sysbench to the built-in test or script specified with TestName. Command defines the action that must be performed by the test. The list of available commands depends on a particular test. Some tests also implement their own custom commands.

    status
    BenchmarkStatus

    SysbenchSpec

    (Appears on: Sysbench)

    SysbenchSpec contains the configuration parameters with scheduling options for the sysbench benchmark. The options, testName and command parameters are passed to the sysbench benchmarking application.

    Field Description
    image
    ImageSpec

    Image defines the sysbench docker image used for the benchmark

    podConfig
    PodConfigurationSpec

    (Members of podConfig are embedded into this type.)

    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    options
    string
    (Optional)

    Options is a list of zero or more command line options starting with ‘–’.

    testName
    string

    TestName is the name of a built-in test (e.g. fileio, memory, cpu, etc.), or a name of one of the bundled Lua scripts (e.g. oltp_read_only), or a path to a custom Lua script.

    command
    string
    (Optional)

    Command is an optional argument that will be passed by sysbench to the built-in test or script specified with TestName. Command defines the action that must be performed by the test. The list of available commands depends on a particular test. Some tests also implement their own custom commands.

    VolumeSpec

    (Appears on: FioSpec, IopingSpec)

    VolumeSpec contains the Volume Definition used for the benchmarks. It can point to an EmptyDir, HostPath, already existing PVC or PVC to be created benchmark time.

    Field Description
    volumeSource
    Kubernetes core/v1.VolumeSource

    VolumeSource represents the source of the volume, e.g. EmptyDir, HostPath, Ceph, PersistentVolumeClaim, etc. PersistentVolumeClaim.claimName can be set to point to an already existing PVC or could be set to ‘GENERATED’. When set to ‘GENERATED’ The PVC will be created based on the PersistentVolumeClaimSpec provided to the VolumeSpec.

    persistentVolumeClaimSpec
    Kubernetes core/v1.PersistentVolumeClaimSpec
    (Optional)

    PersistentVolumeClaimSpec describes the persistent volume claim that will be created and used by the pod. If specified, the VolumeSource.PersistentVolumeClaim’s claimName must be set to ‘GENERATED’

    YcsbBench

    YcsbBench is the Schema for the ycsbbenches API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    YcsbBenchSpec


    image
    ImageSpec

    Image defines the docker image used for the benchmark

    database
    string
    workload
    string
    options
    YcsbBenchOptions
    (Optional)
    properties
    map[string]string
    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)

    status
    BenchmarkStatus

    YcsbBenchOptions

    (Appears on: YcsbBenchSpec)

    Field Description
    threadcount
    int
    target
    int

    YcsbBenchSpec

    (Appears on: YcsbBench)

    YcsbBenchSpec defines the desired state of YcsbBench

    Field Description
    image
    ImageSpec

    Image defines the docker image used for the benchmark

    database
    string
    workload
    string
    options
    YcsbBenchOptions
    (Optional)
    properties
    map[string]string
    podConfig
    PodConfigurationSpec
    (Optional)

    PodConfig contains the configuration for the benchmark pod, including pod labels and scheduling policies (affinity, toleration, node selector…)


    Generated with gen-crd-api-reference-docs on git commit 3ffb0c5.