doc/admin/collection-default-properties.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: admin
   4 title: Configuring collection's default properties
   5 ...
   6
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 Collection's default properties allow a cluster administrator to enable some special behaviors regarding properties at creation & update times.
  14 This page describes how to enable and configure these behaviors on the API server.
  15
  16 h3. API Server configuration
  17
  18 The @collection_default_properties@ setting is used for enabling any of the following behaviors:
  19
  20 h4. Pre-assigned property key & value
  21
  22 For every newly created collection, assign a predefined key/value pair if it isn't already passed at creation time:
  23
  24 <pre>
  25 collection_default_properties:
  26   foo: {value: bar}
  27 </pre>
  28
  29 h4. Original owner UUID
  30
  31 This behavior will assign to a property key the UUID of the user who owns the collection's contaning project.
  32
  33 <pre>
  34 collection_default_properties:
  35   responsible_person_uuid: {function: original_owner}
  36 </pre>
  37
  38 h4. Protected properties
  39
  40 If there's a need to avoid a non-admin user to modify a specific property, even by its owner, the @protected@ attribute can be set to true, like so:
  41
  42 <pre>
  43 collection_default_properties:
  44   responsible_person_uuid: {function: original_owner, protected: true}
  45 </pre>
  46
  47 This property can be applied to any of the defined default properties. If missing, it's assumed as being @false@ by default.