aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2021-05-31 17:23:35 +0200
committerAlex Auvolat <alex@adnab.me>2021-05-31 17:23:35 +0200
commit56ac9fd46013701d3319afaeb69c2dac54d09ff2 (patch)
tree3e99f57f0943da01c745eabb27b92456568d30f9
parentd76a8576f440a90d87fbeaabc80131eadafc88b7 (diff)
downloadgarage-56ac9fd46013701d3319afaeb69c2dac54d09ff2.tar.gz
garage-56ac9fd46013701d3319afaeb69c2dac54d09ff2.zip
Updates to documentation
-rw-r--r--doc/book/src/SUMMARY.md2
-rw-r--r--doc/book/src/quick_start/index.md7
-rw-r--r--doc/book/src/reference_manual/s3_compatibility.md14
3 files changed, 18 insertions, 5 deletions
diff --git a/doc/book/src/SUMMARY.md b/doc/book/src/SUMMARY.md
index 659f880e..9447c3b2 100644
--- a/doc/book/src/SUMMARY.md
+++ b/doc/book/src/SUMMARY.md
@@ -17,7 +17,7 @@
- [Reference Manual](./reference_manual/index.md)
- [Garage configuration file](./reference_manual/configuration.md)
- [Garage CLI](./reference_manual/cli.md)
- - [S3 API](./reference_manual/s3_compatibility.md)
+ - [S3 compatibility status](./reference_manual/s3_compatibility.md)
- [Design](./design/index.md)
- [Related Work](./design/related_work.md)
diff --git a/doc/book/src/quick_start/index.md b/doc/book/src/quick_start/index.md
index d564f760..1625e43b 100644
--- a/doc/book/src/quick_start/index.md
+++ b/doc/book/src/quick_start/index.md
@@ -65,11 +65,10 @@ your data to be persisted properly.
Use the following command to launch the Garage server with our configuration file:
```
-garage server -c garage.toml
+RUST_LOG=garage=info garage server -c garage.toml
```
-By default, Garage displays almost no output. You can tune Garage's verbosity as follows
-(from less verbose to more verbose):
+You can tune Garage's verbosity as follows (from less verbose to more verbose):
```
RUST_LOG=garage=info garage server -c garage.toml
@@ -262,5 +261,5 @@ The following tools can also be used to send and recieve files from/to Garage:
- [Cyberduck](https://cyberduck.io/)
- [`s3cmd`](https://s3tools.org/s3cmd)
-Refer to the ["configuring clients"](../cookbook/clients.md) to learn how to configure
+Refer to the ["configuring clients"](../cookbook/clients.md) page to learn how to configure
these clients to interact with a Garage server.
diff --git a/doc/book/src/reference_manual/s3_compatibility.md b/doc/book/src/reference_manual/s3_compatibility.md
index 5f9f527a..01059218 100644
--- a/doc/book/src/reference_manual/s3_compatibility.md
+++ b/doc/book/src/reference_manual/s3_compatibility.md
@@ -14,6 +14,7 @@ Not implemented:
- vhost-style URLs (`bucket.garage.tld/key`)
- object-level ACL
+- object versioning
- encryption
- most `x-amz-` headers
@@ -54,6 +55,15 @@ Implemented.
Implemented.
+#### GetBucketLocation
+
+Implemented.
+
+#### GetBucketVersioning
+
+Stub implementation (Garage does not yet support versionning so this always returns
+"versionning not enabled").
+
#### GetObject
Implemented.
@@ -66,6 +76,10 @@ Implemented.
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.