doc/admin/collection-versioning.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: admin
   4 title: Configuring collection versioning
   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 This page describes how to enable and configure the collection versioning feature on the API server.
  14
  15 h3. Configuration
  16
  17 There are 2 configuration settings in the @Collections@ section of @config.yml@ that control this feature.
  18
  19 <pre>
  20     Collections:
  21       # If true, enable collection versioning.
  22       # When a collection's preserve_version field is true or the current version
  23       # is older than the amount of seconds defined on PreserveVersionIfIdle,
  24       # a snapshot of the collection's previous state is created and linked to
  25       # the current collection.
  26       CollectionVersioning: true
  27
  28       # This setting control the auto-save aspect of collection versioning, and can be set to:
  29       #   0s = auto-create a new version on every update.
  30       #  -1s = never auto-create new versions.
  31       # > 0s = auto-create a new version when older than the specified number of seconds.
  32       PreserveVersionIfIdle: 10s
  33 </pre>
  34
  35 Note that if you set @CollectionVersioning@ to @false@ after being enabled, old versions will still be accessible, but further changes will not be versioned.
  36
  37 h3. Using collection versioning
  38
  39 "Discussed in the user guide":{{site.baseurl}}/user/topics/collection-versioning.html