diff --git a/elements/os-svc-install/README.md b/elements/os-svc-install/README.md index c947a616..50eec16c 100644 --- a/elements/os-svc-install/README.md +++ b/elements/os-svc-install/README.md @@ -1,9 +1,18 @@ -Installs 'os-svc-install', a script to perform one-line installs of init-controlled openstack services from github. +Command line utilities to simplify instalation of OpenStack services. + +## os-svc-install +Given a git repo url, pip-install the repo and all of its python dependencies into a virtualenv under /opt/stack/venvs. + +## os-svc-daemon +Given a system service command line and run-as user, generate and install system service start script. -Example Usage --------------- -`os-svc-install -u nova -n nova-all -c 'nova-all --someoption' -r https://github.com/openstack/nova.git` +## example usage +```bash +# clone nova.git from github, and install it and its dependencies to /opt/stack/venvs/nova +os-svc-install -u nova -n nova-all -c 'nova-all --someoption' -r https://github.com/openstack/nova.git -The above command will pip-install the repo specified by '-r', and create a service start script called nova-all (from `-n`), which starts the command specified by `-c` as user `-u` +# install a system-start script for nova-api +os-svc-daemon nova-api nova /opt/stack/venvs/nova/bin/nova-api --config-dir /etc/nova +```