Python API

To use ocp-network-split in your python test script, see functions in module ocpnetsplit.main which provides public API and implementation of the command line tools referenced in the previous section.

Example

Quick high level overview of API usage for single cluster mode:

• Generate list of dictionaries representing content of MachineConfig yaml, (which contains network split script and unit files) using ocpnetsplit.main.get_zone_config() and ocpnetsplit.main.get_networksplit_mc_spec().

• Deploy the MachineConfig generated in the previous step and wait for the configuration to be applied on all nodes. This needs to be done only once.

• Pick desired network split configuration from ocpnetsplit.zone.NETWORK_SPLITS.

• Schedule selected network split disruption via ocpnetsplit.main.schedule_split(), this will define 2 timers on each node, one to start the disruption and another one to stop it.

• Wait for the 1st timer to trigger setup of the network split.

• Wait for the 2nd timer to trigger teardown, restoring the network configuration back.

• Optionally schedule another network split again.

API Reference

• ocpnetsplit package
  • ocpnetsplit.machineconfig module
    • create_file_dict()
    • create_latency_mc_dict()
    • create_script_dict()
    • create_split_mc_dict()
    • create_systemdunit_dict()
    • create_unit_dict()
    • create_zone_mc_dict()
    • get_new_mc()
  • ocpnetsplit.main module
    • check_split()
    • get_networksplit_mc_spec()
    • get_zone_config()
    • get_zone_config_fromfile()
    • main_multisetup()
    • main_sched()
    • main_setup()
    • run_ssh_node()
    • schedule_split()
  • ocpnetsplit.ocp module
    • get_all_node_ip_addrs()
    • list_cluster_nodes()
    • run_oc()
    • run_oc_debug_node()
  • ocpnetsplit.zone module
    • NETWORK_SPLITS
    • ZONES
    • ZoneConfig
      • ZoneConfig.add_node()
      • ZoneConfig.add_nodes()
      • ZoneConfig.get_env_file()
      • ZoneConfig.get_nodes()
    • ZoneLatSpec
      • ZoneLatSpec.get_cli_args()
      • ZoneLatSpec.load_arguments()
      • ZoneLatSpec.load_dict()