summaryrefslogtreecommitdiffstats
path: root/tools/README
diff options
context:
space:
mode:
Diffstat (limited to 'tools/README')
-rw-r--r--tools/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/tools/README b/tools/README
new file mode 100644
index 000000000..9477c8988
--- /dev/null
+++ b/tools/README
@@ -0,0 +1,20 @@
+##############################################################################
+# Copyright (c) 2015 Ericsson AB and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+This directory contains various utilities needed in the yardstick environment.
+
+yardstick-img-modify is a generic script (but ubuntu cloud image specific) that
+takes a another script as an argument. This second script does the actual
+modifications of the image. sudo is required since the base image is mounted
+using qemu's network block device support.
+
+Usage example:
+
+$ sudo yardstick-img-modify $HOME/yardstick/tools/ubuntu-server-cloudimg-modify.sh
+