summaryrefslogtreecommitdiffstats
path: root/docs/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..536bc15
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,19 @@
+# Python scripts for creating virtual environments on OpenStack with Ansible playbooks for provisioning.
+
+## Runtime Environment Setup
+ * Python 2.7 (recommend leveraging a Virtual Python runtime, e.g. [Virtualenv](https://virtualenv.pypa.io), in your development environment)
+ * Development packages for python and openssl. On CentOS/RHEL:
+
+ \# yum install python-devel openssl-devel
+
+ On Ubuntu:
+
+ \# apt-get install python2.7-dev libssl-dev
+ * Install SNAPS Library
+ * pip install -e <path to repo>/snaps/
+
+## [Testing](Testing.md)
+## [Virtual Environment Deployment](VirtEnvDeploy.md)
+
+Also see the [CableLabs project wiki page](https://community.cablelabs.com/wiki/display/SNAPS/OpenStack+Instantiation%2C+Provisioning%2C+and+Testing)
+for more information on these scripts.