Improve docs for Standalone GC #8427
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
talSofer
added
docs
|
♻️ PR Preview c3d15d4 has been successfully destroyed since this PR has been closed.
🤖 By surge-preview |
E2E Test Results - DynamoDB Local - Local Block Adapter |
E2E Test Results - Quickstart |
yonipeleg33
requested changes
Dec 16, 2024
yonipeleg33
requested changes
Dec 17, 2024
|
|
||
| Standalone GC is a limited version of the Spark-backed GC that runs without any external dependencies, as a standalone docker image. | ||
| Standalone GC is a simplified version of the Spark-backed GC that runs without any external dependencies, delivered as a standalone | ||
| docker image. It supports S3 and [self-managed S3 compatible storages](#s3-compatible-clients) such as MinIO. |
There was a problem hiding this comment.
The link is invalid - I think you meant to link the "using-s3-compatible-clients" section?
| More about that in the [Get the List of Objects Marked for Deletion](./standalone-gc.md#get-the-list-of-objects-marked-for-deletion) section. | ||
|
|
||
| ### Lab tests | ||
| 1. **No horizontal scalability**: Only a single instance of `lakefs-sgc` can operate on a given repository at a time. |
There was a problem hiding this comment.
Now that I think about it - is it correct to say that another limitation compared to the spark-backed GC is that this one only supports AWS (and s3 compatible) storage? the spark-backed one supports any blockstore, right?
Comment on lines
135
to
137
| Standalone GC supports S3 and S3-compatible storage backends and relies on AWS credentials for authentication. To set up | ||
| credentials, follow AWS guidelines, such as those outlined in [this guide](https://docs.aws.amazon.com/cli/v1/userguide/cli-chap-configure.html). | ||
| For details on how to pass credentials to `lakefs-sgc`, refer to the instructions in [How to Run Standalone GC](#how-to-run-standalone-gc). |
There was a problem hiding this comment.
Consider being a bit more direct about configuring the docker container:
Suggested change
| Standalone GC supports S3 and S3-compatible storage backends and relies on AWS credentials for authentication. To set up | |
| credentials, follow AWS guidelines, such as those outlined in [this guide](https://docs.aws.amazon.com/cli/v1/userguide/cli-chap-configure.html). | |
| For details on how to pass credentials to `lakefs-sgc`, refer to the instructions in [How to Run Standalone GC](#how-to-run-standalone-gc). | |
| Standalone GC supports S3 and S3-compatible storage backends and relies on AWS credentials for authentication. To set up | |
| credentials on the `lakefs-sgc` docker container, follow AWS guidelines, such as those outlined in [this guide](https://docs.aws.amazon.com/cli/v1/userguide/cli-chap-configure.html). | |
| For details on how to pass credentials to `lakefs-sgc`, refer to the instructions in [How to Run Standalone GC](#how-to-run-standalone-gc). |
yonipeleg33
approved these changes
Dec 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes https://github.com/treeverse/product/issues/610