[ARVADOS] updated: 1.1.0-166-g4ad171b
Git user
git at public.curoverse.com
Wed Nov 29 16:51:26 EST 2017
Summary of changes:
doc/user/topics/arv-sync-groups.html.textile.liquid | 21 +++++++++++++++------
1 file changed, 15 insertions(+), 6 deletions(-)
via 4ad171b5486ab8874ffaf9721891c2961fd7c9b2 (commit)
from 53a6cafcdc13c0b8ed60f1a2912d660f2e5b415d (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
commit 4ad171b5486ab8874ffaf9721891c2961fd7c9b2
Author: Tom Morris <tfmorris at veritasgenetics.com>
Date: Wed Nov 29 16:49:37 2017 -0500
12018: Documentation review updates
Arvados-DCO-1.1-Signed-off-by: Tom Morris <tfmorris at veritasgenetics.com>
diff --git a/doc/user/topics/arv-sync-groups.html.textile.liquid b/doc/user/topics/arv-sync-groups.html.textile.liquid
index 6086b1a..e2a42c8 100644
--- a/doc/user/topics/arv-sync-groups.html.textile.liquid
+++ b/doc/user/topics/arv-sync-groups.html.textile.liquid
@@ -21,24 +21,33 @@ Users can be identified by their email address or username: the tool will check
This tool is designed to be run periodically reading a file created by a remote auth system (ie: LDAP) dump script, applying what's included on the file as the source of truth.
-h2. Requirement
- at arv-sync-groups@ needs to perform several administrative tasks on Arvados, and for that, it needs a system user token.
+bq. NOTE: @arv-sync-groups@ needs to perform several administrative tasks on Arvados, so must be run using a superuser token
+
+h2. Options
+
+The following command line options are supported:
+
+table(table table-bordered table-condensed).
+|_. Option |_. Description |
+|==--help==| This list of options|
+|==--parent-group-uuid==| UUID of group to own all the externally synchronized groups|
+|==--user-id== | Identifier to use in looking up user. One of 'email' or 'username' (Default: 'email')|
+|==--verbose==| Log informational messages (Default: False)|
+|==--version==| Print version and exit|
h2. Examples
To sync groups using the username to identify every account, reading from some @external_groups.csv@ file, the command should be called as follows:
<notextile>
-<pre><code>
-~$ <span class="userinput">arv-sync-groups --user-id username /path/to/external_groups.csv </span>
+<pre><code>~$ <span class="userinput">arv-sync-groups --user-id username /path/to/external_groups.csv </span>
</code></pre>
</notextile>
If you want to use a specific preexisting group as the parent of all the remote groups, you can do it this way:
<notextile>
-<pre><code>
-~$ <span class="userinput">arv-sync-groups --parent-group-uuid <preexisting group UUID> --user-id username /path/to/external_groups.csv </span>
+<pre><code>~$ <span class="userinput">arv-sync-groups --parent-group-uuid <preexisting group UUID> --user-id username /path/to/external_groups.csv </span>
</code></pre>
</notextile>
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list