From d2f7cdfa857c0d9376a4f2533b12e4c292626116 Mon Sep 17 00:00:00 2001 From: Jonathan Yantis Date: Thu, 7 Jul 2016 15:19:00 -0400 Subject: [PATCH] Cleaned up Ansible Documentation for v0.7.4 --- docs/INSTALL.md | 14 ++++++++++---- docs/VERSION | 2 +- docs/playbooks/README.md | 39 +++++++++++++++++++++++++++++---------- 3 files changed, 40 insertions(+), 15 deletions(-) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 32ac1fe..88a7cfa 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -1,11 +1,17 @@ ## Install Notes Netgrph was built on Ubuntu 14.04 LTS but should be portable to any other Python -3.4+ system. I have done limited testing at this point on other systems (MacOS), -so I highly recommend this OS right now. In the near future, I plan to ship a -set of ansible scripts for easy install, but at first this is what I have. +3.4+ system. I have done testing on Ubuntu 16.04 and MacOS, and I highly +recommend Ubuntu trusty or xenial for support purposes. I provide ansible +scripts for an easy install on a base Ubuntu system, and will be creating a +Docker file before long. -### Test Install Instructions +### Ansible Install +- See the README.md in docs/playbooks/ +- Install ansible on your machine, and point the playbook towards localhost as + documented, or a remote host if you are familiar with Ansible. + +### Manual Install Instructions - For testing, you can install everything but the database under your user on any system - If you do not have root access to your system, use virtualenv to satisfy the pip requirements diff --git a/docs/VERSION b/docs/VERSION index 3d105a6..520c9c2 100644 --- a/docs/VERSION +++ b/docs/VERSION @@ -1 +1 @@ -v0.7.3 +v0.7.4 diff --git a/docs/playbooks/README.md b/docs/playbooks/README.md index 94aaeb1..16b1b44 100644 --- a/docs/playbooks/README.md +++ b/docs/playbooks/README.md @@ -1,25 +1,44 @@ ## Ansible NetGrph Playbooks -These playbooks will install Ansible on Ubuntu 14.04 or 16.04 for -you. It will not set your database password or configure your -netgrph.ini file for now, so you need to do that manually. Once the -scripts run, browse to http://machine:7474 and setup your -password. Set that same password in /home/netgrph/docs/netgrph.ini, -and run the /home/netgrph/test/first_import.sh. - -### Running Ansible via localhost +These playbooks will install NetGrph via Ansible on Ubuntu 14.04 or 16.04 for +you. It will not set your database password or configure your netgrph.ini file +for now, so you need to do that manually. Once the scripts run, browse to +http://machine:7474 and setup your password. Set that same password in +/home/netgrph/docs/netgrph.ini, and run the /home/netgrph/test/first_import.sh. +#### Setting up Ansible to run via localhost ``` +sudo su - apt-get install ansible -echo [netgrph] >> /etc/ansible/hosts +echo '[netgrph]' >> /etc/ansible/hosts echo localhost ansible_connection=local >> /etc/ansible/hosts +exit ``` -#### Run ansible on localhost +#### Run playbooks against localhost (installs under netgrph user) ``` git clone https://github.com/yantisj/netgrph.git /tmp/netgrph/ cd /tmp/netgrph/docs/playbooks/ ansible-playbook netgrph.yml --ask-sudo-pass ``` + +#### Test the install + +``` +sudo su - netgrph +cd netgrph +``` + +##### Use an insecure DB password for testing (not recommended) +``` +./test/set_neo4j_password.sh +``` + +##### Test a database import +``` +./test/first_import.sh +``` + +- See the INSTALL.md file for test queries and production install information