forked from Deuxfleurs/garage
Update documentation
This commit is contained in:
parent
c18920f8d1
commit
6455347955
2 changed files with 68 additions and 104 deletions
|
|
@ -10,31 +10,26 @@ block_size = 1048576
|
||||||
|
|
||||||
replication_mode = "3"
|
replication_mode = "3"
|
||||||
|
|
||||||
|
rpc_secret = "4425f5c26c5e11581d3223904324dcb5b5d5dfb14e5e7f35e38c595424f5f1e6"
|
||||||
rpc_bind_addr = "[::]:3901"
|
rpc_bind_addr = "[::]:3901"
|
||||||
|
rpc_public_addr = "[fc00:1::1]:3901"
|
||||||
|
|
||||||
bootstrap_peers = [
|
bootstrap_peers = [
|
||||||
"[fc00:1::1]:3901",
|
"563e1ac825ee3323aa441e72c26d1030d6d4414aeb3dd25287c531e7fc2bc95d@[fc00:1::1]:3901",
|
||||||
"[fc00:1::2]:3901",
|
"86f0f26ae4afbd59aaf9cfb059eefac844951efd5b8caeec0d53f4ed6c85f332[fc00:1::2]:3901",
|
||||||
"[fc00:B::1]:3901",
|
"681456ab91350f92242e80a531a3ec9392cb7c974f72640112f90a600d7921a4@[fc00:B::1]:3901",
|
||||||
"[fc00:F::1]:3901",
|
"212fd62eeaca72c122b45a7f4fa0f55e012aa5e24ac384a72a3016413fa724ff@[fc00:F::1]:3901",
|
||||||
]
|
]
|
||||||
|
|
||||||
consul_host = "consul.service"
|
consul_host = "consul.service"
|
||||||
consul_service_name = "garage-daemon"
|
consul_service_name = "garage-daemon"
|
||||||
|
|
||||||
max_concurrent_rpc_requests = 12
|
|
||||||
|
|
||||||
sled_cache_capacity = 134217728
|
sled_cache_capacity = 134217728
|
||||||
sled_flush_every_ms = 2000
|
sled_flush_every_ms = 2000
|
||||||
|
|
||||||
[rpc_tls]
|
|
||||||
ca_cert = "/etc/garage/pki/garage-ca.crt"
|
|
||||||
node_cert = "/etc/garage/pki/garage.crt"
|
|
||||||
node_key = "/etc/garage/pki/garage.key"
|
|
||||||
|
|
||||||
[s3_api]
|
[s3_api]
|
||||||
s3_region = "garage"
|
|
||||||
api_bind_addr = "[::]:3900"
|
api_bind_addr = "[::]:3900"
|
||||||
|
s3_region = "garage"
|
||||||
|
|
||||||
[s3_web]
|
[s3_web]
|
||||||
bind_addr = "[::]:3902"
|
bind_addr = "[::]:3902"
|
||||||
|
|
@ -63,10 +58,15 @@ when [configuring it](../getting_started/05_cluster.md).
|
||||||
|
|
||||||
#### `block_size`
|
#### `block_size`
|
||||||
|
|
||||||
Garage splits stored objects in consecutive chunks of size `block_size` (except the last
|
Garage splits stored objects in consecutive chunks of size `block_size`
|
||||||
one which might be standard). The default size is 1MB and should work in most cases.
|
(except the last one which might be smaller). The default size is 1MB and
|
||||||
If you are interested in tuning this, feel free to do so (and remember to report your
|
should work in most cases. If you are interested in tuning this, feel free
|
||||||
findings to us!)
|
to do so (and remember to report your findings to us!). If this value is
|
||||||
|
changed for a running Garage installation, only files newly uploaded will be
|
||||||
|
affected. Previously uploaded files will remain available. This however
|
||||||
|
means that chunks from existing files will not be deduplicated with chunks
|
||||||
|
from newly uploaded files, meaning you might use more storage space that is
|
||||||
|
optimally possible.
|
||||||
|
|
||||||
#### `replication_mode`
|
#### `replication_mode`
|
||||||
|
|
||||||
|
|
@ -97,6 +97,14 @@ Never run a Garage cluster where that is not the case.**
|
||||||
Changing the `replication_mode` of a cluster might work (make sure to shut down all nodes
|
Changing the `replication_mode` of a cluster might work (make sure to shut down all nodes
|
||||||
and changing it everywhere at the time), but is not officially supported.
|
and changing it everywhere at the time), but is not officially supported.
|
||||||
|
|
||||||
|
#### `rpc_secret`
|
||||||
|
|
||||||
|
Garage uses a secret key that is shared between all nodes of the cluster
|
||||||
|
in order to identify these nodes and allow them to communicate together.
|
||||||
|
This key should be specified here in the form of a 32-byte hex-encoded
|
||||||
|
random string. Such a string can be generated with a command
|
||||||
|
such as `openssl rand -hex 32`.
|
||||||
|
|
||||||
#### `rpc_bind_addr`
|
#### `rpc_bind_addr`
|
||||||
|
|
||||||
The address and port on which to bind for inter-cluster communcations
|
The address and port on which to bind for inter-cluster communcations
|
||||||
|
|
@ -106,10 +114,28 @@ the node, even in the case of a NAT: the NAT should be configured to forward the
|
||||||
port number to the same internal port nubmer. This means that if you have several nodes running
|
port number to the same internal port nubmer. This means that if you have several nodes running
|
||||||
behind a NAT, they should each use a different RPC port number.
|
behind a NAT, they should each use a different RPC port number.
|
||||||
|
|
||||||
|
#### `rpc_public_addr`
|
||||||
|
|
||||||
|
The address and port that other nodes need to use to contact this node for
|
||||||
|
RPC calls. **This parameter is optional but recommended.** In case you have
|
||||||
|
a NAT that binds the RPC port to a port that is different on your public IP,
|
||||||
|
this field might help making it work.
|
||||||
|
|
||||||
#### `bootstrap_peers`
|
#### `bootstrap_peers`
|
||||||
|
|
||||||
A list of IPs and ports on which to contact other Garage peers of this cluster.
|
A list of peer identifiers on which to contact other Garage peers of this cluster.
|
||||||
This should correspond to the RPC ports set up with `rpc_bind_addr`.
|
These peer identifiers have the following syntax:
|
||||||
|
|
||||||
|
```
|
||||||
|
<node public key>@<node public IP or hostname>:<port>
|
||||||
|
```
|
||||||
|
|
||||||
|
In the case where `rpc_public_addr` is correctly specified in the
|
||||||
|
configuration file, the full identifier of a node including IP and port can
|
||||||
|
be obtained by running `garage node-id` and then included directly in the
|
||||||
|
`bootstrap_peers` list of other nodes. Otherwise, only the node's public
|
||||||
|
key will be returned by `garage node-id` and you will have to add the IP
|
||||||
|
yourself.
|
||||||
|
|
||||||
#### `consul_host` and `consul_service_name`
|
#### `consul_host` and `consul_service_name`
|
||||||
|
|
||||||
|
|
@ -121,12 +147,6 @@ The `consul_host` parameter should be set to the hostname of the Consul server,
|
||||||
and `consul_service_name` should be set to the service name under which Garage's
|
and `consul_service_name` should be set to the service name under which Garage's
|
||||||
RPC ports are announced.
|
RPC ports are announced.
|
||||||
|
|
||||||
#### `max_concurrent_rpc_requests`
|
|
||||||
|
|
||||||
Garage implements rate limiting for RPC requests: no more than
|
|
||||||
`max_concurrent_rpc_requests` concurrent outbound RPC requests will be made
|
|
||||||
by a Garage node (additionnal requests will be put in a waiting queue).
|
|
||||||
|
|
||||||
#### `sled_cache_capacity`
|
#### `sled_cache_capacity`
|
||||||
|
|
||||||
This parameter can be used to tune the capacity of the cache used by
|
This parameter can be used to tune the capacity of the cache used by
|
||||||
|
|
@ -143,21 +163,6 @@ of a power outage (though this should not matter much as data is replicated on o
|
||||||
nodes). The default value, 2000ms, should be appropriate for most use cases.
|
nodes). The default value, 2000ms, should be appropriate for most use cases.
|
||||||
|
|
||||||
|
|
||||||
## The `[rpc_tls]` section
|
|
||||||
|
|
||||||
This section should be used to configure the TLS certificates used to encrypt
|
|
||||||
intra-cluster traffic (RPC traffic). The following parameters should be set:
|
|
||||||
|
|
||||||
- `ca_cert`: the certificate of the CA that is allowed to sign individual node certificates
|
|
||||||
- `node_cert`: the node certificate for the current node
|
|
||||||
- `node_key`: the key associated with the node certificate
|
|
||||||
|
|
||||||
Note tha several nodes may use the same node certificate, as long as it is signed
|
|
||||||
by the CA.
|
|
||||||
|
|
||||||
If this section is absent, TLS is not used to encrypt intra-cluster traffic.
|
|
||||||
|
|
||||||
|
|
||||||
## The `[s3_api]` section
|
## The `[s3_api]` section
|
||||||
|
|
||||||
#### `api_bind_addr`
|
#### `api_bind_addr`
|
||||||
|
|
|
||||||
|
|
@ -23,76 +23,35 @@ Not implemented:
|
||||||
|
|
||||||
All APIs that are not mentionned are not implemented and will return a 400 bad request.
|
All APIs that are not mentionned are not implemented and will return a 400 bad request.
|
||||||
|
|
||||||
#### AbortMultipartUpload
|
| Endpoint | Status |
|
||||||
|
|------------------------------|----------------------------------|
|
||||||
|
| AbortMultipartUpload | Implemented |
|
||||||
|
| CompleteMultipartUpload | Implemented |
|
||||||
|
| CopyObject | Implemented |
|
||||||
|
| CreateBucket | Unsupported, stub (see below) |
|
||||||
|
| CreateMultipartUpload | Implemented |
|
||||||
|
| DeleteBucket | Unsupported (see below) |
|
||||||
|
| DeleteObject | Implemented |
|
||||||
|
| DeleteObjects | Implemented |
|
||||||
|
| GetBucketLocation | Implemented |
|
||||||
|
| GetBucketVersioning | Stub (see below) |
|
||||||
|
| GetObject | Implemented |
|
||||||
|
| HeadBucket | Implemented |
|
||||||
|
| HeadObject | Implemented |
|
||||||
|
| ListBuckets | Implemented |
|
||||||
|
| ListObjects | Implemented, bugs? (see below) |
|
||||||
|
| ListObjectsV2 | Implemented |
|
||||||
|
| PutObject | Implemented |
|
||||||
|
| UploadPart | Implemented |
|
||||||
|
|
||||||
Implemented.
|
|
||||||
|
|
||||||
#### CompleteMultipartUpload
|
|
||||||
|
|
||||||
Implemented badly. Garage will not check that all the parts stored correspond to the list given by the client in the request body. This means that the multipart upload might be completed with an invalid size. This is a bug and will be fixed.
|
- **CreateBucket:** Garage does not yet accept creating buckets or giving access using API calls, it has to be done using the CLI tools. CreateBucket will return a 200 if the bucket exists and user has write access, and a 403 Forbidden in all other cases.
|
||||||
|
|
||||||
#### CopyObject
|
- **DeleteBucket:** Garage does not yet accept deleting buckets using API calls, it has to be done using the CLI tools. This request will return a 403 Forbidden.
|
||||||
|
|
||||||
Implemented.
|
- **GetBucketVersioning:** Stub implementation (Garage does not yet support versionning so this always returns
|
||||||
|
|
||||||
#### CreateBucket
|
|
||||||
|
|
||||||
Garage does not accept creating buckets or giving access using API calls, it has to be done using the CLI tools. CreateBucket will return a 200 if the bucket exists and user has write access, and a 403 Forbidden in all other cases.
|
|
||||||
|
|
||||||
#### CreateMultipartUpload
|
|
||||||
|
|
||||||
Implemented.
|
|
||||||
|
|
||||||
#### DeleteBucket
|
|
||||||
|
|
||||||
Garage does not accept deleting buckets using API calls, it has to be done using the CLI tools. This request will return a 403 Forbidden.
|
|
||||||
|
|
||||||
#### DeleteObject
|
|
||||||
|
|
||||||
Implemented.
|
|
||||||
|
|
||||||
#### DeleteObjects
|
|
||||||
|
|
||||||
Implemented.
|
|
||||||
|
|
||||||
#### GetBucketLocation
|
|
||||||
|
|
||||||
Implemented.
|
|
||||||
|
|
||||||
#### GetBucketVersioning
|
|
||||||
|
|
||||||
Stub implementation (Garage does not yet support versionning so this always returns
|
|
||||||
"versionning not enabled").
|
"versionning not enabled").
|
||||||
|
|
||||||
#### GetObject
|
- **ListObjects:** Implemented, but there isn't a very good specification of what `encoding-type=url` covers so there might be some encoding bugs. In our implementation the url-encoded fields are in the same in ListObjects as they are in ListObjectsV2.
|
||||||
|
|
||||||
Implemented.
|
|
||||||
|
|
||||||
#### HeadBucket
|
|
||||||
|
|
||||||
Implemented.
|
|
||||||
|
|
||||||
#### HeadObject
|
|
||||||
|
|
||||||
Implemented.
|
|
||||||
|
|
||||||
#### ListBuckets
|
|
||||||
|
|
||||||
Implemented.
|
|
||||||
|
|
||||||
#### ListObjects
|
|
||||||
|
|
||||||
Implemented, but there isn't a very good specification of what `encoding-type=url` covers so there might be some encoding bugs. In our implementation the url-encoded fields are in the same in ListObjects as they are in ListObjectsV2.
|
|
||||||
|
|
||||||
#### ListObjectsV2
|
|
||||||
|
|
||||||
Implemented.
|
|
||||||
|
|
||||||
#### PutObject
|
|
||||||
|
|
||||||
Implemented.
|
|
||||||
|
|
||||||
#### UploadPart
|
|
||||||
|
|
||||||
Implemented.
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue