aboutsummaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* First version of admin API (#298)Alex2022-05-241-0/+603
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | **Spec:** - [x] Start writing - [x] Specify all layout endpoints - [x] Specify all endpoints for operations on keys - [x] Specify all endpoints for operations on key/bucket permissions - [x] Specify all endpoints for operations on buckets - [x] Specify all endpoints for operations on bucket aliases View rendered spec at <https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/admin-api/doc/drafts/admin-api.md> **Code:** - [x] Refactor code for admin api to use common api code that was created for K2V **General endpoints:** - [x] Metrics - [x] GetClusterStatus - [x] ConnectClusterNodes - [x] GetClusterLayout - [x] UpdateClusterLayout - [x] ApplyClusterLayout - [x] RevertClusterLayout **Key-related endpoints:** - [x] ListKeys - [x] CreateKey - [x] ImportKey - [x] GetKeyInfo - [x] UpdateKey - [x] DeleteKey **Bucket-related endpoints:** - [x] ListBuckets - [x] CreateBucket - [x] GetBucketInfo - [x] DeleteBucket - [x] PutBucketWebsite - [x] DeleteBucketWebsite **Operations on key/bucket permissions:** - [x] BucketAllowKey - [x] BucketDenyKey **Operations on bucket aliases:** - [x] GlobalAliasBucket - [x] GlobalUnaliasBucket - [x] LocalAliasBucket - [x] LocalUnaliasBucket **And also:** - [x] Separate error type for the admin API (this PR includes a quite big refactoring of error handling) - [x] Add management of website access - [ ] Check that nothing is missing wrt what can be done using the CLI - [ ] Improve formatting of the spec - [x] Make sure everyone is cool with the API design Fix #231 Fix #295 Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/298 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me>
* Fix ReadIndex spec and add JSON5 remark to docfix-k2v-docAlex Auvolat2022-05-161-7/+44
|
* First implementation of K2V (#293)Alex2022-05-101-0/+680
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | **Specification:** View spec at [this URL](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/k2v/doc/drafts/k2v-spec.md) - [x] Specify the structure of K2V triples - [x] Specify the DVVS format used for causality detection - [x] Specify the K2V index (just a counter of number of values per partition key) - [x] Specify single-item endpoints: ReadItem, InsertItem, DeleteItem - [x] Specify index endpoint: ReadIndex - [x] Specify multi-item endpoints: InsertBatch, ReadBatch, DeleteBatch - [x] Move to JSON objects instead of tuples - [x] Specify endpoints for polling for updates on single values (PollItem) **Implementation:** - [x] Table for K2V items, causal contexts - [x] Indexing mechanism and table for K2V index - [x] Make API handlers a bit more generic - [x] K2V API endpoint - [x] K2V API router - [x] ReadItem - [x] InsertItem - [x] DeleteItem - [x] PollItem - [x] ReadIndex - [x] InsertBatch - [x] ReadBatch - [x] DeleteBatch **Testing:** - [x] Just a simple Python script that does some requests to check visually that things are going right (does not contain parsing of results or assertions on returned values) - [x] Actual tests: - [x] Adapt testing framework - [x] Simple test with InsertItem + ReadItem - [x] Test with several Insert/Read/DeleteItem + ReadIndex - [x] Test all combinations of return formats for ReadItem - [x] Test with ReadBatch, InsertBatch, DeleteBatch - [x] Test with PollItem - [x] Test error codes - [ ] Fix most broken stuff - [x] test PollItem broken randomly - [x] when invalid causality tokens are given, errors should be 4xx not 5xx **Improvements:** - [x] Descending range queries - [x] Specify - [x] Implement - [x] Add test - [x] Batch updates to index counter - [x] Put K2V behind `k2v` feature flag Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/293 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me>
* 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.
* Add FOSDEM talk and move all .pdf files to Git LFStalk-fosdemAlex Auvolat2022-02-1634-0/+4615
|
* 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
|
* Typos and dead linksQuentin Dufour2021-12-084-4/+4
|
* Add a benchmark page with a first benchmarkQuentin Dufour2021-12-083-0/+62
|
* S3 compatibility targetv0.5.0.1Alex Auvolat2021-12-062-0/+106
|
* Reorganize and improve documentationAlex Auvolat2021-12-0611-101/+127
|
* WIP front page garageQuentin Dufour2021-12-067-51/+116
|
* Improve how node roles are assigned in Garagev0.5-beta1Alex Auvolat2021-11-169-63/+172
| | | | | | | | | | | | | | | | | - change the terminology: the network configuration becomes the role table, the configuration of a nodes becomes a node's role - the modification of the role table takes place in two steps: first, changes are staged in a CRDT data structure. Then, once the user is happy with the changes, they can commit them all at once (or revert them). - update documentation - fix tests - implement smarter partition assignation algorithm This patch breaks the format of the network configuration: when migrating, the cluster will be in a state where no roles are assigned. All roles must be re-assigned and commited at once. This migration should not pose an issue.
* update doc and commentsTrinity Pointard2021-11-161-5/+7
|
* add s3_api.root_domain to doc bookTrinity Pointard2021-11-163-0/+10
|
* added link to RFID Garage talk (#155)adrien2021-11-161-2/+4
| | | | | | | Co-authored-by: ADRN <adrien@luxeylab.net> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/155 Co-authored-by: adrien <adrien@luxeylab.net> Co-committed-by: adrien <adrien@luxeylab.net>
* Add rclone mount docQuentin Dufour2021-11-101-0/+38
|
* Improve CLI documentationQuentin Dufour2021-11-101-5/+44
|
* Add skeleton for backups, fuse and code sectionsQuentin Dufour2021-11-105-1/+154
|
* Add documentation for Gitea.Quentin Dufour2021-11-101-3/+49
|
* Documentation for Nix binary cacheQuentin Dufour2021-11-103-38/+115
|
* hugo deploy does not build website, fix docQuentin Dufour2021-11-101-1/+2
|
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-28 18:42:55 +0000