-
Notifications
You must be signed in to change notification settings - Fork 367
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document replacing credentials in a basic auth setup #8491
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
1. Delete the existing user: | ||||||||||||||||||
```shell | ||||||||||||||||||
lakectl auth users delete --id <user-id> | ||||||||||||||||||
``` | ||||||||||||||||||
2. Shut down the lakeFS server - Required for invalidating the old credentials on the server | ||||||||||||||||||
3. Create a new user, with the same name and new credentials: | ||||||||||||||||||
```shell | ||||||||||||||||||
lakefs superuser --user-name <user-id> | ||||||||||||||||||
``` | ||||||||||||||||||
This will generate a new set of credentials, and will print it out to the screen: | ||||||||||||||||||
``` | ||||||||||||||||||
credentials: | ||||||||||||||||||
access_key_id: *** (omitted) | ||||||||||||||||||
secret_access_key: *** (omitted) | ||||||||||||||||||
``` | ||||||||||||||||||
4. Re-run lakeFS server | ||||||||||||||||||
|
||||||||||||||||||
{: .note .warning} | ||||||||||||||||||
> 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
> | ||||||||||||||||||
> In general, replacing credentials is a risky operation. Proceed with caution. | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure what is the value of this sentence, I would remove it (up to you) |
||||||||||||||||||
|
||||||||||||||||||
## ACLs | ||||||||||||||||||
|
||||||||||||||||||
ACL server was moved out of core lakeFS and into a new package under `contrib/auth/acl`. | ||||||||||||||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Credentials Replacement