Quick Start Guide

Ondrej Lichtner edited this page Oct 17, 2016 · 16 revisions

If this is your first visit to this Wiki and you are not sure what LNST is yet, we suggest you first take a look at the Introductory Guide where you will find the basic information about our project and what it can do.

This document will very quickly guide you through all the steps you need to take in order to successfully run a single LNST recipe. It is intended to demonstrate the functionality so that you can determine if this is something you are looking for or not. For that reason we won't be going into many details on how some parts work, though we will provide links to more in-depth pages.

Requirements for this guide are:

  • two test (slave) machines that are connected to the same L2 network
  • controller machine that has a separate connection to both slave machines

We recommend running Fedora 23+ on all of the machines.

1. Installation

To install the LNST Controller run the following command on your controller machine:

dnf install lnst-ctl

To install the LNST Slaves run the following command on your test machines:

dnf install lnst-slave

You will also probably want to temporarily disable firewalls on the slave machines, since they block lnst communication:

systemctl stop firewalld.service

or

systemctl stop iptables.service

depending on the distribution you're running.

Alternatively, if you are not running Fedora or if you want any further information regarding the installation, please refer to the [[Installation Guide]].

For the purposes of this introduction we can use the default configuration of both the slaves and the controller, therefore we will not be discussing configuration. However if you want to see how to configure LNST, take a look at the document Configure LNST.

2. Create a Machine Pool

In order to be able to run a test, you need to set up a machine pool. Machine Pools are used by the controller to lookup machines suitable for your test. They need to be set up properly so that the controller can execute your recipes. There is no need to set up anything regarding the machine pool on the slave machines so everything in this section is done on the controller itself.

The easiest way to create your first pool is to use the Pool Wizard which is the recommended way for a new user.

However you can also set up a basic pool manually. In case you decide not to use the pool wizard you first need to tell LNST where it will find the pool we are going to create. For that, create a configuration file lnst-ctl.conf inside the directory ~/.lnst/ on your controller, if the directory doesn't exist create it as well:

mkdir ~/.lnst
cd ~/.lnst/
touch lnst-ctl.conf

After that tell LNST to use the directory ~/.lnst/pool/ as a pool directory, by placing this inside the configuration file:

[pools]
pool = ~/.lnst/pool/

Now to create the pool itself, start by creating the pool directory, on the controller machine:

mkdir ~/.lnst/pool

Inside it create two files slave1.xml and slave2.xml with these contents:

<slavemachine>
    <params>
        <param name="hostname" value="HOSTNAME"/>
    </params>
    <interfaces>
        <eth label="A" id="1">
            <params>
                <param name="hwaddr" value="HWADDR"/>
            </params>
        </eth>
    </interfaces>
</slavemachine>

In both files replace HOSTNAME with hostnames or IP addresses of the slave machines and HWADDR with MAC addresses of the network interfaces that are used for the connection between the slaves. The fact that both interfaces have the same label attribute indicates they are both connected to the same L2 network segment (e.g. they are connected to the same switch, bridge, or possibly directly to each other).

At this point the machine pool is ready. Detailed documentation on setting up machine pools can be found in the document Setup your MachinePool.

3. Create a recipe

Now all that you need to run a test with LNST is a recipe. An LNST recipe is an XML file describing the test topology requirements and the Test Tasks that LNST should run. For the purposes of this guide we will be using this recipe:

<lnstrecipe>
  <network>
    <host id="slave1">
        <params/>
        <interfaces>
            <eth id="testifc1" label="A">
                <addresses>
                    <address value="192.168.200.2/24"/>
                </addresses>
            </eth>
        </interfaces>
    </host>

    <host id="slave2">
        <params/>
        <interfaces>
            <eth id="testifc2" label="A">
                <addresses>
                    <address value="192.168.200.3/24"/>
                </addresses>
            </eth>
        </interfaces>
    </host>
  </network>

  <task>
    <run module="IcmpPing" host="slave1">
      <options>
        <option name="addr" value="{ip(slave2,testifc2)}"/>
        <option name="count" value="10"/>
      </options>
    </run>
  </task>
</lnstrecipe>

Copy it and put it into a file named, for example, recipe.xml.

