ocs_ci package

Subpackages

• ocs_ci.cleanup package
  • Subpackages
    • ocs_ci.cleanup.aws package
      • Submodules
      • ocs_ci.cleanup.aws.cleanup module
      • ocs_ci.cleanup.aws.defaults module
      • Module contents
  • Module contents
• ocs_ci.deployment package
  • Subpackages
    • ocs_ci.deployment.helpers package
      • Submodules
      • ocs_ci.deployment.helpers.external_cluster_helpers module
      • ocs_ci.deployment.helpers.hypershift_base module
      • ocs_ci.deployment.helpers.icsp_parser module
      • ocs_ci.deployment.helpers.idms_parser module
      • ocs_ci.deployment.helpers.lso_helpers module
      • ocs_ci.deployment.helpers.mcg_helpers module
      • ocs_ci.deployment.helpers.odf_deployment_helpers module
      • ocs_ci.deployment.helpers.prechecks module
      • ocs_ci.deployment.helpers.rosa_cluster_helpers module
      • ocs_ci.deployment.helpers.storage_class module
      • ocs_ci.deployment.helpers.vsphere_helpers module
      • Module contents
  • Submodules
  • ocs_ci.deployment.acm module
    • Submariner
      • Submariner.create_acm_brew_idms()
      • Submariner.deploy()
      • Submariner.deploy_downstream()
      • Submariner.deploy_upstream()
      • Submariner.download_binary()
      • Submariner.download_downstream_binary()
      • Submariner.get_default_gateway_node()
      • Submariner.get_primary_cluster_index()
      • Submariner.get_subctl_version()
      • Submariner.submariner_configure_upstream()
      • Submariner.wait_for_tar_file()
    • run_subctl_cmd()
    • run_subctl_cmd_interactive()
  • ocs_ci.deployment.assisted_installer module
    • AssistedInstallerCluster
      • AssistedInstallerCluster.create_cluster()
      • AssistedInstallerCluster.create_infrastructure_environment()
      • AssistedInstallerCluster.create_kubeadmin_password_file()
      • AssistedInstallerCluster.create_kubeconfig_file()
      • AssistedInstallerCluster.create_metadata_file()
      • AssistedInstallerCluster.create_openshift_install_log_file()
      • AssistedInstallerCluster.delete_cluster()
      • AssistedInstallerCluster.delete_infrastructure_environment()
      • AssistedInstallerCluster.download_discovery_iso()
      • AssistedInstallerCluster.download_ipxe_config()
      • AssistedInstallerCluster.get_host_id_mac_mapping()
      • AssistedInstallerCluster.get_infra_env_hosts()
      • AssistedInstallerCluster.install_cluster()
      • AssistedInstallerCluster.load_existing_cluster_configuration()
      • AssistedInstallerCluster.prepare_pull_secret()
      • AssistedInstallerCluster.update_hosts_config()
      • AssistedInstallerCluster.verify_validations_info_for_discovered_nodes()
      • AssistedInstallerCluster.wait_for_discovered_nodes()
  • ocs_ci.deployment.aws module
    • AWSIPI
      • AWSIPI.OCPDeployment
      • AWSIPI.deploy_ocp()
      • AWSIPI.destroy_cluster()
    • AWSUPI
      • AWSUPI.OCPDeployment
      • AWSUPI.add_rhel_workers()
      • AWSUPI.build_ansible_inventory()
      • AWSUPI.check_connection()
      • AWSUPI.create_rhel_instance()
      • AWSUPI.deploy_ocp()
      • AWSUPI.destroy_cluster()
      • AWSUPI.gather_worker_data()
      • AWSUPI.get_kube_tag()
      • AWSUPI.get_ready_status()
      • AWSUPI.get_rhcos_workers()
      • AWSUPI.get_worker_resource_id()
      • AWSUPI.remove_rhcos_workers()
      • AWSUPI.run_ansible_playbook()
      • AWSUPI.verify_nodes_added()
  • ocs_ci.deployment.azure module
    • AZUREIPI
      • AZUREIPI.OCPDeployment
      • AZUREIPI.destroy_cluster()
  • ocs_ci.deployment.baremetal module
    • BAREMETALAI
      • BAREMETALAI.OCPDeployment
      • BAREMETALAI.destroy_cluster()
    • BAREMETALBASE
    • BAREMETALUPI
      • BAREMETALUPI.OCPDeployment
    • BMBaseOCPDeployment
      • BMBaseOCPDeployment.check_bm_status_exist()
      • BMBaseOCPDeployment.configure_dnsmasq_common_config()
      • BMBaseOCPDeployment.configure_dnsmasq_hosts_config()
      • BMBaseOCPDeployment.configure_dnsmasq_on_helper_vm()
      • BMBaseOCPDeployment.configure_dnsmasq_pxe_config()
      • BMBaseOCPDeployment.deploy_prereq()
      • BMBaseOCPDeployment.destroy()
      • BMBaseOCPDeployment.get_locked_username()
      • BMBaseOCPDeployment.helper_node_handler
      • BMBaseOCPDeployment.restart_dnsmasq_service_on_helper_vm()
      • BMBaseOCPDeployment.start_dnsmasq_service_on_helper_vm()
      • BMBaseOCPDeployment.stop_dnsmasq_service_on_helper_vm()
      • BMBaseOCPDeployment.update_bm_status()
    • BaremetalPSIUPI
      • BaremetalPSIUPI.OCPDeployment
    • clean_disk()
    • disks_available_to_cleanup()
  • ocs_ci.deployment.cert_manager module
    • deploy_cert_manager()
  • ocs_ci.deployment.cloud module
    • CloudDeploymentBase
      • CloudDeploymentBase.check_cluster_existence()
      • CloudDeploymentBase.deploy_ocp()
    • IPIOCPDeployment
      • IPIOCPDeployment.deploy()
      • IPIOCPDeployment.deploy_prereq()
  • ocs_ci.deployment.cnv module
    • CNVInstaller
      • CNVInstaller.catalog_source_created()
      • CNVInstaller.check_cnv_is_upgradable()
      • CNVInstaller.check_hyperconverged_healthy()
      • CNVInstaller.check_if_any_vm_and_vmi()
      • CNVInstaller.check_virtctl_compatibility()
      • CNVInstaller.cnv_hyperconverged_installed()
      • CNVInstaller.create_cnv_catalog_source()
      • CNVInstaller.create_cnv_namespace()
      • CNVInstaller.create_cnv_operatorgroup()
      • CNVInstaller.create_cnv_subscription()
      • CNVInstaller.deploy_cnv()
      • CNVInstaller.deploy_hyper_converged()
      • CNVInstaller.disable_multicluster_engine()
      • CNVInstaller.download_and_extract_virtctl_binary()
      • CNVInstaller.enable_software_emulation()
      • CNVInstaller.get_running_cnv_version()
      • CNVInstaller.get_virtctl_all_console_links()
      • CNVInstaller.get_virtctl_console_spec_links()
      • CNVInstaller.get_virtctl_download_url()
      • CNVInstaller.post_install_verification()
      • CNVInstaller.remove_cnv_csv()
      • CNVInstaller.remove_cnv_operator()
      • CNVInstaller.remove_cnv_subscription()
      • CNVInstaller.remove_crds()
      • CNVInstaller.remove_hyperconverged()
      • CNVInstaller.remove_namespace()
      • CNVInstaller.uninstall_cnv()
      • CNVInstaller.upgrade_cnv()
      • CNVInstaller.wait_for_the_resource_to_discover()
  • ocs_ci.deployment.deployment module
    • Deployment
      • Deployment.OCPDeployment
      • Deployment.acm_operator_installed()
      • Deployment.add_node()
      • Deployment.cleanup_pgsql_db()
      • Deployment.configure_acm_to_import_mce_clusters()
      • Deployment.deploy_acm_hub()
      • Deployment.deploy_acm_hub_released()
      • Deployment.deploy_acm_hub_unreleased()
      • Deployment.deploy_acm_hub_unreleased_konflux()
      • Deployment.deploy_cluster()
      • Deployment.deploy_gitops_operator()
      • Deployment.deploy_lvmo()
      • Deployment.deploy_multicluster_hub()
      • Deployment.deploy_ocp()
      • Deployment.deploy_ocs()
      • Deployment.deploy_ocs_via_operator()
      • Deployment.deploy_odf_addon()
      • Deployment.deploy_with_external_mode()
      • Deployment.deployment_with_ui()
      • Deployment.destroy_cluster()
      • Deployment.do_deploy_cert_manager()
      • Deployment.do_deploy_cnv()
      • Deployment.do_deploy_hosted_clusters()
      • Deployment.do_deploy_hyperconverged()
      • Deployment.do_deploy_lvmo()
      • Deployment.do_deploy_mce()
      • Deployment.do_deploy_metallb()
      • Deployment.do_deploy_oadp()
      • Deployment.do_deploy_ocp()
      • Deployment.do_deploy_ocs()
      • Deployment.do_deploy_odf_provider_mode()
      • Deployment.do_deploy_rdr()
      • Deployment.do_deploy_submariner()
      • Deployment.do_gitops_deploy()
      • Deployment.external_post_deploy_validation()
      • Deployment.get_arbiter_location()
      • Deployment.get_rdr_conf()
      • Deployment.label_and_taint_nodes()
      • Deployment.muliclusterhub_running()
      • Deployment.objectstore_user_check()
      • Deployment.odf_deployments_check()
      • Deployment.patch_default_sc_to_non_default()
      • Deployment.post_ocp_deploy()
      • Deployment.set_noobaa_core_for_rgw_ssl()
      • Deployment.subscribe_ocs()
      • Deployment.wait_for_csv()
      • Deployment.wait_for_subscription()
    • MDRMultiClusterDROperatorsDeploy
      • MDRMultiClusterDROperatorsDeploy.deploy()
      • MDRMultiClusterDROperatorsDeploy.deploy_dr_policy()
      • MDRMultiClusterDROperatorsDeploy.deploy_multicluster_orchestrator()
    • MultiClusterDROperatorsDeploy
      • MultiClusterDROperatorsDeploy.add_cacert_ramen_configmap()
      • MultiClusterDROperatorsDeploy.backup_pod_status_check()
      • MultiClusterDROperatorsDeploy.build_bucket_name()
      • MultiClusterDROperatorsDeploy.configure_mirror_peer()
      • MultiClusterDROperatorsDeploy.create_dpa()
      • MultiClusterDROperatorsDeploy.create_generic_credentials()
      • MultiClusterDROperatorsDeploy.create_s3_bucket()
      • MultiClusterDROperatorsDeploy.deploy()
      • MultiClusterDROperatorsDeploy.deploy_dr_multicluster_orchestrator()
      • MultiClusterDROperatorsDeploy.deploy_dr_policy()
      • MultiClusterDROperatorsDeploy.enable_cluster_backup()
      • MultiClusterDROperatorsDeploy.enable_managed_serviceaccount()
      • MultiClusterDROperatorsDeploy.mcg_meta_obj_store
      • MultiClusterDROperatorsDeploy.s3_meta_obj_store
      • MultiClusterDROperatorsDeploy.update_config_map_commit()
      • MultiClusterDROperatorsDeploy.update_ramen_config_misc()
      • MultiClusterDROperatorsDeploy.validate_dpa()
      • MultiClusterDROperatorsDeploy.validate_mirror_peer()
      • MultiClusterDROperatorsDeploy.validate_policy_compliance_status()
      • MultiClusterDROperatorsDeploy.validate_secret_creation_oadp()
      • MultiClusterDROperatorsDeploy.verify_dr_hub_operator()
    • RBDDRDeployOps
      • RBDDRDeployOps.configure_rbd()
      • RBDDRDeployOps.deploy()
      • RBDDRDeployOps.validate_csi_sidecar()
      • RBDDRDeployOps.validate_mirror_peer()
    • RDRMultiClusterDROperatorsDeploy
      • RDRMultiClusterDROperatorsDeploy.check_observability_status()
      • RDRMultiClusterDROperatorsDeploy.deploy()
      • RDRMultiClusterDROperatorsDeploy.enable_acm_observability()
      • RDRMultiClusterDROperatorsDeploy.thanos_secret()
    • create_catalog_source()
    • create_ocs_secret()
    • get_multicluster_dr_deployment()
    • setup_persistent_monitoring()
    • validate_acm_hub_install()
  • ocs_ci.deployment.disconnected module
    • get_csv_from_image()
    • mirror_images_from_mapping_file()
    • mirror_index_image_via_oc_mirror()
    • mirror_ocp_release_images()
    • prepare_disconnected_ocs_deployment()
    • prune_and_mirror_index_image()
  • ocs_ci.deployment.encryption module
    • add_encryption_details_to_cluster_data()
    • add_in_transit_encryption_to_cluster_data()
  • ocs_ci.deployment.factory module
    • DeploymentFactory
      • DeploymentFactory.get_deployment()
  • ocs_ci.deployment.flexy module
    • FlexyAWSUPI
    • FlexyBaremetalPSI
    • FlexyBase
      • FlexyBase.build_container_args()
      • FlexyBase.build_destroy_cmd()
      • FlexyBase.build_install_cmd()
      • FlexyBase.clone_and_unlock_ocs_private_conf()
      • FlexyBase.deploy()
      • FlexyBase.deploy_prereq()
      • FlexyBase.destroy()
      • FlexyBase.flexy_backup_work_dir()
      • FlexyBase.flexy_post_processing()
      • FlexyBase.flexy_prepare_work_dir()
      • FlexyBase.get_installer_payload()
      • FlexyBase.merge_flexy_env()
      • FlexyBase.run_container()
    • FlexyVSPHEREUPI
  • ocs_ci.deployment.fusion module
    • FusionDeployment
      • FusionDeployment.create_catalog_source()
      • FusionDeployment.create_namespace_and_operator_group()
      • FusionDeployment.create_spectrum_fusion_cr()
      • FusionDeployment.create_subscription()
      • FusionDeployment.deploy()
      • FusionDeployment.get_installed_version()
      • FusionDeployment.verify()
    • spectrum_fusion_status_check()
    • wait_for_csv()
    • wait_for_subscription()
  • ocs_ci.deployment.fusion_aas module
    • FUSIONAAS
      • FUSIONAAS.OCPDeployment
      • FUSIONAAS.deploy_ocp()
      • FUSIONAAS.deploy_ocs()
      • FUSIONAAS.destroy_ocs()
    • FUSIONAASOCP
      • FUSIONAASOCP.deploy()
  • ocs_ci.deployment.fusion_data_foundation module
    • FusionDataFoundationDeployment
      • FusionDataFoundationDeployment.create_fdf_service_cr()
      • FusionDataFoundationDeployment.create_image_digest_mirror_set()
      • FusionDataFoundationDeployment.create_image_tag_mirror_set()
      • FusionDataFoundationDeployment.create_odfcluster()
      • FusionDataFoundationDeployment.deploy()
      • FusionDataFoundationDeployment.get_installed_version()
      • FusionDataFoundationDeployment.patch_catalogsource()
      • FusionDataFoundationDeployment.setup_fdf_pre_release_deployment()
      • FusionDataFoundationDeployment.setup_storage()
      • FusionDataFoundationDeployment.verify_fdf_installation()
    • FusionServiceInstance
    • OdfCluster
    • add_storage_label()
    • extract_image_digest_mirror_set()
    • fusion_service_instance_health_check()
    • odfcluster_status_check()
    • run_patch_cmd()
    • storagecluster_health_check()
  • ocs_ci.deployment.gcp module
    • GCPIPI
      • GCPIPI.OCPDeployment
  • ocs_ci.deployment.hosted_cluster module
    • HostedClients
      • HostedClients.check_odf_prerequisites()
      • HostedClients.config_has_hosted_odf_image()
      • HostedClients.deploy_hosted_ocp_clusters()
      • HostedClients.deploy_multiple_odf_clients()
      • HostedClients.do_deploy()
      • HostedClients.download_hosted_clusters_kubeconfig_files()
      • HostedClients.get_kubeconfig_path()
      • HostedClients.storage_installation_requested()
      • HostedClients.verify_client_cluster_storage()
      • HostedClients.verify_hosted_ocp_clusters_from_provider()
    • HostedODF
      • HostedODF.apply_network_policy()
      • HostedODF.catalog_source_exists()
      • HostedODF.create_catalog_source()
      • HostedODF.create_ns()
      • HostedODF.create_operator_group()
      • HostedODF.create_storage_claim_cephfs()
      • HostedODF.create_storage_claim_rbd()
      • HostedODF.create_storage_client()
      • HostedODF.create_subscription()
      • HostedODF.csi_pods_exist()
      • HostedODF.do_deploy()
      • HostedODF.enable_client_console_plugin()
      • HostedODF.exec_oc_cmd()
      • HostedODF.get_onboarding_key()
      • HostedODF.get_onboarding_key_ui()
      • HostedODF.get_provider_address()
      • HostedODF.get_storage_client_status()
      • HostedODF.network_policy_exists()
      • HostedODF.odf_client_installed()
      • HostedODF.odf_csv_installed()
      • HostedODF.operator_group_exists()
      • HostedODF.setup_storage_client()
      • HostedODF.setup_storage_client_converged()
      • HostedODF.storage_claim_exists_cephfs()
      • HostedODF.storage_claim_exists_rbd()
      • HostedODF.storage_class_exists()
      • HostedODF.storage_client_exists()
      • HostedODF.subscription_exists()
      • HostedODF.wait_console_plugin_pod_running()
      • HostedODF.wait_storage_claim_cephfs()
      • HostedODF.wait_storage_claim_rbd()
    • HypershiftHostedOCP
      • HypershiftHostedOCP.deploy_dependencies()
      • HypershiftHostedOCP.deploy_ocp()
    • apply_cluster_roles_wa()
    • apply_hosted_cluster_mirrors_max_items_wa()
    • apply_hosted_control_plane_mirrors_max_items_wa()
    • create_agent_service_config()
    • create_host_inventory()
    • get_autodistributed_storage_classes()
    • get_autodistributed_volume_snapshot_classes()
    • get_onboarding_token_from_secret()
    • hypershift_cluster_factory()
    • verify_backing_ceph_storage_for_clients()
  • ocs_ci.deployment.hyperconverged module
    • HyperConverged
      • HyperConverged.create_catalog_source()
      • HyperConverged.create_hyperconverged_instance()
      • HyperConverged.create_hyperconverged_namespace()
      • HyperConverged.create_operator_group()
      • HyperConverged.create_subscription()
      • HyperConverged.deploy_hyperconverged()
    • get_hyperconverged_corresponding_version()
    • get_ocp_corresponding_version()
  • ocs_ci.deployment.ibm module
    • IBMDeployment
      • IBMDeployment.destroy_lso()
      • IBMDeployment.destroy_ocs()
  • ocs_ci.deployment.ibmcloud module
    • IBMCloud
      • IBMCloud.OCPDeployment
      • IBMCloud.check_cluster_existence()
      • IBMCloud.deploy_ocp()
    • IBMCloudIPI
      • IBMCloudIPI.OCPDeployment
      • IBMCloudIPI.check_cluster_existence()
      • IBMCloudIPI.delete_bucket()
      • IBMCloudIPI.delete_leftover_resources()
      • IBMCloudIPI.delete_resource_group()
      • IBMCloudIPI.delete_volumes()
      • IBMCloudIPI.deploy_ocp()
      • IBMCloudIPI.destroy_cluster()
      • IBMCloudIPI.export_api_key()
      • IBMCloudIPI.get_load_balancers()
      • IBMCloudIPI.get_load_balancers_count()
      • IBMCloudIPI.get_resource_group()
      • IBMCloudIPI.manually_create_iam_for_vpc()
      • IBMCloudIPI.prepare_custom_vpc_and_network()
  • ocs_ci.deployment.ingress_node_firewall module
    • IngressNodeFirewallInstaller
      • IngressNodeFirewallInstaller.check_existing_packagemanifests()
      • IngressNodeFirewallInstaller.create_config()
      • IngressNodeFirewallInstaller.create_namespace()
      • IngressNodeFirewallInstaller.create_operatorgroup()
      • IngressNodeFirewallInstaller.create_rules()
      • IngressNodeFirewallInstaller.create_subscription()
      • IngressNodeFirewallInstaller.verify_csv_status()
    • deploy_ingress_node_firewall()
    • restrict_ssh_access_to_nodes()
  • ocs_ci.deployment.install_ocp_on_rhel module
    • OCPINSTALLRHEL
      • OCPINSTALLRHEL.create_inventory()
      • OCPINSTALLRHEL.create_inventory_for_haproxy()
      • OCPINSTALLRHEL.execute_ansible_playbook()
      • OCPINSTALLRHEL.prepare_rhel_nodes()
      • OCPINSTALLRHEL.upload_helpers()
  • ocs_ci.deployment.mce module
    • MCEInstaller
      • MCEInstaller.check_hypershift_namespace()
      • MCEInstaller.check_supported_versions()
      • MCEInstaller.create_image_override()
      • MCEInstaller.create_mce_namespace()
      • MCEInstaller.create_mce_subscription()
      • MCEInstaller.create_multiclusterengine_operatorgroup()
      • MCEInstaller.create_multiclusterengine_resource()
      • MCEInstaller.deploy_mce()
      • MCEInstaller.get_supported_versions()
      • MCEInstaller.mce_exists()
      • MCEInstaller.mce_installed()
      • MCEInstaller.wait_mce_resources()
  • ocs_ci.deployment.metallb module
    • MetalLBInstaller
      • MetalLBInstaller.apply_icsp()
      • MetalLBInstaller.apply_idms()
      • MetalLBInstaller.catalog_source_created()
      • MetalLBInstaller.create_catalog_source()
      • MetalLBInstaller.create_ip_address_pool()
      • MetalLBInstaller.create_l2advertisement()
      • MetalLBInstaller.create_metallb_instance()
      • MetalLBInstaller.create_metallb_namespace()
      • MetalLBInstaller.create_metallb_operator_group()
      • MetalLBInstaller.create_metallb_subscription()
      • MetalLBInstaller.delete_catalogsource()
      • MetalLBInstaller.delete_ipaddresspool()
      • MetalLBInstaller.delete_l2advertisement()
      • MetalLBInstaller.delete_metallb_namespace()
      • MetalLBInstaller.delete_operatorgroup()
      • MetalLBInstaller.delete_subscription()
      • MetalLBInstaller.deploy_lb()
      • MetalLBInstaller.get_running_metallb_version()
      • MetalLBInstaller.idms_brew_registry_exists()
      • MetalLBInstaller.ip_address_pool_created()
      • MetalLBInstaller.l2advertisement_created()
      • MetalLBInstaller.metallb_instance_created()
      • MetalLBInstaller.metallb_kind_available()
      • MetalLBInstaller.metallb_operator_group_created()
      • MetalLBInstaller.metallb_patch_subscription()
      • MetalLBInstaller.subscription_created()
      • MetalLBInstaller.undeploy()
      • MetalLBInstaller.update_ip_address_pool_cr()
      • MetalLBInstaller.upgrade_metallb()
      • MetalLBInstaller.wait_csv_installed()
  • ocs_ci.deployment.multicluster_deployment module
    • OCPDeployWithACM
      • OCPDeployWithACM.deploy_cluster()
      • OCPDeployWithACM.destroy_cluster()
      • OCPDeployWithACM.do_deploy_ocp()
      • OCPDeployWithACM.do_rdr_acm_ocp_deploy()
      • OCPDeployWithACM.post_deploy_ops()
      • OCPDeployWithACM.post_destroy_ops()
      • OCPDeployWithACM.wait_for_all_cluster_async_destroy()
      • OCPDeployWithACM.wait_for_all_clusters_async()
  • ocs_ci.deployment.netsplit module
    • get_netsplit_mc()
  • ocs_ci.deployment.nmstate module
    • NMStateInstaller
      • NMStateInstaller.count_nmstate_pods_running()
      • NMStateInstaller.create_nmstate_instance()
      • NMStateInstaller.create_nmstate_operator_namespace()
      • NMStateInstaller.create_nmstate_operatorgroup()
      • NMStateInstaller.create_nmstate_subscription()
      • NMStateInstaller.running_nmstate()
      • NMStateInstaller.verify_nmstate_csv_status()
      • NMStateInstaller.verify_nmstate_pods_running()
  • ocs_ci.deployment.ocp module
    • OCPDeployment
      • OCPDeployment.create_config()
      • OCPDeployment.deploy()
      • OCPDeployment.deploy_prereq()
      • OCPDeployment.destroy()
      • OCPDeployment.download_installer()
      • OCPDeployment.get_pull_secret()
      • OCPDeployment.get_ssh_key()
      • OCPDeployment.test_cluster()
    • download_pull_secret()
  • ocs_ci.deployment.on_prem module
    • IPIOCPDeployment
      • IPIOCPDeployment.deploy()
      • IPIOCPDeployment.deploy_prereq()
    • OnPremDeploymentBase
      • OnPremDeploymentBase.check_cluster_existence()
      • OnPremDeploymentBase.deploy_ocp()
  • ocs_ci.deployment.openshift_dedicated module
    • OpenshiftDedicated
      • OpenshiftDedicated.OCPDeployment
      • OpenshiftDedicated.check_cluster_existence()
      • OpenshiftDedicated.deploy_ocp()
    • OpenshiftDedicatedOCP
      • OpenshiftDedicatedOCP.deploy()
      • OpenshiftDedicatedOCP.deploy_prereq()
      • OpenshiftDedicatedOCP.destroy()
  • ocs_ci.deployment.qe_app_registry module
    • QeAppRegistry
      • QeAppRegistry.catalog_source()
      • QeAppRegistry.icsp()
      • QeAppRegistry.icsp_brew_registry_exists()
  • ocs_ci.deployment.rhv module
    • RHVIPI
      • RHVIPI.OCPDeployment
  • ocs_ci.deployment.rosa module
    • ROSA
      • ROSA.OCPDeployment
      • ROSA.check_cluster_existence()
      • ROSA.deploy_ocp()
      • ROSA.deploy_ocs()
      • ROSA.destroy_ocs()
      • ROSA.host_network_update()
    • ROSAOCP
      • ROSAOCP.cluster_present()
      • ROSAOCP.deploy()
      • ROSAOCP.deploy_prereq()
      • ROSAOCP.destroy()
  • ocs_ci.deployment.terraform module
    • Terraform
      • Terraform.apply()
      • Terraform.change_statefile()
      • Terraform.destroy()
      • Terraform.destroy_module()
      • Terraform.get_terraform_version()
      • Terraform.initialize()
      • Terraform.output()
  • ocs_ci.deployment.vmware module
    • VSPHEREAI
      • VSPHEREAI.OCPDeployment
      • VSPHEREAI.deploy_ocp()
      • VSPHEREAI.destroy_cluster()
    • VSPHEREIPI
      • VSPHEREIPI.OCPDeployment
      • VSPHEREIPI.deploy_ocp()
      • VSPHEREIPI.destroy_cluster()
      • VSPHEREIPI.post_destroy_checks()
    • VSPHEREUPI
      • VSPHEREUPI.OCPDeployment
      • VSPHEREUPI.deploy_ocp()
      • VSPHEREUPI.destroy_cluster()
      • VSPHEREUPI.destroy_scaleup_nodes()
  • ocs_ci.deployment.zones module
    • are_zone_labels_missing()
    • are_zone_labels_present()
    • assign_dummy_zones()
    • create_dummy_zone_labels()
  • Module contents
