summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2014-12-11 14:50:26 -0500
committerDoug Hellmann <doug@doughellmann.com>2014-12-18 16:08:01 -0500
commitbdb739e249ceee8fd6a460eb0a110c9f60acd07a (patch)
tree13f31192b952e68dc7baa8016d3c941e6f7824d6 /README.rst
parent44aa91f133fecc47a964374a32a33f22ad085b56 (diff)
downloadoslo-rootwrap-bdb739e249ceee8fd6a460eb0a110c9f60acd07a.tar.gz
Move files out of the namespace package
Move the public API out of oslo.rootwrap to oslo_rootwrap. Retain the ability to import from the old namespace package for backwards compatibility for this release cycle. bp/drop-namespace-packages Change-Id: Ifed1a99e5ea6d999760731867c4294707698d41c
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index 6a7fed7..cae0a3a 100644
--- a/README.rst
+++ b/README.rst
@@ -6,8 +6,8 @@ The Oslo Rootwrap allows fine filtering of shell commands to run as `root`
from OpenStack services.
Rootwrap should be used as a separate Python process calling the
-oslo.rootwrap.cmd:main function. You can set up a specific console_script
-calling into oslo.rootwrap.cmd:main, called for example `nova-rootwrap`.
+``oslo_rootwrap.cmd:main`` function. You can set up a specific console_script
+calling into ``oslo_rootwrap.cmd:main``, called for example `nova-rootwrap`.
To keep things simple, this document will consider that your console_script
is called `/usr/bin/nova-rootwrap`.
@@ -318,13 +318,13 @@ Daemon mode
Since 1.3.0 version ``oslo.rootwrap`` supports "daemon mode". In this mode
rootwrap would start, read config file and wait for commands to be run with
root priviledges. All communications with the daemon should go through
-``Client`` class that resides in ``oslo.rootwrap.client`` module.
+``Client`` class that resides in ``oslo_rootwrap.client`` module.
Its constructor expects one argument - a list that can be passed to ``Popen``
to create rootwrap daemon process. For ``root_helper`` above it will be
``["sudo", "nova-rootwrap-daemon", "/etc/neutron/rootwrap.conf"]``,
for example. Note that it uses a separate script that points to
-``oslo.rootwrap.cmd:daemon`` endpoint (instead of ``:main``).
+``oslo_rootwrap.cmd:daemon`` endpoint (instead of ``:main``).
The class provides one method ``execute`` with following arguments: