Document replacing credentials in a basic auth setup #8491
Merged
+29
−1
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
yonipeleg33
added
docs
|
♻️ PR Preview 2dc6a56 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 |
Isan-Rivkin
approved these changes
Jan 14, 2025
| @@ -25,6 +25,34 @@ Existing lakeFS installations that have a single user and a single set of creden | |||
| Installations that have more than one user / credentials will require to run a command and choose which set of user + credentials to migrate | |||
| (more details [here](#migration-of-existing-user)) | |||
|
|
|||
| ### Replacing credentials | |||
|
|
|||
| To replace the credentials of the (single) user in a lakefs installation: | |||
There was a problem hiding this comment.
Suggested change
| To replace the credentials of the (single) user in a lakefs installation: | |
| In non-ACL setup (single user) to replace the credentials in a lakefs installation: |
Comment on lines
49
to
52
| > Calling the `superuser` command with `--access-key-id` and without `--secret-access-key` will make lakefs try to | ||
| > import an existing user (see [Migration of existing user](#migration-of-existing-user)). | ||
| > In case you already deleted the user by following step (1), this import operation will **fail** and result in an | ||
| > **unrecoverable** state, and a clean installation is the only way out. |
There was a problem hiding this comment.
Suggested change
| > Calling the `superuser` command with `--access-key-id` and without `--secret-access-key` will make lakefs try to | |
| > import an existing user (see [Migration of existing user](#migration-of-existing-user)). | |
| > In case you already deleted the user by following step (1), this import operation will **fail** and result in an | |
| > **unrecoverable** state, and a clean installation is the only way out. | |
| > Calling the `superuser` command with pre-defined `--access-key-id` and `--secret-access-key` is possible but should be done with caution. Make sure that `--secret-access-key` is **not empty**, It's suitable for ACL's | |
| > import an existing user (see [Migration of existing user](#migration-of-existing-user)). | |
| > In case you already deleted the user by following step (1), this import operation will **fail** and result in an | |
| > **unrecoverable** state, and a clean installation is the only way out. |
| > In case you already deleted the user by following step (1), this import operation will **fail** and result in an | ||
| > **unrecoverable** state, and a clean installation is the only way out. | ||
| > | ||
| > In general, replacing credentials is a risky operation. Proceed with caution. |
There was a problem hiding this comment.
Not sure what is the value of this sentence, I would remove it (up to you)
yonipeleg33
commented
Jan 14, 2025
There was a problem hiding this comment.
Thanks @Isan-Rivkin, I changed the wording in the "direction" of your suggestions, but not exactly (preferred other sentence structures).
You're welcome to take another look (not asking for re-review though 🙂)
talSofer
approved these changes
Jan 14, 2025
| @@ -25,6 +25,34 @@ Existing lakeFS installations that have a single user and a single set of creden | |||
| Installations that have more than one user / credentials will require to run a command and choose which set of user + credentials to migrate | |||
| (more details [here](#migration-of-existing-user)) | |||
|
|
|||
| ### Replacing credentials | |||
|
|
|||
| In non-ACL setup (single user), replacing credentials can be done as follows: | |||
There was a problem hiding this comment.
Suggested change
| In non-ACL setup (single user), replacing credentials can be done as follows: | |
| In a single user setup, replacing credentials can be done as follows: |
| @@ -25,6 +25,34 @@ Existing lakeFS installations that have a single user and a single set of creden | |||
| Installations that have more than one user / credentials will require to run a command and choose which set of user + credentials to migrate | |||
| (more details [here](#migration-of-existing-user)) | |||
|
|
|||
| ### Replacing credentials | |||
yonipeleg33
commented
Jan 14, 2025
There was a problem hiding this comment.
Thanks @talSofer, fixed your comments.
Waiting for CI and pulling
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 #8444