• ocs_ci.framework package
  • Subpackages
    • ocs_ci.framework.pytest_customization package
      • Subpackages
      • Submodules
      • ocs_ci.framework.pytest_customization.marks module
      • ocs_ci.framework.pytest_customization.ocscilib module
      • ocs_ci.framework.pytest_customization.reports module
      • Module contents
    • ocs_ci.framework.tests package
      • Submodules
      • ocs_ci.framework.tests.conftest module
      • ocs_ci.framework.tests.test_config module
      • ocs_ci.framework.tests.test_custom_logger module
      • ocs_ci.framework.tests.test_main module
      • Module contents
  • Submodules
  • ocs_ci.framework.custom_logger module
    • OCSCILogger
      • OCSCILogger.ai_data()
      • OCSCILogger.assertion()
      • OCSCILogger.test_step()
    • get_current_step()
    • increment_step()
    • reset_step_counts()
  • ocs_ci.framework.deploy module
    • main()
  • ocs_ci.framework.exceptions module
    • ClusterNameLengthError
    • ClusterNameNotProvidedError
    • ClusterNotAccessibleError
    • ClusterPathNotProvidedError
    • InvalidDeploymentType
  • ocs_ci.framework.logger_factory module
    • record_factory()
    • set_log_record_factory()
  • ocs_ci.framework.logger_helper module
    • log_step()
  • ocs_ci.framework.main module
    • main()
  • ocs_ci.framework.testlib module
    • BaseTest
      • BaseTest.pytestmark
    • E2ETest
      • E2ETest.pytestmark
    • EcosystemTest
      • EcosystemTest.pytestmark
    • MCGTest
      • MCGTest.MAX_ENDPOINT_COUNT
      • MCGTest.MIN_ENDPOINT_COUNT
      • MCGTest.pytestmark
    • ManageTest
      • ManageTest.pytestmark
  • Module contents
    • Config
      • Config.AUTH
      • Config.COMPONENTS
      • Config.DEPLOYMENT
      • Config.ENV_DATA
      • Config.EXTERNAL_MODE
      • Config.FLEXY
      • Config.MULTICLUSTER
      • Config.PERF
      • Config.PREUPGRADE_CONFIG
      • Config.REPORTING
      • Config.RUN
      • Config.UI_SELENIUM
      • Config.UPGRADE
      • Config.get_defaults()
      • Config.reset()
      • Config.to_dict()
      • Config.update()
    • ConfigSafeThread
      • ConfigSafeThread.run()
    • GlobalVariables
      • GlobalVariables.TIMEREPORT_DICT
    • MultiClusterConfig
      • MultiClusterConfig.RunWithAcmConfigContext
      • MultiClusterConfig.RunWithConfigContext
      • MultiClusterConfig.RunWithFirstConsumerConfigContextIfAvailable
      • MultiClusterConfig.RunWithPrimaryConfigContext
      • MultiClusterConfig.RunWithProviderConfigContextIfAvailable
      • MultiClusterConfig.cluster_ctx
      • MultiClusterConfig.current_cluster_name()
      • MultiClusterConfig.default_cluster_ctx
      • MultiClusterConfig.default_cluster_index
      • MultiClusterConfig.designate_active_acm_cluster()
      • MultiClusterConfig.get_active_acm_index()
      • MultiClusterConfig.get_client_contexts_if_available()
      • MultiClusterConfig.get_cluster_index_by_name()
      • MultiClusterConfig.get_cluster_name_by_index()
      • MultiClusterConfig.get_cluster_type_indices_list()
      • MultiClusterConfig.get_consumer_indexes_list()
      • MultiClusterConfig.get_provider_cluster_indexes()
      • MultiClusterConfig.get_provider_index()
      • MultiClusterConfig.hci_client_exist()
      • MultiClusterConfig.hci_provider_exist()
      • MultiClusterConfig.init_cluster_configs()
      • MultiClusterConfig.insert_cluster_config()
      • MultiClusterConfig.is_cluster_type_exist()
      • MultiClusterConfig.is_consumer_exist()
      • MultiClusterConfig.is_provider_exist()
      • MultiClusterConfig.remove_cluster()
      • MultiClusterConfig.remove_cluster_by_name()
      • MultiClusterConfig.reset()
      • MultiClusterConfig.reset_ctx()
      • MultiClusterConfig.run_for_all_clusters()
      • MultiClusterConfig.run_with_provider_context_if_available()
      • MultiClusterConfig.switch_acm_ctx()
      • MultiClusterConfig.switch_ctx()
      • MultiClusterConfig.switch_default_cluster_ctx()
      • MultiClusterConfig.switch_to_cluster_by_cluster_type()
      • MultiClusterConfig.switch_to_cluster_by_name()
      • MultiClusterConfig.switch_to_consumer()
      • MultiClusterConfig.switch_to_provider()
      • MultiClusterConfig.update()
    • config_safe_thread_pool_task()
    • merge_dict()
• ocs_ci.helpers package
  • Submodules
  • ocs_ci.helpers.bdi_helpers module
    • clean_temp_files()
    • init_configure_workload_yaml()
    • init_data_load_yaml()
    • init_run_workload_yaml()
    • install_db2u()
  • ocs_ci.helpers.ceph_helpers module
    • wait_for_percent_used_capacity_reached()
  • ocs_ci.helpers.cluster_exp_helpers module
    • BackgroundOps
      • BackgroundOps.EXPANSION_COMPLETED
      • BackgroundOps.wrap()
    • ClusterFiller
      • ClusterFiller.cluster_filler()
      • ClusterFiller.concurrent_copies
      • ClusterFiller.filler()
    • check_nodes_status()
    • cluster_copy_ops()
    • raw_block_io()
  • ocs_ci.helpers.cnv_helpers module
    • cal_md5sum_vm()
    • check_fio_status()
    • clone_dv()
    • convert_ssh_key_to_base64()
    • create_dv()
    • create_fio_service()
    • create_pvc_using_data_source()
    • create_vm_secret()
    • create_volume_import_source()
    • expand_pvc_and_verify()
    • get_pvc_from_vm()
    • get_secret_from_vm()
    • get_ssh_private_key_path()
    • get_ssh_pub_key_with_filename()
    • get_volumeimportsource()
    • install_fio_on_vm()
    • run_dd_io()
    • run_fio()
    • verify_hotplug()
    • verifyvolume()
  • ocs_ci.helpers.disconnected module
    • get_oc_mirror_tool()
    • get_opm_tool()
  • ocs_ci.helpers.disruption_helpers module
    • Disruptions
      • Disruptions.check_new_pid()
      • Disruptions.cluster_kubeconfig
      • Disruptions.daemon_pid
      • Disruptions.delete_resource()
      • Disruptions.kill_daemon()
      • Disruptions.kubeconfig_parameter()
      • Disruptions.resource
      • Disruptions.resource_count
      • Disruptions.resource_obj
      • Disruptions.select_daemon()
      • Disruptions.selector
      • Disruptions.set_resource()
    • delete_resource_multiple_times()
  • ocs_ci.helpers.dr_helpers module
    • add_label_to_appsub()
    • apply_drpolicy_to_workload()
    • check_mirroring_status_for_custom_pool()
    • check_mirroring_status_ok()
    • check_storage_cluster_peer_state()
    • check_vr_state()
    • check_vrg_existence()
    • check_vrg_state()
    • configure_drcluster_for_fencing()
    • configure_rdr_hub_recovery()
    • create_backup_schedule()
    • create_klusterlet_config()
    • create_service_exporter()
    • disable_dr_from_app()
    • disable_dr_rdr()
    • do_discovered_apps_cleanup()
    • do_discovered_apps_cleanup_multi_ns()
    • enable_fence()
    • enable_unfence()
    • failover()
    • fence_state()
    • generate_kubeobject_capture_interval()
    • get_all_drclusters()
    • get_all_drpolicy()
    • get_backend_volumes_for_pvcs()
    • get_cluster_set_name()
    • get_current_primary_cluster_name()
    • get_current_secondary_cluster_name()
    • get_fence_state()
    • get_managed_cluster_node_ips()
    • get_nodes_from_active_zone()
    • get_pv_count()
    • get_replicationdestinations_count()
    • get_replicationsources_count()
    • get_scheduling_interval()
    • get_vr_count()
    • gracefully_reboot_ocp_nodes()
    • relocate()
    • remove_parameter_klusterlet_config()
    • replace_cluster()
    • restore_backup()
    • set_current_primary_cluster_context()
    • set_current_secondary_cluster_context()
    • validate_storage_cluster_peer_state()
    • verify_backend_volume_deletion()
    • verify_backup_is_taken()
    • verify_drpc_placement_deletion()
    • verify_drpolicy_cli()
    • verify_fence_state()
    • verify_last_group_sync_time()
    • verify_last_kubeobject_protection_time()
    • verify_restore_is_completed()
    • verify_volsync()
    • wait_for_all_resources_creation()
    • wait_for_all_resources_deletion()
    • wait_for_backend_volume_deletion()
    • wait_for_cnv_workload()
    • wait_for_mirroring_status_ok()
    • wait_for_replication_destinations_creation()
    • wait_for_replication_destinations_deletion()
    • wait_for_replication_resources_creation()
    • wait_for_replication_resources_deletion()
    • wait_for_vrg_state()
  • ocs_ci.helpers.dr_helpers_ui module
    • application_count_on_ui()
    • assign_drpolicy_for_discovered_vms_via_ui()
    • check_apps_running_on_selected_cluster()
    • check_cluster_operator_status()
    • check_cluster_status_on_acm_console()
    • clusters_in_dr_relationship()
    • delete_application_ui()
    • dr_submariner_validation_from_ui()
    • failover_relocate_ui()
    • health_and_peer_connection_check_on_ui()
    • protected_volume_count_per_cluster()
    • verify_application_present_in_ui()
    • verify_drpolicy_ui()
    • verify_failover_relocate_status_ui()
  • ocs_ci.helpers.e2e_helpers module
    • create_muliple_types_provider_obcs()
    • validate_mcg_bucket_replicaton()
    • validate_mcg_caching()
    • validate_mcg_nsfs_feature()
    • validate_mcg_object_expiration()
    • validate_rgw_kafka_notification()
    • verify_osd_used_capacity_greater_than_expected()
  • ocs_ci.helpers.github module
    • get_asset_from_github()
  • ocs_ci.helpers.helpers module
    • add_route_public_nad()
    • add_scc_policy()
    • apply_custom_taint_and_toleration()
    • calc_local_file_md5_sum()
    • change_default_storageclass()
    • change_reclaimspacecronjob_state_for_pvc()
    • change_vm_network_state()
    • check_cluster_is_compact()
    • check_number_of_mon_pods()
    • check_osd_log_exist_on_rook_ceph_operator_pod()
    • check_pods_status_by_pattern()
    • check_rbd_image_used_size()
    • check_rook_ceph_crashcollector_pods_where_rook_ceph_pods_are_running()
    • check_selinux_relabeling()
    • clean_all_test_projects()
    • clear_crash_warning_and_osd_removal_leftovers()
    • collect_performance_stats()
    • configure_cephcluster_params_in_storagecluster_cr()
    • configure_node_network_configuration_policy_on_all_worker_nodes()
    • converge_lists()
    • craft_s3_command()
    • create_auto_scaler()
    • create_build_from_docker_image()
    • create_ceph_block_pool()
    • create_ceph_file_system()
    • create_lvs_resource()
    • create_multilpe_projects()
    • create_multiple_pvc_parallel()
    • create_multiple_pvcs()
    • create_network_fence()
    • create_network_fence_class()
    • create_ocs_object_from_kind_and_name()
    • create_pod()
    • create_pods()
    • create_pods_parallel()
    • create_priority_class()
    • create_project()
    • create_pvc()
    • create_rbd_deviceclass_storageclass()
    • create_reclaim_space_cronjob()
    • create_reclaim_space_job()
    • create_resource()
    • create_sa_token_secret()
    • create_scc()
    • create_secret()
    • create_serviceaccount()
    • create_storage_class()
    • create_unique_resource_name()
    • default_ceph_block_pool()
    • default_storage_class()
    • default_thick_storage_class()
    • default_volumesnapshotclass()
    • delete_bulk_pvcs()
    • delete_cephblockpools()
    • delete_csi_holder_daemonsets()
    • delete_csi_holder_pods()
    • delete_objs_parallel()
    • delete_storageclasses()
    • delete_volume_in_backend()
    • disable_vm_network_for_duration()
    • enable_csi_disable_holder_pods()
    • fetch_used_size()
    • find_cephblockpoolradosnamespace()
    • find_cephfilesystemsubvolumegroup()
    • flatten_multilevel_dict()
    • get_admin_key()
    • get_all_pvs()
    • get_all_storageclass_names()
    • get_architecture_path()
    • get_ceph_log_level()
    • get_cephblockpool_names()
    • get_cephfs_data_pool_name()
    • get_cephfs_name()
    • get_cephfs_sc_name()
    • get_cephfs_subvolumegroup()
    • get_cephfs_subvolumegroup_names()
    • get_current_test_name()
    • get_daemonsets_names()
    • get_daemonsets_obj()
    • get_default_storage_class()
    • get_end_creation_time()
    • get_end_deletion_time()
    • get_event_line_datetime()
    • get_failure_domain()
    • get_failure_domin()
    • get_full_test_logs_path()
    • get_last_log_time_date()
    • get_logs_rook_ceph_operator()
    • get_logs_with_errors()
    • get_managed_cluster_addons()
    • get_memory_leak_median_value()
    • get_mon_db_size_in_kb()
    • get_mon_pdb()
    • get_network_attachment_definitions()
    • get_node_plugin_label()
    • get_noobaa_db_credentials_from_secret()
    • get_noobaa_db_size()
    • get_noobaa_db_usage_percent()
    • get_noobaa_db_used_space()
    • get_noobaa_url()
    • get_pods_nodes_logs()
    • get_pool_cr()
    • get_provision_time()
    • get_provisioner_label()
    • get_pv_names()
    • get_pv_size()
    • get_rbd_daemonset_csi_addons_node_object()
    • get_rbd_image_info()
    • get_rbd_sc_name()
    • get_reclaimspacecronjob_for_pvc()
    • get_rook_ceph_pod_events()
    • get_rook_ceph_pod_events_by_keyword()
    • get_s3_credentials_from_secret()
    • get_secret_names()
    • get_serviceaccount_obj()
    • get_snapshot_content_obj()
    • get_start_creation_time()
    • get_start_deletion_time()
    • get_volsync_channel()
    • induce_mon_quorum_loss()
    • ip_from_subnet_offset()
    • is_rbd_default_storage_class()
    • is_volume_present_in_backend()
    • label_worker_node()
    • measure_pv_deletion_time_bulk()
    • measure_pvc_creation_time()
    • measure_pvc_creation_time_bulk()
    • measure_pvc_deletion_time()
    • memory_leak_analysis()
    • modify_deployment_replica_count()
    • modify_deploymentconfig_replica_count()
    • modify_job_parallelism_count()
    • modify_osd_replica_count()
    • modify_statefulset_replica_count()
    • mon_pods_running_on_same_node()
    • odf_cli_set_log_level()
    • pod_start_time()
    • pull_images()
    • recover_mon_quorum()
    • refresh_oc_login_connection()
    • remove_label_from_worker_node()
    • remove_ocs_object_from_list()
    • remove_port_from_url()
    • remove_scc_policy()
    • remove_toleration()
    • reset_all_osd_pods()
    • restart_node_if_debug_doesnt_work()
    • retrieve_cli_binary()
    • retrieve_default_ingress_crt()
    • rsync_kubeconf_to_node()
    • run_cmd_verify_cli_output()
    • run_io_with_rados_bench()
    • scale_nb_resources()
    • select_unique_pvcs()
    • set_configmap_log_level_csi_sidecar()
    • set_configmap_log_level_rook_ceph_operator()
    • set_image_lookup()
    • set_rook_log_level()
    • setup_pod_directories()
    • storagecluster_independent_check()
    • unfence_node()
    • update_volsync_channel()
    • upgrade_multus_holder_design()
    • validate_cephfilesystem()
    • validate_pod_oomkilled()
    • validate_pods_are_running_and_not_restarted()
    • validate_pv_delete()
    • validate_scc_policy()
    • verify_block_pool_exists()
    • verify_csi_holder_pods_do_not_exist()
    • verify_log_exist_in_pods_logs()
    • verify_nb_db_psql_version()
    • verify_pdb_mon()
    • verify_performance_profile_change()
    • verify_pod_pattern_does_not_exist()
    • verify_pv_mounted_on_node()
    • verify_pvc_size()
    • verify_quota_resource_exist()
    • verify_reclaimspacecronjob_suspend_state_for_pvc()
    • verify_rook_ceph_crashcollector_pods_where_rook_ceph_pods_are_running()
    • verify_storagecluster_nodetopology()
    • verify_volume_deleted_in_backend()
    • wait_for_ct_pod_recovery()
    • wait_for_pv_delete()
    • wait_for_reclaim_space_cronjob()
    • wait_for_reclaim_space_job()
    • wait_for_resource_count_change()
    • wait_for_resource_state()
    • wait_for_rook_ceph_pod_status()
  • ocs_ci.helpers.keyrotation_helper module
    • KeyRotation
      • KeyRotation.disable_keyrotation()
      • KeyRotation.enable_keyrotation()
      • KeyRotation.get_keyrotation_schedule()
      • KeyRotation.is_keyrotation_enable()
      • KeyRotation.set_keyrotation_defaults()
      • KeyRotation.set_keyrotation_schedule()
    • NoobaaKeyrotation
      • NoobaaKeyrotation.get_noobaa_backend_secret()
      • NoobaaKeyrotation.get_noobaa_keyrotation_schedule()
      • NoobaaKeyrotation.get_noobaa_volume_secret()
      • NoobaaKeyrotation.is_noobaa_keyrotation_enable()
    • OSDKeyrotation
      • OSDKeyrotation.enable_osd_keyrotatio()
      • OSDKeyrotation.get_osd_dm_crypt()
      • OSDKeyrotation.get_osd_keyrotation_schedule()
      • OSDKeyrotation.is_osd_keyrotation_enabled()
      • OSDKeyrotation.verify_keyrotation()
      • OSDKeyrotation.verify_osd_keyrotation_for_kms()
    • PVKeyrotation
      • PVKeyrotation.annotate_storageclass_key_rotation()
      • PVKeyrotation.change_pvc_keyrotation_cronjob_state()
      • PVKeyrotation.compare_keys()
      • PVKeyrotation.get_keyrotation_cronjob_for_pvc()
      • PVKeyrotation.get_pvc_keys_data()
      • PVKeyrotation.set_keyrotation_state_by_annotation()
      • PVKeyrotation.set_keyrotation_state_by_rbac_user()
      • PVKeyrotation.wait_till_all_pv_keyrotation_on_vault_kms()
      • PVKeyrotation.wait_till_keyrotation()
    • compare_noobaa_old_keys_with_new_keys()
    • validate_key_rotation_schedules()
    • verify_new_key_after_rotation()
  • ocs_ci.helpers.longevity_helpers module
    • create_restore_verify_snapshots()
    • expand_verify_pvcs()
    • measure_pod_creation_time()
    • measure_pod_to_pvc_attach_time()
    • measure_pvc_creation_time()
    • measure_pvc_deletion_time()
    • write_empty_files_to_bucket()
  • ocs_ci.helpers.managed_services module
    • get_all_storageclassclaims()
    • get_ocs_osd_deployer_version()
    • get_storageclassclaims_of_storageclient()
    • get_used_capacity()
    • verify_client_operator_security()
    • verify_faas_cluster_secrets()
    • verify_faas_consumer_resources()
    • verify_faas_provider_resources()
    • verify_faas_provider_storagecluster()
    • verify_faas_provider_storagecluster_storages()
    • verify_faas_resources()
    • verify_osd_distribution_on_provider()
    • verify_osd_used_capacity_greater_than_expected()
    • verify_pods_in_managed_fusion_namespace()
    • verify_provider_aws_volumes()
    • verify_provider_topology()
    • verify_storageclient()
    • verify_storageclient_storageclass_claims()
  • ocs_ci.helpers.mcg_stress_helper module
    • delete_objects_in_batches()
    • delete_objs_from_bucket()
    • download_objs_from_bucket()
    • get_mcg_obj()
    • list_objs_from_bucket()
    • run_background_cluster_checks()
    • run_noobaa_metadata_intense_ops()
    • sync_object_directory_with_retry()
    • upload_objs_to_buckets()
  • ocs_ci.helpers.odf_cli module
    • ODFCLIRetriever
      • ODFCLIRetriever.add_cli_to_path()
      • ODFCLIRetriever.check_odf_cli_binary()
      • ODFCLIRetriever.retrieve_odf_cli_binary()
    • ODFCliRunner
      • ODFCliRunner.get_recovery_profile()
      • ODFCliRunner.run_command()
      • ODFCliRunner.run_get_health()
      • ODFCliRunner.run_get_mon_endpoint()
      • ODFCliRunner.run_get_recovery_profile()
      • ODFCliRunner.run_help()
      • ODFCliRunner.run_maintenance_start()
      • ODFCliRunner.run_maintenance_stop()
      • ODFCliRunner.run_rook_restart()
      • ODFCliRunner.run_rook_set_log_level()
      • ODFCliRunner.run_set_ceph_log_level()
      • ODFCliRunner.run_set_recovery_profile()
      • ODFCliRunner.run_set_recovery_profile_balanced()
      • ODFCliRunner.run_set_recovery_profile_high()
      • ODFCliRunner.run_set_recovery_profile_low()
    • odf_cli_setup_helper()
  • ocs_ci.helpers.osd_resize module
    • base_ceph_verification_steps_post_resize_osd()
    • basic_resize_osd()
    • ceph_verification_steps_post_resize_osd()
    • check_ceph_health_after_resize_osd()
    • check_ceph_state_post_resize_osd()
    • check_resize_osd_pre_conditions()
    • check_resources_state_post_resize_osd()
    • check_storage_size_is_reflected()
    • check_storage_size_is_reflected_in_ui()
    • update_resize_osd_count()
  • ocs_ci.helpers.performance_lib module
    • calculate_operation_time()
    • csi_bulk_pvc_time_measure()
    • csi_pvc_time_measure()
    • extruct_timestamp_from_log()
    • get_logfile_names()
    • get_pvc_provision_times()
    • get_snapshot_time()
    • measure_csi_snapshot_creation_time()
    • measure_pvc_creation_time()
    • measure_total_snapshot_creation_time()
    • pod_attach_csi_time()
    • pod_bulk_attach_csi_time()
    • read_csi_logs()
    • run_command()
    • run_oc_command()
    • string_to_time()
    • wait_for_cronjobs()
    • wait_for_resource_bulk_status()
    • write_fio_on_pod()
  • ocs_ci.helpers.proxy module
    • get_cluster_proxies()
    • update_container_with_proxy_env()
  • ocs_ci.helpers.pvc_ops module
    • create_pvcs()
    • delete_pods()
    • test_create_delete_pvcs()
  • ocs_ci.helpers.sanity_helpers module
    • Sanity
      • Sanity.create_pvc_delete()
      • Sanity.create_resources()
      • Sanity.delete_resources()
      • Sanity.health_check()
      • Sanity.obc_put_obj_create_delete()
    • SanityExternalCluster
    • SanityManagedService
      • SanityManagedService.base_create_resources_on_ms_consumers()
      • SanityManagedService.create_resources_on_ms_consumers()
      • SanityManagedService.delete_resources_on_ms_consumers()
      • SanityManagedService.health_check_ms()
    • SanityProviderMode
      • SanityProviderMode.base_create_resources_on_clients()
      • SanityProviderMode.create_resources_on_clients()
      • SanityProviderMode.delete_resources_on_clients()
      • SanityProviderMode.health_check_provider_mode()
  • ocs_ci.helpers.storage_auto_scaler module
    • delete_all_storage_autoscalers()
    • generate_default_scaling_threshold()
    • get_all_storage_autoscaler_names()
    • safe_teardown_delete_all_autoscalers()
    • verify_autoscaler_status_not_trigger()
    • wait_for_auto_scaler_status()
  • ocs_ci.helpers.stretchcluster_helper module
    • check_for_logwriter_workload_pods()
    • recover_by_zone_restart()
    • recover_from_ceph_stuck()
    • recover_workload_pods_post_recovery()
    • verify_data_corruption()
    • verify_data_loss()
    • verify_vm_workload()
  • ocs_ci.helpers.vdbench_helpers module
    • auto_add_openflags_if_raw_device()
    • cleanup_vdbench_resources()
    • create_temp_config_file()
    • create_vdbench_block_scenario()
    • create_vdbench_config_from_dict()
    • create_vdbench_performance_report()
    • create_vdbench_performance_scenario()
    • create_vdbench_rwx_scenario()
    • get_default_vdbench_configs()
    • get_vdbench_logs()
    • get_vdbench_pods()
    • monitor_vdbench_workload()
    • parse_vdbench_output()
    • validate_vdbench_config()
    • validate_vdbench_workload_health()
    • wait_for_vdbench_pods_ready()
  • ocs_ci.helpers.virtctl module
    • get_virtctl_tool()
  • Module contents
