[arvados] updated: 2.1.0-2851-g37ca517de
git repository hosting
git at public.arvados.org
Thu Oct 6 14:20:03 UTC 2022
Summary of changes:
doc/_config.yml | 6 +--
doc/admin/group-management.html.textile.liquid | 18 +++----
doc/admin/project-management.html.textile.liquid | 68 ------------------------
3 files changed, 12 insertions(+), 80 deletions(-)
delete mode 100644 doc/admin/project-management.html.textile.liquid
via 37ca517deefb5cbaef6fbaa1552eb92245364635 (commit)
from e35720b456048c4fafcbb267cb8297522284ed61 (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 37ca517deefb5cbaef6fbaa1552eb92245364635
Author: Peter Amstutz <peter.amstutz at curii.com>
Date: Thu Oct 6 10:19:35 2022 -0400
19180: Move CLI project management over to SDK section
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz at curii.com>
diff --git a/doc/_config.yml b/doc/_config.yml
index f195986a1..a6f7e6086 100644
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -89,6 +89,7 @@ navbar:
- sdk/cli/index.html.textile.liquid
- sdk/cli/reference.html.textile.liquid
- sdk/cli/subcommands.html.textile.liquid
+ - sdk/cli/project-management.html.textile.liquid
- Go:
- sdk/go/index.html.textile.liquid
- sdk/go/example.html.textile.liquid
@@ -172,23 +173,22 @@ navbar:
- Users and Groups:
- admin/user-management.html.textile.liquid
- admin/user-management-cli.html.textile.liquid
+ - admin/group-management.html.textile.liquid
- admin/reassign-ownership.html.textile.liquid
- admin/link-accounts.html.textile.liquid
- - admin/group-management.html.textile.liquid
- admin/federation.html.textile.liquid
- admin/merge-remote-account.html.textile.liquid
- admin/migrating-providers.html.textile.liquid
- user/topics/arvados-sync-external-sources.html.textile.liquid
- admin/scoped-tokens.html.textile.liquid
- admin/token-expiration-policy.html.textile.liquid
- - admin/user-activity.html.textile.liquid
- Monitoring:
- admin/logging.html.textile.liquid
- admin/metrics.html.textile.liquid
- admin/health-checks.html.textile.liquid
- admin/management-token.html.textile.liquid
+ - admin/user-activity.html.textile.liquid
- Data Management:
- - admin/project-management.html.textile.liquid
- admin/collection-versioning.html.textile.liquid
- admin/collection-managed-properties.html.textile.liquid
- admin/restricting-upload-download.html.textile.liquid
diff --git a/doc/admin/group-management.html.textile.liquid b/doc/admin/group-management.html.textile.liquid
index 764204296..43319e873 100644
--- a/doc/admin/group-management.html.textile.liquid
+++ b/doc/admin/group-management.html.textile.liquid
@@ -1,7 +1,7 @@
---
layout: default
navsection: admin
-title: Group management
+title: Role group management at the CLI
...
{% comment %}
@@ -12,7 +12,7 @@ SPDX-License-Identifier: CC-BY-SA-3.0
This page describes how to manage groups at the command line. You should be familiar with the "permission system":{{site.baseurl}}/api/permission-model.html .
-h2. Create a group
+h2. Create a role group
User groups are entries in the "groups" table with @"group_class": "role"@.
@@ -20,7 +20,7 @@ User groups are entries in the "groups" table with @"group_class": "role"@.
arv group create --group '{"name": "My new group", "group_class": "role"}'
</pre>
-h2(#add). Add a user to a group
+h2(#add). Add a user to a role group
There are two separate permissions associated with group membership. The first link grants the user @can_manage@ permission to manage things that the group can manage. The second link grants permission for other users of the group to see that this user is part of the group.
@@ -40,13 +40,13 @@ arv link create --link '{
A user can also be given read-only access to a group. In that case, the first link should be created with @can_read@ instead of @can_manage at .
-h2. List groups
+h2. List role groups
<pre>
arv group list --filters '[["group_class", "=", "role"]]'
</pre>
-h2. List members of a group
+h2. List members of a role group
Use the command "jq":https://stedolan.github.io/jq/ to extract the tail_uuid of each permission link which has the user uuid.
@@ -55,9 +55,9 @@ arv link list --filters '[["link_class", "=", "permission"],
["head_uuid", "=", "the_group_uuid"]]' | jq .items[].tail_uuid
</pre>
-h2(#share-project). Share a project with a group
+h2(#share-project). Share a project with a role group
-This will give all members of the group @can_manage@ access.
+Members of the role group will have access to the project based on their level of access to the role group.
<pre>
arv link create --link '{
@@ -67,7 +67,7 @@ arv link create --link '{
"head_uuid": "the_project_uuid"}'
</pre>
-A project can also be shared read-only. In that case, the first link should be created with @can_read@ instead of @can_manage at .
+A project can also be shared read-only. In that case, the link @name@ should be @can_read@ instead of @can_manage at .
h2. List things shared with the group
@@ -91,7 +91,7 @@ arv --format=uuid link list --filters '[["link_class", "=", "permission"],
arv link delete --uuid each_link_uuid
</pre>
-h2. Remove user from a group
+h2. Remove user from a role group
The first step is to find the permission link objects. The second step is to delete them.
diff --git a/doc/admin/project-management.html.textile.liquid b/doc/admin/project-management.html.textile.liquid
deleted file mode 100644
index 6b3daa830..000000000
--- a/doc/admin/project-management.html.textile.liquid
+++ /dev/null
@@ -1,68 +0,0 @@
----
-layout: default
-navsection: admin
-title: Project management
-...
-
-{% comment %}
-Copyright (C) The Arvados Authors. All rights reserved.
-
-SPDX-License-Identifier: CC-BY-SA-3.0
-{% endcomment %}
-
-This page describes how to manage projects at the command line.
-
-h2. Create a Project
-
-Projects are entries in the "groups" table with @"group_class": "project"@.
-
-<pre>
-arv group create --group '{"group_class": "project", "owner_uuid": "the_parent_project_uuid", "name": "My new Project"}'
-</pre>
-
-h2. Move a collection into a Project
-
-Move a collection by assigning it to a new owner.
-
-<pre>
-arv collection update --uuid the_collection_uuid --collection '{"owner_uuid": "the_project_uuid"}'
-</pre>
-
-h2. Get Project contents
-
-Lists everything owned by the project.
-
-<pre>
-arv group contents --uuid the_project_uuid
-</pre>
-
-h2. Move a Project
-
-Move a project by assigning it to a new owner.
-
-<pre>
-arv group create --uuid the_project_uuid --group '{"owner_uuid": "the_new_parent_project_uuid"}'
-</pre>
-
-h2. Put a Project in the trash
-
-Trashing a project recursively includes all of its contents (collections, subprojects, workflows, etc). This sets @trash_at@ to now and @delete_at@ to the time period @Collection.DefaultTrashLifetime@ in the future. When @delete_at@ is reached, the project and all of its contents are deleted permanently.
-
-<pre>
-arv group delete --uuid the_project_uuid
-</pre>
-
-h2. Recover a Project from the trash
-
-
-<pre>
-arv group untrash --uuid the_project_uuid
-</pre>
-
-h2. Share a project with a user group
-
-See "Share a project with a group":group-management.html#share-project
-
-h2. Stop sharing a project with a user group
-
-See "Stop sharing a project with a group":group-management.html#stop-sharing-project
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list