aboutsummaryrefslogtreecommitdiff
path: root/doc/drafts
Commit message (Collapse)AuthorAgeFilesLines
* Minor typos and grammarhartraft2024-02-201-4/+4
|
* Merge branch 'main' into nextv0.9.0-beta1Alex Auvolat2023-08-291-2/+2
|\
| * doc/drafts: fix typoFlorian Klink2023-07-141-2/+2
| |
* | admin docs: reformatting, key admin: add checkAlex Auvolat2023-06-141-39/+44
| |
* | admin: uniformize layout api and improve codeAlex Auvolat2023-06-141-0/+14
| |
* | admin and cli: hide secret keys unless askedAlex Auvolat2023-06-141-0/+3
| |
* | admin api: move all endpoints to v1/ by default (v0/ still supported)Alex Auvolat2023-06-141-22/+22
| |
* | admin api: fix doc in draftsAlex Auvolat2023-06-141-8/+8
| |
* | admin api: switch GetClusterHealth to camelcase (fix #381 again)Alex Auvolat2023-06-141-20/+20
| |
* | admin api: change cluster status/layout to use lists and not maps (fix #377)Alex Auvolat2023-06-141-39/+80
| |
* | fix mpu counter (add missing workers) and report info at appropriate placesAlex Auvolat2023-06-091-1/+4
|/
* add precision in pollrange docAlex Auvolat2023-01-111-7/+10
|
* PollRange: return immediately if no seen marker is providedAlex Auvolat2023-01-111-0/+7
|
* Add proposal spec for PollRange API endpointAlex Auvolat2023-01-101-0/+57
|
* Always return 200 OK on /v0/health, reinstate admin api doc as draft and ↵Alex Auvolat2022-12-111-0/+686
| | | | complete it
* update k2v docs for status 204 changesTobias Krischer2022-10-181-28/+28
|
* Add documentation for new Admin API and a few infos on K2VAlex Auvolat2022-05-241-603/+0
|
* 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-06 19:27:32 +0000