The recipe consists of two parts:

  • environment description seen in the contents of the tag network specifies two slave machines, each with one network interface connected to the same network, labeled A, we also configure these interfaces to have specific IP addresses.
  • description of actions can be seen in the tag task which tells LNST to run the test IcmpPing on machine slave1 with the target being the network interface of machine slave2. This is the simplest Task description possible, advanced Task descriptions point to a Python script with more complex capabilities.

This is a basic recipe performing a Ping check between two machines, for more information on creating your own recipes you can visit the page How to structure LNST recipes.

4. Run the recipe and get the results

If you followed all the previous steps, you should have everything important prepared and are ready to run the test. First start the lnst-slave service on both slave machines:

systemctl start lnst-slave.service

And now, finally, run the test on the controller:

lnst-ctl run recipe.xml

For more information on running LNST visit the page LNST Invocation.

If you've done everything correctly you should see the test being executed and get some results about what happened. These results can also be found on the controller in the default location for storing logs which is ~/.lnst/logs/.

As an example, the results from this test should look something like this:

$ lnst-ctl run recipe.xml
2013-09-20 12:33:23        (127.0.0.1)     INFO: Checking machine pool availability.
2013-09-20 12:33:23        (127.0.0.1)     INFO: Processing pool dir '/root/.lnst/pool'
2013-09-20 12:33:23        (127.0.0.1)     INFO: f1 [UP] 
2013-09-20 12:33:23        (127.0.0.1)     INFO: f2 [UP] 
2013-09-20 12:33:23        (127.0.0.1)     INFO: Provisioning initialized
2013-09-20 12:33:23        (127.0.0.1)     INFO:   machine slave1 uses f1
2013-09-20 12:33:23        (127.0.0.1)     INFO:   machine slave2 uses f2
2013-09-20 12:33:23        (127.0.0.1)     INFO: Connecting to RPC on machine slave1 (f1)
2013-09-20 12:33:23  (192.168.122.210)     INFO: Recieved a controller connection.
2013-09-20 12:33:24  (192.168.122.210)  WARNING: =============================================
2013-09-20 12:33:24  (192.168.122.210)  WARNING: NetworkManager is running on a slave machine!
2013-09-20 12:33:24  (192.168.122.210)  WARNING: Usage of NM is disabled!
2013-09-20 12:33:24  (192.168.122.210)  WARNING: =============================================
2013-09-20 12:33:24        (127.0.0.1)     INFO: Transfering tcp_conn tools to machine slave1
2013-09-20 12:33:25        (127.0.0.1)     INFO: Transfering multicast tools to machine slave1
2013-09-20 12:33:25        (127.0.0.1)     INFO: Transfering IcmpPing module to machine slave1
2013-09-20 12:33:26        (127.0.0.1)     INFO: Transfering DummyFailing module to machine slave1
2013-09-20 12:33:26        (127.0.0.1)     INFO: Transfering PktgenTx module to machine slave1
2013-09-20 12:33:26        (127.0.0.1)     INFO: Transfering Icmp6Ping module to machine slave1
2013-09-20 12:33:26        (127.0.0.1)     INFO: Transfering PktCounter module to machine slave1
2013-09-20 12:33:26        (127.0.0.1)     INFO: Transfering PacketAssert module to machine slave1
2013-09-20 12:33:26        (127.0.0.1)     INFO: Transfering Multicast module to machine slave1
2013-09-20 12:33:26        (127.0.0.1)     INFO: Transfering Iperf module to machine slave1
2013-09-20 12:33:26        (127.0.0.1)     INFO: Transfering NetCat module to machine slave1
2013-09-20 12:33:26        (127.0.0.1)     INFO: Connecting to RPC on machine slave2 (f2)
2013-09-20 12:33:26   (192.168.122.46)     INFO: Recieved a controller connection.
2013-09-20 12:33:27   (192.168.122.46)  WARNING: =============================================
2013-09-20 12:33:27   (192.168.122.46)  WARNING: NetworkManager is running on a slave machine!
2013-09-20 12:33:27   (192.168.122.46)  WARNING: Usage of NM is disabled!
2013-09-20 12:33:27   (192.168.122.46)  WARNING: =============================================
2013-09-20 12:33:27        (127.0.0.1)     INFO: Transfering tcp_conn tools to machine slave2
2013-09-20 12:33:27        (127.0.0.1)     INFO: Transfering multicast tools to machine slave2
2013-09-20 12:33:28        (127.0.0.1)     INFO: Transfering IcmpPing module to machine slave2
2013-09-20 12:33:28        (127.0.0.1)     INFO: Transfering DummyFailing module to machine slave2
2013-09-20 12:33:28        (127.0.0.1)     INFO: Transfering PktgenTx module to machine slave2
2013-09-20 12:33:29        (127.0.0.1)     INFO: Transfering Icmp6Ping module to machine slave2
2013-09-20 12:33:29        (127.0.0.1)     INFO: Transfering PktCounter module to machine slave2
2013-09-20 12:33:29        (127.0.0.1)     INFO: Transfering PacketAssert module to machine slave2
2013-09-20 12:33:29        (127.0.0.1)     INFO: Transfering Multicast module to machine slave2
2013-09-20 12:33:29        (127.0.0.1)     INFO: Transfering Iperf module to machine slave2
2013-09-20 12:33:29        (127.0.0.1)     INFO: Transfering NetCat module to machine slave2
2013-09-20 12:33:29        (127.0.0.1)     INFO: Configuring interface testifc1 on machine slave1
2013-09-20 12:33:29  (192.168.122.210)     INFO: Initializing 'eth' device class
2013-09-20 12:33:29        (127.0.0.1)     INFO: Configuring interface testifc2 on machine slave2
2013-09-20 12:33:29   (192.168.122.46)     INFO: Initializing 'eth' device class
2013-09-20 12:33:29        (127.0.0.1)     INFO: Executing command: [type(test), module(IcmpPing), machine(slave1)]
2013-09-20 12:33:38        (127.0.0.1)     INFO: Result: PASS
2013-09-20 12:33:38        (127.0.0.1)     INFO: Result data:
2013-09-20 12:33:38        (127.0.0.1)     INFO:     limit_rate:	80
2013-09-20 12:33:38        (127.0.0.1)     INFO:     rtt_min:   	0.286
2013-09-20 12:33:38        (127.0.0.1)     INFO:     rate:      	100
2013-09-20 12:33:38        (127.0.0.1)     INFO:     rtt_max:   	0.664
2013-09-20 12:33:38  (192.168.122.210)     INFO: Restoring system configuration
2013-09-20 12:33:38   (192.168.122.46)     INFO: Restoring system configuration
2013-09-20 12:33:38  (192.168.122.210)     INFO: Killing all forked processes.
2013-09-20 12:33:38  (192.168.122.210)     INFO: Cleaning up 'eth' device class.
2013-09-20 12:33:39  (192.168.122.210)     INFO: Restoring system configuration
2013-09-20 12:33:39   (192.168.122.46)     INFO: Killing all forked processes.
2013-09-20 12:33:39   (192.168.122.46)     INFO: Cleaning up 'eth' device class.
2013-09-20 12:33:40   (192.168.122.46)     INFO: Restoring system configuration
2013-09-20 12:33:40        (127.0.0.1)     INFO: =================== SUMMARY ===================
2013-09-20 12:33:40        (127.0.0.1)     INFO:  recipe.xml                               PASS 
2013-09-20 12:33:40        (127.0.0.1)     INFO:      task: 1  
2013-09-20 12:33:40        (127.0.0.1)     INFO:          test          IcmpPing           PASS 
2013-09-20 12:33:40        (127.0.0.1)     INFO:              limit_rate:	80  
2013-09-20 12:33:40        (127.0.0.1)     INFO:              rtt_min:   	0.286  
2013-09-20 12:33:40        (127.0.0.1)     INFO:              rate:      	100  
2013-09-20 12:33:40        (127.0.0.1)     INFO:              rtt_max:   	0.664  
2013-09-20 12:33:40        (127.0.0.1)     INFO: ===============================================

If you see something similar to this, then congratulations to you, you have just successfully finished your first LNST test. If you want to continue using LNST we suggest you read the rest of the documentation. You can also visit the page Quick Guides for more simple tests you can quickly try with LNST.

If you encounter any problems you can find us on our IRC channel or mailing list.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.