[ARVADOS] created: 1.1.0-164-g4b16a16

Git user git at public.curoverse.com
Thu Nov 23 15:53:51 EST 2017

        at  4b16a16d0de04504f0172ce391da1fa603eb653c (commit)

commit 4b16a16d0de04504f0172ce391da1fa603eb653c
Author: Lucas Di Pentima <ldipentima at veritasgenetics.com>
Date:   Thu Nov 23 17:53:04 2017 -0300

    12018: Added documentation for arv-sync-groups
    Arvados-DCO-1.1-Signed-off-by: Lucas Di Pentima <ldipentima at veritasgenetics.com>

diff --git a/doc/_config.yml b/doc/_config.yml
index 3068647..e8a899c 100644
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -74,6 +74,7 @@ navbar:
       - user/topics/run-command.html.textile.liquid
       - user/reference/job-pipeline-ref.html.textile.liquid
       - user/examples/crunch-examples.html.textile.liquid
+      - user/topics/arv-sync-groups.html.textile.liquid
     - Query the metadata database:
       - user/topics/tutorial-trait-search.html.textile.liquid
     - Arvados License:
diff --git a/doc/user/topics/arv-sync-groups.html.textile.liquid b/doc/user/topics/arv-sync-groups.html.textile.liquid
new file mode 100644
index 0000000..bded05d
--- /dev/null
+++ b/doc/user/topics/arv-sync-groups.html.textile.liquid
@@ -0,0 +1,44 @@
+layout: default
+navsection: userguide
+title: "Using arv-sync-groups"
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+The @arv-sync-groups@ tool allows to synchronize remote groups into Arvados from an external source.
+h1. Using arv-sync-groups
+This tool reads a CSV (comma-separated values) file having information about external groups and their members. When running it for the first time, it'll create a special group named 'Externally synchronized groups' meant to be the parent of all the remote groups.
+Every line on the file should have 2 values: a group name and a local user identifier, meaning that the named user is a member of the group. The tool will create the group if it doesn't exist, and add the user to it. If group member is not present on the input file, the account will be removed from the group.
+Users can be identified by their email address or username: the tool will check if every user exist on the system, and report back when not found. Groups on the other hand, are identified by their name.
+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.
+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:
+~$ <span class="userinput">arv-sync-groups --user-id username /path/to/external_groups.csv </span>
+If you want to use a specific preexisting group as the parent of all the remote groups, you can do it this way:
+~$ <span class="userinput">arv-sync-groups --parent-group-uuid <preexisting group UUID> --user-id username /path/to/external_groups.csv </span>



More information about the arvados-commits mailing list