• ocs_ci.ocs package
  • Subpackages
    • ocs_ci.ocs.acm package
      • Submodules
      • ocs_ci.ocs.acm.acm module
      • ocs_ci.ocs.acm.acm_constants module
      • Module contents
    • ocs_ci.ocs.must_gather package
      • Submodules
      • ocs_ci.ocs.must_gather.const_must_gather module
      • ocs_ci.ocs.must_gather.must_gather module
      • Module contents
    • ocs_ci.ocs.resources package
      • Submodules
      • ocs_ci.ocs.resources.backingstore module
      • ocs_ci.ocs.resources.bucket_logging_manager module
      • ocs_ci.ocs.resources.bucket_notifications_manager module
      • ocs_ci.ocs.resources.bucket_policy module
      • ocs_ci.ocs.resources.bucketclass module
      • ocs_ci.ocs.resources.cache_drop module
      • ocs_ci.ocs.resources.catalog_source module
      • ocs_ci.ocs.resources.clientprofile module
      • ocs_ci.ocs.resources.cloud_manager module
      • ocs_ci.ocs.resources.cloud_uls module
      • ocs_ci.ocs.resources.csv module
      • ocs_ci.ocs.resources.daemonset module
      • ocs_ci.ocs.resources.deployment module
      • ocs_ci.ocs.resources.drpc module
      • ocs_ci.ocs.resources.fips module
      • ocs_ci.ocs.resources.install_plan module
      • ocs_ci.ocs.resources.job module
      • ocs_ci.ocs.resources.machineconfig module
      • ocs_ci.ocs.resources.mcg module
      • ocs_ci.ocs.resources.mcg_lifecycle_policies module
      • ocs_ci.ocs.resources.mcg_params module
      • ocs_ci.ocs.resources.mcg_replication_policy module
      • ocs_ci.ocs.resources.mockup_bucket_logger module
      • ocs_ci.ocs.resources.namespacestore module
      • ocs_ci.ocs.resources.objectbucket module
      • ocs_ci.ocs.resources.objectconfigfile module
      • ocs_ci.ocs.resources.ocs module
      • ocs_ci.ocs.resources.ocsconfigmaps module
      • ocs_ci.ocs.resources.packagemanifest module
      • ocs_ci.ocs.resources.pod module
      • ocs_ci.ocs.resources.pv module
      • ocs_ci.ocs.resources.pvc module
      • ocs_ci.ocs.resources.rgw module
      • ocs_ci.ocs.resources.s3_batch_deleter module
      • ocs_ci.ocs.resources.storage_client module
      • ocs_ci.ocs.resources.storage_cluster module
      • ocs_ci.ocs.resources.storageclassclaim module
      • ocs_ci.ocs.resources.storageconsumer module
      • ocs_ci.ocs.resources.stretchcluster module
      • ocs_ci.ocs.resources.test_packagemanifest module
      • ocs_ci.ocs.resources.topology module
      • Module contents
    • ocs_ci.ocs.tests package
      • Submodules
      • ocs_ci.ocs.tests.test_defaults module
      • ocs_ci.ocs.tests.test_fiojob module
      • Module contents
    • ocs_ci.ocs.ui package
      • Subpackages
      • Submodules
      • ocs_ci.ocs.ui.acm_ui module
      • ocs_ci.ocs.ui.add_replace_device_ui module
      • ocs_ci.ocs.ui.base_ui module
      • ocs_ci.ocs.ui.block_pool module
      • ocs_ci.ocs.ui.deployment_ui module
      • ocs_ci.ocs.ui.helpers_ui module
      • ocs_ci.ocs.ui.mcg_ui module
      • ocs_ci.ocs.ui.odf_topology module
      • ocs_ci.ocs.ui.pvc_ui module
      • ocs_ci.ocs.ui.storageclass module
      • ocs_ci.ocs.ui.validation_ui module
      • ocs_ci.ocs.ui.views module
      • ocs_ci.ocs.ui.workload_ui module
      • Module contents
  • Submodules
  • ocs_ci.ocs.acm_upgrade module
    • ACMUpgrade
      • ACMUpgrade.acm_patch_subscription()
      • ACMUpgrade.annotate_mch()
      • ACMUpgrade.create_catalog_source()
      • ACMUpgrade.get_acm_version_before_upgrade()
      • ACMUpgrade.get_parsed_versions()
      • ACMUpgrade.patch_channel()
      • ACMUpgrade.run_upgrade()
      • ACMUpgrade.upgrade_with_registry()
      • ACMUpgrade.upgrade_without_registry()
      • ACMUpgrade.validate_upgrade()
  • ocs_ci.ocs.amq module
    • AMQ
      • AMQ.check_amq_cluster_exists()
      • AMQ.cleanup()
      • AMQ.create_consumer_pod()
      • AMQ.create_kafka_topic()
      • AMQ.create_kafka_user()
      • AMQ.create_kafkadrop()
      • AMQ.create_messaging_on_amq()
      • AMQ.create_namespace()
      • AMQ.create_producer_pod()
      • AMQ.export_amq_output_to_gsheet()
      • AMQ.is_amq_pod_running()
      • AMQ.run_amq_benchmark()
      • AMQ.run_amq_workload()
      • AMQ.run_in_bg()
      • AMQ.setup_amq_cluster()
      • AMQ.setup_amq_cluster_operator()
      • AMQ.setup_amq_kafka_bridge()
      • AMQ.setup_amq_kafka_connect()
      • AMQ.setup_amq_kafka_persistent()
      • AMQ.validate_amq_benchmark()
      • AMQ.validate_messages_are_consumed()
      • AMQ.validate_messages_are_produced()
      • AMQ.validate_msg()
  • ocs_ci.ocs.api_client module
    • APIClientBase
      • APIClientBase.api_create()
      • APIClientBase.api_delete()
      • APIClientBase.api_get()
      • APIClientBase.api_patch()
      • APIClientBase.api_post()
      • APIClientBase.create_service()
      • APIClientBase.get_labels()
      • APIClientBase.get_pods()
      • APIClientBase.name
    • KubeClient
      • KubeClient.name
    • OCCLIClient
      • OCCLIClient.name
    • OCRESTClient
      • OCRESTClient.api_create()
      • OCRESTClient.api_delete()
      • OCRESTClient.api_get()
      • OCRESTClient.api_patch()
      • OCRESTClient.api_post()
      • OCRESTClient.create_service()
      • OCRESTClient.get_labels()
      • OCRESTClient.get_pods()
      • OCRESTClient.name
    • get_api_client()
  • ocs_ci.ocs.awscli_pod module
    • awscli_pod_cleanup()
    • create_awscli_pod()
  • ocs_ci.ocs.benchmark_operator module
    • BenchmarkOperator
      • BenchmarkOperator.cleanup()
      • BenchmarkOperator.deploy()
      • BenchmarkOperator.get_uuid()
    • benchmark_operator()
  • ocs_ci.ocs.benchmark_operator_fio module
    • BenchmarkOperatorFIO
      • BenchmarkOperatorFIO.calc_number_servers_file_size()
      • BenchmarkOperatorFIO.cleanup()
      • BenchmarkOperatorFIO.clone_benchmark_operator()
      • BenchmarkOperatorFIO.create_benchmark_operator()
      • BenchmarkOperatorFIO.deploy()
      • BenchmarkOperatorFIO.label_worker_nodes()
      • BenchmarkOperatorFIO.pods_expected_status()
      • BenchmarkOperatorFIO.run_fio_benchmark_operator()
      • BenchmarkOperatorFIO.setup_benchmark_fio()
      • BenchmarkOperatorFIO.wait_for_wl_to_complete()
      • BenchmarkOperatorFIO.wait_for_wl_to_start()
    • get_file_size()
  • ocs_ci.ocs.bucket_utils module
    • abort_all_multipart_upload()
    • abort_multipart()
    • bucket_read_api()
    • bulk_s3_put_bucket_lifecycle_config()
    • change_objects_creation_date_in_noobaa_db()
    • change_versions_creation_date_in_noobaa_db()
    • check_cached_objects_by_name()
    • check_if_objects_expired()
    • check_objects_in_bucket()
    • check_pv_backingstore_status()
    • check_pv_backingstore_type()
    • cli_create_aws_backingstore()
    • cli_create_aws_sts_backingstore()
    • cli_create_azure_backingstore()
    • cli_create_google_backingstore()
    • cli_create_ibmcos_backingstore()
    • cli_create_pv_backingstore()
    • cli_create_rgw_backingstore()
    • compare_bucket_object_list()
    • compare_directory()
    • compare_object_checksums_between_bucket_and_local()
    • compare_object_versions()
    • complete_multipart_upload()
    • copy_objects()
    • copy_random_individual_objects()
    • craft_s3_command()
    • craft_s3cmd_command()
    • craft_sts_command()
    • create_aws_bs_using_cli()
    • create_multipart_upload()
    • create_s3client_from_assume_role_creds()
    • del_objects()
    • delete_all_noobaa_buckets()
    • delete_all_objects_in_batches()
    • delete_bucket_policy()
    • delete_object_tags()
    • delete_objects_from_source_and_wait_for_deletion_sync()
    • download_objects_using_s3cmd()
    • expire_multipart_upload_in_noobaa_db()
    • expire_objects_in_bucket()
    • gen_empty_file_and_upload()
    • get_bucket_available_size()
    • get_bucket_policy()
    • get_full_path_object()
    • get_nb_bucket_stores()
    • get_obj_versions()
    • get_object_count_in_bucket()
    • get_object_to_tags_dict()
    • get_public_access_block()
    • get_replication_policy()
    • get_rgw_restart_counts()
    • list_multipart_upload()
    • list_objects_from_bucket()
    • list_objects_in_batches()
    • list_uploaded_parts()
    • map_objects_to_owners()
    • namespace_bucket_update()
    • obc_io_create_delete()
    • oc_create_aws_backingstore()
    • oc_create_azure_backingstore()
    • oc_create_google_backingstore()
    • oc_create_ibmcos_backingstore()
    • oc_create_pv_backingstore()
    • oc_create_rgw_backingstore()
    • patch_replication_policy_to_bucket()
    • patch_replication_policy_to_bucketclass()
    • put_bucket_policy()
    • put_bucket_versioning_via_awscli()
    • put_public_access_block_config()
    • random_object_round_trip_verification()
    • retrieve_anon_s3_resource()
    • retrieve_test_objects_to_pod()
    • retrieve_verification_mode()
    • rm_object_recursive()
    • s3_copy_object()
    • s3_create_bucket()
    • s3_delete_bucket()
    • s3_delete_bucket_website()
    • s3_delete_object()
    • s3_delete_objects()
    • s3_get_bucket_versioning()
    • s3_get_bucket_website()
    • s3_get_object()
    • s3_get_object_acl()
    • s3_head_bucket()
    • s3_head_object()
    • s3_io_create_delete()
    • s3_list_buckets()
    • s3_list_object_versions()
    • s3_list_objects_v1()
    • s3_list_objects_v2()
    • s3_put_bucket_versioning()
    • s3_put_bucket_website()
    • s3_put_object()
    • s3_put_object_tagging()
    • s3_upload_part_copy()
    • sample_if_objects_expired()
    • setup_base_objects()
    • sts_assume_role()
    • sync_object_directory()
    • tag_objects()
    • update_replication_policy()
    • upload_bulk_buckets()
    • upload_obj_versions()
    • upload_objects_with_javasdk()
    • upload_parts()
    • upload_random_objects_to_source_and_wait_for_replication()
    • upload_test_objects_to_source_and_wait_for_replication()
    • verify_objs_deleted_from_objmds()
    • verify_s3_object_integrity()
    • verify_soft_deletion()
    • wait_for_bucket_count_stability()
    • wait_for_cache()
    • wait_for_object_count_in_bucket()
    • wait_for_object_versions_match()
    • wait_for_pv_backingstore()
    • write_individual_s3_objects()
    • write_random_objects_in_pod()
    • write_random_test_objects_to_bucket()
  • ocs_ci.ocs.ceph_debug module
    • CephObjectStoreTool
      • CephObjectStoreTool.run_cot_list_pgs()
    • MonStoreTool
      • MonStoreTool.run_mot_get_monmap()
    • RookCephPlugin
      • RookCephPlugin.check_for_rook_ceph()
      • RookCephPlugin.check_krew_installed()
      • RookCephPlugin.install_krew()
      • RookCephPlugin.install_rook_ceph_plugin()
      • RookCephPlugin.krew_install_cmd
      • RookCephPlugin.maintenance_start()
      • RookCephPlugin.maintenance_stop()
      • RookCephPlugin.rookceph_install_cmd
  • ocs_ci.ocs.cephfs_workload module
    • LogReaderWriterParallel
      • LogReaderWriterParallel.fetch_and_validate_data()
      • LogReaderWriterParallel.log_reader_writer_parallel()
  • ocs_ci.ocs.clients module
    • WinNode
      • WinNode.check_disk()
      • WinNode.connect_to_target()
      • WinNode.create_disk()
      • WinNode.create_fio_job_options()
      • WinNode.create_new_target()
      • WinNode.delete_target()
      • WinNode.disconnect_from_target()
      • WinNode.get_iscsi_initiator_name()
      • WinNode.run_fio_test()
      • WinNode.start_iscsi_initiator()
      • WinNode.win_exec()
  • ocs_ci.ocs.cluster module
    • CephCluster
      • CephCluster.calc_trim_mean_throughput()
      • CephCluster.check_ceph_pool_used_space()
      • CephCluster.cluster_health_check()
      • CephCluster.cluster_name
      • CephCluster.create_new_blockpool()
      • CephCluster.create_new_filesystem()
      • CephCluster.create_user()
      • CephCluster.delete_blockpool()
      • CephCluster.delete_filesystem()
      • CephCluster.get_admin_key()
      • CephCluster.get_blockpool_status()
      • CephCluster.get_ceph_capacity()
      • CephCluster.get_ceph_cluster_iops()
      • CephCluster.get_ceph_default_replica()
      • CephCluster.get_ceph_free_capacity()
      • CephCluster.get_ceph_health()
      • CephCluster.get_ceph_status()
      • CephCluster.get_cephfilesystem_status()
      • CephCluster.get_cluster_throughput()
      • CephCluster.get_iops_percentage()
      • CephCluster.get_mons_from_cluster()
      • CephCluster.get_rebalance_status()
      • CephCluster.get_throughput_percentage()
      • CephCluster.get_user_key()
      • CephCluster.is_health_ok()
      • CephCluster.mcg_obj
      • CephCluster.mds_change_count()
      • CephCluster.mds_health_check()
      • CephCluster.mon_change_count()
      • CephCluster.mon_health_check()
      • CephCluster.namespace
      • CephCluster.noobaa_health_check()
      • CephCluster.pods
      • CephCluster.remove_mon_from_cluster()
      • CephCluster.scan_cluster()
      • CephCluster.set_noout()
      • CephCluster.set_pgs()
      • CephCluster.set_port()
      • CephCluster.set_target_ratio()
      • CephCluster.time_taken_to_complete_rebalance()
      • CephCluster.unset_noout()
      • CephCluster.wait_for_noobaa_health_ok()
      • CephCluster.wait_for_rebalance()
    • CephClusterExternal
      • CephClusterExternal.cluster_health_check()
      • CephClusterExternal.cluster_name
      • CephClusterExternal.namespace
      • CephClusterExternal.validate_pvc()
      • CephClusterExternal.wait_for_cluster_cr()
      • CephClusterExternal.wait_for_nooba_cr()
    • CephClusterMultiCluster
    • CephHealthMonitor
      • CephHealthMonitor.log_error_status()
      • CephHealthMonitor.run()
    • LVM
      • LVM.check_for_alert()
      • LVM.cluster_ip()
      • LVM.compare_percent_data_from_pvc()
      • LVM.compare_thin_pool_data_percent()
      • LVM.create_ssh_object()
      • LVM.exec_cmd_on_cluster_node()
      • LVM.fstrim()
      • LVM.get_and_parse_lvs()
      • LVM.get_and_parse_pvs()
      • LVM.get_and_parse_vgs()
      • LVM.get_lv_data_percent_of_pvc()
      • LVM.get_lv_name_from_pvc()
      • LVM.get_lv_name_from_snapshot()
      • LVM.get_lv_size_of_pvc()
      • LVM.get_lvm_thin_pool()
      • LVM.get_lvm_thin_pool_config_overprovision_ratio()
      • LVM.get_lvm_thin_pool_config_size_percent()
      • LVM.get_lvm_version()
      • LVM.get_lvmcluster()
      • LVM.get_thin_pool1_data_percent()
      • LVM.get_thin_pool1_size()
      • LVM.get_thin_pool_metadata()
      • LVM.get_thin_provisioning_alerts()
      • LVM.get_vg_free()
      • LVM.get_vg_size()
      • LVM.init_prom()
      • LVM.parse_topolvm_metrics()
      • LVM.validate_metrics_vs_operating_system_stats()
    • MulticlusterCephHealthMonitor
    • adjust_active_mds_count_storagecluster()
    • bring_down_mds_memory_usage_gradually()
    • calculate_compression_ratio()
    • ceph_config_set_debug()
    • ceph_details_df_to_dict()
    • ceph_health_detail()
    • change_ceph_backfillfull_ratio()
    • change_ceph_full_ratio()
    • check_ceph_health_after_add_capacity()
    • check_ceph_osd_df_tree()
    • check_ceph_osd_tree()
    • check_ceph_osd_tree_after_node_replacement()
    • check_cephcluster_status()
    • check_clusters()
    • check_osd_tree_1az_cloud()
    • check_osd_tree_1az_vmware()
    • check_osd_tree_1az_vmware_flex()
    • check_osd_tree_3az_cloud()
    • check_osds_in_hosts_are_up()
    • check_osds_in_hosts_osd_tree()
    • check_pool_compression_replica_ceph_level()
    • clear_active_mds_load()
    • client_cluster_health_check()
    • client_clusters_health_check()
    • count_cluster_osd()
    • fetch_connection_scores_for_mon()
    • get_active_mds_count_cephfilesystem()
    • get_active_mds_info()
    • get_active_mds_memory_utilisation_in_percentage()
    • get_active_mds_pod_objs()
    • get_age_of_cluster_in_days()
    • get_all_pgid()
    • get_balancer_eval()
    • get_byte_used_by_pool()
    • get_ceph_df_detail()
    • get_ceph_osd_df_tree_weight_and_size()
    • get_ceph_pool_property()
    • get_child_nodes_osd_tree()
    • get_full_ratio_from_osd_dump()
    • get_lvm_full_version()
    • get_mds_cache_memory_limit()
    • get_mds_counts()
    • get_mds_standby_replay_info()
    • get_mon_config_value()
    • get_mon_quorum_ranks()
    • get_nodes_osd_tree()
    • get_osd_dump()
    • get_osd_pg_log_dups_tracked()
    • get_osd_pods_memory_sum()
    • get_osd_utilization()
    • get_percent_used_capacity()
    • get_pg_balancer_status()
    • get_pgs_brief_dump()
    • get_pgs_per_osd()
    • get_pool_num()
    • get_specific_pool_pgid()
    • get_standby_replay_mds_memory_utilisation_in_percentage()
    • get_used_and_total_capacity_in_gibibytes()
    • is_flexible_scaling_enabled()
    • is_hci_client_cluster()
    • is_hci_cluster()
    • is_hci_provider_cluster()
    • is_lower_requirements()
    • is_lso_cluster()
    • is_managed_service_cluster()
    • is_ms_consumer_cluster()
    • is_ms_provider_cluster()
    • is_vsphere_ipi_cluster()
    • parse_ceph_df_pools()
    • parse_ceph_table_output()
    • set_osd_op_complaint_time()
    • silence_ceph_osd_crash_warning()
    • validate_claim_name_match_pvc()
    • validate_cluster_on_pvc()
    • validate_compression()
    • validate_existence_of_blocking_pdb()
    • validate_num_of_pgs()
    • validate_ocs_pods_on_pvc()
    • validate_osd_utilization()
    • validate_pdb_creation()
    • validate_pg_balancer()
    • validate_replica_data()
    • wait_for_silence_ceph_osd_crash_warning()
  • ocs_ci.ocs.cluster_load module
    • ClusterLoad
      • ClusterLoad.adjust_load_if_needed()
      • ClusterLoad.calc_trim_metric_mean()
      • ClusterLoad.decrease_load()
      • ClusterLoad.get_query()
      • ClusterLoad.increase_load()
      • ClusterLoad.increase_load_and_print_data()
      • ClusterLoad.print_metrics()
      • ClusterLoad.reach_cluster_load_percentage()
      • ClusterLoad.reduce_load()
      • ClusterLoad.resume_load()
    • finish_cluster_load()
    • wrap_msg()
  • ocs_ci.ocs.constants module
  • ocs_ci.ocs.cosbench module
    • Cosbench
      • Cosbench.cleanup()
      • Cosbench.cosbench_full()
      • Cosbench.generate_container_stage_config()
      • Cosbench.generate_stage_config()
      • Cosbench.get_performance_result()
      • Cosbench.get_result_csv()
      • Cosbench.run_cleanup_workload()
      • Cosbench.run_init_workload()
      • Cosbench.run_main_workload()
      • Cosbench.setup_cosbench()
      • Cosbench.submit_workload()
      • Cosbench.validate_workload()
      • Cosbench.wait_for_workload()
  • ocs_ci.ocs.couchbase module
    • CouchBase
      • CouchBase.analyze_run()
      • CouchBase.cleanup()
      • CouchBase.couchbase_full()
      • CouchBase.couchbase_operatorgroup()
      • CouchBase.couchbase_subscription()
      • CouchBase.create_cb_cluster()
      • CouchBase.create_cb_secrets()
      • CouchBase.create_data_buckets()
      • CouchBase.create_namespace()
      • CouchBase.get_couchbase_csv()
      • CouchBase.get_couchbase_nodes()
      • CouchBase.respin_couchbase_app_pod()
      • CouchBase.run_workload()
      • CouchBase.wait_for_pillowfights_to_complete()
  • ocs_ci.ocs.defaults module
  • ocs_ci.ocs.device_classes module
    • check_ceph_state_post_add_deviceclass()
    • create_new_lvs_for_new_deviceclass()
    • verification_steps_after_adding_new_deviceclass()
  • ocs_ci.ocs.disruptive_operations module
    • get_ocs_operator_node_name()
    • osd_node_reboot()
    • worker_node_shutdown()
  • ocs_ci.ocs.dr_upgrade module
    • DRClusterOperatorUpgrade
      • DRClusterOperatorUpgrade.run_upgrade()
      • DRClusterOperatorUpgrade.validate_upgrade()
    • DRHubUpgrade
      • DRHubUpgrade.run_upgrade()
      • DRHubUpgrade.validate_upgrade()
    • DRUpgrade
      • DRUpgrade.check_if_upgrade_completed()
      • DRUpgrade.collect_data()
      • DRUpgrade.run_upgrade()
      • DRUpgrade.update_subscription()
      • DRUpgrade.validate_upgrade()
    • MultiClusterOrchestratorUpgrade
      • MultiClusterOrchestratorUpgrade.run_upgrade()
      • MultiClusterOrchestratorUpgrade.validate_upgrade()
  • ocs_ci.ocs.elasticsearch module
    • ElasticSearch
      • ElasticSearch.cleanup()
      • ElasticSearch.dumping_all_data()
      • ElasticSearch.get_health()
      • ElasticSearch.get_indices()
      • ElasticSearch.get_ip()
      • ElasticSearch.get_password()
      • ElasticSearch.get_port()
      • ElasticSearch.get_scheme()
    • elasticsearch_load()
  • ocs_ci.ocs.ephernal_storage module
    • EphemeralPodFactory
      • EphemeralPodFactory.create_cephfs_pod_dict()
      • EphemeralPodFactory.create_ephemeral_pod()
      • EphemeralPodFactory.create_pod_dict()
      • EphemeralPodFactory.create_rbd_pod_dict()
      • EphemeralPodFactory.delete_ephemeral_pod()
  • ocs_ci.ocs.exceptions module
    • ACMClusterConfigurationException
    • ACMClusterDeployException
    • ACMClusterDestroyException
    • ACMClusterImportException
    • ACMObservabilityNotEnabled
    • APIRequestError
    • ActiveMdsValueNotMatch
    • AlertingError
    • ArchitectureNotSupported
    • AuthError
    • BenchmarkTestFailed
    • CPUNotSufficientException
    • CSVNotFound
    • CephHealthException
    • CephHealthNotRecoveredException
    • CephHealthRecoveredException
    • CephToolBoxNotFoundException
    • ChannelNotFound
    • ClassCreationException
    • ClientDownloadError
    • ClusterNotFoundException
    • ClusterNotInSTSModeException
    • CommandFailed
    • ConfigurationError
    • ConnectivityFail
    • CredReqSecretNotFound
    • DRPrimaryNotFoundException
    • DeploymentPlatformNotSupported
    • DistributionStatusError
    • ElasticSearchNotDeployed
    • ExternalClusterCephSSHAuthDetailsMissing
    • ExternalClusterCephfsMissing
    • ExternalClusterDetailsException
    • ExternalClusterExporterRunFailed
    • ExternalClusterNodeRoleNotFound
    • ExternalClusterObjectStoreUserCreationFailed
    • ExternalClusterRBDNamespaceCreationFailed
    • ExternalClusterRGWAdminOpsUserException
    • ExternalClusterRGWEndPointMissing
    • ExternalClusterRGWEndPointPortMissing
    • FailedToAddNodeException
    • FailedToDeleteInstance
    • FailedToRemoveNodeException
    • FipsNotInstalledException
    • FlexyDataNotFound
    • FloatingIPAssignException
    • HPCSDeploymentError
    • HostNameNotFoundInOSDStatus
    • HostValidationFailed
    • HyperConvergedHealthException
    • HyperConvergedNotDeployedException
    • IPAMAssignUpdateFailed
    • IPAMReleaseUpdateFailed
    • ImageIsNotDeletedOrNotFound
    • IncorrectUiOptionRequested
    • InteractivePromptException
    • InvalidPodPresent
    • InvalidStatusCode
    • KMIPDeploymentError
    • KMIPOperationError
    • KMSConnectionDetailsError
    • KMSNotSupported
    • KMSResourceCleaneupError
    • KMSTokenError
    • LVMOHealthException
    • LeftoversExistError
    • LvDataPercentSizeWrong
    • LvSizeWrong
    • LvThinUtilNotChanged
    • MDRDeploymentException
    • MDSCountException
    • ManagedServiceAddonDeploymentError
    • ManagedServiceSecurityGroupNotFound
    • Md5CheckFailed
    • MemoryNotSufficientException
    • MissingDecoratorError
    • MissingRequiredConfigKeyError
    • MonCountException
    • MultiClusterEngineNotDeployedException
    • MultiStorageClusterExternalCephHealth
    • NoBucketPolicyResponse
    • NoInstallPlanForApproveFoundException
    • NoRunningCephToolBoxException
    • NoThreadingLockUsedError
    • NodeHasNoAttachedVolume
    • NodeNotFoundError
    • NonUpgradedImagesFoundError
    • NoobaaCliChecksumFailedException
    • NoobaaConditionException
    • NoobaaHealthException
    • NotAllNodesCreated
    • NotAllPodsHaveSameImagesError
    • NotFoundError
    • NotSupportedException
    • NotSupportedFunctionError
    • NotSupportedProxyConfiguration
    • OCSWorkerScaleFailed
    • OSDScaleFailed
    • ObjectsStillBeingDeletedException
    • OpenShiftAPIResponseException
    • OpenshiftConsoleSuiteNotDefined
    • OperationFailedToCompleteException
    • PDBNotCreatedException
    • PSIVolumeCreationFailed
    • PSIVolumeDeletionFailed
    • PSIVolumeNotInExpectedState
    • PVCNotCreated
    • PVNotSufficientException
    • PageNotLoaded
    • PassThroughEnabledDeviceNotFound
    • PendingCSRException
    • PerformanceException
    • PodNotCreated
    • PoolCephValueNotMatch
    • PoolCompressionWrong
    • PoolDataNotErased
    • PoolDidNotReachReadyState
    • PoolNotCompressedAsExpected
    • PoolNotDeleted
    • PoolNotDeletedFromUI
    • PoolNotFound
    • PoolNotReplicatedAsNeeded
    • PoolSizeWrong
    • PoolStateIsUnknow
    • ProviderModeNotFoundException
    • PvcNotDeleted
    • RBDSideCarContainerException
    • RDMDiskNotFound
    • RDRDeploymentException
    • ROSAAdminLoginFailedException
    • RebootEventNotFoundException
    • ResourceLeftoversException
    • ResourceNameNotSpecifiedException
    • ResourceNotDeleted
    • ResourceNotFoundError
    • ResourcePoolNotFound
    • ResourceWrongStatusException
    • ReturnedEmptyResponseException
    • RhcosImageNotFound
    • SameNameClusterAlreadyExistsException
    • SameNamePrefixClusterAlreadyExistsException
    • ServiceUnavailable
    • StorageClassNotDeletedFromUI
    • StorageNotSufficientException
    • StorageSizeNotReflectedException
    • StorageclassIsNotDeleted
    • StorageclassNotCreated
    • SubctlDownloadFailed
    • TagNotFoundException
    • TemplateNotFound
    • TemporaryPodsDuringDeployment
    • TerrafromFileNotFoundException
    • ThinPoolUtilityWrong
    • TimeoutException
    • TimeoutExpiredError
      • TimeoutExpiredError.message
    • TolerationNotFoundException
    • UnableUpgradeConnectionException
    • UnavailableBuildException
    • UnavailableResourceException
    • UnexpectedBehaviour
    • UnexpectedDeploymentConfiguration
    • UnexpectedImage
    • UnexpectedInput
    • UnexpectedODFAccessException
    • UnexpectedVolumeType
    • UnhealthyBucket
    • UnknownCloneTypeException
    • UnknownOperationForTerraformVariableUpdate
    • UnsupportedBrowser
    • UnsupportedFeatureError
    • UnsupportedOSType
    • UnsupportedPlatformError
    • UnsupportedPlatformVersionError
    • UnsupportedWorkloadError
    • UsernameNotFoundException
    • VMIndexNotFoundException
    • VMMaxDisksReachedException
    • VSLMNotFoundException
    • VaultDeploymentError
    • VaultOperationError
    • VolumePathNotFoundException
    • VolumesExistError
    • WrongVersionExpression
    • ZombieProcessFoundException
  • ocs_ci.ocs.external_ceph module
    • Ceph
      • Ceph.ceph_demon_stat
      • Ceph.get_ceph_demons()
      • Ceph.get_ceph_object()
      • Ceph.get_ceph_objects()
      • Ceph.get_metadata_list()
      • Ceph.get_node_by_hostname()
      • Ceph.get_nodes()
      • Ceph.get_osd_by_id()
      • Ceph.get_osd_container_name_by_id()
      • Ceph.get_osd_data_partition()
      • Ceph.get_osd_data_partition_path()
      • Ceph.get_osd_device()
      • Ceph.get_osd_metadata()
      • Ceph.get_osd_service_name()
      • Ceph.role_to_node_mapping()
    • CephClient
    • CephDemon
      • CephDemon.ceph_demon_by_container_name()
      • CephDemon.container_name
      • CephDemon.container_prefix
      • CephDemon.exec_command()
    • CephNode
      • CephNode.connect()
      • CephNode.create_ceph_object()
      • CephNode.exec_command()
      • CephNode.check_ec
      • CephNode.get_allocated_volumes()
      • CephNode.get_ceph_demons()
      • CephNode.get_ceph_objects()
      • CephNode.get_free_volumes()
      • CephNode.obtain_root_permissions()
      • CephNode.reconnect()
      • CephNode.remove_ceph_object()
      • CephNode.role
      • CephNode.search_ethernet_interface()
      • CephNode.set_eth_interface()
      • CephNode.set_internal_ip()
      • CephNode.write_file()
    • CephObject
      • CephObject.exec_command()
      • CephObject.pkg_type
      • CephObject.write_file()
    • CephObjectFactory
      • CephObjectFactory.CLIENT_ROLES
      • CephObjectFactory.DEMON_ROLES
      • CephObjectFactory.create_ceph_object()
    • CephOsd
      • CephOsd.container_name
      • CephOsd.is_active
    • NodeVolume
      • NodeVolume.ALLOCATED
      • NodeVolume.FREE
    • RolesContainer
      • RolesContainer.append()
      • RolesContainer.clear()
      • RolesContainer.equals()
      • RolesContainer.extend()
      • RolesContainer.remove()
      • RolesContainer.update_role()
    • SSHConnectionManager
      • SSHConnectionManager.client
      • SSHConnectionManager.get_client()
      • SSHConnectionManager.get_transport()
      • SSHConnectionManager.transport
  • ocs_ci.ocs.fio_artefacts module
    • get_configmap_dict()
    • get_job_dict()
    • get_mcg_conf()
    • get_pvc_dict()
  • ocs_ci.ocs.fiojob module
    • delete_fio_data()
    • fio_to_dict()
    • get_ceph_storage_stats()
    • get_pool_name()
    • get_sc_name()
    • get_storageutilization_size()
    • get_timeout()
    • wait_for_job_completion()
    • workload_fio_storageutilization()
    • write_data_via_fio()
  • ocs_ci.ocs.flowtest module
    • BackgroundOps
      • BackgroundOps.handler()
      • BackgroundOps.wait_for_bg_operations()
    • FlowOperations
      • FlowOperations.add_capacity_entry_criteria()
      • FlowOperations.add_capacity_exit_criteria()
      • FlowOperations.node_operations_entry_criteria()
      • FlowOperations.validate_cluster()
  • ocs_ci.ocs.fusion module
    • create_fusion_monitoring_resources()
    • deploy_odf()
  • ocs_ci.ocs.hsbench module
    • HsBench
      • HsBench.cleanup()
      • HsBench.create_resource_hsbench()
      • HsBench.create_test_user()
      • HsBench.delete_bucket()
      • HsBench.delete_objects_in_bucket()
      • HsBench.delete_test_user()
      • HsBench.install_hsbench()
      • HsBench.run_benchmark()
      • HsBench.validate_hsbench_put_get_list_objects()
      • HsBench.validate_hsbench_workload()
      • HsBench.validate_reshard_process()
      • HsBench.validate_s3_objects()
  • ocs_ci.ocs.jenkins module
    • Jenkins
      • Jenkins.cleanup()
      • Jenkins.create_app_jenkins()
      • Jenkins.create_jenkins_build_config()
      • Jenkins.create_jenkins_pvc()
      • Jenkins.create_ocs_jenkins_template()
      • Jenkins.create_project_names()
      • Jenkins.export_builds_results_to_googlesheet()
      • Jenkins.get_build_duration_time()
      • Jenkins.get_build_name_by_pattern()
      • Jenkins.get_builds_obj()
      • Jenkins.get_builds_sorted_by_number()
      • Jenkins.get_jenkins_deploy_pods()
      • Jenkins.get_node_name_where_jenkins_pod_not_hosted()
      • Jenkins.number_builds_per_project
      • Jenkins.number_projects
      • Jenkins.print_completed_builds_results()
      • Jenkins.start_build()
      • Jenkins.wait_for_build_to_complete()
      • Jenkins.wait_for_jenkins_deploy_status()
  • ocs_ci.ocs.longevity module
    • Longevity
      • Longevity.cluster_sanity_check()
      • Longevity.collect_cluster_sanity_checks_outputs()
      • Longevity.construct_stage_builder_bulk_pod_creation_yaml()
      • Longevity.construct_stage_builder_bulk_pvc_creation_yaml()
      • Longevity.construct_stage_builder_kube_job()
      • Longevity.create_stage_builder_kube_job()
      • Longevity.create_stagebuilder_all_pvc_types()
      • Longevity.create_stagebuilder_obc()
      • Longevity.create_stagebuilder_pods_with_all_pvc_types()
      • Longevity.delete_stage_builder_kube_job()
      • Longevity.get_pvc_bound_list()
      • Longevity.get_resource_yaml_dict_from_kube_job_obj()
      • Longevity.longevity_all_stages()
      • Longevity.stage_0()
      • Longevity.stage_2()
      • Longevity.stage_3()
      • Longevity.stage_4()
      • Longevity.validate_obcs_in_kube_job_reached_running_state()
      • Longevity.validate_pods_in_kube_job_reached_running_state()
      • Longevity.validate_pvc_in_kube_job_reached_bound_state()
    • start_app_workload()
    • start_ocp_workload()
  • ocs_ci.ocs.machine module
    • add_annotation_to_machine()
    • add_node()
    • change_current_replica_count_to_ready_replica_count()
    • check_machineset_exists()
    • create_custom_machineset()
    • create_ocs_infra_nodes()
    • delete_custom_machineset()
    • delete_machine()
    • delete_machine_and_check_state_of_new_spinned_machine()
    • delete_machines()
    • get_labeled_nodes()
    • get_machine_from_machineset()
    • get_machine_from_node_name()
    • get_machine_objs()
    • get_machine_type()
    • get_machines()
    • get_machines_in_statuses()
    • get_machineset_from_machine_name()
    • get_machineset_objs()
    • get_machinesets()
    • get_ready_replica_count()
    • get_replica_count()
    • get_storage_cluster()
    • set_replica_count()
    • wait_for_current_replica_count_to_reach_expected_value()
    • wait_for_machines_count_to_reach_status()
    • wait_for_new_node_to_be_ready()
    • wait_for_ready_replica_count_to_reach_expected_value()
  • ocs_ci.ocs.machinepool module
    • MachinePool
      • MachinePool.apply()
      • MachinePool.auto_repair
      • MachinePool.availability_zone
      • MachinePool.cluster_name
      • MachinePool.current_replicas
      • MachinePool.exist
      • MachinePool.from_dict()
      • MachinePool.get_machinepool_details()
      • MachinePool.get_machinepool_updated_replicas()
      • MachinePool.instance_profile
      • MachinePool.instance_type
      • MachinePool.labels
      • MachinePool.machine_pool_link
      • MachinePool.machinepool_id
      • MachinePool.node_drain_grace_period
      • MachinePool.refresh()
      • MachinePool.replicas
      • MachinePool.root_volume_size
      • MachinePool.subnet
      • MachinePool.tags
      • MachinePool.version_id
      • MachinePool.version_raw_id
      • MachinePool.wait_replicas_ready()
    • MachinePools
      • MachinePools.add_machinepool()
      • MachinePools.get_machinepools()
      • MachinePools.refresh_machinepools()
      • MachinePools.create_machine_pool()
      • MachinePools.delete_machine_pool()
      • MachinePools.edit_machine_pool()
      • MachinePools.filter()
      • MachinePools.get_machinepool_replicas()
      • MachinePools.load_all_machinepools()
    • NodeConf
      • NodeConf.availability_zone
      • NodeConf.disk_size
      • NodeConf.enable_autoscaling
      • NodeConf.instance_type
      • NodeConf.labels
      • NodeConf.machinepool_id
      • NodeConf.max_replicas
      • NodeConf.min_replicas
      • NodeConf.multi_availability_zone
      • NodeConf.node_drain_grace_period
      • NodeConf.replicas
      • NodeConf.spot_max_price
      • NodeConf.subnet
      • NodeConf.tags
      • NodeConf.use_spot_instances
    • build_machinepool_cmd_base()
    • get_machinepools()
    • run_create_machinepool()
    • run_delete_machinepool()
    • run_edit_machinepool()
  • ocs_ci.ocs.managedservice module
    • change_current_index_to_default_index()
    • check_and_change_current_index_to_default_index()
    • check_default_cluster_context_index_equal_to_current_index()
    • check_switch_to_correct_cluster_at_setup()
    • get_admin_key_from_provider()
    • get_consumer_names()
    • get_dms_secret_name()
    • get_managedocs_component_state()
    • get_pagerduty_secret_name()
    • get_parameters_secret_name()
    • get_provider_service_type()
    • get_smtp_secret_name()
    • is_rados_connect_error_in_ex()
    • patch_consumer_toolbox()
    • update_non_ga_version()
    • update_pull_secret()
  • ocs_ci.ocs.mcg_workload module
    • create_workload_job()
    • get_configmap_dict()
    • get_job_dict()
    • mcg_job_factory()
    • wait_for_active_pods()
  • ocs_ci.ocs.metrics module
    • get_missing_metrics()
  • ocs_ci.ocs.monitoring module
    • check_ceph_health_status_metrics_on_prometheus()
    • check_ceph_metrics_available()
    • check_if_monitoring_stack_exists()
    • check_pvcdata_collected_on_prometheus()
    • create_configmap_cluster_monitoring_pod()
    • get_ceph_capacity_metrics()
    • get_list_pvc_objs_created_on_monitoring_pods()
    • get_metrics_persistentvolumeclaims_info()
    • get_prometheus_response()
    • get_pvc_namespace_metrics()
    • prometheus_health_check()
    • validate_pvc_are_mounted_on_monitoring_pods()
    • validate_pvc_created_and_bound_on_monitoring_pods()
  • ocs_ci.ocs.node module
    • add_disk_stretch_arbiter()
    • add_disk_to_node()
    • add_new_disk_for_vsphere()
    • add_new_node_and_label_it()
    • add_new_node_and_label_upi()
    • add_new_nodes_and_label_after_node_failure_ipi()
    • add_new_nodes_and_label_them_rosa_hcp()
    • add_new_nodes_and_label_upi_lso()
    • add_node_to_lvd_and_lvs()
    • apply_node_affinity_for_ceph_toolbox()
    • apply_node_affinity_for_noobaa_pod()
    • base_get_node_rack_or_zone()
    • check_for_zombie_process_on_node()
    • check_node_ip_equal_to_associated_pods_ips()
    • check_nodes_specs()
    • check_taint_on_nodes()
    • consumer_verification_steps_after_provider_node_replacement()
    • delete_and_create_osd_node_aws_upi()
    • delete_and_create_osd_node_ipi()
    • delete_and_create_osd_node_managed_cp()
    • delete_and_create_osd_node_vsphere_upi()
    • delete_and_create_osd_node_vsphere_upi_lso()
    • drain_nodes()
    • generate_new_nodes_and_osd_running_nodes_ipi()
    • generate_nodes_for_provider_worker_node_tests()
    • get_all_nodes()
    • get_another_osd_node_in_same_rack_or_zone()
    • get_app_pod_running_nodes()
    • get_both_osd_and_app_pod_running_node()
    • get_ceph_tools_running_node()
    • get_compute_node_names()
    • get_crashcollector_nodes()
    • get_encrypted_osd_devices()
    • get_master_nodes()
    • get_mon_running_nodes()
    • get_node_az()
    • get_node_by_internal_ip()
    • get_node_from_machine_name()
    • get_node_hostname_label()
    • get_node_index_in_local_block()
    • get_node_internal_ip()
    • get_node_ip_addresses()
    • get_node_ips()
    • get_node_logs()
    • get_node_mon_ids()
    • get_node_name()
    • get_node_names()
    • get_node_names_from_osd_status()
    • get_node_objs()
    • get_node_osd_ids()
    • get_node_pods()
    • get_node_pods_to_scale_down()
    • get_node_rack()
    • get_node_rack_dict()
    • get_node_rack_or_zone()
    • get_node_rack_or_zone_dict()
    • get_node_resource_utilization_from_adm_top()
    • get_node_resource_utilization_from_oc_describe()
    • get_node_rook_ceph_pod_names()
    • get_node_status()
    • get_node_zone()
    • get_node_zone_dict()
    • get_nodes()
    • get_nodes_having_label()
    • get_nodes_in_statuses()
    • get_nodes_racks_or_zones()
    • get_nodes_where_ocs_pods_running()
    • get_num_of_racks()
    • get_ocs_nodes()
    • get_odf_zone_count()
    • get_osd_ids_per_node()
    • get_osd_running_nodes()
    • get_osds_per_node()
    • get_other_worker_nodes_in_same_rack_or_zone()
    • get_provider()
    • get_running_pod_count_from_node()
    • get_typed_worker_nodes()
    • get_worker_node_where_ceph_toolbox_not_running()
    • get_worker_nodes()
    • get_worker_nodes_not_in_ocs()
    • gracefully_reboot_nodes()
    • has_taint()
    • is_node_labeled()
    • is_node_rack_or_zone_exist()
    • label_nodes()
    • list_encrypted_rbd_devices_onnode()
    • node_network_failure()
    • node_replacement_verification_steps_ceph_side()
    • node_replacement_verification_steps_user_side()
    • power_on_ocp_node_vms()
    • print_table_node_resource_utilization()
    • recover_node_to_ready_state()
    • remove_nodes()
    • replace_old_node_in_lvd_and_lvs()
    • scale_down_deployments()
    • schedule_nodes()
    • select_osd_node()
    • taint_nodes()
    • unschedule_nodes()
    • untaint_nodes()
    • verify_all_nodes_created()
    • verify_crypt_device_present_onnode()
    • verify_nodes_in_ceph_osd_status()
    • verify_worker_nodes_security_groups()
    • wait_for_all_osd_ids_come_up_on_nodes()
    • wait_for_new_osd_node()
    • wait_for_new_worker_node_ipi()
    • wait_for_node_count_to_reach_status()
    • wait_for_nodes_racks_or_zones()
    • wait_for_nodes_status()
    • wait_for_osd_ids_come_up_on_node()
  • ocs_ci.ocs.ocp module
    • OCP
      • OCP.add_label()
      • OCP.annotate()
      • OCP.api_version
      • OCP.apply()
      • OCP.check_function_supported()
      • OCP.check_name_is_specified()
      • OCP.check_phase()
      • OCP.check_resource_existence()
      • OCP.create()
      • OCP.data
      • OCP.delete()
      • OCP.delete_identity()
      • OCP.delete_project()
      • OCP.describe()
      • OCP.exec_oc_cmd()
      • OCP.exec_oc_debug_cmd()
      • OCP.get()
      • OCP.get_logs()
      • OCP.get_resource()
      • OCP.get_resource_status()
      • OCP.get_user_identities()
      • OCP.get_user_name()
      • OCP.get_user_token()
      • OCP.is_exist()
      • OCP.kind
      • OCP.login()
      • OCP.login_as_user()
      • OCP.namespace
      • OCP.new_project()
      • OCP.patch()
      • OCP.reload_data()
      • OCP.remove_label()
      • OCP.resource_name
      • OCP.wait()
      • OCP.wait_for_delete()
      • OCP.wait_for_phase()
      • OCP.wait_for_resource()
    • check_cluster_operator_versions()
    • clear_overprovision_spec()
    • confirm_cluster_operator_version()
    • get_all_cluster_operators()
    • get_all_resource_names_of_a_kind()
    • get_all_resource_of_kind_containing_string()
    • get_build()
    • get_cluster_operator_version()
    • get_clustername()
    • get_current_oc_version()
    • get_images()
    • get_ocp_channel()
    • get_ocp_upgrade_channel()
    • get_ocp_url()
    • get_services_by_label()
    • get_sha256_digest()
    • patch_ocp_upgrade_channel()
    • rsync()
    • set_overprovision_policy()
    • switch_to_default_rook_cluster_project()
    • switch_to_project()
    • upgrade_ocp()
    • validate_cluster_version_status()
    • verify_cluster_operator_status()
    • verify_images_upgraded()
    • verify_ocp_upgrade_channel()
    • wait_for_cluster_connectivity()
  • ocs_ci.ocs.ocs_upgrade module
    • OCSUpgrade
      • OCSUpgrade.check_if_upgrade_completed()
      • OCSUpgrade.get_csv_name_pre_upgrade()
      • OCSUpgrade.get_images_post_upgrade()
      • OCSUpgrade.get_parsed_versions()
      • OCSUpgrade.get_pre_upgrade_image()
      • OCSUpgrade.get_upgrade_version()
      • OCSUpgrade.load_version_config_file()
      • OCSUpgrade.ocs_registry_image
      • OCSUpgrade.set_upgrade_channel()
      • OCSUpgrade.set_upgrade_images()
      • OCSUpgrade.update_subscription()
      • OCSUpgrade.version_before_upgrade
    • get_expected_noobaa_pod_count()
    • get_upgrade_image_info()
    • ocs_odf_upgrade_ui()
    • run_ocs_upgrade()
    • set_update_strategy()
    • verify_image_versions()
    • verify_noobaa_pods_upgraded()
  • ocs_ci.ocs.openshift_ops module
    • OCP
      • OCP.call_api()
      • OCP.create_project()
      • OCP.get_labels()
      • OCP.get_pods()
      • OCP.get_projects()
      • OCP.get_services()
      • OCP.get_services_in_namespace()
      • OCP.set_kubeconfig()
  • ocs_ci.ocs.openstack module
    • CephVMNode
      • CephVMNode.attach_floating_ip()
      • CephVMNode.create_node()
      • CephVMNode.destroy_node()
      • CephVMNode.destroy_volume()
      • CephVMNode.get_driver()
      • CephVMNode.get_private_ip()
      • CephVMNode.get_volume()
    • GetIPError
    • InvalidHostName
    • NodeErrorState
  • ocs_ci.ocs.osd_operations module
    • osd_device_replacement()
  • ocs_ci.ocs.parallel module
    • ExceptionHolder
    • capture_traceback()
    • parallel
      • parallel.spawn()
    • resurrect_traceback()
  • ocs_ci.ocs.perf_pgsql module
    • PerfPGSQL
      • PerfPGSQL.validate_pgbench_perf()
  • ocs_ci.ocs.perfresult module
    • PerfResult
      • PerfResult.add_key()
      • PerfResult.dump_to_file()
      • PerfResult.es_connect()
      • PerfResult.es_read()
      • PerfResult.es_write()
      • PerfResult.results_link()
    • ResultsAnalyse
  • ocs_ci.ocs.perftests module
    • PASTest
      • PASTest.add_test_to_results_check()
      • PASTest.check_results_and_push_to_dashboard()
      • PASTest.check_tests_results()
      • PASTest.cleanup_testing_pod()
      • PASTest.cleanup_testing_pvc()
      • PASTest.copy_es_data()
      • PASTest.create_fio_pod_yaml()
      • PASTest.create_new_pool()
      • PASTest.create_test_project()
      • PASTest.create_testing_pod_and_wait_for_completion()
      • PASTest.create_testing_pvc_and_wait_for_bound()
      • PASTest.delete_ceph_pool()
      • PASTest.delete_test_project()
      • PASTest.deploy_and_wait_for_wl_to_start()
      • PASTest.deploy_benchmark_operator()
      • PASTest.es_connect()
      • PASTest.es_info_backup()
      • PASTest.get_cephfs_data()
      • PASTest.get_env_info()
      • PASTest.get_kibana_indexid()
      • PASTest.get_node_info()
      • PASTest.get_osd_info()
      • PASTest.get_time()
      • PASTest.initialize_test_crd()
      • PASTest.push_to_dashboard()
      • PASTest.read_from_es()
      • PASTest.set_results_path_and_file()
      • PASTest.set_storageclass()
      • PASTest.setup()
      • PASTest.teardown()
      • PASTest.wait_for_wl_to_finish()
      • PASTest.write_result_to_file()
  • ocs_ci.ocs.pgsql module
    • Postgresql
      • Postgresql.attach_pgsql_pod_to_claim_pvc()
      • Postgresql.cleanup()
      • Postgresql.create_pgbench_benchmark()
      • Postgresql.delete_pgbench_pods()
      • Postgresql.export_pgoutput_to_googlesheet()
      • Postgresql.filter_pgbench_nodes_from_nodeslist()
      • Postgresql.get_pgbech_pod_status_table()
      • Postgresql.get_pgbench_pods()
      • Postgresql.get_pgbench_running_nodes()
      • Postgresql.get_pgbench_status()
      • Postgresql.get_pgsql_nodes()
      • Postgresql.get_postgres_pods()
      • Postgresql.get_postgres_pvc()
      • Postgresql.get_postgres_used_file_space()
      • Postgresql.is_pgbench_running()
      • Postgresql.pgsql_full()
      • Postgresql.respin_pgsql_app_pod()
      • Postgresql.setup_postgresql()
      • Postgresql.validate_pgbench_run()
      • Postgresql.wait_for_pgbench_status()
      • Postgresql.wait_for_postgres_status()
  • ocs_ci.ocs.pillowfight module
    • PillowFight
      • PillowFight.MAX_ACCEPTABLE_RESPONSE_TIME
      • PillowFight.MIN_ACCEPTABLE_OPS_PER_SEC
      • PillowFight.analyze_all()
      • PillowFight.cleanup()
      • PillowFight.export_pfoutput_to_googlesheet()
      • PillowFight.parse_pillowfight_log()
      • PillowFight.run_pillowfights()
      • PillowFight.sanity_check()
      • PillowFight.wait_for_pillowfights_to_complete()
  • ocs_ci.ocs.platform_nodes module
    • AWSNodes
      • AWSNodes.all_nodes_found()
      • AWSNodes.approve_all_nodes_csr()
      • AWSNodes.attach_nodes_to_cluster()
      • AWSNodes.attach_nodes_to_upi_cluster()
      • AWSNodes.attach_rhel_nodes_to_upi_cluster()
      • AWSNodes.attach_volume()
      • AWSNodes.build_ansible_inventory()
      • AWSNodes.check_connection()
      • AWSNodes.create_nodes()
      • AWSNodes.detach_volume()
      • AWSNodes.get_available_slots()
      • AWSNodes.get_data_volumes()
      • AWSNodes.get_ec2_instances()
      • AWSNodes.get_existing_indexes()
      • AWSNodes.get_node_by_attached_volume()
      • AWSNodes.get_ready_status()
      • AWSNodes.get_stack_name_of_node()
      • AWSNodes.restart_nodes()
      • AWSNodes.restart_nodes_by_stop_and_start()
      • AWSNodes.restart_nodes_by_stop_and_start_teardown()
      • AWSNodes.start_nodes()
      • AWSNodes.stop_nodes()
      • AWSNodes.terminate_nodes()
      • AWSNodes.verify_nodes_added()
      • AWSNodes.wait_for_nodes_to_stop()
      • AWSNodes.wait_for_nodes_to_stop_or_terminate()
      • AWSNodes.wait_for_nodes_to_terminate()
      • AWSNodes.wait_for_volume_attach()
    • AWSUPINode
      • AWSUPINode.add_cert_to_template()
      • AWSUPINode.build_stack_params()
      • AWSUPINode.gather_worker_data()
      • AWSUPINode.get_cert_content()
      • AWSUPINode.get_kube_tag()
      • AWSUPINode.get_rhcos_worker_template()
      • AWSUPINode.get_worker_resource_id()
      • AWSUPINode.update_template_with_cert()
    • AZURENodes
      • AZURENodes.attach_nodes_to_cluster()
      • AZURENodes.attach_volume()
      • AZURENodes.create_and_attach_nodes_to_cluster()
      • AZURENodes.create_nodes()
      • AZURENodes.detach_volume()
      • AZURENodes.get_data_volumes()
      • AZURENodes.get_node_by_attached_volume()
      • AZURENodes.restart_nodes()
      • AZURENodes.restart_nodes_by_stop_and_start()
      • AZURENodes.restart_nodes_by_stop_and_start_teardown()
      • AZURENodes.start_nodes()
      • AZURENodes.stop_nodes()
      • AZURENodes.wait_for_volume_attach()
    • BaremetalNodes
      • BaremetalNodes.attach_nodes_to_cluster()
      • BaremetalNodes.attach_volume()
      • BaremetalNodes.create_and_attach_nodes_to_cluster()
      • BaremetalNodes.create_nodes()
      • BaremetalNodes.detach_volume()
      • BaremetalNodes.get_data_volumes()
      • BaremetalNodes.get_node_by_attached_volume()
      • BaremetalNodes.read_default_config()
      • BaremetalNodes.restart_nodes()
      • BaremetalNodes.restart_nodes_by_stop_and_start_teardown()
      • BaremetalNodes.start_nodes()
      • BaremetalNodes.stop_nodes()
      • BaremetalNodes.wait_for_volume_attach()
    • GCPNodes
      • GCPNodes.restart_nodes()
      • GCPNodes.restart_nodes_by_stop_and_start()
      • GCPNodes.restart_nodes_by_stop_and_start_teardown()
      • GCPNodes.start_nodes()
      • GCPNodes.stop_nodes()
      • GCPNodes.terminate_nodes()
    • IBMCloud
      • IBMCloud.attach_volume()
      • IBMCloud.check_workers_ready_state()
      • IBMCloud.create_and_attach_nodes_to_cluster()
      • IBMCloud.create_nodes()
      • IBMCloud.delete_volume_id()
      • IBMCloud.detach_volume()
      • IBMCloud.get_data_volumes()
      • IBMCloud.get_node_by_attached_volume()
      • IBMCloud.get_volume_id()
      • IBMCloud.restart_nodes()
      • IBMCloud.restart_nodes_by_stop_and_start()
      • IBMCloud.restart_nodes_by_stop_and_start_teardown()
      • IBMCloud.start_nodes()
      • IBMCloud.stop_nodes()
      • IBMCloud.wait_for_volume_attach()
    • IBMCloudBMNodes
      • IBMCloudBMNodes.create_nodes()
      • IBMCloudBMNodes.get_machines()
      • IBMCloudBMNodes.restart_nodes()
      • IBMCloudBMNodes.restart_nodes_by_stop_and_start()
      • IBMCloudBMNodes.restart_nodes_by_stop_and_start_teardown()
      • IBMCloudBMNodes.start_nodes()
      • IBMCloudBMNodes.stop_nodes()
      • IBMCloudBMNodes.terminate_nodes()
    • IBMCloudIPI
      • IBMCloudIPI.attach_nodes_to_cluster()
      • IBMCloudIPI.attach_volume()
      • IBMCloudIPI.create_and_attach_nodes_to_cluster()
      • IBMCloudIPI.create_nodes()
      • IBMCloudIPI.detach_volume()
      • IBMCloudIPI.get_data_volumes()
      • IBMCloudIPI.get_node_by_attached_volume()
      • IBMCloudIPI.read_default_config()
      • IBMCloudIPI.restart_nodes()
      • IBMCloudIPI.restart_nodes_by_stop_and_start()
      • IBMCloudIPI.restart_nodes_by_stop_and_start_teardown()
      • IBMCloudIPI.start_nodes()
      • IBMCloudIPI.stop_nodes()
      • IBMCloudIPI.terminate_nodes()
      • IBMCloudIPI.wait_for_nodes_to_stop()
      • IBMCloudIPI.wait_for_nodes_to_stop_or_terminate()
      • IBMCloudIPI.wait_for_nodes_to_terminate()
      • IBMCloudIPI.wait_for_volume_attach()
    • IBMPowerNodes
      • IBMPowerNodes.restart_nodes()
      • IBMPowerNodes.restart_nodes_by_stop_and_start()
      • IBMPowerNodes.restart_nodes_by_stop_and_start_teardown()
      • IBMPowerNodes.start_nodes()
      • IBMPowerNodes.stop_nodes()
    • KubevirtVMNodes
      • KubevirtVMNodes.create_nodes()
      • KubevirtVMNodes.get_kubevirt_vms()
      • KubevirtVMNodes.restart_nodes()
      • KubevirtVMNodes.restart_nodes_by_stop_and_start()
      • KubevirtVMNodes.restart_nodes_by_stop_and_start_teardown()
      • KubevirtVMNodes.start_nodes()
      • KubevirtVMNodes.stop_nodes()
      • KubevirtVMNodes.terminate_nodes()
    • NodesBase
      • NodesBase.attach_nodes_to_cluster()
      • NodesBase.attach_volume()
      • NodesBase.create_and_attach_nodes_to_cluster()
      • NodesBase.create_and_attach_volume()
      • NodesBase.create_and_attach_volumes()
      • NodesBase.create_nodes()
      • NodesBase.detach_volume()
      • NodesBase.disable_nodes_network_temporarily()
      • NodesBase.get_data_volumes()
      • NodesBase.get_node_by_attached_volume()
      • NodesBase.read_default_config()
      • NodesBase.restart_nodes()
      • NodesBase.restart_nodes_by_stop_and_start()
      • NodesBase.restart_nodes_by_stop_and_start_teardown()
      • NodesBase.start_nodes()
      • NodesBase.stop_nodes()
      • NodesBase.terminate_nodes()
      • NodesBase.wait_for_nodes_to_stop()
      • NodesBase.wait_for_nodes_to_stop_or_terminate()
      • NodesBase.wait_for_nodes_to_terminate()
      • NodesBase.wait_for_volume_attach()
    • PlatformNodesFactory
      • PlatformNodesFactory.get_nodes_platform()
    • RHVNodes
      • RHVNodes.get_rhv_vm_instances()
      • RHVNodes.restart_nodes()
      • RHVNodes.restart_nodes_by_stop_and_start()
      • RHVNodes.restart_nodes_by_stop_and_start_teardown()
      • RHVNodes.start_nodes()
      • RHVNodes.stop_nodes()
    • ROSAHCPNode
      • ROSAHCPNode.create_and_attach_nodes_to_cluster()
      • ROSAHCPNode.create_nodes()
    • VMWareIPINodes
      • VMWareIPINodes.get_vms()
    • VMWareLSONodes
      • VMWareLSONodes.detach_volume()
      • VMWareLSONodes.get_data_volumes()
      • VMWareLSONodes.get_volume_path()
    • VMWareNodes
      • VMWareNodes.attach_volume()
      • VMWareNodes.create_and_attach_nodes_to_cluster()
      • VMWareNodes.create_and_attach_volume()
      • VMWareNodes.create_and_attach_volumes()
      • VMWareNodes.detach_volume()
      • VMWareNodes.disable_nodes_network_temporarily()
      • VMWareNodes.get_data_volumes()
      • VMWareNodes.get_node_by_attached_volume()
      • VMWareNodes.get_reboot_events()
      • VMWareNodes.get_vm_from_ips()
      • VMWareNodes.get_vms()
      • VMWareNodes.get_volume_path()
      • VMWareNodes.restart_nodes()
      • VMWareNodes.restart_nodes_by_stop_and_start()
      • VMWareNodes.restart_nodes_by_stop_and_start_teardown()
      • VMWareNodes.start_nodes()
      • VMWareNodes.stop_nodes()
      • VMWareNodes.terminate_nodes()
      • VMWareNodes.wait_for_volume_attach()
    • VMWareUPINodes
      • VMWareUPINodes.terminate_nodes()
    • VSPHEREUPINode
      • VSPHEREUPINode.add_node()
      • VSPHEREUPINode.add_nodes_with_terraform()
      • VSPHEREUPINode.add_nodes_without_terraform()
      • VSPHEREUPINode.change_terraform_statefile_after_remove_vm()
      • VSPHEREUPINode.change_terraform_tfvars_after_remove_vm()
      • VSPHEREUPINode.generate_node_names_for_vsphere()
      • VSPHEREUPINode.get_vm_module_and_index()
      • VSPHEREUPINode.update_terraform_tfvars_compute_count()
      • VSPHEREUPINode.wait_for_connection_and_set_host_name()
  • ocs_ci.ocs.pod_exec module
    • CmdObj
      • CmdObj.check_ec
      • CmdObj.cmd
      • CmdObj.long_running
      • CmdObj.timeout
      • CmdObj.wait
    • Exec
      • Exec.run()
    • KubClient
      • KubClient.run()
    • register_class()
  • ocs_ci.ocs.provider_client_upgrade module
    • OperatorUpgrade
      • OperatorUpgrade.bump_ocs_version_on_clients()
      • OperatorUpgrade.run_acm_operator_upgrade()
      • OperatorUpgrade.run_operators_upgrade()
    • ProviderClusterOperatorUpgrade
      • ProviderClusterOperatorUpgrade.run_provider_upgrade()
    • ProviderUpgrade
      • ProviderUpgrade.pytestmark
  • ocs_ci.ocs.quay_operator module
    • QuayOperator
      • QuayOperator.check_quay_registry_endpoint()
      • QuayOperator.create_quay_registry()
      • QuayOperator.get_quay_endpoint()
      • QuayOperator.setup_quay_operator()
      • QuayOperator.teardown()
      • QuayOperator.wait_for_quay_endpoint()
    • check_super_user()
    • create_quay_org()
    • create_quay_repository()
    • delete_quay_repository()
    • get_super_user_token()
    • quay_super_user_login()
  • ocs_ci.ocs.rados_utils module
    • RadosHelper
      • RadosHelper.create_pool()
      • RadosHelper.get_mgr_proxy_container()
      • RadosHelper.get_num_pools()
      • RadosHelper.get_osd_dump_json()
      • RadosHelper.get_pg_primary()
      • RadosHelper.get_pg_random()
      • RadosHelper.get_pgid()
      • RadosHelper.get_pool_dump()
      • RadosHelper.get_pool_num()
      • RadosHelper.get_pool_property()
      • RadosHelper.is_up()
      • RadosHelper.kill_osd()
      • RadosHelper.list_pools()
      • RadosHelper.raw_cluster_cmd()
      • RadosHelper.revive_osd()
    • check_phase_of_rados_namespace()
    • corrupt_pg()
    • fetch_cephfilesystem_subvolume_groups()
    • fetch_filesystem_names()
    • fetch_pool_names()
    • fetch_rados_namespaces()
    • get_pg_log_dups_count_via_cot()
    • inject_corrupted_dups_into_pg_via_cot()
    • verify_cephblockpool_status()
  • ocs_ci.ocs.registry module
    • add_role_to_user()
    • change_registry_backend_to_ocs()
    • check_if_registry_stack_exists()
    • check_image_exists_in_registry()
    • enable_route_and_create_ca_for_registry_access()
    • get_build_name_by_pattern()
    • get_default_route_name()
    • get_oc_podman_login_cmd()
    • get_registry_pod_obj()
    • image_list_all()
    • image_pull()
    • image_pull_and_push()
    • image_push()
    • image_rm()
    • modify_registry_pod_count()
    • remove_role_from_user()
    • validate_image_exists()
    • validate_pvc_mount_on_registry_pod()
    • validate_registry_pod_status()
  • ocs_ci.ocs.replica_one module
    • count_osd_pods()
    • delete_replica1_cephblockpools_cr()
    • delete_replica_1_sc()
    • get_all_osd_names_by_device_class()
    • get_device_class_from_ceph()
    • get_failure_domains()
    • get_failures_domain_name()
    • get_osd_kb_used_data()
    • get_osd_pgs_used()
    • get_replica1_osd_deployment()
    • get_replica_1_osds()
    • modify_replica1_osd_count()
    • purge_replica1_osd()
    • scaledown_deployment()
  • ocs_ci.ocs.scale_lib module
    • FioPodScale
      • FioPodScale.cleanup()
      • FioPodScale.create_and_set_namespace()
      • FioPodScale.create_multi_pvc_pod()
      • FioPodScale.create_scale_pods()
      • FioPodScale.kind
      • FioPodScale.node_selector
      • FioPodScale.pvc_expansion()
    • add_worker_based_on_cpu_utilization()
    • add_worker_based_on_pods_count_per_node()
    • attach_multiple_pvc_to_pod_dict()
    • check_all_pod_reached_running_state_in_kube_job()
    • check_all_pvc_reached_bound_state_in_kube_job()
    • check_and_add_enough_worker()
    • check_enough_resource_available_in_workers()
    • collect_scale_data_in_file()
    • construct_pvc_clone_yaml_bulk_for_kube_job()
    • construct_pvc_creation_yaml_bulk_for_kube_job()
    • delete_objs_parallel()
    • get_expected_worker_count()
    • get_max_pvc_count()
    • get_pod_creation_time_in_kube_job()
    • get_rate_based_on_cls_iops()
    • get_size_based_on_cls_usage()
    • increase_pods_per_worker_node_count()
    • scale_capacity_with_deviceset()
    • scale_ocs_node()
    • validate_all_expanded_pvc_size_in_kube_job()
    • validate_all_pods_and_check_state()
    • validate_all_pvcs_and_check_state()
    • validate_node_and_oc_services_are_up_after_reboot()
  • ocs_ci.ocs.scale_noobaa_lib module
    • check_all_obc_reached_bound_state_in_kube_job()
    • check_all_obcs_status()
    • check_memory_leak_in_noobaa_endpoint_log()
    • cleanup()
    • construct_obc_creation_yaml_bulk_for_kube_job()
    • create_namespace()
    • delete_bucket()
    • delete_namespace()
    • delete_object()
    • fetch_noobaa_storage_class_name()
    • get_endpoint_pod_count()
    • get_hpa_utilization()
    • get_noobaa_pods_status()
    • get_pod_obj()
    • hsbench_cleanup()
    • hsbench_io()
    • hsbench_setup()
    • measure_obc_creation_time()
    • measure_obc_deletion_time()
    • noobaa_running_node_restart()
    • validate_bucket()
  • ocs_ci.ocs.scale_pgsql module
    • ScalePodPGSQL
      • ScalePodPGSQL.cleanup()
      • ScalePodPGSQL.setup_postgresql()
    • add_worker_node()
    • delete_worker_node()
  • ocs_ci.ocs.small_file_workload module
    • SmallFiles
      • SmallFiles.delete()
      • SmallFiles.run()
      • SmallFiles.setup_operations()
      • SmallFiles.setup_storageclass()
      • SmallFiles.setup_test_params()
      • SmallFiles.setup_vol_size()
  • ocs_ci.ocs.uninstall module
    • remove_cluster_logging_operator_from_ocs()
    • remove_monitoring_stack_from_ocs()
    • remove_ocp_registry_from_ocs()
    • uninstall_lso()
    • uninstall_ocs()
  • ocs_ci.ocs.utils module
    • apply_oc_resource()
    • check_ceph_healthly()
    • cleanup_ceph_nodes()
    • cluster_config_reindex()
    • collect_ceph_external()
    • collect_noobaa_db_dump()
    • collect_ocs_logs()
    • collect_pod_container_rpm_package()
    • collect_prometheus_metrics()
    • config_ntp()
    • create_ceph_conf()
    • create_ceph_nodes()
    • create_nodes()
    • create_oc_resource()
    • enable_console_plugin()
    • enable_mco_console_plugin()
    • export_mg_pods_logs()
    • generate_repo_file()
    • get_active_acm_index()
    • get_all_acm_and_recovery_indexes()
    • get_all_acm_indexes()
    • get_ceph_versions()
    • get_cluster_object()
    • get_dr_operator_versions()
    • get_expected_nb_db_psql_version()
    • get_external_mode_rhcs()
    • get_helper_pods_output()
    • get_iso_file_url()
    • get_logs_ocp_mg_pods()
    • get_namespce_name_by_pattern()
    • get_nb_db_psql_version_from_image()
    • get_non_acm_and_non_recovery_cluster_config()
    • get_non_acm_cluster_config()
    • get_non_acm_cluster_indexes()
    • get_openstack_driver()
    • get_passive_acm_index()
    • get_pod_name_by_pattern()
    • get_primary_cluster_config()
    • get_primary_cluster_index()
    • get_public_network()
    • get_recovery_cluster_config()
    • get_rook_version()
    • get_root_permissions()
    • hard_reboot()
    • is_acm_cluster()
    • is_dr_scenario()
    • is_recovery_cluster()
    • keep_alive()
    • kill_osd_external()
    • label_pod_security_admission()
    • node_power_failure()
    • oc_get_all_obc_names()
    • open_firewall_port()
    • query_nb_db_psql_version()
    • reboot_node()
    • revive_osd_external()
    • run_must_gather()
    • search_ethernet_interface()
    • set_cdn_repo()
    • set_recovery_as_primary()
    • setup_cdn_repos()
    • setup_ceph_toolbox()
    • setup_deb_cdn_repo()
    • setup_deb_repos()
    • setup_repos()
    • setup_vm_node()
    • store_cluster_state()
    • thread_init_class()
    • update_ca_cert()
    • write_docker_daemon_json()
  • ocs_ci.ocs.version module
    • get_environment_info()
    • get_ocp_version()
    • get_ocp_version_dict()
    • get_ocs_version()
    • if_version()
    • main()
    • report_ocs_version()
  • ocs_ci.ocs.warp module
    • Warp
      • Warp.cleanup()
      • Warp.create_resource_warp()
      • Warp.run_benchmark()
      • Warp.validate_warp_workload()
  • ocs_ci.ocs.workload module
    • WorkLoad
      • WorkLoad.run()
      • WorkLoad.setup()
  • Module contents
