ocs_ci.utility.workloads package

Submodules

ocs_ci.utility.workloads.fio module

This module implements all the functionalities required for setting up and running Fio workloads on the pods.

This module implements few functions:

setup(): for setting up fio utility on the pod and any necessary
    environmental params.
run(): for running fio on pod on specified mount point

Note: The above mentioned functions will be invoked from Workload.setup() and Workload.run() methods along with user provided parameters.

ocs_ci.utility.workloads.fio.run(**kwargs)

Run fio with params from kwargs. Default parameter list can be found in templates/workloads/fio/workload_io.yaml and user can update the dict as per the requirement.

Parameters

kwargs (dict) – IO params for fio

Result:

result of command

ocs_ci.utility.workloads.fio.setup(**kwargs)

setup fio workload

Parameters

**kwargs (dict) – fio setup configuration. At this point in time only argument present in kwargs will be ‘pod’ on which we want to setup. In future if we move to containerized fio then pod.yaml will be presented in kwargs.

Returns

True if setup succeeds else False

Return type

bool

ocs_ci.utility.workloads.helpers module

Helper function for workloads to use

ocs_ci.utility.workloads.helpers.find_distro(io_pod)

Find whats the os distro on pod

Parameters

io_pod (Pod) – app pod object

Returns

representing ‘Debian’ or ‘RHEL’ as of now

Return type

distro (str)

ocs_ci.utility.workloads.jenkins module

This module implements all the functionalities required for setting up and running “Jenkins” like workloads on the pods.

This module implements few functions:

setup(): for setting up git utility on the pod and any necessary
    environmental params.
run(): for running 'git clone' on pod to simulate a working environment for
    a developer

Note: The above mentioned functions will be invoked from Workload.setup() and Workload.run() methods along with user provided parameters.

ocs_ci.utility.workloads.jenkins.run(**kwargs)

Run git clone

Returns

result of command

Return type

str

ocs_ci.utility.workloads.jenkins.setup(**kwargs)

setup git workload

Parameters

**kwargs (dict) – git setup configuration. The only argument present in kwargs is ‘pod’ on which we want to setup

Returns

True if setup succeeds else False

Return type

bool

Module contents