3 navsection: installguide
4 title: Configure S3 object storage
7 Copyright (C) The Arvados Authors. All rights reserved.
9 SPDX-License-Identifier: CC-BY-SA-3.0
12 Keepstore can store data in object storage compatible with the S3 API, such as Amazon S3, Google Cloud Storage, or Ceph RADOS.
14 Volumes are configured in the @Volumes@ section of the cluster configuration file.
16 {% include 'assign_volume_uuid' %}
18 <notextile><pre><code>Clusters:
19 <span class="userinput">uuid_prefix</span>:
21 <span class="userinput">uuid_prefix</span>-nyw5e-<span class="userinput">000000000000000</span>:
23 # This section determines which keepstore servers access the
24 # volume. In this example, keep0 has read/write access, and
25 # keep1 has read-only access.
27 # If the AccessViaHosts section is empty or omitted, all
28 # keepstore servers will have read/write access to the
30 "http://<span class="userinput">keep0.uuid_prefix.example.com</span>:25107/": {}
31 "http://<span class="userinput">keep1.uuid_prefix.example.com</span>:25107/": {ReadOnly: true}
35 # IAM role name to use when retrieving credentials from
36 # instance metadata. It can be omitted, in which case the
37 # role name itself will be retrieved from instance metadata
38 # -- but setting it explicitly may protect you from using
39 # the wrong credentials in the event of an
40 # installation/configuration error.
43 # If you are not using an IAM role for authentication,
44 # specify access credentials here instead.
48 # Storage provider endpoint. For Amazon S3, use "" or
49 # omit. For Google Cloud Storage, use
50 # "https://storage.googleapis.com".
53 # Storage provider region. For Google Cloud Storage, use ""
57 # Change to true if the region requires a LocationConstraint
59 LocationConstraint: false
62 Bucket: example-bucket-name
64 # Requested page size for "list bucket contents" requests.
67 # Maximum time to wait while making the initial connection
68 # to the backend before failing the request.
71 # Maximum time to wait for a complete response from the
72 # backend before failing the request.
75 # Maximum eventual consistency latency
78 # Enable deletion (garbage collection) even when the
79 # configured BlobTrashLifetime is zero. WARNING: eventual
80 # consistency may result in race conditions that can cause
81 # data loss. Do not enable this unless you understand and
85 # How much replication is provided by the underlying bucket.
86 # This is used to inform replication decisions at the Keep
90 # If true, do not accept write or trash operations, even if
91 # AccessViaHosts.*.ReadOnly is false.
93 # If false or omitted, enable write access (subject to
94 # AccessViaHosts.*.ReadOnly, where applicable).
97 # Storage classes to associate with this volume. See "Storage
98 # classes" in the "Admin" section of doc.arvados.org.
100 </code></pre></notextile>