• ocs_ci.tests package
  • Submodules
  • ocs_ci.tests.test_import_all module
    • list_submodules()
    • test_import()
  • ocs_ci.tests.test_pytest_sanity module
    • test_nontest_code_unexpected_in_tests_dir()
  • Module contents
• ocs_ci.utility package
  • Subpackages
    • ocs_ci.utility.perf_dash package
      • Submodules
      • ocs_ci.utility.perf_dash.dashboard_api module
      • Module contents
    • ocs_ci.utility.spreadsheet package
      • Submodules
      • ocs_ci.utility.spreadsheet.spreadsheet_api module
      • Module contents
    • ocs_ci.utility.tests package
      • Submodules
      • ocs_ci.utility.tests.test_azure_utils module
      • ocs_ci.utility.tests.test_deployment_utils module
      • ocs_ci.utility.tests.test_gcp module
      • ocs_ci.utility.tests.test_prometheus module
      • ocs_ci.utility.tests.test_rgwutils module
      • ocs_ci.utility.tests.test_utils module
      • ocs_ci.utility.tests.test_utils_timeout_sampler module
      • ocs_ci.utility.tests.test_version module
      • Module contents
    • ocs_ci.utility.workloads package
      • Submodules
      • ocs_ci.utility.workloads.fio module
      • ocs_ci.utility.workloads.helpers module
      • ocs_ci.utility.workloads.jenkins module
      • Module contents
  • Submodules
  • ocs_ci.utility.assisted_installer module
    • AccountsMgmtAPI
      • AccountsMgmtAPI.get_pull_secret_for_current_user()
    • AssistedInstallerAPI
      • AssistedInstallerAPI.create_cluster()
      • AssistedInstallerAPI.create_infra_env()
      • AssistedInstallerAPI.delete_cluster()
      • AssistedInstallerAPI.delete_infra_env()
      • AssistedInstallerAPI.download_cluster_file()
      • AssistedInstallerAPI.download_cluster_logs()
      • AssistedInstallerAPI.download_infra_file()
      • AssistedInstallerAPI.get_cluster()
      • AssistedInstallerAPI.get_cluster_admin_credentials()
      • AssistedInstallerAPI.get_cluster_host()
      • AssistedInstallerAPI.get_cluster_hosts()
      • AssistedInstallerAPI.get_cluster_kubeconfig()
      • AssistedInstallerAPI.get_clusters()
      • AssistedInstallerAPI.get_component_versions()
      • AssistedInstallerAPI.get_discovery_iso_url()
      • AssistedInstallerAPI.get_infra_env()
      • AssistedInstallerAPI.get_infra_env_host()
      • AssistedInstallerAPI.get_infra_env_hosts()
      • AssistedInstallerAPI.get_infra_envs()
      • AssistedInstallerAPI.install_cluster()
      • AssistedInstallerAPI.update_infra_env_host()
    • OpenShiftAPI
      • OpenShiftAPI.api_base_url
      • OpenShiftAPI.delete_request()
      • OpenShiftAPI.get_api_endpoint_url()
      • OpenShiftAPI.get_request()
      • OpenShiftAPI.headers
      • OpenShiftAPI.patch_request()
      • OpenShiftAPI.post_request()
      • OpenShiftAPI.token
  • ocs_ci.utility.aws module
    • AWS
      • AWS.append_security_group()
      • AWS.attach_role_policy()
      • AWS.attach_volume()
      • AWS.block_instances_access()
      • AWS.cf_client
      • AWS.check_volume_attributes()
      • AWS.cloudfront_client
      • AWS.create_hosted_zone()
      • AWS.create_iam_role()
      • AWS.create_security_group()
      • AWS.create_stack()
      • AWS.create_volume()
      • AWS.create_volume_and_attach()
      • AWS.delete_all_record_sets()
      • AWS.delete_apps_record_set()
      • AWS.delete_bucket()
      • AWS.delete_buckets()
      • AWS.delete_cf_stack_including_dependencies()
      • AWS.delete_cloudformation_stacks()
      • AWS.delete_cloudfront_distribution()
      • AWS.delete_cloudfront_origin_access_identity()
      • AWS.delete_hosted_zone()
      • AWS.delete_iam_role()
      • AWS.delete_objects_in_bucket()
      • AWS.delete_oidc_provider()
      • AWS.delete_record()
      • AWS.delete_record_from_base_domain()
      • AWS.delete_role_policy()
      • AWS.delete_s3_object()
      • AWS.delete_security_group()
      • AWS.delete_volume()
      • AWS.detach_and_delete_volume()
      • AWS.detach_role_policy()
      • AWS.detach_volume()
      • AWS.disable_cloudfront_distribution()
      • AWS.ec2_client
      • AWS.ec2_resource
      • AWS.elb_client
      • AWS.get_all_security_groups()
      • AWS.get_all_stacks()
      • AWS.get_attached_role_policies()
      • AWS.get_availability_zone_id_by_instance_id()
      • AWS.get_bucket_time_based_rules()
      • AWS.get_buckets_to_delete()
      • AWS.get_caller_identity()
      • AWS.get_cloudformation_stacks()
      • AWS.get_cloudfront_distribution()
      • AWS.get_cloudfront_distribution_config()
      • AWS.get_cloudfront_distributions()
      • AWS.get_cloudfront_origin_access_identies()
      • AWS.get_cloudfront_origin_access_identity()
      • AWS.get_cluster_subnet_ids()
      • AWS.get_ec2_instance()
      • AWS.get_ec2_instance_volumes()
      • AWS.get_hosted_zone_details()
      • AWS.get_hosted_zone_id()
      • AWS.get_hosted_zone_id_for_domain()
      • AWS.get_iam_roles()
      • AWS.get_instance_id_from_private_dns_name()
      • AWS.get_instance_profiles_for_role()
      • AWS.get_instances_by_name_pattern()
      • AWS.get_instances_response_by_name_pattern()
      • AWS.get_instances_status_by_id()
      • AWS.get_matching_stacks()
      • AWS.get_ns_for_hosted_zone()
      • AWS.get_record_sets()
      • AWS.get_role_policies()
      • AWS.get_s3_bucket_object_url()
      • AWS.get_security_groups_by_instance_id()
      • AWS.get_stack_instance_id()
      • AWS.get_stack_name_by_instance_id()
      • AWS.get_stack_params()
      • AWS.get_volume_data()
      • AWS.get_volume_tag_value()
      • AWS.get_volumes_by_name_pattern()
      • AWS.get_volumes_by_tag_pattern()
      • AWS.get_vpc_id_by_instance_id()
      • AWS.get_worker_ignition_location()
      • AWS.get_worker_instance_profile_name()
      • AWS.get_worker_stacks()
      • AWS.iam_client
      • AWS.list_buckets()
      • AWS.remove_role_from_instance_profile()
      • AWS.remove_security_group()
      • AWS.restart_ec2_instances()
      • AWS.restart_ec2_instances_by_stop_and_start()
      • AWS.restore_instances_access()
      • AWS.route53_client
      • AWS.s3_client
      • AWS.s3_resource
      • AWS.start_ec2_instances()
      • AWS.stop_ec2_instances()
      • AWS.store_security_groups_for_instances()
      • AWS.sts_client
      • AWS.terminate_ec2_instances()
      • AWS.update_cloudfront_distribution()
      • AWS.update_hosted_zone_record()
      • AWS.upload_file_to_s3_bucket()
      • AWS.wait_for_instances_to_stop()
      • AWS.wait_for_instances_to_stop_or_terminate()
      • AWS.wait_for_instances_to_terminate()
      • AWS.wait_for_record_set()
    • AWSTimeoutException
    • StackStatusError
    • check_root_volume()
    • create_and_attach_ebs_volumes()
    • create_and_attach_sts_role()
    • create_and_attach_volume_for_all_workers()
    • delete_cloudfront_origin_access_identities()
    • delete_cluster_buckets()
    • delete_sts_iam_roles()
    • delete_subnet_tags()
    • destroy_volumes()
    • get_data_volumes()
    • get_instances_ids_and_names()
    • get_rhel_worker_instances()
    • get_stack_name_from_instance_dict()
    • get_vpc_id_by_node_obj()
    • terminate_rhel_workers()
    • update_config_from_s3()
    • wait_for_distribution_status_deployed()
  • ocs_ci.utility.azure_utils module
    • AZURE
      • AZURE.az_login()
      • AZURE.cluster_resource_group
      • AZURE.compute_client
      • AZURE.credentials
      • AZURE.detach_volume()
      • AZURE.get_data_volumes()
      • AZURE.get_disk_state()
      • AZURE.get_node_by_attached_volume()
      • AZURE.get_storage_account_properties()
      • AZURE.get_storage_accounts()
      • AZURE.get_storage_accounts_names()
      • AZURE.get_vm_instance()
      • AZURE.get_vm_names()
      • AZURE.get_vm_power_status()
      • AZURE.resource_client
      • AZURE.restart_vm_instances()
      • AZURE.restart_vm_instances_by_stop_and_start()
      • AZURE.set_auth_env_vars()
      • AZURE.start_vm_instances()
      • AZURE.stop_vm_instances()
      • AZURE.storage_client
    • AzureAroUtil
      • AzureAroUtil.check_cluster_response_ok()
      • AzureAroUtil.create_aro_service_principal()
      • AzureAroUtil.create_cluster()
      • AzureAroUtil.create_network()
      • AzureAroUtil.delete_aro_service_principal()
      • AzureAroUtil.delete_dns_records()
      • AzureAroUtil.delete_network()
      • AzureAroUtil.destroy_cluster()
      • AzureAroUtil.get_aro_ocp_version()
      • AzureAroUtil.get_cluster_details()
      • AzureAroUtil.get_kubeconfig()
      • AzureAroUtil.set_dns_records()
      • AzureAroUtil.update_kubeconfig_with_ocs_ca()
      • AzureAroUtil.write_kubeadmin_password()
    • azure_storageaccount_check()
    • load_cluster_resource_group()
    • load_service_principal_dict()
  • ocs_ci.utility.baremetal module
    • BAREMETAL
      • BAREMETAL.get_ipmi_ctx()
      • BAREMETAL.get_nodes_ipmi_ctx()
      • BAREMETAL.get_power_status()
      • BAREMETAL.restart_baremetal_machines()
      • BAREMETAL.start_baremetal_machines()
      • BAREMETAL.start_baremetal_machines_with_ipmi_ctx()
      • BAREMETAL.stop_baremetal_machines()
      • BAREMETAL.verify_machine_is_down()
    • update_uefi_boot_order()
  • ocs_ci.utility.bootstrap module
    • gather_bootstrap()
    • get_gather_bootstrap_node_data()
    • get_node_data_aws()
    • get_node_data_vsphere()
  • ocs_ci.utility.cco module
    • configure_cloud_credential_operator()
    • create_manifests()
    • create_service_id()
    • delete_oidc_resource_group()
    • delete_service_id()
    • extract_ccoctl_binary()
    • extract_credentials_requests()
    • extract_credentials_requests_ibmcloud()
    • get_cco_container_image()
    • process_credentials_requests_aws()
    • process_credentials_requests_azure()
    • set_credentials_mode_manual()
    • set_resource_group_name()
  • ocs_ci.utility.connection module
    • Connection
      • Connection.exec_cmd()
      • Connection.upload_file()
  • ocs_ci.utility.csr module
    • approve_csrs()
    • approve_pending_csr()
    • check_no_pending_csr()
    • get_csr_resource()
    • get_nodes_csr()
    • get_pending_csr()
    • wait_for_all_nodes_csr_and_approve()
  • ocs_ci.utility.decorators module
    • enable_high_recovery()
    • enable_high_recovery_during_rebalance_flag()
    • switch_to_client_for_function()
    • switch_to_default_cluster_index_at_last()
    • switch_to_orig_index_at_last()
    • switch_to_provider_for_function()
  • ocs_ci.utility.deployment module
    • create_external_secret()
    • create_openshift_install_log_file()
    • get_and_apply_idms_from_catalog()
    • get_cluster_prefix()
    • get_ocp_ga_version()
    • get_ocp_release_image()
    • get_ocp_release_image_from_installer()
    • workaround_mark_disks_as_ssd()
  • ocs_ci.utility.deployment_openshift_logging module
    • create_UI_Plugin()
    • create_clusterlogforwarder()
    • create_clusterlogging_operator_group()
    • create_clusterobservability_operator_group()
    • create_lokistack()
    • create_lokistack_operator_group()
    • create_namespace()
    • get_cluster_observability_subscription()
    • get_clusterlogging_subscription()
    • get_lokistack_subscription()
    • get_obc()
    • get_secret_to_lokistack()
    • install_logging()
    • setup_sa_permissions()
  • ocs_ci.utility.environment_check module
    • assign_get_values()
    • compare_dicts()
    • get_environment_status()
    • get_status_after_execution()
    • get_status_before_execution()
  • ocs_ci.utility.flexy module
    • configure_allowed_domains_in_proxy()
    • load_cluster_info()
  • ocs_ci.utility.gcp module
    • GoogleCloud
      • GoogleCloud.base_instance_operation()
      • GoogleCloud.base_instances_operation()
      • GoogleCloud.get_instance_zone_dict()
      • GoogleCloud.get_instances_zones()
      • GoogleCloud.get_operation_data()
      • GoogleCloud.get_operations_data()
      • GoogleCloud.restart_instances()
      • GoogleCloud.restart_instances_by_stop_and_start()
      • GoogleCloud.start_instances()
      • GoogleCloud.stop_instances()
      • GoogleCloud.terminate_instances()
      • GoogleCloud.wait_for_operations_to_complete()
    • GoogleCloudUtil
      • GoogleCloudUtil.compute_driver
      • GoogleCloudUtil.service_account
    • SERVICE_ACCOUNT_KEY_FILEPATH
    • load_service_account_key_dict()
  • ocs_ci.utility.ibmcloud module
    • IBMCloud
      • IBMCloud.attach_volume()
      • IBMCloud.delete_volume_id()
      • IBMCloud.detach_volume()
      • IBMCloud.get_data_volumes()
      • IBMCloud.get_node_by_attached_volume()
      • IBMCloud.get_volume_id()
      • IBMCloud.is_volume_attached()
      • IBMCloud.restart_nodes()
      • IBMCloud.restart_nodes_by_stop_and_start()
      • IBMCloud.start_nodes()
      • IBMCloud.stop_nodes()
      • IBMCloud.wait_for_volume_attach()
    • IBMCloudIPI
      • IBMCloudIPI.attach_volume()
      • IBMCloudIPI.check_node_status()
      • IBMCloudIPI.detach_volume()
      • IBMCloudIPI.is_volume_attached()
      • IBMCloudIPI.restart_nodes()
      • IBMCloudIPI.restart_nodes_by_stop_and_start()
      • IBMCloudIPI.restart_nodes_by_stop_and_start_force()
      • IBMCloudIPI.start_nodes()
      • IBMCloudIPI.stop_nodes()
      • IBMCloudIPI.terminate_nodes()
      • IBMCloudIPI.wait_for_volume_attach()
    • IBMCloudObjectStorage
      • IBMCloudObjectStorage.delete_bucket()
      • IBMCloudObjectStorage.delete_objects()
      • IBMCloudObjectStorage.get_bucket_objects()
      • IBMCloudObjectStorage.get_buckets()
    • add_deployment_dependencies()
    • add_security_group_rule()
    • assign_floating_ips_to_workers()
    • attach_subnet_to_public_gateway()
    • cleanup_policies_and_service_ids()
    • configure_ingress_load_balancer_security_group()
    • create_address_prefix()
    • create_cluster()
    • create_public_gateway()
    • create_resource_group()
    • create_subnet()
    • create_vpc()
    • delete_account_policy()
    • delete_dns_records()
    • delete_service_id()
    • destroy_cluster()
    • find_free_network_subnets()
    • get_api_token()
    • get_bucket_regions_map()
    • get_cluster_account_policies()
    • get_cluster_details()
    • get_cluster_service_ids()
    • get_ibmcloud_ocp_version()
    • get_kubeconfig()
    • get_region()
    • get_resource_group_name()
    • get_used_subnets()
    • get_worker_floating_ips()
    • is_cluster_installed()
    • is_ibm_platform()
    • label_nodes_region()
    • list_clusters()
    • login()
    • run_ibmcloud_cmd()
    • set_region()
    • set_resource_group_name()
    • set_target_region()
  • ocs_ci.utility.ibmcloud_bm module
    • IBMCloudBM
      • IBMCloudBM.get_all_machines()
      • IBMCloudBM.get_machines_by_names()
      • IBMCloudBM.get_machines_that_are_not_off_from_sensor_data()
      • IBMCloudBM.login()
      • IBMCloudBM.restart_machines()
      • IBMCloudBM.restart_machines_by_stop_and_start()
      • IBMCloudBM.run_ibmcloud_bm_cmd()
      • IBMCloudBM.start_machines()
      • IBMCloudBM.stop_machines()
  • ocs_ci.utility.ipam module
    • IPAM
      • IPAM.assign_ip()
      • IPAM.assign_ips()
      • IPAM.release_ip()
      • IPAM.release_ips()
  • ocs_ci.utility.jira module
    • JiraHelper
      • JiraHelper.add_comment()
      • JiraHelper.get_issue()
  • ocs_ci.utility.json module
    • SetToListJSONEncoder
      • SetToListJSONEncoder.default()
  • ocs_ci.utility.kms module
    • AzureKV
      • AzureKV.azure_kv_osd_keys()
      • AzureKV.azure_kv_secrets()
      • AzureKV.create_azure_kv_csi_kms_connection_details()
      • AzureKV.create_azure_kv_ocs_csi_kms_connection_details()
      • AzureKV.create_azure_kv_secrets()
      • AzureKV.deploy()
      • AzureKV.is_azure_kv_connection_exists()
      • AzureKV.post_deploy_verification()
      • AzureKV.remove_kmsid()
      • AzureKV.verify_osd_keys_present_on_azure_kv()
      • AzureKV.verify_pv_secrets_present_in_azure_kv()
    • HPCS
      • HPCS.cleanup()
      • HPCS.create_hpcs_csi_kms_connection_details()
      • HPCS.create_ibm_kp_kms_secret()
      • HPCS.create_ocs_hpcs_resources()
      • HPCS.delete_resource()
      • HPCS.deploy()
      • HPCS.deploy_hpcs_external()
      • HPCS.gather_hpcs_config()
      • HPCS.gather_init_hpcs_conf()
      • HPCS.get_token_for_ibm_api_key()
      • HPCS.list_hpcs_keys()
      • HPCS.post_deploy_verification()
      • HPCS.validate_external_hpcs()
    • KMIP
      • KMIP.check_key_exists_in_ciphertrust()
      • KMIP.cleanup()
      • KMIP.create_ciphertrust_key()
      • KMIP.create_kmip_csi_kms_connection_details()
      • KMIP.create_kmip_secret()
      • KMIP.create_odf_kmip_resources()
      • KMIP.delete_ciphertrust_key()
      • KMIP.deploy()
      • KMIP.deploy_kmip_ciphertrust()
      • KMIP.get_key_info_ciphertrust()
      • KMIP.get_key_list_ciphertrust()
      • KMIP.get_noobaa_key_id()
      • KMIP.get_osd_key_ids()
      • KMIP.post_deploy_verification()
      • KMIP.update_kmip_env_vars()
      • KMIP.validate_ciphertrust_deployment()
    • KMS
      • KMS.create_csi_kms_resources()
      • KMS.create_resource()
      • KMS.deploy()
      • KMS.post_deploy_verification()
    • Vault
      • Vault.cleanup()
      • Vault.create_namespace()
      • Vault.create_ocs_kube_auth_resources()
      • Vault.create_ocs_vault_cert_resources()
      • Vault.create_ocs_vault_resources()
      • Vault.create_tenant_configmap()
      • Vault.create_tenant_sa()
      • Vault.create_token_reviewer_resources()
      • Vault.create_vault_csi_kms_connection_details()
      • Vault.create_vault_csi_kms_token()
      • Vault.create_vault_kube_auth_role()
      • Vault.deploy()
      • Vault.deploy_vault_external()
      • Vault.deploy_vault_internal()
      • Vault.gather_init_vault_conf()
      • Vault.gather_vault_config()
      • Vault.generate_vault_token()
      • Vault.get_noobaa_secret()
      • Vault.get_osd_secret()
      • Vault.get_pv_secret()
      • Vault.get_vault_backend_path()
      • Vault.get_vault_connection_info()
      • Vault.get_vault_kube_auth_role()
      • Vault.get_vault_namespace()
      • Vault.get_vault_path_token()
      • Vault.kms_vault_policy_name
      • Vault.post_deploy_verification()
      • Vault.remove_vault_backend_path()
      • Vault.remove_vault_namespace()
      • Vault.remove_vault_policy()
      • Vault.set_vault_policy()
      • Vault.setup_vault_client_cert()
      • Vault.update_vault_env_vars()
      • Vault.validate_external_vault()
      • Vault.vault_backend_path_exists()
      • Vault.vault_create_backend_path()
      • Vault.vault_create_namespace()
      • Vault.vault_create_policy()
      • Vault.vault_kube_auth_setup()
      • Vault.vault_namespace_exists()
      • Vault.vault_path_token
      • Vault.vault_sealed()
      • Vault.vault_unseal()
    • fetch_noobaa_secret_from_vault()
    • fetch_osd_secret_from_vault()
    • get_encryption_kmsid()
    • get_kms_deployment()
    • get_kms_details()
    • get_kms_endpoint()
    • get_ksctl_cli()
    • is_key_present_in_path()
    • is_kms_enabled()
    • remove_kmsid()
    • remove_token_reviewer_resources()
    • set_kms_endpoint()
    • update_csi_kms_vault_connection_details()
    • vault_kv_list()
  • ocs_ci.utility.kubevirt_vm module
    • KubevirtVM
      • KubevirtVM.get_all_kubevirt_vms()
      • KubevirtVM.get_kubevirt_vms_by_names()
      • KubevirtVM.pause_kubevirt_vms()
      • KubevirtVM.restart_kubevirt_vms()
      • KubevirtVM.restart_kubevirt_vms_by_stop_and_start()
      • KubevirtVM.restart_kubevirt_vms_by_stop_and_start_teardown()
      • KubevirtVM.run_kubevirt_vm_cmd()
      • KubevirtVM.start_kubevirt_vms()
      • KubevirtVM.stop_kubevirt_vms()
      • KubevirtVM.unpause_kubevirt_vms()
      • KubevirtVM.wait_for_vms_status()
    • get_vm_name()
  • ocs_ci.utility.load_balancer module
    • LoadBalancer
      • LoadBalancer.compact_mode_route_ingress_trafic_to_control_plane_nodes()
      • LoadBalancer.modify_haproxy_service()
      • LoadBalancer.reload_daemon()
      • LoadBalancer.remove_boostrap_in_proxy()
      • LoadBalancer.remove_compute_node_in_proxy()
      • LoadBalancer.rename_haproxy()
      • LoadBalancer.rename_haproxy_conf_and_reload()
      • LoadBalancer.restart_haproxy()
      • LoadBalancer.restart_service()
      • LoadBalancer.update_haproxy_with_nodes()
  • ocs_ci.utility.localstorage module
    • check_local_volume_local_volume_set()
    • check_pvs_created()
    • fetch_all_device_paths()
    • get_local_volume_cr()
    • get_lso_channel()
    • get_new_device_paths()
  • ocs_ci.utility.lvm_utils module
    • lvcreate()
    • make_partition()
    • osd_scenario1()
    • osd_scenario1_dmcrypt()
    • osd_scenario2()
    • osd_scenario2_dmcrypt()
    • osd_scenario3()
    • osd_scenario3_dmcrypt()
    • pvcreate()
    • vgcreate()
  • ocs_ci.utility.lvmo_utils module
    • delete_lvm_cluster()
    • get_lvm_cluster_name()
    • get_sno_blockdevices()
    • get_sno_disks_by_path()
    • lvmo_health_check()
    • lvmo_health_check_base()
  • ocs_ci.utility.managedservice module
    • add_header_footer_to_key()
    • generate_onboarding_token()
    • get_storage_provider_endpoint()
    • remove_header_footer_from_key()
  • ocs_ci.utility.memory module
    • MemoryMonitor
      • MemoryMonitor.run()
    • catch_empty_mem_df()
    • get_consumed_ram()
    • get_consumed_virt_mem()
    • get_peak_sum_mem()
    • mon
    • peak_mem_stats_human_readable()
    • read_peak_mem_stats()
    • start_monitor_memory()
    • stop_monitor_memory()
  • ocs_ci.utility.metadata_utils module
    • available_subvolumes()
    • check_setmetadata_availability()
    • created_subvolume()
    • disable_metadata()
    • enable_metadata()
    • fetch_metadata()
    • patch_metadata()
    • update_testdata_for_external_modes()
    • validate_metadata()
  • ocs_ci.utility.mirror_openshift module
    • prepare_mirror_openshift_credential_files()
  • ocs_ci.utility.monitoring_tool module
    • check_go_version()
    • comparetool_deviation_check()
    • convert_yaml_file_to_json_file()
  • ocs_ci.utility.multicluster module
    • MDRClusterUpgradeParametrize
      • MDRClusterUpgradeParametrize.config_init()
    • MultiClusterUpgradeParametrize
      • MultiClusterUpgradeParametrize.MULTICLUSTER_UPGRADE_MARKERS
      • MultiClusterUpgradeParametrize.config_init()
      • MultiClusterUpgradeParametrize.generate_config_index_map()
      • MultiClusterUpgradeParametrize.generate_pytest_parameters()
      • MultiClusterUpgradeParametrize.generate_role_ranks()
      • MultiClusterUpgradeParametrize.generate_role_to_param_tuple_map()
      • MultiClusterUpgradeParametrize.generate_zone_ranks()
      • MultiClusterUpgradeParametrize.generate_zone_role_map()
      • MultiClusterUpgradeParametrize.get_all_acm_roles_to_param_tuple()
      • MultiClusterUpgradeParametrize.get_all_odf_roles_to_param_tuple()
      • MultiClusterUpgradeParametrize.get_all_roles_to_param_tuples()
      • MultiClusterUpgradeParametrize.get_dr_all_param_tuples()
      • MultiClusterUpgradeParametrize.get_pytest_params_tuple()
      • MultiClusterUpgradeParametrize.get_roles()
      • MultiClusterUpgradeParametrize.get_zone_info()
    • RDRClusterUpgradeParametrize
      • RDRClusterUpgradeParametrize.config_init()
    • get_multicluster_upgrade_parametrizer()
  • ocs_ci.utility.nfs_utils module
    • check_cluster_resources_for_nfs()
    • create_nfs_load_balancer_service()
    • create_nfs_sc_retain()
    • delete_nfs_load_balancer_service()
    • nfs_disable()
    • nfs_enable()
    • provisioner_selectors()
    • skip_test_if_nfs_client_unavailable()
    • unmount()
    • update_etc_hosts_on_nfs_client()
  • ocs_ci.utility.ocp_upgrade module
    • pause_machinehealthcheck()
    • resume_machinehealthcheck()
  • ocs_ci.utility.ocs_build module
    • init_arg_parser()
    • main()
  • ocs_ci.utility.openshift_console module
    • OpenshiftConsole
      • OpenshiftConsole.run_openshift_console()
      • OpenshiftConsole.setup_console_prereq()
  • ocs_ci.utility.openshift_dedicated module
    • create_cluster()
    • destroy_cluster()
    • download_ocm_cli()
    • get_admin_name()
    • get_cached_credentials()
    • get_cluster_details()
    • get_credentials()
    • get_kubeadmin_password()
    • get_kubeconfig()
    • list_cluster()
    • login()
    • update_cached_credentials()
  • ocs_ci.utility.pagerduty module
    • PagerDutyAPI
      • PagerDutyAPI.check_incident_cleared()
      • PagerDutyAPI.create()
      • PagerDutyAPI.delete()
      • PagerDutyAPI.get()
      • PagerDutyAPI.get_escalation_policy_id()
      • PagerDutyAPI.get_integration_dict()
      • PagerDutyAPI.get_service_dict()
      • PagerDutyAPI.get_vendor_id()
      • PagerDutyAPI.wait_for_incident_cleared()
    • check_incident_list()
    • get_pagerduty_service_id()
    • set_pagerduty_faas_secret()
    • set_pagerduty_integration_secret()
  • ocs_ci.utility.pgsql module
    • PgsqlManager
      • PgsqlManager.Cursor
      • PgsqlManager.close_conn()
      • PgsqlManager.conn
      • PgsqlManager.conn_closure()
      • PgsqlManager.create_database()
      • PgsqlManager.delete_database()
  • ocs_ci.utility.powernodes module
    • PowerNodes
      • PowerNodes.iskvm()
      • PowerNodes.restart_powernodes_machines()
      • PowerNodes.restart_powernodes_machines_powervs()
      • PowerNodes.start_powernodes_machines()
      • PowerNodes.start_powernodes_machines_powervs()
      • PowerNodes.stop_powernodes_machines()
      • PowerNodes.stop_powernodes_machines_powervs()
      • PowerNodes.verify_machine_is_down()
  • ocs_ci.utility.prometheus module
    • PrometheusAPI
      • PrometheusAPI.check_alert_cleared()
      • PrometheusAPI.generate_cert()
      • PrometheusAPI.get()
      • PrometheusAPI.prometheus_log()
      • PrometheusAPI.query()
      • PrometheusAPI.query_range()
      • PrometheusAPI.refresh_connection()
      • PrometheusAPI.verify_alerts_via_prometheus()
      • PrometheusAPI.wait_for_alert()
    • PrometheusAlertSubscriber
      • PrometheusAlertSubscriber.clear_alerts()
      • PrometheusAlertSubscriber.get_alerts()
      • PrometheusAlertSubscriber.prometheus_alert_list
      • PrometheusAlertSubscriber.run()
      • PrometheusAlertSubscriber.subscribe()
      • PrometheusAlertSubscriber.unsubscribe()
    • check_alert_list()
    • check_query_range_result_enum()
    • check_query_range_result_limits()
    • check_query_range_result_viafunction()
    • log_parsing_error()
    • validate_status()
  • ocs_ci.utility.proxy module
    • update_kubeconfig_with_proxy_url_for_client()
  • ocs_ci.utility.psiutils module
    • PSIUtils
      • PSIUtils.attach_volume()
      • PSIUtils.check_expected_vol_status()
      • PSIUtils.check_vol_deleted()
      • PSIUtils.create_volume()
      • PSIUtils.detach_and_delete_vols()
      • PSIUtils.get_instances_with_pattern()
      • PSIUtils.get_volumes_with_tag()
  • ocs_ci.utility.reporting module
    • get_polarion_id()
    • get_rp_launch_attributes()
    • get_rp_launch_description()
    • get_rp_launch_name()
    • update_live_must_gather_image()
  • ocs_ci.utility.resource_check module
    • create_resource_dct()
    • get_environment_status_after_execution()
  • ocs_ci.utility.retry module
    • catch_exceptions()
    • retry()
    • retry_until_exception()
    • validate_retry_params()
  • ocs_ci.utility.rgwutils module
    • get_rgw_count()
  • ocs_ci.utility.rhv module
    • RHV
      • RHV.add_disk()
      • RHV.add_disks()
      • RHV.close_engine_connection()
      • RHV.create_engine_connection()
      • RHV.disks_service
      • RHV.engine_connection
      • RHV.get_compute_vms()
      • RHV.get_disk_attachment_service()
      • RHV.get_disk_attachments()
      • RHV.get_disk_attachments_service()
      • RHV.get_disk_service()
      • RHV.get_disks_by_pattern()
      • RHV.get_rhv_vm_instance()
      • RHV.get_vm_names()
      • RHV.get_vm_service()
      • RHV.get_vm_status()
      • RHV.get_vms_by_pattern()
      • RHV.reboot_rhv_vms()
      • RHV.remove_disk()
      • RHV.remove_disks()
      • RHV.restart_rhv_vms_by_stop_and_start()
      • RHV.start_rhv_vms()
      • RHV.stop_rhv_vms()
      • RHV.system_service
      • RHV.vms_service
  • ocs_ci.utility.rosa module
    • appliance_mode_cluster()
    • create_account_roles()
    • create_cluster()
    • create_oidc_config()
    • create_oidc_provider()
    • create_operator_roles()
    • delete_account_roles()
    • delete_odf_addon()
    • delete_oidc_config()
    • delete_oidc_provider()
    • delete_operator_roles()
    • destroy_appliance_mode_cluster()
    • destroy_rosa_cluster()
    • download_rosa_cli()
    • edit_addon_installation()
    • get_addon_info()
    • get_associated_oidc_config_id()
    • get_console_url()
    • get_latest_oidc_config_id()
    • get_oidc_config_ids()
    • get_oidc_endpoint_url()
    • get_operator_roles_data()
    • get_rosa_cluster_service_id()
    • get_rosa_service_details()
    • install_odf_addon()
    • is_odf_addon_installed()
    • label_nodes()
    • login()
    • post_onboarding_verification()
    • rosa_create_htpasswd_idp()
    • rosa_delete_htpasswd_idp()
    • rosa_list_idps()
    • rosa_ocp_version_endpoint()
    • upgrade_rosa_cluster()
    • validate_ocp_version()
    • wait_console_url()
    • wait_for_addon_to_be_ready()
    • wait_operator_roles()
  • ocs_ci.utility.secret module
    • link_all_sa_and_secret()
    • link_all_sa_and_secret_and_delete_pods()
    • link_sa_and_secret()
  • ocs_ci.utility.service module
    • KubeletService
      • KubeletService.restart()
      • KubeletService.start()
      • KubeletService.stop()
    • Service
      • Service.kill()
      • Service.restart()
      • Service.start()
      • Service.status()
      • Service.stop()
      • Service.verify_service()
  • ocs_ci.utility.ssl_certs module
    • CSR
    • Certificate
      • Certificate.crt
      • Certificate.csr
      • Certificate.key
      • Certificate.save_crt()
      • Certificate.save_csr()
      • Certificate.save_key()
    • Key
    • LetsEncryptCertificate
      • LetsEncryptCertificate.generate_csr()
      • LetsEncryptCertificate.generate_key()
      • LetsEncryptCertificate.get_crt()
      • LetsEncryptCertificate.run_certbot()
    • OCSCertificate
      • OCSCertificate.generate_csr()
      • OCSCertificate.generate_key()
      • OCSCertificate.get_crt()
    • configure_custom_api_cert()
    • configure_custom_ingress_cert()
    • configure_ingress_and_api_certificates()
    • configure_trusted_ca_bundle()
    • create_ocs_ca_bundle()
    • get_root_ca_cert()
    • init_arg_parser()
    • main()
  • ocs_ci.utility.storage_cluster_setup module
    • StorageClusterSetup
      • StorageClusterSetup.setup_storage_cluster()
    • create_external_pgsql_secret()
  • ocs_ci.utility.svt module
    • svt_cleanup()
    • svt_cluster_loader()
    • svt_create_venv_setup()
    • svt_project_clone()
    • svt_setup()
  • ocs_ci.utility.system module
    • is_path_empty()
  • ocs_ci.utility.templating module
    • Templating
      • Templating.base_path
      • Templating.render_template()
    • dump_data_to_json()
    • dump_data_to_temp_yaml()
    • dump_to_temp_yaml()
    • generate_yaml_from_jinja2_template_with_data()
    • get_n_document_from_yaml()
    • json_to_dict()
    • load_config_data()
    • load_yaml()
    • to_nice_yaml()
  • ocs_ci.utility.uninstall_openshift_logging module
    • check_pod_vanished()
    • delete_logging_namespaces()
    • uninstall_cluster_logging()
  • ocs_ci.utility.users module
    • add_htpasswd_user()
    • create_htpasswd_idp()
    • create_htpasswd_secret()
    • delete_htpasswd_secret()
    • get_server_url()
    • login()
    • logout()
    • user_factory()
  • ocs_ci.utility.utils module
    • AZInfo
      • AZInfo.get_zone_number()
      • AZInfo.zone_number
    • TimeoutIterator
    • TimeoutSampler
      • TimeoutSampler.wait_for_func_status()
      • TimeoutSampler.wait_for_func_value()
    • activate_multiple_mdss()
    • add_chrony_to_ocp_deployment()
    • add_info_about_mg_skips()
    • add_mem_stats()
    • add_path_to_env_path()
    • add_squad_analysis_to_email()
    • add_stage_cert()
    • add_time_report_to_email()
    • allow_dir_fragmentation()
    • archive_ceph_crashes()
    • auth_list()
    • bin_xml_escape()
    • censor_values()
    • ceph_crash_info_display()
    • ceph_health_check()
    • ceph_health_check_base()
    • ceph_health_check_multi_storagecluster_external()
    • ceph_health_multi_storagecluster_external_base()
    • ceph_health_recover()
    • ceph_health_resolve_crash()
    • ceph_health_resolve_mon_slow_ops()
    • ceph_health_resolve_network_partition()
    • check_for_rhcos_images()
    • check_if_executable_in_path()
    • check_timeout_reached()
    • clean_up_pods_for_provider()
    • clone_notify()
    • clone_repo()
    • compare_dictionaries()
    • config_to_string()
    • configure_chrony_and_wait_for_machineconfig_status()
    • convert_bytes_to_unit()
    • convert_device_size()
    • convert_hostnames_to_ips()
    • convert_yaml2tfvars()
    • create_ceph_health_cmd()
    • create_config_ini_file()
    • create_directory_path()
    • create_rhelpod()
    • create_stats_dir()
    • create_unreleased_oadp_catalog()
    • custom_ceph_config()
    • date_in_minimal_format()
    • decode()
    • decompose_html_attributes()
    • delete_dir()
    • delete_file()
    • destroy_cluster()
    • disable_huge_pages()
    • download_file()
    • download_file_from_git_repo()
    • dump_config_to_file()
    • email_reports()
    • enable_huge_pages()
    • encode()
    • ensure_nightly_build_availability()
    • exec_cmd()
    • exec_nb_db_query()
    • expose_ocp_version()
    • extract_image_urls()
    • extract_ocp_binary_from_image()
    • file_locking()
    • filter_out_emojis()
    • filter_unrepresentable_values()
    • fuse_client_io()
    • fuse_client_md5()
    • fuse_mount()
    • generate_folder_with_files()
    • get_acm_version()
    • get_architecture_host()
    • get_attr_chain()
    • get_available_ocp_versions()
    • get_az_count()
    • get_ceph_crashes()
    • get_ceph_version()
    • get_client_info()
    • get_client_type_by_name()
    • get_client_version()
    • get_cluster_id()
    • get_cluster_image()
    • get_cluster_name()
    • get_cluster_version()
    • get_cluster_version_info()
    • get_csi_versions()
    • get_default_if_keyval_empty()
    • get_glibc_version()
    • get_image_with_digest()
    • get_infra_id()
    • get_infra_id_from_openshift_install_state()
    • get_kubeadmin_password()
    • get_latest_acm_tag_unreleased()
    • get_latest_ds_olm_tag()
    • get_latest_ocp_version()
    • get_latest_release_version()
    • get_module_ip()
    • get_next_version_available_for_upgrade()
    • get_nightly_oc_via_ga()
    • get_noobaa_cli_config()
    • get_oadp_version()
    • get_ocm_cli()
    • get_ocp_repo()
    • get_ocp_upgrade_history()
    • get_ocp_version()
    • get_ocs_build_number()
    • get_ocs_olm_operator_tags()
    • get_ocs_version_from_image()
    • get_openshift_client()
    • get_openshift_installer()
    • get_openshift_mirror_url()
    • get_primary_nb_db_pod()
    • get_pytest_fixture_value()
    • get_random_letters()
    • get_random_str()
    • get_role_arn_from_sub()
    • get_rook_repo()
    • get_rook_version()
    • get_root_disk()
    • get_rosa_cli()
    • get_running_acm_version()
    • get_running_cluster_id()
    • get_running_ocp_version()
    • get_system_architecture()
    • get_terraform()
    • get_terraform_ignition_provider()
    • get_testrun_name()
    • get_trim_mean()
    • get_url_content()
    • get_vault_cli()
    • human_to_bytes_ui()
    • inspect_image()
    • is_cluster_running()
    • is_cluster_y_version_upgraded()
    • is_emoji()
    • is_ocp_version_gaed()
    • is_z_stream_upgrade()
    • kernel_client_io()
    • kernel_client_md5()
    • kernel_mount()
    • list_insert_at_position()
    • load_auth_config()
    • load_config_file()
    • login_to_mirror_registry()
    • mask_secrets()
    • mds_fail_over()
    • mirror_image()
    • mkdir_pinning()
    • modify_csv()
    • move_summary_to_top()
    • ocsci_log_path()
    • parse_html_for_email()
    • parse_pgsql_logs()
    • pinned_dir_io()
    • prepare_bin_dir()
    • prepare_customized_pull_secret()
    • query_quay_for_operator_tags()
    • read_file_as_str()
    • remove_ceph_crashes()
    • remove_keys_from_tf_variable_file()
    • replace_content_in_file()
    • restart_mon_pods()
    • run_async()
    • run_ceph_health_cmd()
    • run_cmd()
    • run_cmd_interactive()
    • run_cmd_multicluster()
    • save_reports()
    • set_aws_region()
    • set_registry_to_managed_state()
    • set_selinux_permissions()
    • skip_for_provider_if_ocs_version()
    • skipif_ocp_version()
    • skipif_ocs_version()
    • skipif_ui_not_support()
    • skipif_upgraded_from()
    • string_chunkify()
    • sum_of_two_storage_sizes()
    • switch_to_correct_client_type()
    • switch_to_correct_cluster_at_setup()
    • update_container_with_mirrored_image()
    • upload_file()
    • use_system_available_client_and_kubectl()
    • validate_dict_values()
    • wait_custom_resource_defenition_available()
    • wait_for_ceph_health_not_ok()
    • wait_for_co()
    • wait_for_machineconfigpool_status()
    • wipe_all_disk_partitions_for_node()
    • wipe_partition()
  • ocs_ci.utility.version module
    • compare_versions()
    • drop_z_version()
    • get_dr_cluster_operator_version()
    • get_dr_hub_operator_version()
    • get_latest_rosa_ocp_version()
    • get_next_ocp_version_rosa()
    • get_ocp_gitops_operator_version()
    • get_ocp_versions_rosa()
    • get_ocs_version_from_csv()
    • get_odf_multicluster_orchestrator_version()
    • get_previous_version()
    • get_running_odf_version()
    • get_semantic_ocp_running_version()
    • get_semantic_ocp_version_from_config()
    • get_semantic_ocs_version_from_config()
    • get_semantic_running_odf_version()
    • get_semantic_version()
    • get_submariner_operator_version()
    • get_volsync_operator_version()
    • ocp_version_available_on_rosa()
  • ocs_ci.utility.vsphere module
    • VSPHERE
      • VSPHERE.add_disk()
      • VSPHERE.add_disks()
      • VSPHERE.add_disks_with_same_size()
      • VSPHERE.add_interface_to_compute_vms()
      • VSPHERE.add_pci_device()
      • VSPHERE.add_rdm_disk()
      • VSPHERE.available_storage_devices()
      • VSPHERE.change_vm_network_state()
      • VSPHERE.check_folder_exists()
      • VSPHERE.clone_vm()
      • VSPHERE.destroy_folder()
      • VSPHERE.destroy_pool()
      • VSPHERE.destroy_vms()
      • VSPHERE.erase_partition()
      • VSPHERE.find_datacenter_by_name()
      • VSPHERE.find_datastore_by_name()
      • VSPHERE.find_ip_by_vm()
      • VSPHERE.find_object_by_name()
      • VSPHERE.find_resource_pool_by_name()
      • VSPHERE.find_vms_without_ip()
      • VSPHERE.get_active_partition()
      • VSPHERE.get_active_partition_from_mount_info()
      • VSPHERE.get_all_objs()
      • VSPHERE.get_all_vms_in_dc()
      • VSPHERE.get_all_vms_in_pool()
      • VSPHERE.get_cluster()
      • VSPHERE.get_compute_vms_in_pool()
      • VSPHERE.get_content
      • VSPHERE.get_controller_for_adding_disk()
      • VSPHERE.get_controllers()
      • VSPHERE.get_datastore_free_capacity()
      • VSPHERE.get_datastore_type()
      • VSPHERE.get_datastore_type_by_name()
      • VSPHERE.get_dc()
      • VSPHERE.get_device_by_key()
      • VSPHERE.get_disks()
      • VSPHERE.get_host()
      • VSPHERE.get_host_obj()
      • VSPHERE.get_lunids()
      • VSPHERE.get_mounted_devices()
      • VSPHERE.get_mounted_devices_in_vmfs()
      • VSPHERE.get_mounted_devices_in_vsan()
      • VSPHERE.get_network_device()
      • VSPHERE.get_passthrough_enabled_devices()
      • VSPHERE.get_pool()
      • VSPHERE.get_search_index
      • VSPHERE.get_storage_devices()
      • VSPHERE.get_storage_object_manger()
      • VSPHERE.get_unit_number()
      • VSPHERE.get_used_devices()
      • VSPHERE.get_used_unit_number()
      • VSPHERE.get_used_unit_number_with_all_unit_number()
      • VSPHERE.get_vm_by_ip()
      • VSPHERE.get_vm_in_pool_by_name()
      • VSPHERE.get_vm_power_status()
      • VSPHERE.get_vms_by_string()
      • VSPHERE.get_vms_ips()
      • VSPHERE.get_volume_path()
      • VSPHERE.get_vslm_id()
      • VSPHERE.is_resource_pool_exist()
      • VSPHERE.is_resource_pool_prefix_exist()
      • VSPHERE.is_template_exist()
      • VSPHERE.is_vm_obj_exist()
      • VSPHERE.map_lunids_to_devices()
      • VSPHERE.poweroff_vms()
      • VSPHERE.poweron_vms()
      • VSPHERE.remove_disk()
      • VSPHERE.remove_disks()
      • VSPHERE.remove_disks_with_main_disk()
      • VSPHERE.remove_vms_from_inventory()
      • VSPHERE.restart_vms()
      • VSPHERE.restart_vms_by_stop_and_start()
      • VSPHERE.start_vms()
      • VSPHERE.stop_vms()
      • VSPHERE.wait_for_task()
      • VSPHERE.wait_for_vm_delete()
      • VSPHERE.wait_for_vm_status()
  • ocs_ci.utility.vsphere_nodes module
    • VSPHERENode
      • VSPHERENode.reboot()
      • VSPHERENode.replace_ntp_server_in_chrony()
      • VSPHERENode.restart_chrony()
      • VSPHERENode.restart_service()
      • VSPHERENode.set_host_name()
    • get_node_ips_from_module()
    • update_ntp_and_restart_chrony()
    • update_ntp_compute_nodes()
  • ocs_ci.utility.workloadfixture module
    • ignore_next_measurement_file()
    • is_measurement_done()
    • measure_operation()
  • Module contents
• ocs_ci.workloads package
  • Submodules
  • ocs_ci.workloads.vdbench module
    • VdbenchWorkload
      • VdbenchWorkload.cleanup_workload()
      • VdbenchWorkload.get_all_deployment_pod_logs()
      • VdbenchWorkload.get_workload_status()
      • VdbenchWorkload.pause_workload()
      • VdbenchWorkload.resume_workload()
      • VdbenchWorkload.scale_down_pods()
      • VdbenchWorkload.scale_up_pods()
      • VdbenchWorkload.start_workload()
      • VdbenchWorkload.stop_workload()
  • Module contents

Module contents