X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Ftools%2Fvirl%2FREADME.md;fp=resources%2Ftools%2Fvirl%2FREADME.md;h=fe4edd8853012657a08ba9316bb8641e1d12efba;hb=f9e2ef4af9dee2220d4ee2ebeae5012de84a83fe;hp=0000000000000000000000000000000000000000;hpb=da8aebf2e722f2c441a03b300de71f9143d010a3;p=csit.git

diff --git a/resources/tools/virl/README.md b/resources/tools/virl/README.md
new file mode 100644
index 0000000000..fe4edd8853
--- /dev/null
+++ b/resources/tools/virl/README.md
@@ -0,0 +1,18 @@
+## VIRL scripts
+
+This directory, and subdirectories, contain files required for automated VIRL testing. These files
+are based on the following assumptions:
+
+  - Files in this directory are installed on the VIRL server host, and scripts in bin/ directory
+    are executable by the user used in the bootstrap.sh script in the root directory of this
+    project
+
+  - the VIRL server has a "server" image, as well as a "vPP" image that is accepting a cloud-init
+    configuration and is ready to receive a VPP upgrade.
+
+  - the VIRL server has an NFS export that can be mounted by VIRL VMs, or there is an NFS server
+    with an export mounted by the VIRL server and mountable by VIRL VMs.
+
+  - the bin/start_testcase script has hardcoded default values both in variable assignments
+    near the beginning of the file, as well as in "parser.add_argument", "default=" options.
+    These may need to be updated.