aboutsummaryrefslogtreecommitdiff
path: root/doc/book
Commit message (Collapse)AuthorAgeFilesLines
...
* Merge pull request 'Documentation changes for v0.8' (#394) from doc-0.8 into ↵Alex2022-09-273-7/+41
|\ | | | | | | | | | | main Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/394
| * Update docker image linksAlex Auvolat2022-09-261-6/+6
| |
| * Add garage v0.8 migration guideAlex Auvolat2022-09-262-1/+35
| |
* | Update READMEnew-readmeAlex Auvolat2022-09-211-1/+1
|/
* Finish writing about Garage features, and fix from-source instructionsAlex Auvolat2022-09-153-45/+106
|
* Some work on documentation towards v0.8Alex Auvolat2022-09-1415-71/+151
|
* Document available build featuresAlex Auvolat2022-09-061-16/+33
|
* Add some documentation for CaddyQuentin Dufour2022-08-121-0/+22
|
* Fix typoAlex2022-06-291-1/+1
|
* improve internal item counter mechanisms and implement bucket quotas (#326)Alex2022-06-151-70/+88
| | | | | | | | | | | | | | | | - [x] Refactoring of internal counting API - [x] Repair procedure for counters (it's an offline procedure!!!) - [x] New counter for objects in buckets - [x] Add quotas to buckets struct - [x] Add CLI to manage bucket quotas - [x] Add admin API to manage bucket quotas - [x] Apply quotas by adding checks on put operations - [x] Proof-read Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/326 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me>
* docs: Add Trafik reverse proxy documentationSimon C2022-06-071-2/+139
|
* docs: Fix title levelSimon C2022-06-071-1/+1
|
* docs: Add link to facilitate navigation in the documentationSimon C2022-06-071-1/+1
|
* Remove useless MC_REGION env variabledoc2Quentin Dufour2022-06-021-10/+0
|
* Fixes to S3 compatibility page (#314)Alex2022-05-251-29/+48
| | | | | | | | | Mention PostObject is implemented, fix english mistakes Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/314 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me>
* Update Ceph S3 endpoints compatibilityQuentin Dufour2022-05-251-28/+36
|
* Shorter page titledoc/admin-apiAlex Auvolat2022-05-241-1/+1
|
* Add lost content for Restic with GarageAlex Auvolat2022-05-241-0/+55
| | | | Suggested-by: Quentin <quentin@deuxfleurs.fr>
* Add documentation for new Admin API and a few infos on K2VAlex Auvolat2022-05-243-4/+716
|
* Add documentation on running Kopia with GarageBaptiste Jonglez2022-04-101-0/+21
|
* Be clearer on what upgrades are (not) supporteddoc/upgradingQuentin Dufour2022-04-063-10/+4
|
* Add an "upgrading" section, add a guide for 0.7Quentin Dufour2022-04-053-2/+89
|
* Add documentation for winscp+sftpgodoc/winscp+sftpgoQuentin Dufour2022-03-311-2/+57
|
* New replication modes and their documentationfeature/documentationAlex Auvolat2022-03-281-17/+70
|
* document administrative optionsAlex Auvolat2022-03-281-0/+23
|
* Talk a bit about capacity balancing between regionsAlex Auvolat2022-03-221-11/+18
|
* document request routing logicRune Henriksen2022-03-211-0/+45
|
* add short tutorial for duplicati usage with garageRune Henriksen2022-03-211-1/+16
|
* Change position of the node-id argumentSteam2022-03-191-4/+4
|
* add support for kubernetes service discoveryMax Audron2022-03-121-0/+18
| | | | | | | | | | | | | | | | | | | | | This commit adds support to discover garage instances running in kubernetes. Once enabled by setting `kubernetes_namespace` and `kubernetes_service_name` garage will create a Custom Resources `garagenodes.deuxfleurs.fr` with nodes public key as the resource name. and IP and Port information as spec in the namespace configured by `kubernetes_namespace`. For discovering nodes the resources are filtered with the optionally set `kubernetes_service_name` which sets a label `garage.deuxfleurs.fr/service` on the resources. This allows to separate multiple garage deployments in a single namespace. the `kubernetes_skip_crd` variable allows to disable the creation of the CRD by garage itself. The user must deploy this manually.
* documentation: add mention to install build-essentialAlex Auvolat2022-02-161-3/+8
|
* Small documentation updates (#237)Alex2022-02-103-18/+23
| | | | | | | | | Fixes #234, among other things Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/237 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me>
* Add a new S3 comparison Matrix to documentation (#220)Quentin2022-02-071-54/+192
| | | | | | | Co-authored-by: Quentin Dufour <quentin@deuxfleurs.fr> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/220 Co-authored-by: Quentin <quentin@dufour.io> Co-committed-by: Quentin <quentin@dufour.io>
* Fix anchors in linksdoc/clean-and-testsAlex Auvolat2022-02-073-7/+7
|
* Update quickstart to set endpoints ending in localhostQuentin Dufour2022-02-071-2/+2
|
* Improve integration part of the docQuentin Dufour2022-02-077-227/+271
|
* Reorganize documentation for new website (#213)Alex2022-02-0755-395/+338
| | | | | | | | | | | | | | This PR should be merged after the new website is deployed. - [x] Rename files - [x] Add front matter section to all `.md` files in the book (necessary for Zola) - [x] Change all internal links to use Zola's linking system that checks broken links - [x] Some updates to documentation contents and organization Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/213 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me>
* Add advice about --fast-listAlex Auvolat2022-01-311-0/+5
|
* Add step to 0.6.0 migration guideAlex Auvolat2022-01-271-4/+8
|
* Implement {Put,Get,Delete}BucketCors and CORS in generalAlex Auvolat2022-01-242-5/+9
| | | | | | - OPTIONS request against API endpoint - Returning corresponding CORS headers on API calls - Returning corresponding CORS headers on website GET's
* Test ListParts endpoint with awsclifeatures/list-partsQuentin Dufour2022-01-211-1/+1
|
* Update documentationimprove-website-configAlex Auvolat2022-01-132-5/+4
|
* Implement UploadPartCopyAlex Auvolat2022-01-132-2/+3
|
* Implement ListMultipartUploads (#171)Quentin2022-01-121-0/+2
| | | | | | | | | | | | | | | | | | | | | | | Implement ListMultipartUploads, also refactor ListObjects and ListObjectsV2. It took me some times as I wanted to propose the following things: - Using an iterator instead of the loop+goto pattern. I find it easier to read and it should enable some optimizations. For example, when consuming keys of a common prefix, we do many [redundant checks](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/main/src/api/s3_list.rs#L125-L156) while the only thing to do is to [check if the following key is still part of the common prefix](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/feature/s3-multipart-compat/src/api/s3_list.rs#L476). - Try to name things (see ExtractionResult and RangeBegin enums) and to separate concerns (see ListQuery and Accumulator) - An IO closure to make unit tests possibles. - Unit tests, to track regressions and document how to interact with the code - Integration tests with `s3api`. In the future, I would like to move them in Rust with the aws rust SDK. Merging of the logic of ListMultipartUploads and ListObjects was not a goal but a consequence of the previous modifications. Some points that we might want to discuss: - ListObjectsV1, when using pagination and delimiters, has a weird behavior (it lists multiple times the same prefix) with `aws s3api` due to the fact that it can not use our optimization to skip the whole prefix. It is independant from my refactor and can be tested with the commented `s3api` tests in `test-smoke.sh`. It probably has the same weird behavior on the official AWS S3 implementation. - Considering ListMultipartUploads, I had to "abuse" upload id marker to support prefix skipping. I send an `upload-id-marker` with the hardcoded value `include` to emulate your "including" token. - Some ways to test ListMultipartUploads with existing software (my tests are limited to s3api for now). Co-authored-by: Quentin Dufour <quentin@deuxfleurs.fr> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/171 Co-authored-by: Quentin <quentin@dufour.io> Co-committed-by: Quentin <quentin@dufour.io>
* Add documentation to migrate to 0.6update-documentationcreate-delete-bucketsAlex Auvolat2022-01-102-0/+47
|
* Update documentationAlex Auvolat2022-01-072-9/+4
|
* update s3 compatibility list (#177)trinity-1686a2021-12-152-16/+22
| | | | | | | Co-authored-by: Trinity Pointard <trinity.pointard@gmail.com> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/177 Co-authored-by: trinity-1686a <trinity.pointard@gmail.com> Co-committed-by: trinity-1686a <trinity.pointard@gmail.com>
* Add compression using zstd (#173)trinity-1686a2021-12-152-0/+28
| | | | | | | | | fix #27 Co-authored-by: Trinity Pointard <trinity.pointard@gmail.com> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/173 Co-authored-by: trinity-1686a <trinity.pointard@gmail.com> Co-committed-by: trinity-1686a <trinity.pointard@gmail.com>
* Add a second plotdoc/bench-multi-dcQuentin Dufour2021-12-132-1/+21
|
* Update benchmarkdoc/fixQuentin Dufour2021-12-091-0/+0
|