openairinterface5g/ci-scripts/doc/vm_based_simulator_destroy.md

OAI CI Virtual-Machine-based Test Environment: Properly Destroy all VM instances

Table of Contents

[[TOC]]

1. Introduction

$ cd /tmp/CI-raphael
$ ./ci-scripts/oai-ci-vm-tool destroy --help
OAI CI VM script
   Original Author: Raphael Defosseux
   Requirements:
     -- uvtool uvtool-libvirt apt-cacher

Usage:
------
    oai-ci-vm-tool destroy [OPTIONS]

Mandatory Options:
--------
    --job-name #### OR -jn ####
    Specify the name of the Jenkins job.

    --build-id #### OR -id ####
    Specify the build ID of the Jenkins job.

Options:
--------
    --help OR -h
    Print this help message.

2. Detailed Description

Source file concerned: ci-scripts/destroyAllRunningVM.sh

2.1. destroy_vm function

This is the function that is being called from the main oai-vm-tool script.

The main purpose is to destroy all VM instances whose name matches a pattern.

It also cleans up the .ssh/known_hosts file.

3. Typical Usage

$ cd /tmp/CI-raphael
$ ./ci-scripts/oai-ci-vm-tool destroy --job-name raphael --build-id 1

---

You can go back to the CI dev main page